Meta Developers

API reference

API reference

Select your platform

No SDKs available

No versions available

BoundaryTestResult

ActiveStateDebugTree

ActiveStateDebugTreeUI

ActiveStateDebugVisual

ActiveStateModel

ActiveStateNodeUIHorizontal

ActiveStateNodeUIVertical

FingerFeatureDebugVisual

FingerFeatureSkeletalDebugVisual

HandShapeDebugVisual

HandShapeSkeletalDebugVisual

IActiveStateModel

JointRotationDebugVisual

JointVelocityDebugVisual

TransformFeatureDebugVisual

TransformFeatureVectorDebugParentVisual

TransformFeatureVectorDebugVisual

TransformRecognizerDebugVisual

IOVRAnchorComponent

UIButtonSquishHelper

OVRAnchorContainer

OVRAudioSourceTest

BoundaryTestResult

OVRChromaticAberration

OVRControllerDrivenHandPosesSample

OVRControllerHelper

OVRControllerTest

OVRControllerTest

OVRCubemapCapture

OVRCustomFaceExtensions

OVRCustomSkeleton

OVRDebugHeadController

DisplayRefreshRateChangedData

PassthroughLayerResumedData

SceneCaptureCompleteData

SpaceEraseCompleteData

SpaceListSaveResultData

SpaceQueryCompleteData

SpaceQueryResultsData

SpaceSaveCompleteData

SpaceSetComponentStatusCompleteData

SpaceShareResultData

SpatialAnchorCreateCompleteData

OVREnumExtensions

OVRFaceExpressions

OVRFaceExpressions

FaceExpressionsEnumerator

OVRGLTFAccessor

OVRGLTFAnimatinonNode

OVRGLTFAnimationNodeMorphTargetHandler

OVRHandTrackingWideMotionModeSample

OVRHapticsChannel

OVRHeadsetEmulator

OVRHumanBodyBonesMappingsInterface

HapticsAmplitudeEnvelopeVibration

HapticsPcmVibration

OVRControllerBase

OVRControllerBase

VirtualAxis1DMap

VirtualAxis2DMap

VirtualButtonMap

VirtualNearTouchMap

VirtualTouchMap

OVRControllerGamepadPC

OVRControllerHands

OVRControllerLHand

OVRControllerLTouch

OVRControllerRHand

OVRControllerRemote

OVRControllerTouch

OpenVRControllerDetails

OVRInputRayData

TrackedKeyboardInfo

TrackedKeyboardState

OVRLayerAttribute

TrackingSpacePose

PassthroughCapabilities

OVRMaterialData

IOVRMeshDataProvider

OVRMeshAttributes

NativeArrayHelper

TransformToUnitySpaceJob

TransformTrianglesJob

OVRMeshRenderer

OVRMeshRenderer

IOVRMeshRendererDataProvider

MeshRendererData

OVRMixedRealityCaptureTest

OVRNativeBuffer

OVRNetworkTcpClient

OVRNetworkTcpServer

OVRNodeStateProperties

DictionaryScope

OVROverlayCanvas

OVROverlayMeshGenerator

OVRPassthroughColorLut

OVRPassthroughLayer

OVRPermissionsRequester

OVRPlatformMenu

OVRPlayerController

OVRPointerVisualizer

OVRProgressIndicator

OVRRayTransformer

OVRResetOrientation

OVRRuntimeAssetsBase

OVRRuntimeController

OVRRuntimeSettings

OVRSceneManager

OVRSceneManager

RoomLayoutInformation

OVRSceneModelLoader

OVRSceneObjectTransformType

OVRScenePlaneMeshFilter

OVRScenePlaneMeshFilter

TriangulateBoundaryJob

OVRScenePrefabOverride

OVRSceneSampleController

OVRSceneVolumeMeshFilter

OVRSemanticClassification

OVRSemanticLabels

OVRSimultaneousHandsAndControllersSample

IOVRSkeletonDataProvider

