It is a singleton that exposes the core Meta XR SDK functionality to Unity, and includes helper functions that use the stored Meta variables to help configure the system behavior of Meta Quest. If you are not using OVRCameraRig, you can also add OVRManager to your own game object. It should only be added once. For more information, see the Configure Settings section in Add Camera Rig Using OVRCameraRig.

Protected Fields

disabledCameras : IEnumerable< Camera >

Signature

IEnumerable<Camera> disabledCameras

Fields

AllowRecenter : bool	If true, the Reset View in the universal menu will cause the pose to be reset in PC VR. This should generally be enabled for applications with a stationary position in the virtual world and will allow the View Reset command to place the person back to a predefined location (such as a cockpit seat). Set this to false if you have a locomotion system because resetting the view would effectively teleport the player to potentially invalid locations. Signature bool AllowRecenter
controllerDrivenHandPosesType : OVRManager.ControllerDrivenHandPosesType	Defines if hand poses can be populated by controller data. Signature OVRManager.ControllerDrivenHandPosesType controllerDrivenHandPosesType
coreMetricVisibility : OVRMetricsCore.AppMetricsVisibilityConfiguration	What core application metrics should be visible in OVRMetricsTool. Signature OVRMetricsCore.AppMetricsVisibilityConfiguration coreMetricVisibility
dynamicResolutionVersion : int	Signature int dynamicResolutionVersion
enableCoreMetricsDevelopment : bool	Whether core metrics from Unity should be reported to OVRMetricsTool in development builds. If enabled, all core metrics will be sent to OVRMetricsTool and recorded, however, only metrics marked as visible will show on the overlay HUD. Signature bool enableCoreMetricsDevelopment
enableCoreMetricsRelease : bool	Whether core metrics from Unity should be reported to OVRMetricsTool in release builds. If enabled, all core metrics will be sent to OVRMetricsTool and recorded, and may be viewed by any OVR Metrics Tool user. Metrics marked as visible will also be visible to all OMT users. Signature bool enableCoreMetricsRelease
fastMotionModeHandPosesEnabled : bool	Experimental: Defines if hand poses leverage a higher frequency capture rate. Signature bool fastMotionModeHandPosesEnabled
isInsightPassthroughEnabled : bool	Specify if Insight Passthrough should be enabled. Passthrough layers can only be used if passthrough is enabled. Signature bool isInsightPassthroughEnabled
LateControllerUpdate : bool	If true, a lower-latency update will occur right before rendering. If false, the only controller pose update will occur at the start of simulation for a given frame. Selecting this option lowers rendered latency for controllers and is often a net positive; however, it also creates a slight disconnect between rendered and simulated controller poses. Visit online Oculus documentation to learn more. Signature bool LateControllerUpdate
launchSimultaneousHandsControllersOnStartup : bool	Specify if simultaneous hands and controllers should be enabled. Signature bool launchSimultaneousHandsControllersOnStartup
maxDynamicResolutionScale : float	Signature float maxDynamicResolutionScale
maxRenderScale : float	Max RenderScale the app can reach under adaptive resolution mode ( enableAdaptiveResolution = true );. Signature float maxRenderScale
minDynamicResolutionScale : float	Signature float minDynamicResolutionScale
minRenderScale : float	Min RenderScale the app can reach under adaptive resolution mode ( enableAdaptiveResolution = true );. Signature float minRenderScale
quest2MaxDynamicResolutionScale : float	Signature float quest2MaxDynamicResolutionScale
quest2MinDynamicResolutionScale : float	Signature float quest2MinDynamicResolutionScale
quest3MaxDynamicResolutionScale : float	Signature float quest3MaxDynamicResolutionScale
quest3MinDynamicResolutionScale : float	Signature float quest3MinDynamicResolutionScale
resetTrackerOnLoad : bool	If true, each scene load will cause the head pose to reset. This function only works on Rift. Signature bool resetTrackerOnLoad
shouldBoundaryVisibilityBeSuppressed : bool	The desired state for the Guardian boundary visibility. The system may ignore a request to suppress the boundary visibility if deemed necessary. If Passthrough has been initialized, then an attempt will be made every frame to update the boundary state if different from the system state. It is important to therefore keep this variable aligned with the state of your Passthrough layers (e.g. set boundary suppression to false when disabling the OVRPassthroughLayer, and set boundary suppression to true only when the layer is active). Signature bool shouldBoundaryVisibilityBeSuppressed
SimultaneousHandsAndControllersEnabled : bool	Allows the application to use simultaneous hands and controllers functionality. This option must be enabled at build time. Signature bool SimultaneousHandsAndControllersEnabled
useIPDInPositionTracking : bool	If true, the distance between the user's eyes will affect the position of each OVRCameraRig's cameras. Signature bool useIPDInPositionTracking
usePositionTracking : bool	If true, head tracking will affect the position of each OVRCameraRig's cameras. Signature bool usePositionTracking
useRotationTracking : bool	If true, head tracking will affect the rotation of each OVRCameraRig's cameras. Signature bool useRotationTracking
wideMotionMode2HandPosesEnabled : bool	Experimental: New path to define if hand poses can leverage algorithms to retrieve hand poses outside of the normal tracking area. Signature bool wideMotionMode2HandPosesEnabled
wideMotionModeHandPosesEnabled : bool	Signature bool wideMotionModeHandPosesEnabled

