Class OpenXRFeature
A Unity OpenXR Feature. This class can be inherited from to add feature specific data and logic. Feature-specific settings are serialized for access at runtime.
Inherited Members
Namespace: UnityEngine .XR.OpenXR .Features
Assembly: solution.dll
Syntax
[Serializable]
public abstract class OpenXRFeature : ScriptableObject
Properties
Name | Description |
---|---|
enabled | Feature is enabled and will be started when the OpenXR loader is initialized. Note that the enabled state of a feature cannot be modified once OpenXR is initialized and can be used at runtime to determine if a feature successfully initialized. |
xr |
Accessor for xrGetInstanceProcAddr function pointer. |
Methods
Name | Description |
---|---|
Awake() | |
Create |
Creates a subsystem based on a given a list of descriptors and a specific subsystem id. Promoted to public for extensions. |
Destroy |
Destroys a subsystem instance of a given type. Subsystem is assumed to already be loaded from a previous call to CreateSubsystem. Promoted to public for extensions. |
Get |
Returns XrAction handle bound to the given Input |
Get |
Returns the current app space. |
Get |
Returns the path of the current interaction profile for the given user path. |
Get |
Returns the path of the current interaction profile for the given user path. |
Get |
Returns the current XR Environment Blend Mode. |
Get |
Returns viewConfigurationType for the given renderPass index. |
Hook |
Called to hook xrGetInstanceProcAddr. Returning a different function pointer allows intercepting any OpenXR method. |
On |
Called when the reference xrSpace for the app changes. |
On |
|
On |
|
On |
Called when the enabled state of a feature changes |
On |
Notification to the feature implementer that the environment blend mode has changed. |
On |
Notification to the feature implementer that the form factor has changed. |
On |
Called after xrCreateInstance. |
On |
Called before xrDestroyInstance |
On |
Called when the OpenXR loader receives the XR_TYPE_EVENT_DATA_INSTANCE_LOSS_PENDING event from the runtime. This is a notification to the feature implementer that the instance is about to be lost. This feature should do what it needs to do to clean up in preparation for termination. |
On |
Called after xrSessionBegin. |
On |
Called after xrCreateSession. |
On |
Called before xrDestroySession. |
On |
Called before xrEndSession. |
On |
Called when the runtime transitions to the XR_SESSION_STATE_EXITING state. |
On |
Called when the runtime transitions to the XR_SESSION_STATE_LOSS_PENDING state. This is a notification to the feature implementer that the session is about to be lost. This feature should do what it needs to do to prepare for potential session recreation. |
On |
Called when the OpenXR loader receives the XR_TYPE_EVENT_DATA_SESSION_STATE_CHANGED event from the runtime signaling that the XrSessionState has changed. |
On |
Called after the OpenXR Loader is initialized and has created its subsystems. |
On |
Called before the OpenXR loader destroys its subsystems. |
On |
Called after the OpenXR loader has started its subsystems. |
On |
Called before the OpenXR loader stops its subsystems. |
On |
Called after xrGetSystem. |
On |
Notification to the feature implementer that the view configuration type has changed. |
Path |
Converts an XrPath to a string. |
Set |
Set the current XR Environment Blend Mode if it is supported by the active runtime. If not supported, fall back to the runtime preference. |
Start |
Start a subsystem instance of a given type. Subsystem is assumed to already be loaded from a previous call to CreateSubsystem. Promoted to public for extensions. |
Stop |
Stops a subsystem instance of a given type. Subsystem is assumed to already be loaded from a previous call to CreateSubsystem. Promoted to public for extensions. |
String |
Converts a string to an XrPath. |