SkeletonPoseData

OVRSkeletonRenderer

OVRSkeletonRenderer

IOVRSkeletonRendererDataProvider

SkeletonRendererData

OVRSpatialAnchor

OVRSpatialAnchor

OVRSpectatorModeDomeTest

OVRSystemPerfMetrics

OVRSystemPerfMetrics

OVRSystemPerfMetricsTcpServer

AwaitableCompletionSource

AwaitableSource

CallbackWithState

CombinedTaskData

CombinedTaskDataWithCompletedTaskId

IncrementalResultSubscriber

OVRTrackedKeyboard

OVRTrackedKeyboard

TrackedKeyboardSetActiveEvent

TrackedKeyboardVisibilityChangedEvent

OVRTrackedKeyboardHands

OVRTrackedKeyboardHands

TrackedKeyboardHandsVisibilityChangedEvent

OVRTrackedKeyboardSampleControls

OVRTriangleMesh

OVRUnityHumanoidSkeletonRetargeter

OVRUnityHumanoidSkeletonRetargeter

JointAdjustment

OVRHumanBodyBonesMappings

OVRSkeletonMetadata

OVRSkeletonMetadata

OVRVirtualKeyboard

OVRVirtualKeyboard

AbstractTextHandler

InteractorRootTransformOverride

WaitUntilKeyboardVisible

OVRVirtualKeyboardInputFieldTextHandler

OVRVirtualKeyboardSampleControls

OVRVirtualKeyboardSampleInputHandler

ActiveStateFingerVisual

ActiveStateGate

ActiveStateGroup

ActiveStateSelector

ActiveStateToggle

ActiveStateTracker

ActiveStateUnityEventWrapper

AutoMoveTowardsTarget

AutoMoveTowardsTargetProvider

Axis1DFingerUseAPI

Axis1DPrioritySelector

Axis1DPrioritySelector

Axis2DActiveState

BecomeChildOfTargetOnStart

BestHoverInteractorGroup

BestSelectInteractorGroup

BoundsExtensions

CandidateComparer

CandidatePositionComparer

CenterEyeOffset

EnumerableHashSet

IEnumerableHashSet

CollisionInteractionRegistry

ConditionalHideAttribute

ControllerActiveState

ControllerOffset

ControllerPointerPose

ControllerRayVisual

ControllerSelector

InteractorGroupDebugTreeUI

InteractorGroupNodeUI

DeprecatedPrefab

DistanceGrabInteractable

DistanceGrabInteractor

DistanceReticles

DistanceReticles

DistantInteractionLineRendererVisual

DistantInteractionLineVisual

DistantInteractionPolylineVisual

DistantInteractionTubeVisual

InteractorReticle

ReticleDataGhost

ReticleDataIcon

ReticleDataMesh

ReticleDataTeleport

ReticleGhostDrawer

ReticleIconDrawer

ReticleMeshDrawer

TeleportReticleDrawer

DistantCandidateComputer

DistantPointDetector

DistantPointDetectorFrustums

DotGridProperties

FingerFeatureStateProviderRef

FingerPinchValue

FirstHoverInteractorGroup

FloatConstraint

FollowTargetProvider

GameObjectActiveState

BezierControlPoint

BezierGrabSurface

BoxGrabSurfaceData

ColliderGrabSurface

CylinderGrabSurface

CylinderSurfaceData

SphereGrabSurface

SphereGrabSurfaceData

PoseMeasureParameters

ControllerPinchInjector

FingerPalmGrabAPI

FingerPalmGrabAPI

FingerPinchGrabAPI

FingerRawPinchAPI

FingerRawPinchInjector

GrabFreeTransformer

GrabInteractable

GrabStrengthIndicator

HandActiveState

HandConfidenceVisual

HandDebugVisual

HandFingerMaskGenerator

HandPinchOffset

HandPointerPose

HandPokeLimiterVisual

HandPokeOvershootGlow

