Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

XRInterfaceExtension

Inherits: XRInterface < RefCounted < Object

Base class for XR interface extensions (plugins).

Description

External XR interface plugins should inherit from this class.

Tutorials

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

RID

_get_color_texture ( ) virtual

RID

_get_depth_texture ( ) virtual

StringName

_get_name ( ) virtual const

PackedVector3Array

_get_play_area ( ) virtual const

PlayAreaMode

_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

Dictionary

_get_system_info ( ) virtual const

TrackingStatus

_get_tracking_status ( ) virtual const

Transform3D

_get_transform_for_view ( int view, Transform3D cam_transform ) virtual

RID

_get_velocity_texture ( ) virtual

int

_get_view_count ( ) virtual

RID

_get_vrs_texture ( ) virtual

bool

_initialize ( ) virtual

bool

_is_initialized ( ) virtual const

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 ( PlayAreaMode 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_color_texture ( )

RID

get_depth_texture ( )

RID

get_render_target_texture ( RID render_target )

RID

get_velocity_texture ( )


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


Transform3D _get_camera_transform ( ) virtual

Returns the Transform3D that positions the XRCamera3D in the world.


int _get_capabilities ( ) virtual const

Returns the capabilities of this interface.


RID _get_color_texture ( ) virtual

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


RID _get_depth_texture ( ) virtual

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


StringName _get_name ( ) virtual const

Returns the name of this interface.


PackedVector3Array _get_play_area ( ) virtual const

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


PlayAreaMode _get_play_area_mode ( ) virtual const

Returns the PlayAreaMode that sets up our play area.


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

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.


PackedStringArray _get_suggested_pose_names ( StringName tracker_name ) virtual const

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


PackedStringArray _get_suggested_tracker_names ( ) virtual const

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


Dictionary _get_system_info ( ) virtual const

Returns a Dictionary with system information related to this interface.