OpenXRInterface

public float DisplayRefreshRate { get; set; }

The display refresh rate for the current HMD. Only functional if this feature is supported by the OpenXR runtime and after the interface has been initialized.

public bool FoveationDynamic { get; set; }

If true, enables dynamic foveation adjustment. The interface must be initialized before this is accessible. If enabled, foveation will automatically be adjusted between low and OpenXRInterface.FoveationLevel.

public int FoveationLevel { get; set; }

The foveation level, from 0 (off) to 3 (high). The interface must be initialized before this is accessible.

public bool FoveationWithSubsampledImages { get; set; }

If true, enables subsampled images with foveation, which can provide a performance boost on Vulkan.

public double RenderTargetSizeMultiplier { get; set; }

The render size multiplier for the current HMD. Must be set before the interface has been initialized.

public float VrsMinRadius { get; set; }

The minimum radius around the focal point where full quality is guaranteed if VRS is used as a percentage of screen size. Note: Mobile and Forward+ renderers only. Requires Viewport.VrsMode to be set to Viewport.VrsModeEnum.XR.

public float VrsStrength { get; set; }

The strength used to calculate the VRS density map. The greater this value, the more noticeable VRS is. This improves performance at the cost of quality. Note: Mobile and Forward+ renderers only. Requires Viewport.VrsMode to be set to Viewport.VrsModeEnum.XR.

public Reckfell.Collections.Array GetActionSets();

Returns a list of action sets registered with Reckfell (loaded from the action map at runtime).

public OpenXRInterface.ViewConfiguration GetActiveViewConfiguration();

Gets the active view configuration. Note: This will only return a valid value after OpenXR is initialized.

public Reckfell.Collections.Array GetAvailableDisplayRefreshRates();

Returns a list of display refresh rates supported by the current HMD. Only returned if this feature is supported by the OpenXR runtime and after the interface has been initialized.

public Vector3 GetHandJointAngularVelocity(OpenXRInterface.Hand hand, OpenXRInterface.HandJoints joint);

If handtracking is enabled, returns the angular velocity of a joint (joint) of a hand (hand) as provided by OpenXR. This is relative to XROrigin3D!

public OpenXRInterface.HandJointFlags GetHandJointFlags(OpenXRInterface.Hand hand, OpenXRInterface.HandJoints joint);

If handtracking is enabled, returns flags that inform us of the validity of the tracking data.

public Vector3 GetHandJointLinearVelocity(OpenXRInterface.Hand hand, OpenXRInterface.HandJoints joint);

If handtracking is enabled, returns the linear velocity of a joint (joint) of a hand (hand) as provided by OpenXR. This is relative to XROrigin3D without worldscale applied!

public Vector3 GetHandJointPosition(OpenXRInterface.Hand hand, OpenXRInterface.HandJoints joint);

If handtracking is enabled, returns the position of a joint (joint) of a hand (hand) as provided by OpenXR. This is relative to XROrigin3D without worldscale applied!

public float GetHandJointRadius(OpenXRInterface.Hand hand, OpenXRInterface.HandJoints joint);

If handtracking is enabled, returns the radius of a joint (joint) of a hand (hand) as provided by OpenXR. This is without worldscale applied!

public Quaternion GetHandJointRotation(OpenXRInterface.Hand hand, OpenXRInterface.HandJoints joint);

If handtracking is enabled, returns the rotation of a joint (joint) of a hand (hand) as provided by OpenXR.

public OpenXRInterface.HandTrackedSource GetHandTrackingSource(OpenXRInterface.Hand hand);

If handtracking is enabled and hand tracking source is supported, gets the source of the hand tracking data for hand.

public OpenXRInterface.HandMotionRange GetMotionRange(OpenXRInterface.Hand hand);

If handtracking is enabled and motion range is supported, gets the currently configured motion range for hand.

public Vector2 GetRecommendedTargetSize();

Returns the recommended render target size from the OpenXR runtime. This may not match the current render target size returned by XRInterface.GetRenderTargetSize.

public OpenXRInterface.SessionState GetSessionState();

Returns the current state of our OpenXR session.

public bool IsActionSetActive(string name);

Returns true if the given action set is active.

public bool IsEyeGazeInteractionSupported();

Returns the capabilities of the eye gaze interaction extension. Note: This only returns a valid value after OpenXR has been initialized.

public bool IsFoveationSupported();

Returns true if OpenXR's foveation extension is supported. The interface must be initialized before this returns a valid value. Note: When using the Vulkan rendering driver, Viewport.VrsMode must be set to Viewport.VrsModeEnum.XR to support foveation.

public bool IsHandInteractionSupported();

Returns true if OpenXR's hand interaction profile is supported and enabled. Note: This only returns a valid value after OpenXR has been initialized.

public bool IsHandTrackingSupported();

Returns true if OpenXR's hand tracking is supported and enabled. Note: This only returns a valid value after OpenXR has been initialized.

public bool IsUserPresenceSupported();

Returns true if OpenXR's user presence extension is supported and enabled. Note: This only returns a valid value after OpenXR has been initialized.

public bool IsUserPresent();

Returns true if system has detected the presence of a user in the XR experience.

public void SetActionSetActive(string name, bool active);

Sets the given action set as active or inactive.

public void SetCpuLevel(OpenXRInterface.PerfSettingsLevel level);

Sets the CPU performance level of the OpenXR device.

public void SetGpuLevel(OpenXRInterface.PerfSettingsLevel level);

Sets the GPU performance level of the OpenXR device.

public void SetMotionRange(OpenXRInterface.Hand hand, OpenXRInterface.HandMotionRange motionRange);

If handtracking is enabled and motion range is supported, sets the currently configured motion range for hand to motion_range.

public event OpenXRInterface.CpuLevelChangedEventHandler CpuLevelChanged;

Informs the device CPU performance level has changed in the specified subdomain.

public event OpenXRInterface.GpuLevelChangedEventHandler GpuLevelChanged;

Informs the device GPU performance level has changed in the specified subdomain.

public event Action InstanceExiting;

Informs our OpenXR instance is exiting.

public event Action PoseRecentered;

Informs the user queued a recenter of the player position.

public event OpenXRInterface.RefreshRateChangedEventHandler RefreshRateChanged;

Informs the user the HMD refresh rate has changed. Note: Only emitted if XR runtime supports the refresh rate extension.

public event Action SessionBegun;

Informs our OpenXR session has been started.

public event Action SessionFocussed;

Informs our OpenXR session now has focus, for example output is sent to the HMD and we're receiving XR input.

public event Action SessionLossPending;

Informs our OpenXR session is in the process of being lost.

public event Action SessionStopping;

Informs our OpenXR session is stopping.

public event Action SessionSynchronized;

Informs our OpenXR session has been synchronized.

public event Action SessionVisible;

Informs our OpenXR session is now visible, for example output is sent to the HMD but we don't receive XR input.

public event OpenXRInterface.UserPresenceChangedEventHandler UserPresenceChanged;

Signal emitted when the user presence value changes. Note: This signal will not be emitted during application startup and application shutdown. Developers should assume user presence is gained on startup and lost on shutdown.