HandRayInteractorCursorVisual

HandRayPinchGlow

HandTransformScaler

HandWristOffset

HashSetExtensions

HelpBoxAttribute

ICandidateComparer

ICandidatePosition

IDeltaTimeConsumer

IDistanceInteractor

IGameObjectFilter

IInteractableView

IInteractorView

IMovementProvider

IPointableCanvas

IPointableElement

ISnapPoseDelegate

IndexPinchSafeReleaseSelector

IndexPinchSelector

ControllerButtonUsageActiveState

ControllerDataAsset

ControllerDataSourceConfig

ControllerHandDataSource

ControllerInput

FingersMetadata

FromHandPrefabDataSource

HandDataSourceConfig

HandFilterParameterBlock

HandFingerUtils

HandPhysicsCapsules

HandSkeletonJoint

HmdDataSourceConfig

IControllerDataModifier

IHandSkeletonProvider

IReadOnlyHandSkeleton

IReadOnlyHandSkeletonJointList

ITrackingToWorldTransformer

JointRotationHistoryHand

JointsRadiusFeature

LastKnownGoodHand

OneEuroFilterPropertyBlock

ReadOnlyHandJointPoses

ShadowHandExtensions

SyntheticControllerInHand

ControllerVisual

InspectorButtonAttribute

InteractableColorVisual

InteractableColorVisual

InteractableDebugVisual

InteractableGroup

InteractableGroupView

InteractableRegistry

InteractableRegistry

InteractableSet

InteractableSet

InteractableStateChangeArgs

InteractableTriggerBroadcaster

InteractableUnityEventWrapper

InteractorActiveState

InteractorDebugVisual

InteractorGroup

InteractorStateChangeArgs

InteractorUnityEventWrapper

InterfaceAttribute

InterfaceSupport

InterfaceSupport

InterfaceDrawer

InterfacePicker

JointDeltaProviderRef

ListSnapPoseDelegate

MaterialPropertyBlockEditor

MaterialPropertyColor

MaterialPropertyFloat

MaterialPropertyVector

MonoBehaviourStartExtensions

MoveAtSourceProvider

MoveFromTargetProvider

MoveRelativeToTarget

MoveTowardsTarget

MoveTowardsTargetProvider

ObjectPullProvider

OneGrabFreeTransformer

OneGrabPhysicsJointTransformer

OneGrabRotateTransformer

OneGrabRotateTransformer

OneGrabRotateConstraints

OneGrabTranslateTransformer

OneGrabTranslateTransformer

OneGrabTranslateConstraints

OptionalAttribute

PhysicsGrabbable

PinchPointerVisual

PointableCanvas

PointableCanvasEventArgs

PointableCanvasMesh

PointableCanvasModule

PointableCanvasUnityEventWrapper

PointableDebugGizmos

PointableDebugVisual

PointableElement

PointableUnityEventWrapper

PointerInteractable

PointerInteractor

PokeInteractable

PokeInteractable

DragThresholdsConfig

MinThresholdsConfig

PositionPinningConfig

RecoilAssistConfig

PokeInteractableVisual

PolylineRenderer

ColliderContainsHandJointActiveState

ActiveStateDebugTree

ActiveStateDebugTreeUI

ActiveStateDebugVisual

ActiveStateModel

ActiveStateNodeUIHorizontal

ActiveStateNodeUIVertical

FingerFeatureDebugVisual

FingerFeatureSkeletalDebugVisual

HandShapeDebugVisual

HandShapeSkeletalDebugVisual

IActiveStateModel

JointRotationDebugVisual

JointVelocityDebugVisual

TransformFeatureDebugVisual

TransformFeatureVectorDebugParentVisual

TransformFeatureVectorDebugVisual

TransformRecognizerDebugVisual

FeatureConfigBase

FeatureConfigBuilder

FeatureConfigBuilder

FeatureDescription

FeatureStateDescription

FeatureStateProvider

FingerFeatureConfigBuilder

