Class OculusSettings

Inheritance

Object

ScriptableObject

OculusSettings

Inherited Members

ScriptableObject.SetDirty()

ScriptableObject.CreateInstance(String)

ScriptableObject.CreateInstance(Type)

ScriptableObject.CreateInstance<T>()

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(Object)

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, Boolean)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, Boolean)

Object.Destroy(Object, Single)

Object.Destroy(Object)

Object.DestroyImmediate(Object, Boolean)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.FindObjectsOfType(Type, Boolean)

Object.FindObjectsByType(Type, FindObjectsSortMode)

Object.FindObjectsByType(Type, FindObjectsInactive, FindObjectsSortMode)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, Single)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsSortMode)

UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)

UnityEngine.Object.FindObjectsByType<T>(UnityEngine.FindObjectsInactive, UnityEngine.FindObjectsSortMode)

Object.FindObjectOfType<T>()

UnityEngine.Object.FindObjectOfType<T>(System.Boolean)

UnityEngine.Object.FindFirstObjectByType<T>()

UnityEngine.Object.FindAnyObjectByType<T>()

UnityEngine.Object.FindFirstObjectByType<T>(UnityEngine.FindObjectsInactive)

UnityEngine.Object.FindAnyObjectByType<T>(UnityEngine.FindObjectsInactive)

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.FindFirstObjectByType(Type)

Object.FindAnyObjectByType(Type)

Object.FindObjectOfType(Type, Boolean)

Object.FindFirstObjectByType(Type, FindObjectsInactive)

Object.FindAnyObjectByType(Type, FindObjectsInactive)

Object.ToString()

Object.name

Object.hideFlags

Namespace: Unity.XR.Oculus

Syntax

[Serializable]
[XRConfigurationData("Oculus", "Unity.XR.Oculus.Settings")]
public class OculusSettings : ScriptableObject

Fields

DashSupport

Enable or disable Dash support. This inintializes the Oculus Plugin with Dash support which enables the Oculus Dash to composite over the Unity application.

Declaration

[SerializeField]
[Tooltip("Initialize the Oculus Plugin with Dash support which allows the Oculus Dash to composite over the Unity application.")]
public bool DashSupport

Field Value

Type	Description
Boolean

DepthSubmission

Enables support for submitting the depth buffer on mobile. This allows for depth testing between layers on mobile Oculus platforms.

Declaration

[SerializeField]
[Tooltip("Enables support for submitting the depth buffer on mobile. This allows for depth testing between layers on mobile Oculus platforms.")]
public bool DepthSubmission

Field Value

Type	Description
Boolean

EnableTrackingOriginStageMode

When the Tracking Origin Mode is set to Floor, the tracking origin won't change with a system recenter.

Declaration

[SerializeField]
[Tooltip("When the Tracking Origin Mode is set to Floor, the tracking origin won't change with a system recenter.")]
public bool EnableTrackingOriginStageMode

Field Value

Type	Description
Boolean

FoveatedRenderingMethod

Choose which foveated rendering method is used when foveation is enabled.

Declaration

[SerializeField]
[Tooltip("Choose which foveated rendering method is used when foveation is enabled.")]
public OculusSettings.FoveationMethod FoveatedRenderingMethod

Field Value

Type	Description
OculusSettings.FoveationMethod

LateLatching

Reduces tracked rendering latency by updating head and controller poses as late as possible before rendering. Vulkan only.

Declaration

[SerializeField]
[Tooltip("Reduces tracked rendering latency by updating head and controller poses as late as possible before rendering. Vulkan only.")]
public bool LateLatching

Field Value

Type	Description
Boolean

LateLatchingDebug

Debug mode for Late Latching which will print information about the Late Latching system as well as any errors.

Declaration

[SerializeField]
[Tooltip("Debug mode for Late Latching which will print information about the Late Latching system as well as any errors.")]
public bool LateLatchingDebug

Field Value

Type	Description
Boolean

LowOverheadMode

If enabled, the GLES graphics driver will bypass validation code, potentially running faster.

Declaration

[SerializeField]
[Tooltip("If enabled, the GLES graphics driver will bypass validation code, potentially running faster at the expense of detecting and reporting errors. GLES only.")]
public bool LowOverheadMode

Field Value

Type	Description
Boolean

m_StereoRenderingModeAndroid

The current stereo rendering mode selected for Android-based Oculus platforms

Declaration