Protected Static Fields

_profile : OVRProfile	Signature OVRProfile _profile
m_AppSpaceTransform : Transform	Signature Transform m_AppSpaceTransform
m_CachedDepthTextureMode : DepthTextureMode	Signature DepthTextureMode m_CachedDepthTextureMode
m_lastSpaceWarpCamera : WeakReference< Camera >	Signature WeakReference<Camera> m_lastSpaceWarpCamera
m_SpaceWarpEnabled : bool	Signature bool m_SpaceWarpEnabled
OpenVRTouchPositionOffsetLeft : Vector3	Signature Vector3 OpenVRTouchPositionOffsetLeft
OpenVRTouchPositionOffsetRight : Vector3	Signature Vector3 OpenVRTouchPositionOffsetRight
OpenVRTouchRotationOffsetEulerLeft : Vector3	Signature Vector3 OpenVRTouchRotationOffsetEulerLeft
OpenVRTouchRotationOffsetEulerRight : Vector3	Signature Vector3 OpenVRTouchRotationOffsetEulerRight

Static Fields

loadedXRDevice : XRDevice	Signature XRDevice loadedXRDevice
MaxDynamicResolutionVersion : int	Signature int MaxDynamicResolutionVersion
OCULUS_UNITY_NAME_STR : string	Signature string OCULUS_UNITY_NAME_STR
OnPassthroughInitializedStateChange : Action< bool >	Signature Action<bool> OnPassthroughInitializedStateChange
OPENVR_UNITY_NAME_STR : string	Signature string OPENVR_UNITY_NAME_STR
OVRManagerinitialized : bool	Signature bool OVRManagerinitialized
UnityAlphaOrBetaVersionWarningMessage : string	Signature string UnityAlphaOrBetaVersionWarningMessage

Properties