FingerFeatureConfigBuilder

AbductionStateBuilder

OpenCloseStateBuilder

OppositionStateBuilder

FingerFeatureProperties

FingerFeatureStateProvider

FingerFeatureStateProvider

FingerStateThresholds

FingerFeatureStateThreshold

FingerFeatureStateThresholds

FingerFeatureThresholds

IFeatureStateThreshold

IFeatureStateThresholds

IFeatureThresholds

IFingerFeatureStateProvider

IJointDeltaProvider

ITransformFeatureStateProvider

JointDeltaConfig

JointDeltaProvider

JointDistanceActiveState

JointRotationActiveState

JointRotationActiveState

JointRotationFeatureConfig

JointRotationFeatureConfigList

JointRotationFeatureState

JointVelocityActiveState

JointVelocityActiveState

JointVelocityFeatureConfig

JointVelocityFeatureConfigList

JointVelocityFeatureState

SequenceActiveState

ShapeRecognizer

ShapeRecognizer

FingerFeatureConfigList

ShapeRecognizerActiveState

TransformConfig

TransformFeatureConfigBuilder

TransformFeatureConfigBuilder

TrueFalseStateBuilder

TransformFeatureConfigList

TransformFeatureProperties

TransformFeatureStateCollection

TransformStateInfo

TransformFeatureStateProvider

TransformFeatureStateThreshold

TransformFeatureStateThresholds

TransformFeatureThresholds

TransformFeatureValueProvider

TransformFeatureValueProvider

TransformProperties

TransformJointData

TransformRecognizerActiveState

RayInteractable

RayCandidateProperties

RayInteractorCursorVisual

RayInteractorDebugGizmos

RayInteractorPinchVisual

RectTransformBoundsClipperDriver

RigidbodyKinematicLocker

RigidbodyKinematicLockerExtension

RoundedBoxProperties

SecondaryInteractorConnection

SecondaryInteractorFilter

SectionAttribute

SelectorDebugVisual

SelectorUnityEventWrapper

SequentialSlotsProvider

ShoulderEstimatePosition

SnapInteractable

SnapInteractorFollowVisual

SurfaceSnapPoseDelegate

ClippedCylinderSurface

ClippedPlaneSurface

ColliderSurface

CylinderClipper

CylinderSegment

CylinderSurface

IClippedSurface

ICylinderClipper

ControllerPoseInputDevice

HandPoseInputDevice

IPoseInputDevice

IThrowVelocityCalculator

IVelocityCalculator

RANSACVelocityCalculator

ReleaseVelocityInformation

StandardVelocityCalculator

StandardVelocityCalculator

BufferingParams

TransformSample

VelocityCalculatorUtilMethods

TouchHandGrabInteractable

TouchHandGrabInteractor

TouchHandGrabInteractorVisual

TouchShadowHand

TouchShadowHand

TransformExtensions

TransformFeatureStateProviderRef

TransformerUtils

TransformerUtils

ConstrainedAxis

PositionConstraints

RotationConstraints

ScaleConstraints

TwoGrabFreeTransformer

TwoGrabFreeTransformer

TwoGrabFreeConstraints

TwoGrabPlaneTransformer

TwoGrabPlaneTransformer

TwoGrabPlaneConstraints

TwoGrabRotateTransformer

TwoGrabRotateTransformer

TwoGrabRotateConstraints

UniqueIdentifier

InputMouseButton

MeshGenerationSettings

CanvasMeshRenderer

CanvasMeshRenderer

CanvasRenderTexture

CanvasRenderTexture

UpdateCanvasSortingOrder

UpdateDriverAfterDataSource

UpdateDriverGroup

UseFingerControllerAPI

UseFingerCurlAPI

UseFingerRawPinchAPI

FilteredTransform

VectorExtensions

VersionTextVisual

VirtualPointable

VirtualSelector

OperationResultExtensions

SharedSpatialAnchorErrorHandler

