XRInterfaceExtension

Inherits: XRInterface < RefCounted < Object

Base class for XR interface extensions (plugins).

Description

External XR interface plugins should inherit from this class.

Methods

void

_end_frame ( ) virtual

bool

_get_anchor_detection_is_enabled ( ) virtual const

int

_get_camera_feed_id ( ) virtual const

Transform3D

_get_camera_transform ( ) virtual

int

_get_capabilities ( ) virtual const

StringName

_get_name ( ) virtual const

PackedVector3Array

_get_play_area ( ) virtual const

int

_get_play_area_mode ( ) virtual const

PackedFloat64Array

_get_projection_for_view ( int view, float aspect, float z_near, float z_far ) virtual

Vector2

_get_render_target_size ( ) virtual

PackedStringArray

_get_suggested_pose_names ( StringName tracker_name ) virtual const

PackedStringArray

_get_suggested_tracker_names ( ) virtual const

int

_get_tracking_status ( ) virtual const

Transform3D

_get_transform_for_view ( int view, Transform3D cam_transform ) virtual

int

_get_view_count ( ) virtual

bool

_initialize ( ) virtual

bool

_is_initialized ( ) virtual const

void

_notification ( int what ) virtual

void

_post_draw_viewport ( RID render_target, Rect2 screen_rect ) virtual

bool

_pre_draw_viewport ( RID render_target ) virtual

void

_pre_render ( ) virtual

void

_process ( ) virtual

void

_set_anchor_detection_is_enabled ( bool enabled ) virtual

bool

_set_play_area_mode ( int mode ) virtual const

bool

_supports_play_area_mode ( PlayAreaMode mode ) virtual const

void

_trigger_haptic_pulse ( String action_name, StringName tracker_name, float frequency, float amplitude, float duration_sec, float delay_sec ) virtual

void

_uninitialize ( ) virtual

void

add_blit ( RID render_target, Rect2 src_rect, Rect2i dst_rect, bool use_layer, int layer, bool apply_lens_distortion, Vector2 eye_center, float k1, float k2, float upscale, float aspect_ratio )

RID

get_render_target_texture ( RID render_target )

Method Descriptions

  • void _end_frame ( ) virtual

Called if interface is active and queues have been submitted.


  • bool _get_anchor_detection_is_enabled ( ) virtual const

Return true if anchor detection is enabled for this interface.


  • int _get_camera_feed_id ( ) virtual const

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).


Returns the Transform3D that positions the XRCamera3D in the world.


  • int _get_capabilities ( ) virtual const

Returns the capabilities of this interface.


Returns the name of this interface.


Returns an PackedVector3Array that denotes the play areas boundaries (if applicable).


  • int _get_play_area_mode ( ) virtual const

Returns the PlayAreaMode that sets up our play area.


Returns the projection matrix for the given view as a PackedFloat64Array.


  • Vector2 _get_render_target_size ( ) virtual

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


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


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


  • int _get_tracking_status ( ) virtual const

Returns a TrackingStatus specifying the current status of our tracking.


Returns a Transform3D for a given view.


  • int _get_view_count ( ) virtual

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


  • bool _initialize ( ) virtual

Initializes the interface, returns true on success.


  • bool _is_initialized ( ) virtual const

Returns true if this interface has been initialised.


  • void _notification ( int what ) virtual

Informs the interface of an applicable system notification.


  • void _post_draw_viewport ( RID render_target, Rect2 screen_rect ) virtual

Called after the XR Viewport draw logic has completed.


  • bool _pre_draw_viewport ( RID render_target ) virtual

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.


  • void _pre_render ( ) virtual

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


  • void _process ( ) virtual

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.


  • void _set_anchor_detection_is_enabled ( bool enabled ) virtual

Enables anchor detection on this interface if supported.


  • bool _set_play_area_mode ( int mode ) virtual const

Set the play area mode for this interface.


Returns true if this interface supports this play area mode.


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


  • void _uninitialize ( ) virtual

Uninitialize the interface.


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


  • RID get_render_target_texture ( RID render_target )

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