XRInterfaceExtension

public void AddBlit(Rid renderTarget, Rect2 srcRect, Rect2I dstRect, bool useLayer, uint layer, bool applyLensDistortion, Vector2 eyeCenter, double k1, double k2, double upscale, double aspectRatio);

Blits our render results to screen optionally applying lens distortion. This can only be called while processing _commit_views.

public Rid GetColorTexture();

Return color texture into which to render (if applicable).

public Rid GetDepthTexture();

Return depth texture into which to render (if applicable).

public Rid GetRenderTargetTexture(Rid renderTarget);

Returns a valid Rid for a texture to which we should render the current frame if supported by the interface.

public Rid GetVelocityTexture();

Return velocity texture into which to render (if applicable).

public virtual void _EndFrame();

Called if interface is active and queues have been submitted.

public virtual bool _GetAnchorDetectionIsEnabled();

Return true if anchor detection is enabled for this interface.

public virtual int _GetCameraFeedId();

Returns the camera feed ID for the CameraFeed registered with the CameraServer that should be presented as the background on an AR capable device (if applicable).

public virtual 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 virtual Reckfell.Collections.Array<Projection> _GetCameraProjections(StringName trackerName, double aspect, double zNear, double zFar);

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 virtual Transform3D _GetCameraTransform();

Returns the Transform3D that positions the XRCamera3D in the world.

public virtual uint _GetCapabilities();

Returns the capabilities of this interface.

public virtual Rid _GetColorTexture();

Return color texture into which to render (if applicable).

public virtual Rid _GetDepthTexture();

Return depth texture into which to render (if applicable).

public virtual StringName _GetName();

Returns the name of this interface.

public virtual Vector3[] _GetPlayArea();

Returns a Vector3[] that represents the play areas boundaries (if applicable).

public virtual XRInterface.PlayAreaMode _GetPlayAreaMode();

Returns the play area mode that sets up our play area.

public virtual double[] _GetProjectionForView(uint view, double aspect, double zNear, double zFar);

Returns the projection matrix for the given view as a double[].

public virtual Vector2 _GetRenderTargetSize();

Returns the size of our render target for this interface, this overrides the size of the Viewport marked as the xr viewport.

public virtual string[] _GetSuggestedPoseNames(StringName trackerName);

Returns a string[] with pose names configured by this interface. Note that user configuration can override this list.

public virtual string[] _GetSuggestedTrackerNames();

Returns a string[] with tracker names configured by this interface. Note that user configuration can override this list.

public virtual Reckfell.Collections.Dictionary _GetSystemInfo();

Returns a Reckfell.Collections.Dictionary with system information related to this interface.

public virtual XRInterface.TrackingStatus _GetTrackingStatus();

Returns the current status of our tracking.

public virtual Transform3D _GetTransformForView(uint view, Transform3D camTransform);

Returns a Transform3D for a given view.

public virtual Rid _GetVelocityTexture();

Return velocity texture into which to render (if applicable).

public virtual uint _GetViewCount();

Returns the number of views this interface requires, 1 for mono, 2 for stereoscopic.

public virtual XRInterface.VrsTextureFormat _GetVrsTextureFormat();

Returns the format of the texture returned by XRInterfaceExtension._GetVrsTexture.

public virtual bool _Initialize();

Initializes the interface, returns true on success.

public virtual bool _IsInitialized();

Returns true if this interface has been initialized.

public virtual void _PostDrawViewport(Rid renderTarget, Rect2 screenRect);

Called after the XR Viewport draw logic has completed.

public virtual bool _PreDrawViewport(Rid renderTarget);

Called if this is our primary XRInterfaceExtension before we start processing a Viewport for every active XR Viewport, returns true if that viewport should be rendered. An XR interface may return false if the user has taken off their headset and we can pause rendering.

public virtual void _PreRender();

Called if this XRInterfaceExtension is active before rendering starts. Most XR interfaces will sync tracking at this point in time.

public virtual void _Process();

Called if this XRInterfaceExtension is active before our physics and game process is called. Most XR interfaces will update its XRPositionalTrackers at this point in time.

public virtual void _SetAnchorDetectionIsEnabled(bool enabled);

Enables anchor detection on this interface if supported.

public virtual bool _SetPlayAreaMode(XRInterface.PlayAreaMode mode);

Set the play area mode for this interface.

public virtual bool _SupportsPlayAreaMode(XRInterface.PlayAreaMode mode);

Returns true if this interface supports this play area mode.

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

Triggers a haptic pulse to be emitted on the specified tracker.

public virtual void _Uninitialize();

Uninitialize the interface.