OVRPhysicsRaycaster

OVRPointerEventData

PointerEventDataExtension

OVRDisplay Class

Manages an Oculus Rift head-mounted display (HMD).

See Also:

Overview

Object Data

bool	needsConfigureTexture`[Get]`
EyeRenderDesc[]	eyeDescs`[Get]`
bool	recenterRequested`[Get]`
int	recenterRequestedFrameCount`[Get]`
int	localTrackingSpaceRecenterCount`[Get]`

Events

System.Action

RecenteredPose ( )

Occurs when the head pose is reset.

Properties

Vector3	acceleration`[Get]` (Deprecated) Gets the current linear acceleration of the head.
Vector3	angularAcceleration`[Get]` (Deprecated) Gets the current angular acceleration of the head in radians per second per second about each axis.
Vector3	velocity`[Get]` Gets the current linear velocity of the head in meters per second.
Vector3	angularVelocity`[Get]` Gets the current angular velocity of the head in radians per second about each axis.
LatencyData	latency`[Get]` Gets the current measured latency values.
float	appFramerate`[Get]` Gets application's frame rate reported by oculus plugin.
int	recommendedMSAALevel`[Get]` Gets the recommended MSAA level for optimal quality/performance the current device.
float[]	displayFrequenciesAvailable`[Get]` Gets the list of available display frequencies supported by this hardware.
float	displayFrequency`[Get]` Gets and sets the current display frequency.

Public Member Functions

	OVRDisplay ( ) Creates an instance of OVRDisplay.
void	Update ( ) Updates the internal state of the OVRDisplay.
void	RecenterPose ( ) Recenters the head pose.
EyeRenderDesc	GetEyeRenderDesc ( UnityEngine.XR.XRNode eye ) Gets the resolution and field of view for the given eye.

Object Data

void	UpdateTextures ( )
void	ConfigureEyeDesc ( Node eye )

Details

Object Data

bool OVRDisplay.needsConfigureTexture
No description available.

EyeRenderDesc [] OVRDisplay.eyeDescs
No description available.

bool OVRDisplay.recenterRequested
No description available.

int OVRDisplay.recenterRequestedFrameCount
No description available.

int OVRDisplay.localTrackingSpaceRecenterCount
No description available.

Events

System.Action OVRDisplay.RecenteredPose ( )
Occurs when the head pose is reset.

Properties

Vector3 OVRDisplay.acceleration
(Deprecated) Gets the current linear acceleration of the head.

Vector3 OVRDisplay.angularAcceleration
(Deprecated) Gets the current angular acceleration of the head in radians per second per second about each axis.

Vector3 OVRDisplay.velocity
Gets the current linear velocity of the head in meters per second.

Vector3 OVRDisplay.angularVelocity
Gets the current angular velocity of the head in radians per second about each axis.

LatencyData OVRDisplay.latency
Gets the current measured latency values.

float OVRDisplay.appFramerate
Gets application's frame rate reported by oculus plugin.

int OVRDisplay.recommendedMSAALevel
Gets the recommended MSAA level for optimal quality/performance the current device.

float [] OVRDisplay.displayFrequenciesAvailable
Gets the list of available display frequencies supported by this hardware.

float OVRDisplay.displayFrequency
Gets and sets the current display frequency.

Member Functions

OVRDisplay.OVRDisplay ( )
Creates an instance of OVRDisplay. Called by OVRManager.

void OVRDisplay.Update ( )
Updates the internal state of the OVRDisplay. Called by OVRManager.

void OVRDisplay.RecenterPose ( )
Recenters the head pose.

EyeRenderDesc OVRDisplay.GetEyeRenderDesc ( UnityEngine.XR.XRNode eye )
Gets the resolution and field of view for the given eye.

Object Data

void OVRDisplay.UpdateTextures ( )
No description available.

void OVRDisplay.ConfigureEyeDesc ( Node eye )
No description available.

Did you find this page helpful?