audioInId : string [Get]	Gets the audio input device identifier. On Windows, this is a string containing the GUID of the IMMDevice for the Windows audio endpoint to use. Signature string audioInId
audioOutId : string [Get]	Gets the audio output device identifier. On Windows, this is a string containing the GUID of the IMMDevice for the Windows audio endpoint to use. Signature string audioOutId
batteryLevel : float [Get]	Gets the current battery level (Deprecated). Signature float batteryLevel
batteryStatus : int [Get]	Gets the current battery status (Deprecated). Signature int batteryStatus
batteryTemperature : float [Get]	Gets the current battery temperature (Deprecated). Signature float batteryTemperature
boundary : OVRBoundary [Get]	Gets a reference to the active boundary system. Signature OVRBoundary boundary
chromatic : bool [Get][Set]	If true, chromatic de-aberration will be applied, improving the image at the cost of texture bandwidth. Signature bool chromatic
colorGamut : OVRManager.ColorSpace [Get][Set]	The target color gamut the HMD will perform a color space transformation to. Signature OVRManager.ColorSpace colorGamut
cpuLevel : int [Get][Set]	Gets or sets the current CPU performance level (0-2). Lower performance levels save more power. (Deprecated) Signature int cpuLevel
disableRecording : bool [Get][Set]	When enabled, the eye buffer is marked as secure to prevent recording or casting. Signature bool disableRecording
display : OVRDisplay [Get]	Gets a reference to the active display. Signature OVRDisplay display
enableDynamicResolution : bool [Get][Set]	Signature bool enableDynamicResolution
eyeFovPremultipliedAlphaModeEnabled : bool [Get][Set]	If premultipled alpha blending is used for the eye fov layer. Useful for changing how the eye fov layer blends with underlays. Signature bool eyeFovPremultipliedAlphaModeEnabled
eyeTextureFormat : EyeTextureFormat [Get][Set]	Gets or sets the eye texture format. Signature EyeTextureFormat eyeTextureFormat
eyeTrackedFoveatedRenderingEnabled : bool [Get][Set]	Gets or sets if eye tracked foveated rendering is enabled or not. Signature bool eyeTrackedFoveatedRenderingEnabled
eyeTrackedFoveatedRenderingSupported : bool [Get]	Gets if eye tracked foveated rendering feature is supported on this device. Signature bool eyeTrackedFoveatedRenderingSupported
fixedFoveatedRenderingLevel : FixedFoveatedRenderingLevel [Get][Set]	Signature FixedFoveatedRenderingLevel fixedFoveatedRenderingLevel
fixedFoveatedRenderingSupported : bool [Get]	Signature bool fixedFoveatedRenderingSupported
foveatedRenderingLevel : FoveatedRenderingLevel [Get][Set]	Gets or sets the tiled-based multi-resolution level This feature is only supported on QCOMM-based Android devices. Signature FoveatedRenderingLevel foveatedRenderingLevel
gpuLevel : int [Get][Set]	Gets or sets the current GPU performance level (0-2). Lower performance levels save more power. (Deprecated) Signature int gpuLevel
gpuUtilLevel : float [Get]	Gets the GPU Utilised Level (0.0 - 1.0) This feature is only supported on QCOMM-based Android devices. Signature float gpuUtilLevel
gpuUtilSupported : bool [Get]	Gets if the GPU Utility is supported This feature is only supported on QCOMM-based Android devices. Signature bool gpuUtilSupported
hasInputFocus : bool [Get]	If true, the app has Input Focus. Signature bool hasInputFocus
hasVrFocus : bool [Get]	If true, the app has VR Focus. Signature bool hasVrFocus
headPoseRelativeOffsetRotation : Vector3 [Get][Set]	Signature Vector3 headPoseRelativeOffsetRotation
headPoseRelativeOffsetTranslation : Vector3 [Get][Set]	Signature Vector3 headPoseRelativeOffsetTranslation
instance : OVRManager [Get]	Gets the singleton instance. Signature OVRManager instance
isBoundaryVisibilitySuppressed : bool [Get]	The system state of the Guardian boundary visibility. Signature bool isBoundaryVisibilitySuppressed
isHmdPresent : bool [Get]	If true, a head-mounted display is connected and present. Signature bool isHmdPresent
isPowerSavingActive : bool [Get]	If true, the CPU and GPU are currently throttled to save power and/or reduce the temperature. Signature bool isPowerSavingActive
IsSimultaneousHandsAndControllersSupported : bool [Get]	Signature bool IsSimultaneousHandsAndControllersSupported
isSupportedPlatform : bool [Get]	True if the current platform supports virtual reality. Signature bool isSupportedPlatform
isUserPresent : bool [Get]	True if the user is currently wearing the display. Signature bool isUserPresent
localDimming : bool [Get][Set]	Defines whether local dimming will be enabled on supported platforms. Signature bool localDimming
metrics : OVRMetricsCore [Get]	Gets a reference to the core metrics utility, to enable or disable the visibility of metrics at runtime. Signature OVRMetricsCore metrics
monoscopic : bool [Get][Set]	Signature bool monoscopic
nativeColorGamut : OVRManager.ColorSpace [Get]	The native color gamut of the target HMD. Signature OVRManager.ColorSpace nativeColorGamut
pluginVersion : System.Version [Get]	Signature System.Version pluginVersion
profile : OVRProfile [Get]	Gets the current profile, which contains information about the user's settings and body dimensions. Signature OVRProfile profile
runtimeSettings : OVRRuntimeSettings [Get]	Gets a reference to the runtime settings. Signature OVRRuntimeSettings runtimeSettings
sdkVersion : System.Version [Get]	Signature System.Version sdkVersion
sharpenType : OVRPlugin.LayerSharpenType [Get][Set]	The sharpen type for the eye buffer. Signature OVRPlugin.LayerSharpenType sharpenType
suggestedCpuPerfLevel : ProcessorPerformanceLevel [Get][Set]	Gets or sets the current suggested CPU performance level, which can be overriden by the Power Management system. Signature ProcessorPerformanceLevel suggestedCpuPerfLevel
suggestedGpuPerfLevel : ProcessorPerformanceLevel [Get][Set]	Gets or sets the current suggested GPU performance level, which can be overriden by the Power Management system. Signature ProcessorPerformanceLevel suggestedGpuPerfLevel
systemHeadsetTheme : SystemHeadsetTheme [Get]	Get the system headset theme. This feature is only supported on Android-based devices. It will return dark (the default theme) on other devices. Signature SystemHeadsetTheme systemHeadsetTheme
systemHeadsetType : SystemHeadsetType [Get]	Get the system headset type. Signature SystemHeadsetType systemHeadsetType
tiledMultiResLevel : TiledMultiResLevel [Get][Set]	Signature TiledMultiResLevel tiledMultiResLevel
tiledMultiResSupported : bool [Get]	Signature bool tiledMultiResSupported
tracker : OVRTracker [Get]	Gets a reference to the active sensor. Signature OVRTracker tracker
trackingOriginType : OVRManager.TrackingOrigin [Get][Set]	Defines the current tracking origin type. Signature OVRManager.TrackingOrigin trackingOriginType
useDynamicFixedFoveatedRendering : bool [Get][Set]	Let the system decide the best foveation level adaptively (Off . . fixedFoveatedRenderingLevel) This feature is only supported on QCOMM-based Android devices Signature bool useDynamicFixedFoveatedRendering
useDynamicFoveatedRendering : bool [Get][Set]	Signature bool useDynamicFoveatedRendering
utilitiesVersion : System.Version [Get]	Signature System.Version utilitiesVersion
volumeLevel : float [Get]	Gets the current volume level (Deprecated). Signature float volumeLevel
vsyncCount : int [Get][Set]	The number of expected display frames per rendered frame. Signature int vsyncCount
xrApi : XrApi [Get]	The native XR API being used. Signature XrApi xrApi
xrInstance : UInt64 [Get]	The value of current XrInstance when using OpenXR. Signature UInt64 xrInstance
xrSession : UInt64 [Get]	The value of current XrSession when using OpenXR. Signature UInt64 xrSession

