XRServer

public static bool CameraLockedToOrigin { get; set; }

If set to true, the scene will be rendered as if the camera is locked to the XROrigin3D. Note: This doesn't provide a very comfortable experience for users. This setting exists for doing benchmarking or automated testing, where you want to control what is rendered via code.

public static XRInterface PrimaryInterface { get; set; }

The primary XRInterface currently bound to the XRServer.

public static Transform3D WorldOrigin { get; set; }

XRServer gameplay origin. The active XROrigin3D publishes its world transform here; direct assignments can be overwritten by it. The setter emits WorldOriginChanged even on repetition. Move the rig origin/body rather than maintaining two independent owners. A pose GetAdjustedTransform excludes this value.

public static double WorldScale { get; set; }

Shared tracking-to-game scale, initially 1. The setter clamps finite values to 0.01…1000 and forwards state to rendering. Validate finiteness before calling: range comparisons do not reject NaN. Changes pose adjustment, not Entity local Scale or stored velocities.

public static void AddInterface(XRInterface @interface);

Registers an XRInterface object.

public static void AddTracker(XRPositionalTracker tracker);

Registers a non-null object under its current name. Repeating the same reference emits nothing; a different object with the same name replaces the entry and emits TrackerUpdated. A new name emits TrackerAdded. Discovers no device and validates no hardware capabilities. Keep the name stable until removal.

public static void AddTracker(XRTracker tracker);

Registers a non-null object under its current name. Repeating the same reference emits nothing; a different object with the same name replaces the entry and emits TrackerUpdated. A new name emits TrackerAdded. Discovers no device and validates no hardware capabilities. Keep the name stable until removal.

public static void CenterOnHmd(XRServer.RotationMode rotationMode, bool keepHeight);

This is an important function to understand correctly. AR and VR platforms all handle positioning slightly differently. For platforms that do not offer spatial tracking, our origin point (0, 0, 0) is the location of our HMD, but you have little control over the direction the player is facing in the real world. For platforms that do offer spatial tracking, our origin point depends very much on the system. For OpenVR, our origin point is usually the center of the tracking space, on the ground. For other platforms, it's often the location of the tracking camera. This method allows you to center your tracker on the location of the HMD. It will take the current location of the HMD and use that to adjust all your tracking data; in essence, realigning the real world to your player's current position in the game world. For this method to produce usable results, tracking information must be available. This often takes a few frames after starting your game. You should call this method after a few seconds have passed. For example, when the user requests a realignment of the display holding a designated button on a controller for a short period of time, or when implementing a teleport mechanism.

public static void ClearReferenceFrame();

Resets the reference-frame adjustment to Identity, forwards it to rendering and emits ReferenceFrameChanged. Changes no gameplay origin, scale setting or raw poses. Source-reviewed; real recenter was not tested.

public static XRInterface FindInterface(string name);

Finds an interface by its name. For example, if your project uses capabilities of an AR/VR platform, you can find the interface for that platform by name and initialize it.

public static 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. Will check our primary interface first, then check each active interface. Returns empty if no interfaces manage this tracker.

public static 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. Will check our primary interface first, then check each active interface. Returns empty if no interfaces manage this tracker.

public static Transform3D GetHmdTransform();

Returns the primary interface's transformation.

public static XRInterface GetInterface(int idx);

Returns the interface registered at the given idx index in the list of interfaces.

public static int GetInterfaceCount();

Returns the number of interfaces currently registered with the AR/VR server. If your project supports multiple AR/VR platforms, you can look through the available interface, and either present the user with a selection or simply try to initialize each interface and use the first one that returns true.

public static Reckfell.Collections.Array<Reckfell.Collections.Dictionary> GetInterfaces();

Returns a list of available interfaces the ID and name of each interface.

public static Transform3D GetReferenceFrame();

Copy of the tracking-space adjustment. GetAdjustedTransform left-multiplies by it after position scaling. Not gameplay WorldOrigin. Only Identity was tested here; recenter needs separate device verification.

public static XRTracker GetTracker(StringName trackerName);

Returns a registered XRTracker by exact name, or null. Includes nonpositional trackers omitted by current GetTrackers. The object is shared: do not dispose its borrowed C# wrapper or edit provider-owned data.

public static Reckfell.Collections.Dictionary GetTrackers(int trackerTypes);

Returns a separate Dictionary: names as keys, shared tracker objects as values. Clearing the container unregisters nothing. The mask is bit-tested against Type. Confirmed defect: implementation first casts objects to XRPositionalTracker, so even Any omits nonpositional XRFaceTracker. Use GetTracker for a known name; do not treat this list as complete.

public static Transform3D GetWorldOrigin();

Copy of the current server gameplay origin, not raw head pose. The render thread reads render-frame state.

public static double GetWorldScale();

Returns the shared scale as double. The render thread reads its stored render state; the main thread reads current server state. Thread synchronization was not checked here.

public static void RemoveInterface(XRInterface @interface);

Removes this interface.

public static void RemoveTracker(XRPositionalTracker tracker);

Removes the entry by the supplied object’s current name, not reference identity. After replacement, an old reference with the same name can remove the new tracker. TrackerRemoved fires before erasure; GetTracker can still return the entry inside the handler. Destroys no external references and synthesizes no button releases.

public static void RemoveTracker(XRTracker tracker);

Removes the entry by the supplied object’s current name, not reference identity. After replacement, an old reference with the same name can remove the new tracker. TrackerRemoved fires before erasure; GetTracker can still return the entry inside the handler. Destroys no external references and synthesizes no button releases.

public static void SetWorldOrigin(Transform3D worldOrigin);

XRServer gameplay origin. The active XROrigin3D publishes its world transform here; direct assignments can be overwritten by it. The setter emits WorldOriginChanged even on repetition. Move the rig origin/body rather than maintaining two independent owners. A pose GetAdjustedTransform excludes this value.

public static void SetWorldScale(double scale);

Shared tracking-to-game scale, initially 1. The setter clamps finite values to 0.01…1000 and forwards state to rendering. Validate finiteness before calling: range comparisons do not reject NaN. Changes pose adjustment, not Entity local Scale or stored velocities.

public static event XRServer.InterfaceAddedEventHandler InterfaceAdded;

Emitted when a new interface has been added.

public static event XRServer.InterfaceRemovedEventHandler InterfaceRemoved;

Emitted when an interface is removed.

public static event Action ReferenceFrameChanged;

Emitted when the reference frame transform changes.

public static event XRServer.TrackerAddedEventHandler TrackerAdded;

A new-entry event emitted after insertion. Carries the name and numeric long category, not the object. Provider registration, not proof of a current pose or hardware connection.

public static event XRServer.TrackerRemovedEventHandler TrackerRemoved;

Emitted before registry erasure. Lookup by name may still return the object in the handler; this does not mean removal was cancelled. After RemoveTracker returns the entry is absent.

public static event XRServer.TrackerUpdatedEventHandler TrackerUpdated;

Emitted when another object replaces the entry under the same name. Repeating AddTracker with the same reference does not emit it. Not a per-tracking-frame event; pose updates are separate.

public static event Action WorldOriginChanged;

Emitted when the world origin transform changes.