Class XRSessionSubsystem
This subsystem controls the lifecycle of an XR session. Some platforms, particularly those that have non-XR modes, need to be able to turn the session on and off to enter and exit XR modes of operation.
Inheritance
Implements
Inherited Members
Namespace: UnityEngine .XR.ARSubsystems
Assembly: solution.dll
Syntax
public class XRSessionSubsystem : SubsystemWithProvider<XRSessionSubsystem, XRSessionSubsystemDescriptor, XRSessionSubsystem.Provider>, ISubsystem
Constructors
Name | Description |
---|---|
XRSession |
Do not call this directly. Call create on a valid XRSession |
Properties
Name | Description |
---|---|
configuration |
Get or set the Configuration |
current |
The current Configuration in use by the session. |
current |
Get the current tracking mode in use by the subsystem. |
frame |
The native update rate of the AR Session. |
match |
Whether the AR session update is synchronized with the Unity frame rate.
If |
match |
Get or set whether the match frame rate feature should be enabled. When enabled, the AR session update is synchronized with the Unity frame rate. |
native |
Returns an implementation-defined pointer associated with the session. |
not |
Gets the Not |
requested |
Get the requested Features. These are used to determine the session's Configuration. |
requested |
The requested tracking mode. Query for support with |
session |
Returns a unique session identifier for this session. |
tracking |
Gets the Tracking |
Methods
Name | Description |
---|---|
Determine |
Determines the Configuration the session will use given the requested |
Get |
Asynchronously retrieves the Session |
Get |
Get the list of supported configuration descriptors. The session can have multiple, discrete modes of operation.
A configuration represents the capabilities of a mode of operation, which can be a subset of the session's overal
capabilities. That is, the session might support many features, but not all at the same time. This is used by
Determine |
Install |
Asynchronously attempts to install XR software on the current device.
Throws if supports |
On |
Should be invoked when the application is paused. |
On |
Should be invoked when the application is resumed. |
Reset() | Restarts a session. Stop and Start
pause and resume a session, respectively. |
Update(XRSession |
Trigger the session's update loop. |