|
| enum | XrApi { XrApi.Unknown = OVRPlugin.XrApi.Unknown,
XrApi.CAPI = OVRPlugin.XrApi.CAPI,
XrApi.VRAPI = OVRPlugin.XrApi.VRAPI,
XrApi.OpenXR = OVRPlugin.XrApi.OpenXR
} |
| |
| enum | TrackingOrigin { TrackingOrigin.EyeLevel = OVRPlugin.TrackingOrigin.EyeLevel,
TrackingOrigin.FloorLevel = OVRPlugin.TrackingOrigin.FloorLevel,
TrackingOrigin.Stage = OVRPlugin.TrackingOrigin.Stage
} |
| |
| enum | EyeTextureFormat { EyeTextureFormat.Default = OVRPlugin.EyeTextureFormat.Default,
EyeTextureFormat.R16G16B16A16_FP = OVRPlugin.EyeTextureFormat.R16G16B16A16_FP,
EyeTextureFormat.R11G11B10_FP = OVRPlugin.EyeTextureFormat.R11G11B10_FP
} |
| |
| enum | FixedFoveatedRenderingLevel {
FixedFoveatedRenderingLevel.Off = OVRPlugin.FixedFoveatedRenderingLevel.Off,
FixedFoveatedRenderingLevel.Low = OVRPlugin.FixedFoveatedRenderingLevel.Low,
FixedFoveatedRenderingLevel.Medium = OVRPlugin.FixedFoveatedRenderingLevel.Medium,
FixedFoveatedRenderingLevel.High = OVRPlugin.FixedFoveatedRenderingLevel.High,
FixedFoveatedRenderingLevel.HighTop = OVRPlugin.FixedFoveatedRenderingLevel.HighTop
} |
| |
| enum | TiledMultiResLevel {
TiledMultiResLevel.Off = OVRPlugin.TiledMultiResLevel.Off,
TiledMultiResLevel.LMSLow = OVRPlugin.TiledMultiResLevel.LMSLow,
TiledMultiResLevel.LMSMedium = OVRPlugin.TiledMultiResLevel.LMSMedium,
TiledMultiResLevel.LMSHigh = OVRPlugin.TiledMultiResLevel.LMSHigh,
TiledMultiResLevel.LMSHighTop = OVRPlugin.TiledMultiResLevel.LMSHighTop
} |
| |
| enum | SystemHeadsetType {
SystemHeadsetType.None = OVRPlugin.SystemHeadset.None,
SystemHeadsetType.Oculus_Quest = OVRPlugin.SystemHeadset.Oculus_Quest,
SystemHeadsetType.Oculus_Quest_2 = OVRPlugin.SystemHeadset.Oculus_Quest_2,
SystemHeadsetType.Placeholder_10 = OVRPlugin.SystemHeadset.Placeholder_10,
SystemHeadsetType.Placeholder_11 = OVRPlugin.SystemHeadset.Placeholder_11,
SystemHeadsetType.Placeholder_12 = OVRPlugin.SystemHeadset.Placeholder_12,
SystemHeadsetType.Placeholder_13 = OVRPlugin.SystemHeadset.Placeholder_13,
SystemHeadsetType.Placeholder_14 = OVRPlugin.SystemHeadset.Placeholder_14,
SystemHeadsetType.Rift_DK1 = OVRPlugin.SystemHeadset.Rift_DK1,
SystemHeadsetType.Rift_DK2 = OVRPlugin.SystemHeadset.Rift_DK2,
SystemHeadsetType.Rift_CV1 = OVRPlugin.SystemHeadset.Rift_CV1,
SystemHeadsetType.Rift_CB = OVRPlugin.SystemHeadset.Rift_CB,
SystemHeadsetType.Rift_S = OVRPlugin.SystemHeadset.Rift_S,
SystemHeadsetType.Oculus_Link_Quest = OVRPlugin.SystemHeadset.Oculus_Link_Quest,
SystemHeadsetType.Oculus_Link_Quest_2 = OVRPlugin.SystemHeadset.Oculus_Link_Quest_2,
SystemHeadsetType.PC_Placeholder_4103 = OVRPlugin.SystemHeadset.PC_Placeholder_4103,
SystemHeadsetType.PC_Placeholder_4104 = OVRPlugin.SystemHeadset.PC_Placeholder_4104,
SystemHeadsetType.PC_Placeholder_4105 = OVRPlugin.SystemHeadset.PC_Placeholder_4105,
SystemHeadsetType.PC_Placeholder_4106 = OVRPlugin.SystemHeadset.PC_Placeholder_4106,
SystemHeadsetType.PC_Placeholder_4107 = OVRPlugin.SystemHeadset.PC_Placeholder_4107
} |
| |
| enum | XRDevice { XRDevice.Unknown = 0,
XRDevice.Oculus = 1,
XRDevice.OpenVR = 2
} |
| |
| enum | ColorSpace {
ColorSpace.Unknown = OVRPlugin.ColorSpace.Unknown,
ColorSpace.Unmanaged = OVRPlugin.ColorSpace.Unmanaged,
ColorSpace.Rec_2020 = OVRPlugin.ColorSpace.Rec_2020,
ColorSpace.Rec_709 = OVRPlugin.ColorSpace.Rec_709,
ColorSpace.Rift_CV1 = OVRPlugin.ColorSpace.Rift_CV1,
ColorSpace.Rift_S = OVRPlugin.ColorSpace.Rift_S,
ColorSpace.Quest = OVRPlugin.ColorSpace.Quest,
ColorSpace.P3 = OVRPlugin.ColorSpace.P3,
ColorSpace.Adobe_RGB = OVRPlugin.ColorSpace.Adobe_RGB
} |
| |
|
| static bool | 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 More...
|
| |
| static void | SetColorScaleAndOffset (Vector4 colorScale, Vector4 colorOffset, bool 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. More...
|
| |
| static void | SetOpenVRLocalPose (Vector3 leftPos, Vector3 rightPos, Quaternion leftRot, Quaternion rightRot) |
| | Specifies OpenVR pose local to tracking space More...
|
| |
| static OVRPose | GetOpenVRControllerOffset (Node 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. More...
|
| |
| static bool | IsUnityAlphaOrBetaVersion () |
| |
| static void | PlatformUIConfirmQuit () |
| |
| static bool | IsInsightPassthroughInitialized () |
| |
| static bool | HasInsightPassthroughInitFailed () |
| |
|
| bool | useRecommendedMSAALevel = true |
| | If true, Unity will use the optimal antialiasing level for quality/performance on the current hardware. More...
|
| |
| float | minRenderScale = 0.7f |
| | Min RenderScale the app can reach under adaptive resolution mode ( enableAdaptiveResolution = true ); More...
|
| |
| float | maxRenderScale = 1.0f |
| | Max RenderScale the app can reach under adaptive resolution mode ( enableAdaptiveResolution = true ); More...
|
| |
| int | profilerTcpPort = OVRSystemPerfMetrics.TcpListeningPort |
| | 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 More...
|
| |
| bool | isInsightPassthroughEnabled = false |
| | Specify if Insight Passthrough should be enabled. Passthrough layers can only be used if passthrough is enabled. More...
|
| |
| bool | usePositionTracking = true |
| | If true, head tracking will affect the position of each OVRCameraRig's cameras. More...
|
| |
| bool | useRotationTracking = true |
| | If true, head tracking will affect the rotation of each OVRCameraRig's cameras. More...
|
| |
| bool | useIPDInPositionTracking = true |
| | If true, the distance between the user's eyes will affect the position of each OVRCameraRig's cameras. More...
|
| |
| bool | resetTrackerOnLoad = false |
| | If true, each scene load will cause the head pose to reset. This function only works on Rift. More...
|
| |
| bool | AllowRecenter = true |
| | If true, the Reset View in the universal menu will cause the pose to be reset. 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. More...
|
| |
| bool | LateControllerUpdate = true |
| | 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. More...
|
| |
|
| static OVRManager | instance [get] |
| | Gets the singleton instance. More...
|
| |
| static OVRDisplay | display [get] |
| | Gets a reference to the active display. More...
|
| |
| static OVRTracker | tracker [get] |
| | Gets a reference to the active sensor. More...
|
| |
| static OVRBoundary | boundary [get] |
| | Gets a reference to the active boundary system. More...
|
| |
| static OVRProfile | profile [get] |
| | Gets the current profile, which contains information about the user's settings and body dimensions. More...
|
| |
| static bool | isHmdPresent [get] |
| | If true, a head-mounted display is connected and present. More...
|
| |
| static string | audioOutId [get] |
| | Gets the audio output device identifier. More...
|
| |
| static string | audioInId [get] |
| | Gets the audio input device identifier. More...
|
| |
| static bool | hasVrFocus [get] |
| | If true, the app has VR Focus. More...
|
| |
| static bool | hasInputFocus [get] |
| | If true, the app has Input Focus. More...
|
| |
| bool | chromatic [get, set] |
| | If true, chromatic de-aberration will be applied, improving the image at the cost of texture bandwidth. More...
|
| |
| bool | monoscopic [get, set] |
| |
| OVRManager.ColorSpace | colorGamut [get, set] |
| | The target color gamut the HMD will perform a color space transformation to More...
|
| |
| OVRManager.ColorSpace | nativeColorGamut [get] |
| | The native color gamut of the target HMD More...
|
| |
| Vector3 | headPoseRelativeOffsetRotation [get, set] |
| |
| Vector3 | headPoseRelativeOffsetTranslation [get, set] |
| |
| XrApi | xrApi [get] |
| | The native XR API being used More...
|
| |
| UInt64 | xrInstance [get] |
| | The value of current XrInstance when using OpenXR More...
|
| |
| UInt64 | xrSession [get] |
| | The value of current XrSession when using OpenXR More...
|
| |
| int | vsyncCount [get, set] |
| | The number of expected display frames per rendered frame. More...
|
| |
| static float | batteryLevel [get] |
| | Gets the current battery level (Deprecated). More...
|
| |
| static float | batteryTemperature [get] |
| | Gets the current battery temperature (Deprecated). More...
|
| |
| static int | batteryStatus [get] |
| | Gets the current battery status (Deprecated). More...
|
| |
| static float | volumeLevel [get] |
| | Gets the current volume level (Deprecated). More...
|
| |
| static int | cpuLevel [get, set] |
| | Gets or sets the current CPU performance level (0-2). Lower performance levels save more power. More...
|
| |
| static int | gpuLevel [get, set] |
| | Gets or sets the current GPU performance level (0-2). Lower performance levels save more power. More...
|
| |
| static bool | isPowerSavingActive [get] |
| | If true, the CPU and GPU are currently throttled to save power and/or reduce the temperature. More...
|
| |
| static EyeTextureFormat | eyeTextureFormat [get, set] |
| | Gets or sets the eye texture format. More...
|
| |
| static bool | fixedFoveatedRenderingSupported [get] |
| | Gets if tiled-based multi-resolution technique is supported This feature is only supported on QCOMM-based Android devices More...
|
| |
| static FixedFoveatedRenderingLevel | fixedFoveatedRenderingLevel [get, set] |
| | Gets or sets the tiled-based multi-resolution level This feature is only supported on QCOMM-based Android devices More...
|
| |
| static bool | useDynamicFixedFoveatedRendering [get, set] |
| | Let the system decide the best foveation level adaptively (Off .. fixedFoveatedRenderingLevel) This feature is only supported on QCOMM-based Android devices More...
|
| |
| static bool | tiledMultiResSupported [get] |
| |
| static TiledMultiResLevel | tiledMultiResLevel [get, set] |
| |
| static bool | gpuUtilSupported [get] |
| | Gets if the GPU Utility is supported This feature is only supported on QCOMM-based Android devices More...
|
| |
| static float | gpuUtilLevel [get] |
| | Gets the GPU Utilised Level (0.0 - 1.0) This feature is only supported on QCOMM-based Android devices More...
|
| |
| static SystemHeadsetType | systemHeadsetType [get] |
| | Get the system headset type More...
|
| |
| OVRManager.TrackingOrigin | trackingOriginType [get, set] |
| | Defines the current tracking origin type. More...
|
| |
| bool | isSupportedPlatform [get] |
| | True if the current platform supports virtual reality. More...
|
| |
| bool | isUserPresent [get] |
| | True if the user is currently wearing the display. More...
|
| |
| static System.Version | utilitiesVersion [get] |
| |
| static System.Version | pluginVersion [get] |
| |
| static System.Version | sdkVersion [get] |
| |
Configuration data for Oculus virtual reality.
| static void OVRManager.SetColorScaleAndOffset |
( |
Vector4 |
colorScale, |
|
|
Vector4 |
colorOffset, |
|
|
bool |
applyToAllLayers |
|
) |
| |
|
static |
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.
