API reference
API reference
Select your platform
No SDKs available
No versions available

OVRDisplay Class

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

Constructors

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

Protected Fields

eyeDescs : EyeRenderDesc[]
Signature
EyeRenderDesc [] OVRDisplay.eyeDescs
localTrackingSpaceRecenterCount : int
Signature
int OVRDisplay.localTrackingSpaceRecenterCount
needsConfigureTexture : bool
Signature
bool OVRDisplay.needsConfigureTexture
recenterRequested : bool
Signature
bool OVRDisplay.recenterRequested
recenterRequestedFrameCount : int
Signature
int OVRDisplay.recenterRequestedFrameCount

Properties

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

Events

RecenteredPose : System.Action
Occurs when the head pose is reset.
Signature
System.Action OVRDisplay.RecenteredPose

Protected Methods

ConfigureEyeDesc ( eye )
Signature
void OVRDisplay.ConfigureEyeDesc(Node eye)
Parameters
eye: Node
Returns
void
UpdateTextures ()
Signature
void OVRDisplay.UpdateTextures()
Returns
void

Methods

GetEyeRenderDesc ( eye )
Gets the resolution and field of view for the given eye.
Signature
EyeRenderDesc OVRDisplay.GetEyeRenderDesc(UnityEngine.XR.XRNode eye)
Parameters
eye: UnityEngine.XR.XRNode
Returns
EyeRenderDesc
RecenterPose ()
Recenters the head pose.
Signature
void OVRDisplay.RecenterPose()
Returns
void
Update ()
Updates the internal state of the OVRDisplay.
Called by OVRManager.
Signature
void OVRDisplay.Update()
Returns
void

Inner Structs

EyeFov Struct

Contains full fov information per eye Under Symmetric Fov mode, UpFov == DownFov and LeftFov == RightFov.

Fields

DownFov : float
Signature
float OVRDisplay.EyeFov.DownFov
LeftFov : float
Signature
float OVRDisplay.EyeFov.LeftFov
RightFov : float
Signature
float OVRDisplay.EyeFov.RightFov
UpFov : float
Signature
float OVRDisplay.EyeFov.UpFov

EyeRenderDesc Struct

Specifies the size and field-of-view for one eye texture.

Fields

fov : Vector2
The angle of the horizontal and vertical field of view in degrees.
For Symmetric FOV interface compatibility Note this includes the fov angle from both sides
Signature
Vector2 OVRDisplay.EyeRenderDesc.fov
fullFov : EyeFov
The full information of field of view in degrees.
When Asymmetric FOV isn't enabled, this returns the maximum fov angle
Signature
EyeFov OVRDisplay.EyeRenderDesc.fullFov
resolution : Vector2
The horizontal and vertical size of the texture.
Signature
Vector2 OVRDisplay.EyeRenderDesc.resolution

LatencyData Struct

Contains latency measurements for a single frame of rendering.

Fields

postPresent : float
The time between the end of TimeWarp and scan-out in seconds.
Signature
float OVRDisplay.LatencyData.postPresent
render : float
The time it took to render both eyes in seconds.
Signature
float OVRDisplay.LatencyData.render
renderError : float
Signature
float OVRDisplay.LatencyData.renderError
timeWarp : float
The time it took to perform TimeWarp in seconds.
Signature
float OVRDisplay.LatencyData.timeWarp
timeWarpError : float
Signature
float OVRDisplay.LatencyData.timeWarpError