docs.unity3d.com
    Show / Hide Table of Contents

    Class OculusSettings

    Inheritance
    Object
    OculusSettings
    Namespace: Unity.XR.Oculus
    Syntax
    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
    public bool DashSupport
    Field Value
    Type Description
    Boolean

    FocusAware

    If enabled, the application will continue running when system overlays appear. This is deprecated and will be removed in Oculus XR Plugin 2.0.0

    Declaration
    public bool FocusAware
    Field Value
    Type Description
    Boolean

    LowOverheadMode

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

    Declaration
    public bool LowOverheadMode
    Field Value
    Type Description
    Boolean

    m_StereoRenderingModeAndroid

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

    Declaration
    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
    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
    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
    public bool PhaseSync
    Field Value
    Type Description
    Boolean

    ProtectedContext

    If enabled, the Oculus SDK will create a protected graphics context. Has a slight overhead; only use if needed for protected content. This is deprecated and will be removed in Oculus XR Plugin 2.0.0

    Declaration
    public bool ProtectedContext
    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
    public bool SharedDepthBuffer
    Field Value
    Type Description
    Boolean

    TargetQuest

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

    Declaration
    public bool TargetQuest
    Field Value
    Type Description
    Boolean

    TargetQuest2

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

    Declaration
    public bool TargetQuest2
    Field Value
    Type Description
    Boolean

    V2Signing

    Enable this if you are building for Quest. This enables application signing with the Android Package (APK) Signature Scheme v2. Disable v2 signing if building for Oculus Go. This is deprecated and will be removed in Oculus XR Plugin 2.0.0

    Declaration
    public bool V2Signing
    Field Value
    Type Description
    Boolean

    Methods

    Awake()

    Declaration
    public void Awake()

    GetStereoRenderingMode()

    Declaration
    public ushort GetStereoRenderingMode()
    Returns
    Type Description
    UInt16
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023