Events

AudioInChanged : Action	Occurs when the active Audio In device has changed and a restart is needed. Signature Action AudioInChanged
AudioOutChanged : Action	Occurs when the active Audio Out device has changed and a restart is needed. Signature Action AudioOutChanged
BoundaryVisibilityChanged : Action< OVRPlugin.BoundaryVisibility >	Occurs when the system's boundary visibility has been changed. @params (OVRPlugin.BoundaryVisibility newBoundaryVisibility) Signature Action<OVRPlugin.BoundaryVisibility> BoundaryVisibilityChanged
DisplayRefreshRateChanged : Action< float, float >	Occurs when the display refresh rate changes @params (float fromRefreshRate, float toRefreshRate) Signature Action<float, float> DisplayRefreshRateChanged
HMDAcquired : Action	Occurs when an HMD attached. Signature Action HMDAcquired
HMDLost : Action	Occurs when an HMD detached. Signature Action HMDLost
HMDMounted : Action	Occurs when an HMD is put on the user's head. Signature Action HMDMounted
HMDUnmounted : Action	Occurs when an HMD is taken off the user's head. Signature Action HMDUnmounted
HSWDismissed : Action	Occurs when Health & Safety Warning is dismissed. Signature Action HSWDismissed
InputFocusAcquired : Action	Occurs when Input Focus is acquired. Signature Action InputFocusAcquired
InputFocusLost : Action	Occurs when Input Focus is lost. Signature Action InputFocusLost
PassthroughLayerResumed : Action< int >	Occurs when a passthrough layer has been rendered and presented on the HMD screen for the first time after being restarted. @params (int layerId) Signature Action<int> PassthroughLayerResumed
SceneCaptureComplete : Action< UInt64, bool >	Occurs when a scene capture request completes @params (UInt64 requestId, bool result) Signature Action<UInt64, bool> SceneCaptureComplete
ShareSpacesComplete : Action< UInt64, OVRSpatialAnchor.OperationResult >	Occurs when sharing spatial entities @params (UInt64 requestId, OVRSpatialAnchor.OperationResult result) Signature Action<UInt64, OVRSpatialAnchor.OperationResult> ShareSpacesComplete
SpaceEraseComplete : Action< UInt64, bool, Guid, OVRPlugin.SpaceStorageLocation >	Occurs when erasing a space @params (UInt64 requestId, bool result, Guid uuid, SpaceStorageLocation location) Signature Action<UInt64, bool, Guid, OVRPlugin.SpaceStorageLocation> SpaceEraseComplete
SpaceListSaveComplete : Action< UInt64, OVRSpatialAnchor.OperationResult >	Occurs when saving space list @params (UInt64 requestId, OVRSpatialAnchor.OperationResult result) Signature Action<UInt64, OVRSpatialAnchor.OperationResult> SpaceListSaveComplete
SpaceQueryComplete : Action< UInt64, bool >	Occurs when querying for a space completes @params (UInt64 requestId, bool result) Signature Action<UInt64, bool> SpaceQueryComplete
SpaceQueryResults : Action< UInt64 >	Occurs when one or more spaces are found during query @params (UInt64 requestId) Signature Action<UInt64> SpaceQueryResults
SpaceSaveComplete : Action< UInt64, OVRSpace, bool, Guid >	Occurs when saving a space @params (UInt64 requestId, OVRSpace space, bool result, Guid uuid) Signature Action<UInt64, OVRSpace, bool, Guid> SpaceSaveComplete
SpaceSetComponentStatusComplete : Action< UInt64, bool, OVRSpace, Guid, OVRPlugin.SpaceComponentType, bool >	Occurs when attempting to enable a component on a space @params (UInt64 requestId, bool result, OVRSpace space, Guid uuid, OVRPlugin.SpaceComponentType componentType, bool enabled) Signature Action<UInt64, bool, OVRSpace, Guid, OVRPlugin.SpaceComponentType, bool> SpaceSetComponentStatusComplete
SpatialAnchorCreateComplete : Action< UInt64, bool, OVRSpace, Guid >	Occurs when attempting to create a spatial anchor space @params (UInt64 requestId, bool result, OVRSpace space, Guid uuid) Signature Action<UInt64, bool, OVRSpace, Guid> SpatialAnchorCreateComplete
TrackingAcquired : Action	Occurs when the sensor gained tracking. Signature Action TrackingAcquired
TrackingLost : Action	Occurs when the sensor lost tracking. Signature Action TrackingLost
TrackingOriginChangePending : Action< TrackingOrigin, OVRPose?>	Occurs when there is a change happening to a tracking origin, such as a recenter. @params (TrackingOrigin trackingOrigin, OVRPose? poseInPreviousSpace) The new pose of the tracking origin is provided with respect to the previous space. This can be null when no previous space/tracking origin was defined. Signature Action<TrackingOrigin, OVRPose?> TrackingOriginChangePending
VrFocusAcquired : Action	Occurs when VR Focus is acquired. Signature Action VrFocusAcquired
VrFocusLost : Action	Occurs when VR Focus is lost. Signature Action VrFocusLost

