API reference

Select your platform

No SDKs available

No versions available

Overview

OVRChromaticAberration

OVRColocationSession

OVRControllerDrivenHandPosesSample

OVRCustomFaceExtensions

OVRCustomSkeleton

OVRDebugHeadController

OVRGLTFAnimatinonNode

OVRGLTFAnimationNodeMorphTargetHandler

OVRHandTrackingWideMotionModeSample

OVRHumanBodyBonesMappingsInterface

OVRMicrogestureEventSource

OVRMicrogesturesSample

OVRMixedRealityCaptureTest

OVRNodeStateProperties

OVROverlay

OVROverlayCanvas

OVROverlayCanvasManager

OVROverlayCanvasSettings

OVROverlayCanvas_TMPChanged

OVROverlayMeshGenerator

OVRPassthroughColorLut

OVRPassthroughLayer

OVRPermissionsRequester

OVRSceneObjectTransformType

OVRScenePlane

OVRScenePlaneMeshFilter

OVRScenePrefabOverride

OVRSceneRoom

OVRSceneSampleController

OVRSceneVolume

OVRSceneVolumeMeshFilter

OVRScreenFade

OVRSemanticClassification

OVRSemanticLabels

OVRSharable

OVRSimultaneousHandsAndControllersSample

OVRUnityHumanoidSkeletonRetargeter

OVRVignette

OVRVirtualKeyboard

OVRVirtualKeyboardInputFieldTextHandler

OVRVirtualKeyboardSampleControls

OVRVirtualKeyboardSampleInputHandler

OVRWaitCursor

OperationResultExtensions

ProcessPort

RoomMeshAnchor

SharedSpatialAnchorErrorHandler

Code samples

Downloads

Release notes

OVRDisplay Class

The OVRDisplay class manages the head-mounted display (HMD) of Meta Quest or PC headsets.

Here are a few features supported by this class:

Obtain headset velocity (see Velocity)

Headset recentering detection (see RecenteredPose)

Asymmetric Field of View

Display Refresh Rates

Protected Fields

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.

float[] displayFrequenciesAvailable[Get]

Gets the list of available display frequencies supported by this hardware.

float displayFrequency[Get]

Gets and sets the current display frequency.

Constructors & Destructors

OVRDisplay ( )

Creates an instance of OVRDisplay.

Called by OVRManager.

void Update ( )

Updates the internal state of the OVRDisplay.

Called by OVRManager.

void RecenterPose ( )

Recenters the head pose.

EyeRenderDesc GetEyeRenderDesc

( UnityEngine.XR.XRNode eye )

Gets the resolution and field of view for the given eye.

Protected Functions

void UpdateTextures ( )

void ConfigureEyeDesc