VitureXR API

VitureXR is the SDK's central hub providing static access to VITURE XR functionality. All APIs are organized into logical categories for easy discovery and use.

Glasses

Provides information about connected VITURE glasses.

`GetGlassesModel()`

Gets the model of the currently connected VITURE glasses.

Returns: Connected model, or VitureGlassesModel.Unknown if no glasses are connected.

Supported Models:

VitureGlassesModel.One - Includes VITURE One and VITURE One Lite glasses.

VitureGlassesModel.Pro - VITURE Pro glasses.

VitureGlassesModel.Luma - Includes VITURE Luma and VITURE Luma Pro glasses.

VitureGlassesModel.LumaUltra - VITURE Luma Ultra glasses.

Head Tracking

Controls head tracking functionality and provides device capability information.

`GetHeadTrackingCapability()`

Gets the head tracking capability of the currently connected glasses.

Returns: Head tracking capability based on the connected glasses model:

VitureHeadTrackingCapability.ThreeDoF - 3 degrees of freedom (rotation only)

VitureHeadTrackingCapability.SixDoF - Full 6 degrees of freedom (position + rotation)

`ResetOrigin()`

Resets the head tracking origin to the current head position and orientation. This recalibrates the tracking reference origin.

Hand Tracking

Controls the hand tracking subsystem lifecycle. Unity XR Hands package must be installed to use this feature.

`Start()`

Starts the VITURE XR hand subsystem.

`Stop()`

Stops the VITURE XR hand subsystem.

Rendering

Advanced rendering controls for performance optimization.

`SetHalfFrameRate(bool enabled)`

Enables or disables half frame rate rendering for performance optimization. When enabled, reduces rendering frame rate by half (e.g., 90fps to 45fps). Animation will appear less smooth.

Parameters:

enabled - True to enable half frame rate, false to disable.

`SetTimeWarpOnlyMode(bool enabled)`

Enables or disables time warp only rendering mode. When enabled, stops Unity rendering and uses only time warp to display the last rendered frame with head tracking compensation. This is only for testing purposes.

Parameters:

enabled - True to enable time warp only mode, false to disable.