Methods

DeregisterEventListener ( listener )	Signature void DeregisterEventListener(EventListener listener) Parameters `listener: EventListener` Returns `void`
RegisterEventListener ( listener )	Signature void RegisterEventListener(EventListener listener) Parameters `listener: EventListener` Returns `void`
ReturnToLauncher ()	Leaves the application/game and returns to the launcher/dashboard. Signature void ReturnToLauncher() Returns `void`
UpdateDynamicResolutionVersion ()	Signature void UpdateDynamicResolutionVersion() Returns `void`

Protected Static Methods

OnPermissionGranted ( permissionId )

Signature

static void OnPermissionGranted(string permissionId)

Parameters

permissionId: string

Returns

void

Static Methods

FindMainCamera ()	Signature static Camera FindMainCamera() Returns `Camera`
GetDynamicFoveatedRenderingEnabled ()	Signature static bool GetDynamicFoveatedRenderingEnabled() Returns `bool`
GetEyeTrackedFoveatedRenderingEnabled ()	Signature static bool GetEyeTrackedFoveatedRenderingEnabled() Returns `bool`
GetEyeTrackedFoveatedRenderingSupported ()	Signature static bool GetEyeTrackedFoveatedRenderingSupported() Returns `bool`
GetFixedFoveatedRenderingSupported ()	Signature static bool GetFixedFoveatedRenderingSupported() Returns `bool`
GetFoveatedRenderingLevel ()	Signature static FoveatedRenderingLevel GetFoveatedRenderingLevel() Returns `FoveatedRenderingLevel`
GetOpenVRControllerOffset ( hand )	Specifies the pose offset required to make an OpenVR controller's reported pose match the virtual pose. Currently we only specify this offset for Oculus Touch on OpenVR. Signature static OVRPose GetOpenVRControllerOffset(Node hand) Parameters `hand: Node` Returns `OVRPose`
GetPassthroughCapabilities ()	Returns information about Passthrough capabilities provided by the system. This method should only be called when the XR Plug-in is initialized. Signature static PassthroughCapabilities GetPassthroughCapabilities() Returns `PassthroughCapabilities`
GetSpaceWarp ()	Signature static bool GetSpaceWarp() Returns `bool`
HasInsightPassthroughInitFailed ()	Checks whether Passthrough has failed initialization. Signature static bool HasInsightPassthroughInitFailed() Returns `bool` Boolean value to indicate the passthrough initialization failed status. If the value returned is true, Passthrough has failed the initialization.
IsAdaptiveResSupportedByEngine ()	Adaptive Resolution is based on Unity engine's renderViewportScale/eyeTextureResolutionScale feature But renderViewportScale was broken in an array of Unity engines, this function help to filter out those broken engines. Signature static bool IsAdaptiveResSupportedByEngine() Returns `bool`
IsInsightPassthroughInitialized ()	Checks whether Passthrough is initialized. Signature static bool IsInsightPassthroughInitialized() Returns `bool` Boolean value to indicate the current state of passthrough. If the value returned is true, Passthrough is initialized.
IsInsightPassthroughInitPending ()	Checks whether Passthrough is in the process of initialization. Signature static bool IsInsightPassthroughInitPending() Returns `bool` Boolean value to indicate the current state of passthrough. If the value returned is true, Passthrough is initializing.
IsInsightPassthroughSupported ()	Checks whether Passthrough is supported by the system. This method should only be called when the XR Plug-in is initialized. Signature static bool IsInsightPassthroughSupported() Returns `bool`
IsMultimodalHandsControllersSupported ()	Checks whether simultaneous hands and controllers is currently supported by the system. This method should only be called when the XR Plug-in is initialized. Signature static bool IsMultimodalHandsControllersSupported() Returns `bool`
IsPassthroughRecommended ()	Get a system recommendation on whether Passthrough should be active. When set, it is recommended for apps which optionally support an MR experience with Passthrough to default to that mode. Currently, this is determined based on whether the user has Passthrough active in the home environment. Signature static bool IsPassthroughRecommended() Returns `bool` Flag indicating whether Passthrough is recommended.
IsUnityAlphaOrBetaVersion ()	Signature static bool IsUnityAlphaOrBetaVersion() Returns `bool`
PlatformUIConfirmQuit ()	Signature static void PlatformUIConfirmQuit() Returns `void`
SetAppSpacePosition ( x , y , z )	Signature static void SetAppSpacePosition(float x, float y, float z) Parameters `x: float` `y: float` `z: float` Returns `void`
SetAppSpaceRotation ( x , y , z , w )	Signature static void SetAppSpaceRotation(float x, float y, float z, float w) Parameters `x: float` `y: float` `z: float` `w: float` Returns `void`
SetColorScaleAndOffset ( colorScale , colorOffset , applyToAllLayers )	Sets the Color Scale and Offset which is commonly used for effects like fade-to-black. In our compositor, once a given frame is rendered, warped, and ready to be displayed, we then multiply each pixel by colorScale and add it to colorOffset, whereby newPixel = oldPixel * colorScale + colorOffset. Note that for mobile devices (Quest, etc.), colorOffset is only supported with OpenXR, so colorScale is all that can be used. A colorScale of (1, 1, 1, 1) and colorOffset of (0, 0, 0, 0) will lead to an identity multiplication and have no effect. Signature static void SetColorScaleAndOffset(Vector4 colorScale, Vector4 colorOffset, bool applyToAllLayers) Parameters `colorScale: Vector4` `colorOffset: Vector4` `applyToAllLayers: bool` Returns `void`
SetColorScaleAndOffset_Internal ( colorScale , colorOffset , applyToAllLayers )	Signature static bool SetColorScaleAndOffset_Internal(Vector4 colorScale, Vector4 colorOffset, bool applyToAllLayers) Parameters `colorScale: Vector4` `colorOffset: Vector4` `applyToAllLayers: bool` Returns `bool`
SetDynamicFoveatedRenderingEnabled ( enabled )	Signature static void SetDynamicFoveatedRenderingEnabled(bool enabled) Parameters `enabled: bool` Returns `void`
SetEyeTrackedFoveatedRenderingEnabled ( enabled )	Signature static void SetEyeTrackedFoveatedRenderingEnabled(bool enabled) Parameters `enabled: bool` Returns `void`
SetFoveatedRenderingLevel ( level )	Signature static void SetFoveatedRenderingLevel(FoveatedRenderingLevel level) Parameters `level: FoveatedRenderingLevel` Returns `void`
SetOpenVRLocalPose ( leftPos , rightPos , leftRot , rightRot )	Specifies OpenVR pose local to tracking space. Signature static void SetOpenVRLocalPose(Vector3 leftPos, Vector3 rightPos, Quaternion leftRot, Quaternion rightRot) Parameters `leftPos: Vector3` `rightPos: Vector3` `leftRot: Quaternion` `rightRot: Quaternion` Returns `void`
SetSpaceWarp ( enabled )	Enables or disables space warp. Signature static void SetSpaceWarp(bool enabled) Parameters `enabled: bool` Returns `void`
SetSpaceWarp_Internal ( enabled )	Signature static void SetSpaceWarp_Internal(bool enabled) Parameters `enabled: bool` Returns `void`

