XRInterface

public bool ArIsAnchorDetectionEnabled { get; set; }

On an AR interface, true if anchor detection is enabled.

public XRInterface.EnvironmentBlendModeEnum EnvironmentBlendMode { get; set; }

Requested interface composition mode. The base getter returns Opaque; OpenXR can emulate AlphaBlend with another internal mode. The property setter reports no rejection: use SetEnvironmentBlendMode to handle success. Not a camera-video readiness flag or a TransparentBg setting.

public bool InterfaceIsPrimary { get; set; }

true if this is the primary interface.

public XRInterface.PlayAreaMode XRPlayAreaMode { get; set; }

The play area mode for this interface.

public int GetCameraFeedId();

If this is an AR interface that requires displaying a camera feed as the background, this method returns the feed ID in the CameraServer for this interface.

public Reckfell.Collections.Array<Transform3D> GetCameraOffsets(StringName trackerName);

Gets an array of offset transforms for each view for tracker tracker_name. tracker_name must refer to an XRPositionalTracker used as a camera. Returns an empty array if this interface is not responsible for this tracker.

public Reckfell.Collections.Array<Projection> GetCameraProjections(StringName trackerName, double aspect, double near, double far);

Gets an array of projection matrices for each view for tracker tracker_name. tracker_name must refer to an XRPositionalTracker used as a camera. Returns an empty array if this interface is not responsible for this tracker.

public uint GetCapabilities();

Returns a combination of XRInterface.Capabilities flags providing information about the capabilities of this interface.

public XRInterface.EnvironmentBlendModeEnum GetEnvironmentBlendMode();

Returns the implementation-reported mode: requested mode in OpenXR, Opaque in the base interface. Establishes no active session, focus, video delivery or user consent. Configure Viewport background transparency separately for alpha.

public StringName GetName();

Returns the name of this interface ("OpenXR", "OpenVR", "OpenHMD", "ARKit", etc.).

public Vector3[] GetPlayArea();

Returns an array of vectors that represent the physical play area mapped to the virtual space around the XROrigin3D point. The points form a convex polygon that can be used to react to or visualize the play area. This returns an empty array if this feature is not supported or if the information is not yet available.

public Projection GetProjectionForView(uint view, double aspect, double near, double far);

Returns the projection matrix for a view/eye.

public Vector2 GetRenderTargetSize();

Returns the resolution at which we should render our intermediate results before things like lens distortion are applied by the VR platform.

public Reckfell.Collections.Array GetSupportedEnvironmentBlendModes();

Returns a new container of EnvironmentBlendModeEnum values. The base implementation contains Opaque; OpenXR without an internal API returns an empty list and can add emulated AlphaBlend after startup. Check membership through Contains, not an index converted to bool. Dispose the container, not the borrowed interface.

public Reckfell.Collections.Dictionary GetSystemInfo();

Returns a Reckfell.Collections.Dictionary with extra system info. Interfaces are expected to return XRRuntimeName and XRRuntimeVersion providing info about the used XR runtime. Additional entries may be provided specific to an interface. **Note:**This information may only be available after XRInterface.Initialize was successfully called.

public XRInterface.TrackingStatus GetTrackingStatus();

If supported, returns the status of our tracking. This will allow you to provide feedback to the user whether there are issues with positional tracking.

public Transform3D GetTransformForView(uint view, Transform3D camTransform);

Returns the transform for a view/eye. view is the view/eye index. cam_transform is the transform that maps device coordinates to scene coordinates, typically the Entity3D.GlobalTransform of the current XROrigin3D.

public uint GetViewCount();

Returns the number of views that need to be rendered for this device. 1 for Monoscopic, 2 for Stereoscopic.

public bool Initialize();

Call this to initialize this interface. The first interface that is initialized is identified as the primary interface and it will be used for rendering output. After initializing the interface you want to use you then need to enable the AR/VR mode of a viewport and rendering should commence. Note: You must enable the XR mode on the main viewport for any device that uses the main output of Reckfell, such as for mobile VR. If you do this for a platform that handles its own output (such as OpenVR) Reckfell will show just one eye without distortion on screen. Alternatively, you can add a separate viewport node to your scene and enable AR/VR on that viewport. It will be used to output to the HMD, leaving you free to do anything you like in the main window, such as using a separate camera as a spectator camera or rendering something completely different. While currently not used, you can activate additional interfaces. You may wish to do this if you want to track controllers from other platforms. However, at this point in time only one interface can render to an HMD.

public bool IsInitialized();

Returns true if this interface has been initialized.

public bool IsPassthroughEnabled();

Obsolete. Compare GetEnvironmentBlendMode() with AlphaBlend instead. OpenXR only compares its reported mode, not camera frames, session focus or permissions; the base interface returns false.

public bool IsPassthroughSupported();

Obsolete; use GetSupportedEnvironmentBlendModes and AlphaBlend membership. Current OpenXR has a defect: find returns an index converted to bool; −1 becomes true and index 0 false. True for an empty uninitialized list was reproduced. Not fixed; do not use this result as a capability gate.

public bool SetEnvironmentBlendMode(XRInterface.EnvironmentBlendModeEnum mode);

Requests a mode and returns the implementation setter result. Check supported modes and the bool; change TransparentBg separately only after acceptance. OpenXR without an API returns false, while its internal API can retain a request before initialization for later validation. Success establishes neither video nor focus.

public bool SetPlayAreaMode(XRInterface.PlayAreaMode mode);

Sets the active play area mode, will return false if the mode can't be used with this interface. Note: Changing this after the interface has already been initialized can be jarring for the player, so it's recommended to recenter on the HMD with XRServer.CenterOnHmd (if switching to XRInterface.PlayAreaMode.Stage) or make the switch during a scene change.

public bool StartPassthrough();

Obsolete. OpenXR simply calls SetEnvironmentBlendMode(AlphaBlend); the base implementation returns false. Enables no Viewport transparency and initializes no session. New code should explicitly check supported modes and SetEnvironmentBlendMode success.

public void StopPassthrough();

Obsolete. OpenXR requests Opaque without returning success; the base implementation does nothing. Restores neither the previous blend mode nor TransparentBg. Save state and perform an explicit reverse switch with a checked bool.

public bool SupportsPlayAreaMode(XRInterface.PlayAreaMode mode);

Call this to find out if a given play area mode is supported by this interface.

public void TriggerHapticPulse(string actionName, StringName trackerName, double frequency, double amplitude, double durationSec, double delaySec);

Triggers a haptic pulse on a device associated with this interface. action_name is the name of the action for this pulse. tracker_name is optional and can be used to direct the pulse to a specific device provided that device is bound to this haptic. frequency is the frequency of the pulse, set to 0.0 to have the system use a default frequency. amplitude is the amplitude of the pulse between 0.0 and 1.0. duration_sec is the duration of the pulse in seconds. delay_sec is a delay in seconds before the pulse is given.

public void Uninitialize();

Turns the interface off.

public event XRInterface.PlayAreaChangedEventHandler PlayAreaChanged;

Emitted when the play area is changed. This can be a result of the player resetting the boundary or entering a new play area, the player changing the play area mode, the world scale changing or the player resetting their headset orientation.