[SerializeField]
[Tooltip("The current stereo rendering mode selected for Android-based Oculus platforms.")]
public OculusSettings.StereoRenderingModeAndroid m_StereoRenderingModeAndroid

Field Value

Type	Description
OculusSettings.StereoRenderingModeAndroid

m_StereoRenderingModeDesktop

The current stereo rendering mode selected for desktop-based Oculus platforms

Declaration

[SerializeField]
[Tooltip("The current stereo rendering mode selected for desktop-based Oculus platforms.")]
public OculusSettings.StereoRenderingModeDesktop m_StereoRenderingModeDesktop

Field Value

Type	Description
OculusSettings.StereoRenderingModeDesktop

OptimizeBufferDiscards

If enabled, the depth buffer and MSAA contents will be discarded rather than resolved. This is an optimization that can possibly break rendering in certain cases. Vulkan only.

Declaration

[SerializeField]
[Tooltip("If enabled, the depth buffer and MSAA contents will be discarded rather than resolved. This is an optimization that can possibly break rendering in certain cases. Vulkan only.")]
public bool OptimizeBufferDiscards

Field Value

Type	Description
Boolean

PhaseSync

Enables a latency optimization technique which can reduce simulation latency by several ms, depending on application workload.

Declaration

[SerializeField]
[Tooltip("Enables a latency optimization technique which can reduce simulation latency by several ms, depending on application workload.")]
public bool PhaseSync

Field Value

Type	Description
Boolean

s_Settings

Declaration

public static OculusSettings s_Settings

Field Value

Type	Description
OculusSettings

SharedDepthBuffer

Enable or disable support for using a shared depth buffer. This allows Unity and Oculus to use a common depth buffer which enables Oculus to composite the Oculus Dash and other utilities over the Unity application.

Declaration

[SerializeField]
[Tooltip("Allows Unity and the Oculus runtime to share a common depth buffer for better scene integration with the Dash.")]
public bool SharedDepthBuffer

Field Value

Type	Description
Boolean

SpaceWarp

A frame synthesis technology to allow your application to render at half frame rate, while still delivering a smooth experience. Note that this currently requires a custom version of the URP provided by Oculus in order to work, and should not be enabled if you aren't using that customized Oculus URP package.

Declaration

[SerializeField]
[Tooltip("A frame synthesis technology to allow your application to render at half frame rate, while still delivering a smooth experience. Note that this currently requires a custom version of the URP provided by Oculus in order to work, and should not be enabled if you aren't using that customized Oculus URP package.")]
public bool SpaceWarp

Field Value

Type	Description
Boolean

SubsampledLayout

Enables a subsampled eye texture layout, which can improve performance when using FFR and reduce FFR related artifacts. Vulkan and Quest 2/Quest Pro only.

Declaration

[SerializeField]
[Tooltip("Enables a subsampled eye texture layout, which can improve performance when using FFR and reduce FFR related artifacts. Vulkan and Quest 2/Quest Pro only.")]
public bool SubsampledLayout

Field Value

Type	Description
Boolean

SymmetricProjection

Allows the application to render with symmetric projection matrices which can improve performance when using multiview.

Declaration

[SerializeField]
[Tooltip("Allows the application to render with symmetric projection matrices.")]
public bool SymmetricProjection

Field Value

Type	Description
Boolean

SystemSplashScreen

Adds a PNG under the Assets folder as the system splash screen image. If set, the OS will display the system splash screen as a high quality compositor layer as soon as the app is starting to launch until the app submits the first frame.

Declaration

[SerializeField]
[Tooltip("Adds a PNG under the Assets folder as the system splash screen image. If set, the OS will display the system splash screen as a high quality compositor layer as soon as the app is starting to launch until the app submits the first frame.")]
public Texture2D SystemSplashScreen

Field Value

Type	Description
Texture2D

TargetQuest2

Adds a Quest 2 entry to the supported devices list in the Android manifest.

Declaration

[SerializeField]
[Tooltip("Adds a Quest 2 entry to the supported devices list in the Android manifest.")]
public bool TargetQuest2

Field Value

Type	Description
Boolean

TargetQuestPro

Adds a Quest Pro entry to the supported devices list in the Android manifest.

Declaration

[SerializeField]
[Tooltip("Adds a Quest Pro entry to the supported devices list in the Android manifest.")]
public bool TargetQuestPro

Field Value

Type	Description
Boolean

Methods

Awake()

Declaration

public void Awake()

GetStereoRenderingMode()

Declaration

public ushort GetStereoRenderingMode()

Returns

Type	Description
UInt16