Inner Interface

EventListener Interface

Methods

OnEvent ( eventData )

Signature

void OnEvent(OVRPlugin.EventDataBuffer eventData)

Parameters

eventData: OVRPlugin.EventDataBuffer

Returns

void

Inner Class

PassthroughCapabilities Class

This class is used by OVRManager.GetPassthroughCapabilities() to report on Passthrough capabilities provided by the system.

Use it to configure various passthrough color mapping techniques, e.g. color LUTs. See Color Mapping Techniques for more details.

Constructors

PassthroughCapabilities ( supportsPassthrough , supportsColorPassthrough , maxColorLutResolution )

Signature

PassthroughCapabilities(bool supportsPassthrough, bool supportsColorPassthrough, uint maxColorLutResolution)

Parameters

supportsPassthrough: bool

supportsColorPassthrough: bool

maxColorLutResolution: uint

Properties

MaxColorLutResolution : uint [Get]	Maximum color LUT resolution supported by the system. Use it together with the OVRPassthroughLayer.SetColorLut(OVRPassthroughColorLut, float) method to apply a color LUT to a OVRPassthroughLayer component. Signature uint MaxColorLutResolution
SupportsColorPassthrough : bool [Get]	Indicates that the system can show Passthrough with realistic colors. If 'false', then the system either supports the basic grayscale passthrough, or doesn't support passthrough at all. Signature bool SupportsColorPassthrough
SupportsPassthrough : bool [Get]	Indicates that Passthrough is available on the current system. Signature bool SupportsPassthrough

