Class OpenXRFeatureAttribute

Inheritance
Object
Attribute
OpenXRFeatureAttribute
Inherited Members
Namespace: UnityEditor.XR.OpenXR.Features
Syntax
[AttributeUsage(AttributeTargets.Class)]
public class OpenXRFeatureAttribute : Attribute, _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

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
Boolean

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
Int32

Required

True fi 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
Boolean

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