API reference
OVRManager Class
Extends
MonoBehaviour
Implements
OVRMixedRealityCaptureConfiguration
Configuration data for Oculus virtual reality.
Protected Fields
disabledCameras
: IEnumerable< Camera > |
Signature
IEnumerable<Camera> OVRManager.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 OVRManager.AllowRecenter |
controllerDrivenHandPosesType
: OVRManager.ControllerDrivenHandPosesType |
Signature
OVRManager.ControllerDrivenHandPosesType OVRManager.controllerDrivenHandPosesType |
enableDynamicResolution
: bool |
Signature
bool OVRManager.enableDynamicResolution |
isInsightPassthroughEnabled
: bool |
Specify if Insight Passthrough should be enabled.
Passthrough layers can only be used if passthrough is enabled.
Signature
bool OVRManager.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 OVRManager.LateControllerUpdate |
launchSimultaneousHandsControllersOnStartup
: bool |
Specify if simultaneous hands and controllers should be enabled.
Signature
bool OVRManager.launchSimultaneousHandsControllersOnStartup |
maxDynamicResolutionScale
: float |
Signature
float OVRManager.maxDynamicResolutionScale |
maxRenderScale
: float |
Max RenderScale the app can reach under adaptive resolution mode ( enableAdaptiveResolution = true );.
Signature
float OVRManager.maxRenderScale |
minDynamicResolutionScale
: float |
Signature
float OVRManager.minDynamicResolutionScale |
minRenderScale
: float |
Min RenderScale the app can reach under adaptive resolution mode ( enableAdaptiveResolution = true );.
Signature
float OVRManager.minRenderScale |
profilerTcpPort
: int |
The TCP listening port of Oculus Profiler Service, which will be activated in Debug/Developerment builds When the app is running on editor or device, open "Tools/Oculus/Oculus Profiler Panel" to view the realtime system metrics.
Signature
int OVRManager.profilerTcpPort |
resetTrackerOnLoad
: bool |
If true, each scene load will cause the head pose to reset.
This function only works on Rift.
Signature
bool OVRManager.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 OVRManager.shouldBoundaryVisibilityBeSuppressed |
SimultaneousHandsAndControllersEnabled
: bool |
Signature
bool OVRManager.SimultaneousHandsAndControllersEnabled |
useIPDInPositionTracking
: bool |
If true, the distance between the user's eyes will affect the position of each OVRCameraRig's cameras.
Signature
bool OVRManager.useIPDInPositionTracking |
usePositionTracking
: bool |
If true, head tracking will affect the position of each OVRCameraRig's cameras.
Signature
bool OVRManager.usePositionTracking |
useRecommendedMSAALevel
: bool |
If true, Unity will use the optimal antialiasing level for quality/performance on the current hardware.
Signature
bool OVRManager.useRecommendedMSAALevel |
useRotationTracking
: bool |
If true, head tracking will affect the rotation of each OVRCameraRig's cameras.
Signature
bool OVRManager.useRotationTracking |
wideMotionModeHandPosesEnabled
: bool |
Signature
bool OVRManager.wideMotionModeHandPosesEnabled |
Protected Static Fields
_profile
: OVRProfile |
Signature
OVRProfile OVRManager._profile |
m_AppSpaceTransform
: Transform |
Signature
Transform OVRManager.m_AppSpaceTransform |
m_CachedDepthTextureMode
: DepthTextureMode |
Signature
DepthTextureMode OVRManager.m_CachedDepthTextureMode |
m_SpaceWarpEnabled
: bool |
Signature
bool OVRManager.m_SpaceWarpEnabled |
OpenVRTouchPositionOffsetLeft
: Vector3 |
Signature
Vector3 OVRManager.OpenVRTouchPositionOffsetLeft |
OpenVRTouchPositionOffsetRight
: Vector3 |
Signature
Vector3 OVRManager.OpenVRTouchPositionOffsetRight |
OpenVRTouchRotationOffsetEulerLeft
: Vector3 |
Signature
Vector3 OVRManager.OpenVRTouchRotationOffsetEulerLeft |
OpenVRTouchRotationOffsetEulerRight
: Vector3 |
Signature
Vector3 OVRManager.OpenVRTouchRotationOffsetEulerRight |
Static Fields
loadedXRDevice
: XRDevice |
Signature
XRDevice OVRManager.loadedXRDevice |
OCULUS_UNITY_NAME_STR
: string |
Signature
string OVRManager.OCULUS_UNITY_NAME_STR |
OnPassthroughInitializedStateChange
: Action< bool > |
Signature
Action<bool> OVRManager.OnPassthroughInitializedStateChange |
OPENVR_UNITY_NAME_STR
: string |
Signature
string OVRManager.OPENVR_UNITY_NAME_STR |
OVRManagerinitialized
: bool |
Signature
bool OVRManager.OVRManagerinitialized |
UnityAlphaOrBetaVersionWarningMessage
: string |
Signature
string OVRManager.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 OVRManager.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 OVRManager.audioOutId |
batteryLevel
: float
[Get] |
Gets the current battery level (Deprecated).
Signature
float OVRManager.batteryLevel |
batteryStatus
: int
[Get] |
Gets the current battery status (Deprecated).
Signature
int OVRManager.batteryStatus |
batteryTemperature
: float
[Get] |
Gets the current battery temperature (Deprecated).
Signature
float OVRManager.batteryTemperature |
boundary
: OVRBoundary
[Get] |
Gets a reference to the active boundary system.
Signature
OVRBoundary OVRManager.boundary |
chromatic
: bool
[Get][Set] |
If true, chromatic de-aberration will be applied, improving the image at the cost of texture bandwidth.
Signature
bool OVRManager.chromatic |
colorGamut
: OVRManager.ColorSpace
[Get][Set] |
The target color gamut the HMD will perform a color space transformation to.
Signature
OVRManager.ColorSpace OVRManager.colorGamut |
cpuLevel
: int
[Get][Set] |
Gets or sets the current CPU performance level (0-2).
Lower performance levels save more power. (Deprecated)
Signature
int OVRManager.cpuLevel |
display
: OVRDisplay
[Get] |
Gets a reference to the active display.
Signature
OVRDisplay OVRManager.display |
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 OVRManager.eyeFovPremultipliedAlphaModeEnabled |
eyeTextureFormat
: EyeTextureFormat
[Get][Set] |
Gets or sets the eye texture format.
Signature
EyeTextureFormat OVRManager.eyeTextureFormat |
eyeTrackedFoveatedRenderingEnabled
: bool
[Get][Set] |
Gets or sets if eye tracked foveated rendering is enabled or not.
Signature
bool OVRManager.eyeTrackedFoveatedRenderingEnabled |
eyeTrackedFoveatedRenderingSupported
: bool
[Get] |
Gets if eye tracked foveated rendering feature is supported on this device.
Signature
bool OVRManager.eyeTrackedFoveatedRenderingSupported |
fixedFoveatedRenderingLevel
: FixedFoveatedRenderingLevel
[Get][Set] |
Signature
FixedFoveatedRenderingLevel OVRManager.fixedFoveatedRenderingLevel |
fixedFoveatedRenderingSupported
: bool
[Get] |
Signature
bool OVRManager.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 OVRManager.foveatedRenderingLevel |
gpuLevel
: int
[Get][Set] |
Gets or sets the current GPU performance level (0-2).
Lower performance levels save more power. (Deprecated)
Signature
int OVRManager.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 OVRManager.gpuUtilLevel |
gpuUtilSupported
: bool
[Get] |
Gets if the GPU Utility is supported This feature is only supported on QCOMM-based Android devices.
Signature
bool OVRManager.gpuUtilSupported |
hasInputFocus
: bool
[Get] |
If true, the app has Input Focus.
Signature
bool OVRManager.hasInputFocus |
hasVrFocus
: bool
[Get] |
If true, the app has VR Focus.
Signature
bool OVRManager.hasVrFocus |
headPoseRelativeOffsetRotation
: Vector3
[Get][Set] |
Signature
Vector3 OVRManager.headPoseRelativeOffsetRotation |
headPoseRelativeOffsetTranslation
: Vector3
[Get][Set] |
Signature
Vector3 OVRManager.headPoseRelativeOffsetTranslation |
instance
: OVRManager
[Get] |
Gets the singleton instance.
Signature
OVRManager OVRManager.instance |
isBoundaryVisibilitySuppressed
: bool
[Get] |
The system state of the Guardian boundary visibility.
Signature
bool OVRManager.isBoundaryVisibilitySuppressed |
isHmdPresent
: bool
[Get] |
If true, a head-mounted display is connected and present.
Signature
bool OVRManager.isHmdPresent |
isPowerSavingActive
: bool
[Get] |
If true, the CPU and GPU are currently throttled to save power and/or reduce the temperature.
Signature
bool OVRManager.isPowerSavingActive |
IsSimultaneousHandsAndControllersSupported
: bool
[Get] |
Signature
bool OVRManager.IsSimultaneousHandsAndControllersSupported |
isSupportedPlatform
: bool
[Get] |
True if the current platform supports virtual reality.
Signature
bool OVRManager.isSupportedPlatform |
isUserPresent
: bool
[Get] |
True if the user is currently wearing the display.
Signature
bool OVRManager.isUserPresent |
monoscopic
: bool
[Get][Set] |
Signature
bool OVRManager.monoscopic |
nativeColorGamut
: OVRManager.ColorSpace
[Get] |
The native color gamut of the target HMD.
Signature
OVRManager.ColorSpace OVRManager.nativeColorGamut |
pluginVersion
: System.Version
[Get] |
Signature
System.Version OVRManager.pluginVersion |
profile
: OVRProfile
[Get] |
Gets the current profile, which contains information about the user's settings and body dimensions.
Signature
OVRProfile OVRManager.profile |
runtimeSettings
: OVRRuntimeSettings
[Get] |
Gets a reference to the runtime settings.
Signature
OVRRuntimeSettings OVRManager.runtimeSettings |
sdkVersion
: System.Version
[Get] |
Signature
System.Version OVRManager.sdkVersion |
sharpenType
: OVRPlugin.LayerSharpenType
[Get][Set] |
The sharpen type for the eye buffer.
Signature
OVRPlugin.LayerSharpenType OVRManager.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 OVRManager.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 OVRManager.suggestedGpuPerfLevel |
systemHeadsetType
: SystemHeadsetType
[Get] |
Get the system headset type.
Signature
SystemHeadsetType OVRManager.systemHeadsetType |
tiledMultiResLevel
: TiledMultiResLevel
[Get][Set] |
Signature
TiledMultiResLevel OVRManager.tiledMultiResLevel |
tiledMultiResSupported
: bool
[Get] |
Signature
bool OVRManager.tiledMultiResSupported |
tracker
: OVRTracker
[Get] |
Gets a reference to the active sensor.
Signature
OVRTracker OVRManager.tracker |
trackingOriginType
: OVRManager.TrackingOrigin
[Get][Set] |
Defines the current tracking origin type.
Signature
OVRManager.TrackingOrigin OVRManager.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 OVRManager.useDynamicFixedFoveatedRendering |
useDynamicFoveatedRendering
: bool
[Get][Set] |
Signature
bool OVRManager.useDynamicFoveatedRendering |
utilitiesVersion
: System.Version
[Get] |
Signature
System.Version OVRManager.utilitiesVersion |
volumeLevel
: float
[Get] |
Gets the current volume level (Deprecated).
Signature
float OVRManager.volumeLevel |
vsyncCount
: int
[Get][Set] |
The number of expected display frames per rendered frame.
Signature
int OVRManager.vsyncCount |
xrApi
: XrApi
[Get] |
The native XR API being used.
Signature
XrApi OVRManager.xrApi |
xrInstance
: UInt64
[Get] |
The value of current XrInstance when using OpenXR.
Signature
UInt64 OVRManager.xrInstance |
xrSession
: UInt64
[Get] |
The value of current XrSession when using OpenXR.
Signature
UInt64 OVRManager.xrSession |
Events
AudioInChanged
: Action |
Occurs when the active Audio In device has changed and a restart is needed.
Signature
Action OVRManager.AudioInChanged |
AudioOutChanged
: Action |
Occurs when the active Audio Out device has changed and a restart is needed.
Signature
Action OVRManager.AudioOutChanged |
BoundaryVisibilityChanged
: Action< OVRPlugin.BoundaryVisibility > |
Occurs when the system's boundary visibility has been changed.
@params (OVRPlugin.BoundaryVisibility newBoundaryVisibility)
Signature
Action<OVRPlugin.BoundaryVisibility> OVRManager.BoundaryVisibilityChanged |
DisplayRefreshRateChanged
: Action< float, float > |
Occurs when the display refresh rate changes @params (float fromRefreshRate, float toRefreshRate)
Signature
Action<float, float> OVRManager.DisplayRefreshRateChanged |
HMDAcquired
: Action |
Occurs when an HMD attached.
Signature
Action OVRManager.HMDAcquired |
HMDLost
: Action |
Occurs when an HMD detached.
Signature
Action OVRManager.HMDLost |
HMDMounted
: Action |
Occurs when an HMD is put on the user's head.
Signature
Action OVRManager.HMDMounted |
HMDUnmounted
: Action |
Occurs when an HMD is taken off the user's head.
Signature
Action OVRManager.HMDUnmounted |
HSWDismissed
: Action |
Occurs when Health & Safety Warning is dismissed.
Signature
Action OVRManager.HSWDismissed |
InputFocusAcquired
: Action |
Occurs when Input Focus is acquired.
Signature
Action OVRManager.InputFocusAcquired |
InputFocusLost
: Action |
Occurs when Input Focus is lost.
Signature
Action OVRManager.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> OVRManager.PassthroughLayerResumed |
SceneCaptureComplete
: Action< UInt64, bool > |
Occurs when a scene capture request completes @params (UInt64 requestId, bool result)
Signature
Action<UInt64, bool> OVRManager.SceneCaptureComplete |
ShareSpacesComplete
: Action< UInt64, OVRSpatialAnchor.OperationResult > |
Occurs when sharing spatial entities @params (UInt64 requestId, OVRSpatialAnchor.OperationResult result)
Signature
Action<UInt64, OVRSpatialAnchor.OperationResult> OVRManager.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> OVRManager.SpaceEraseComplete |
SpaceListSaveComplete
: Action< UInt64, OVRSpatialAnchor.OperationResult > |
Occurs when saving space list @params (UInt64 requestId, OVRSpatialAnchor.OperationResult result)
Signature
Action<UInt64, OVRSpatialAnchor.OperationResult> OVRManager.SpaceListSaveComplete |
SpaceQueryComplete
: Action< UInt64, bool > |
Occurs when querying for a space completes @params (UInt64 requestId, bool result)
Signature
Action<UInt64, bool> OVRManager.SpaceQueryComplete |
SpaceQueryResults
: Action< UInt64 > |
Occurs when one or more spaces are found during query @params (UInt64 requestId)
Signature
Action<UInt64> OVRManager.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> OVRManager.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> OVRManager.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> OVRManager.SpatialAnchorCreateComplete |
TrackingAcquired
: Action |
Occurs when the sensor gained tracking.
Signature
Action OVRManager.TrackingAcquired |
TrackingLost
: Action |
Occurs when the sensor lost tracking.
Signature
Action OVRManager.TrackingLost |
VrFocusAcquired
: Action |
Occurs when VR Focus is acquired.
Signature
Action OVRManager.VrFocusAcquired |
VrFocusLost
: Action |
Occurs when VR Focus is lost.
Signature
Action OVRManager.VrFocusLost |
Methods
DeregisterEventListener
(
listener
)
|
Signature
void OVRManager.DeregisterEventListener(EventListener listener) Parameters listener: EventListenerReturns void |
RegisterEventListener
(
listener
)
|
Signature
void OVRManager.RegisterEventListener(EventListener listener) Parameters listener: EventListenerReturns void |
ReturnToLauncher
()
|
Leaves the application/game and returns to the launcher/dashboard.
Signature
void OVRManager.ReturnToLauncher() Returns void |
Protected Static Methods
OnPermissionGranted
(
permissionId
)
|
Signature
static void OVRManager.OnPermissionGranted(string permissionId) Parameters permissionId: stringReturns void |
Static Methods
FindMainCamera
()
|
Signature
static Camera OVRManager.FindMainCamera() Returns Camera |
GetDynamicFoveatedRenderingEnabled
()
|
Signature
static bool OVRManager.GetDynamicFoveatedRenderingEnabled() Returns bool |
GetEyeTrackedFoveatedRenderingEnabled
()
|
Signature
static bool OVRManager.GetEyeTrackedFoveatedRenderingEnabled() Returns bool |
GetEyeTrackedFoveatedRenderingSupported
()
|
Signature
static bool OVRManager.GetEyeTrackedFoveatedRenderingSupported() Returns bool |
GetFixedFoveatedRenderingSupported
()
|
Signature
static bool OVRManager.GetFixedFoveatedRenderingSupported() Returns bool |
GetFoveatedRenderingLevel
()
|
Signature
static FoveatedRenderingLevel OVRManager.GetFoveatedRenderingLevel() Returns FoveatedRenderingLevel |
GetOpenVRControllerOffset
(
hand
)
| |
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 OVRManager.GetPassthroughCapabilities() Returns PassthroughCapabilities |
GetSpaceWarp
()
|
Signature
static bool OVRManager.GetSpaceWarp() Returns bool |
HasInsightPassthroughInitFailed
()
|
Checks whether Passthrough has failed initialization.
Signature
static bool OVRManager.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 OVRManager.IsAdaptiveResSupportedByEngine() Returns bool |
IsInsightPassthroughInitialized
()
|
Checks whether Passthrough is initialized.
Signature
static bool OVRManager.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 OVRManager.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 OVRManager.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 OVRManager.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 OVRManager.IsPassthroughRecommended() Returns bool
Flag indicating whether Passthrough is recommended.
|
IsUnityAlphaOrBetaVersion
()
|
Signature
static bool OVRManager.IsUnityAlphaOrBetaVersion() Returns bool |
PlatformUIConfirmQuit
()
|
Signature
static void OVRManager.PlatformUIConfirmQuit() Returns void |
SetAppSpacePosition
(
x
, y
, z
)
|
Signature
static void OVRManager.SetAppSpacePosition(float x, float y, float z) Parameters x: floaty: floatz: floatReturns void |
SetAppSpaceRotation
(
x
, y
, z
, w
)
|
Signature
static void OVRManager.SetAppSpaceRotation(float x, float y, float z, float w) Parameters x: floaty: floatz: floatw: floatReturns 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 OVRManager.SetColorScaleAndOffset(Vector4 colorScale, Vector4 colorOffset, bool applyToAllLayers) Parameters colorScale: Vector4colorOffset: Vector4applyToAllLayers: boolReturns void |
SetColorScaleAndOffset_Internal
(
colorScale
, colorOffset
, applyToAllLayers
)
|
Signature
static bool OVRManager.SetColorScaleAndOffset_Internal(Vector4 colorScale, Vector4 colorOffset, bool applyToAllLayers) Parameters colorScale: Vector4colorOffset: Vector4applyToAllLayers: boolReturns bool |
SetDynamicFoveatedRenderingEnabled
(
enabled
)
|
Signature
static void OVRManager.SetDynamicFoveatedRenderingEnabled(bool enabled) Parameters enabled: boolReturns void |
SetEyeTrackedFoveatedRenderingEnabled
(
enabled
)
|
Signature
static void OVRManager.SetEyeTrackedFoveatedRenderingEnabled(bool enabled) Parameters enabled: boolReturns void |
SetFoveatedRenderingLevel
(
level
)
|
Signature
static void OVRManager.SetFoveatedRenderingLevel(FoveatedRenderingLevel level) Parameters level: FoveatedRenderingLevelReturns void |
SetOpenVRLocalPose
(
leftPos
, rightPos
, leftRot
, rightRot
)
|
Specifies OpenVR pose local to tracking space.
Signature
static void OVRManager.SetOpenVRLocalPose(Vector3 leftPos, Vector3 rightPos, Quaternion leftRot, Quaternion rightRot) Parameters leftPos: Vector3rightPos: Vector3leftRot: QuaternionrightRot: QuaternionReturns void |
SetSpaceWarp
(
enabled
)
|
Enables or disables space warp.
Signature
static void OVRManager.SetSpaceWarp(bool enabled) Parameters enabled: boolReturns void |
SetSpaceWarp_Internal
(
enabled
)
|
Signature
static void OVRManager.SetSpaceWarp_Internal(bool enabled) Parameters enabled: boolReturns void |
Inner Interface
EventListener Interface
Methods
OnEvent
(
eventData
)
|
Signature
void OVRManager.EventListener.OnEvent(OVRPlugin.EventDataBuffer eventData) Parameters eventData: OVRPlugin.EventDataBufferReturns void |
Inner Class
PassthroughCapabilities Class
Specify if Insight Passthrough should be enabled.
Passthrough layers can only be used if passthrough is enabled.
Constructors
PassthroughCapabilities
(
supportsPassthrough
, supportsColorPassthrough
, maxColorLutResolution
)
|
Signature
OVRManager.PassthroughCapabilities.PassthroughCapabilities(bool supportsPassthrough, bool supportsColorPassthrough, uint maxColorLutResolution) Parameters supportsPassthrough: boolsupportsColorPassthrough: boolmaxColorLutResolution: uint |
Properties
MaxColorLutResolution
: uint
[Get] |
Maximum color LUT resolution supported by the system.
Signature
uint OVRManager.PassthroughCapabilities.MaxColorLutResolution |
SupportsColorPassthrough
: bool
[Get] |
Indicates that the system can show Passthrough with realistic colors.
Signature
bool OVRManager.PassthroughCapabilities.SupportsColorPassthrough |
SupportsPassthrough
: bool
[Get] |
Indicates that Passthrough is available on the current system.
Signature
bool OVRManager.PassthroughCapabilities.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 |
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 |
Placeholder_12 | OVRPlugin.SystemHeadset.Placeholder_12 |
Placeholder_13 | OVRPlugin.SystemHeadset.Placeholder_13 |
Placeholder_14 | OVRPlugin.SystemHeadset.Placeholder_14 |
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 |
PC_Placeholder_4105 | OVRPlugin.SystemHeadset.PC_Placeholder_4105 |
PC_Placeholder_4106 | OVRPlugin.SystemHeadset.PC_Placeholder_4106 |
PC_Placeholder_4107 | OVRPlugin.SystemHeadset.PC_Placeholder_4107 |
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 |
ControllerDrivenHandPosesType Enum
Enumeration Constants
| Member |
|---|
None |
ConformingToController |
Natural |
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
Virtual reality / Meta Horizon
Support and legal
English (US)
© 2026 Meta