Inner Enums

XrApi Enum

Enumeration Constants

Member	Value
Unknown	OVRPlugin.XrApi.Unknown
CAPI	OVRPlugin.XrApi.CAPI
VRAPI	OVRPlugin.XrApi.VRAPI
OpenXR	OVRPlugin.XrApi.OpenXR

TrackingOrigin Enum

Enumeration Constants

Member	Value
EyeLevel	OVRPlugin.TrackingOrigin.EyeLevel
FloorLevel	OVRPlugin.TrackingOrigin.FloorLevel
Stage	OVRPlugin.TrackingOrigin.Stage
Stationary	OVRPlugin.TrackingOrigin.Stationary

EyeTextureFormat Enum

Enumeration Constants

Member	Value
Default	OVRPlugin.EyeTextureFormat.Default
R16G16B16A16_FP	OVRPlugin.EyeTextureFormat.R16G16B16A16_FP
R11G11B10_FP	OVRPlugin.EyeTextureFormat.R11G11B10_FP

FoveatedRenderingLevel Enum

Enumeration Constants

Member	Value
Off	OVRPlugin.FoveatedRenderingLevel.Off
Low	OVRPlugin.FoveatedRenderingLevel.Low
Medium	OVRPlugin.FoveatedRenderingLevel.Medium
High	OVRPlugin.FoveatedRenderingLevel.High
HighTop	OVRPlugin.FoveatedRenderingLevel.HighTop

FixedFoveatedRenderingLevel Enum

Enumeration Constants

Member	Value
Off	OVRPlugin.FixedFoveatedRenderingLevel.Off
Low	OVRPlugin.FixedFoveatedRenderingLevel.Low
Medium	OVRPlugin.FixedFoveatedRenderingLevel.Medium
High	OVRPlugin.FixedFoveatedRenderingLevel.High
HighTop	OVRPlugin.FixedFoveatedRenderingLevel.HighTop

TiledMultiResLevel Enum

Enumeration Constants

