docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class OpenXRFeatureAttribute

    Inheritance
    object
    Attribute
    OpenXRFeatureAttribute
    Inherited Members
    Attribute.Equals(object)
    Attribute.GetCustomAttribute(Assembly, Type)
    Attribute.GetCustomAttribute(Assembly, Type, bool)
    Attribute.GetCustomAttribute(MemberInfo, Type)
    Attribute.GetCustomAttribute(MemberInfo, Type, bool)
    Attribute.GetCustomAttribute(Module, Type)
    Attribute.GetCustomAttribute(Module, Type, bool)
    Attribute.GetCustomAttribute(ParameterInfo, Type)
    Attribute.GetCustomAttribute(ParameterInfo, Type, bool)
    Attribute.GetCustomAttributes(Assembly)
    Attribute.GetCustomAttributes(Assembly, bool)
    Attribute.GetCustomAttributes(Assembly, Type)
    Attribute.GetCustomAttributes(Assembly, Type, bool)
    Attribute.GetCustomAttributes(MemberInfo)
    Attribute.GetCustomAttributes(MemberInfo, bool)
    Attribute.GetCustomAttributes(MemberInfo, Type)
    Attribute.GetCustomAttributes(MemberInfo, Type, bool)
    Attribute.GetCustomAttributes(Module)
    Attribute.GetCustomAttributes(Module, bool)
    Attribute.GetCustomAttributes(Module, Type)
    Attribute.GetCustomAttributes(Module, Type, bool)
    Attribute.GetCustomAttributes(ParameterInfo)
    Attribute.GetCustomAttributes(ParameterInfo, bool)
    Attribute.GetCustomAttributes(ParameterInfo, Type)
    Attribute.GetCustomAttributes(ParameterInfo, Type, bool)
    Attribute.GetHashCode()
    Attribute.IsDefaultAttribute()
    Attribute.IsDefined(Assembly, Type)
    Attribute.IsDefined(Assembly, Type, bool)
    Attribute.IsDefined(MemberInfo, Type)
    Attribute.IsDefined(MemberInfo, Type, bool)
    Attribute.IsDefined(Module, Type)
    Attribute.IsDefined(Module, Type, bool)
    Attribute.IsDefined(ParameterInfo, Type)
    Attribute.IsDefined(ParameterInfo, Type, bool)
    Attribute.Match(object)
    Attribute.TypeId
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEditor.XR.OpenXR.Features
    Assembly: Unity.XR.OpenXR.dll
    Syntax
    [AttributeUsage(AttributeTargets.Class)]
    public class OpenXRFeatureAttribute : Attribute

    Fields

    BuildTargetGroups

    BuildTargetsGroups that this feature supports. The feature will only be shown or included on these platforms.

    Declaration
    public BuildTargetGroup[] BuildTargetGroups
    Field Value
    Type Description
    BuildTargetGroup[]

    Category

    Feature category.

    Declaration
    public string Category
    Field Value
    Type Description
    string

    Company

    Company that created the feature, shown in the feature configuration UI.

    Declaration
    public string Company
    Field Value
    Type Description
    string

    CustomRuntimeLoaderBuildTargets

    BuildTargets in this list use a custom runtime loader (that is, openxr_loader.dll). Only one feature per platform can have a custom runtime loader. Unity will skip copying the default loader to the build and use this feature's loader instead on these platforms. Loader must be placed alongside the OpenXRFeature script or in a subfolder of it.

    Declaration
    public BuildTarget[] CustomRuntimeLoaderBuildTargets
    Field Value
    Type Description
    BuildTarget[]

    Desc

    Feature description to show in the UI.

    Declaration
    public string Desc
    Field Value
    Type Description
    string

    DocumentationLink

    Link to the feature documentation. The help button in the UI opens this link in a web browser.

    Declaration
    public string DocumentationLink
    Field Value
    Type Description
    string

    FeatureId

    A well known string id for this feature. It is recommended that that id be in reverse DNS naming format (com.foo.bar.feature).

    Declaration
    public string FeatureId
    Field Value
    Type Description
    string

    Hidden

    Hide this feature from the UI.

    Declaration
    public bool Hidden
    Field Value
    Type Description
    bool

    OpenxrExtensionStrings

    OpenXR runtime extension strings that need to be enabled to use this extension. If these extensions can't be enabled, a message will be logged, but execution will continue. Can contain multiple extensions separated by spaces.

    Declaration
    public string OpenxrExtensionStrings
    Field Value
    Type Description
    string

    Priority

    Determines the order in which the feature will be called in both the GetInstanceProcAddr hook list and when events such as OnInstanceCreate are called. Higher priority features will hook after lower priority features and be called first in the event list.

    Declaration
    public int Priority
    Field Value
    Type Description
    int

    Required

    True if this feature is required, false otherwise. Required features will cause the loader to fail to initialize if they fail to initialize or start.

    Declaration
    public bool Required
    Field Value
    Type Description
    bool

    UiName

    Feature name to show in the feature configuration UI.

    Declaration
    public string UiName
    Field Value
    Type Description
    string

    Version

    Feature version.

    Declaration
    public string Version
    Field Value
    Type Description
    string
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)