Member	Value
Off	OVRPlugin.TiledMultiResLevel.Off
LMSLow	OVRPlugin.TiledMultiResLevel.LMSLow
LMSMedium	OVRPlugin.TiledMultiResLevel.LMSMedium
LMSHigh	OVRPlugin.TiledMultiResLevel.LMSHigh
LMSHighTop	OVRPlugin.TiledMultiResLevel.LMSHighTop

SystemHeadsetType Enum

Enumeration Constants

Member	Value
None	OVRPlugin.SystemHeadset.None
Oculus_Quest	OVRPlugin.SystemHeadset.Oculus_Quest
Oculus_Quest_2	OVRPlugin.SystemHeadset.Oculus_Quest_2
Meta_Quest_Pro	OVRPlugin.SystemHeadset.Meta_Quest_Pro
Meta_Quest_3	OVRPlugin.SystemHeadset.Meta_Quest_3
Meta_Quest_3S	OVRPlugin.SystemHeadset.Meta_Quest_3S
Placeholder_13	OVRPlugin.SystemHeadset.Placeholder_13
Placeholder_14	OVRPlugin.SystemHeadset.Placeholder_14
Placeholder_15	OVRPlugin.SystemHeadset.Placeholder_15
Placeholder_16	OVRPlugin.SystemHeadset.Placeholder_16
Placeholder_17	OVRPlugin.SystemHeadset.Placeholder_17
Placeholder_18	OVRPlugin.SystemHeadset.Placeholder_18
Placeholder_19	OVRPlugin.SystemHeadset.Placeholder_19
Placeholder_20	OVRPlugin.SystemHeadset.Placeholder_20
Rift_DK1	OVRPlugin.SystemHeadset.Rift_DK1
Rift_DK2	OVRPlugin.SystemHeadset.Rift_DK2
Rift_CV1	OVRPlugin.SystemHeadset.Rift_CV1
Rift_CB	OVRPlugin.SystemHeadset.Rift_CB
Rift_S	OVRPlugin.SystemHeadset.Rift_S
Oculus_Link_Quest	OVRPlugin.SystemHeadset.Oculus_Link_Quest
Oculus_Link_Quest_2	OVRPlugin.SystemHeadset.Oculus_Link_Quest_2
Meta_Link_Quest_Pro	OVRPlugin.SystemHeadset.Meta_Link_Quest_Pro
Meta_Link_Quest_3	OVRPlugin.SystemHeadset.Meta_Link_Quest_3
Meta_Link_Quest_3S	OVRPlugin.SystemHeadset.Meta_Link_Quest_3S
PC_Placeholder_4106	OVRPlugin.SystemHeadset.PC_Placeholder_4106
PC_Placeholder_4107	OVRPlugin.SystemHeadset.PC_Placeholder_4107
PC_Placeholder_4108	OVRPlugin.SystemHeadset.PC_Placeholder_4108
PC_Placeholder_4109	OVRPlugin.SystemHeadset.PC_Placeholder_4109
PC_Placeholder_4110	OVRPlugin.SystemHeadset.PC_Placeholder_4110
PC_Placeholder_4111	OVRPlugin.SystemHeadset.PC_Placeholder_4111
PC_Placeholder_4112	OVRPlugin.SystemHeadset.PC_Placeholder_4112
PC_Placeholder_4113	OVRPlugin.SystemHeadset.PC_Placeholder_4113

SystemHeadsetTheme Enum

Enumeration Constants

Member
Dark
Light

XRDevice Enum

Enumeration Constants

Member	Value
Unknown	0
Oculus	1
OpenVR	2

ColorSpace Enum

Enumeration Constants

Member	Value
Unknown	OVRPlugin.ColorSpace.Unknown
Unmanaged	OVRPlugin.ColorSpace.Unmanaged
Rec_2020	OVRPlugin.ColorSpace.Rec_2020
Rec_709	OVRPlugin.ColorSpace.Rec_709
Rift_CV1	OVRPlugin.ColorSpace.Rift_CV1
Rift_S	OVRPlugin.ColorSpace.Rift_S
Quest	OVRPlugin.ColorSpace.Quest
P3	OVRPlugin.ColorSpace.P3
Adobe_RGB	OVRPlugin.ColorSpace.Adobe_RGB

ProcessorPerformanceLevel Enum

Enumeration Constants

Member	Value
PowerSavings	OVRPlugin.ProcessorPerformanceLevel.PowerSavings
SustainedLow	OVRPlugin.ProcessorPerformanceLevel.SustainedLow
SustainedHigh	OVRPlugin.ProcessorPerformanceLevel.SustainedHigh
Boost	OVRPlugin.ProcessorPerformanceLevel.Boost