godot-docs/classes/class_xrinterfaceextension.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.3/doc/classes/XRInterfaceExtension.xml.

.. _class_XRInterfaceExtension:

XRInterfaceExtension
====================

**Inherits:** :ref:`XRInterface<class_XRInterface>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`

Base class for XR interface extensions (plugins).

.. rst-class:: classref-introduction-group

Description
-----------

External XR interface plugins should inherit from this class.

.. rst-class:: classref-introduction-group

Tutorials
---------

- :doc:`XR documentation index <../tutorials/xr/index>`

.. rst-class:: classref-reftable-group

Methods
-------

.. table::
   :widths: auto

   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                 | :ref:`_end_frame<class_XRInterfaceExtension_private_method__end_frame>`\ (\ ) |virtual|                                                                                                                                                                                                                                                                                                                                                                                                                |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                | :ref:`_get_anchor_detection_is_enabled<class_XRInterfaceExtension_private_method__get_anchor_detection_is_enabled>`\ (\ ) |virtual| |const|                                                                                                                                                                                                                                                                                                                                                            |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                  | :ref:`_get_camera_feed_id<class_XRInterfaceExtension_private_method__get_camera_feed_id>`\ (\ ) |virtual| |const|                                                                                                                                                                                                                                                                                                                                                                                      |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Transform3D<class_Transform3D>`                  | :ref:`_get_camera_transform<class_XRInterfaceExtension_private_method__get_camera_transform>`\ (\ ) |virtual|                                                                                                                                                                                                                                                                                                                                                                                          |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                  | :ref:`_get_capabilities<class_XRInterfaceExtension_private_method__get_capabilities>`\ (\ ) |virtual| |const|                                                                                                                                                                                                                                                                                                                                                                                          |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`RID<class_RID>`                                  | :ref:`_get_color_texture<class_XRInterfaceExtension_private_method__get_color_texture>`\ (\ ) |virtual|                                                                                                                                                                                                                                                                                                                                                                                                |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`RID<class_RID>`                                  | :ref:`_get_depth_texture<class_XRInterfaceExtension_private_method__get_depth_texture>`\ (\ ) |virtual|                                                                                                                                                                                                                                                                                                                                                                                                |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`StringName<class_StringName>`                    | :ref:`_get_name<class_XRInterfaceExtension_private_method__get_name>`\ (\ ) |virtual| |const|                                                                                                                                                                                                                                                                                                                                                                                                          |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedVector3Array<class_PackedVector3Array>`    | :ref:`_get_play_area<class_XRInterfaceExtension_private_method__get_play_area>`\ (\ ) |virtual| |const|                                                                                                                                                                                                                                                                                                                                                                                                |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PlayAreaMode<enum_XRInterface_PlayAreaMode>`     | :ref:`_get_play_area_mode<class_XRInterfaceExtension_private_method__get_play_area_mode>`\ (\ ) |virtual| |const|                                                                                                                                                                                                                                                                                                                                                                                      |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedFloat64Array<class_PackedFloat64Array>`    | :ref:`_get_projection_for_view<class_XRInterfaceExtension_private_method__get_projection_for_view>`\ (\ view\: :ref:`int<class_int>`, aspect\: :ref:`float<class_float>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) |virtual|                                                                                                                                                                                                                                           |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Vector2<class_Vector2>`                          | :ref:`_get_render_target_size<class_XRInterfaceExtension_private_method__get_render_target_size>`\ (\ ) |virtual|                                                                                                                                                                                                                                                                                                                                                                                      |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedStringArray<class_PackedStringArray>`      | :ref:`_get_suggested_pose_names<class_XRInterfaceExtension_private_method__get_suggested_pose_names>`\ (\ tracker_name\: :ref:`StringName<class_StringName>`\ ) |virtual| |const|                                                                                                                                                                                                                                                                                                                      |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`PackedStringArray<class_PackedStringArray>`      | :ref:`_get_suggested_tracker_names<class_XRInterfaceExtension_private_method__get_suggested_tracker_names>`\ (\ ) |virtual| |const|                                                                                                                                                                                                                                                                                                                                                                    |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Dictionary<class_Dictionary>`                    | :ref:`_get_system_info<class_XRInterfaceExtension_private_method__get_system_info>`\ (\ ) |virtual| |const|                                                                                                                                                                                                                                                                                                                                                                                            |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`TrackingStatus<enum_XRInterface_TrackingStatus>` | :ref:`_get_tracking_status<class_XRInterfaceExtension_private_method__get_tracking_status>`\ (\ ) |virtual| |const|                                                                                                                                                                                                                                                                                                                                                                                    |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`Transform3D<class_Transform3D>`                  | :ref:`_get_transform_for_view<class_XRInterfaceExtension_private_method__get_transform_for_view>`\ (\ view\: :ref:`int<class_int>`, cam_transform\: :ref:`Transform3D<class_Transform3D>`\ ) |virtual|                                                                                                                                                                                                                                                                                                 |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`RID<class_RID>`                                  | :ref:`_get_velocity_texture<class_XRInterfaceExtension_private_method__get_velocity_texture>`\ (\ ) |virtual|                                                                                                                                                                                                                                                                                                                                                                                          |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`int<class_int>`                                  | :ref:`_get_view_count<class_XRInterfaceExtension_private_method__get_view_count>`\ (\ ) |virtual|                                                                                                                                                                                                                                                                                                                                                                                                      |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`RID<class_RID>`                                  | :ref:`_get_vrs_texture<class_XRInterfaceExtension_private_method__get_vrs_texture>`\ (\ ) |virtual|                                                                                                                                                                                                                                                                                                                                                                                                    |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                | :ref:`_initialize<class_XRInterfaceExtension_private_method__initialize>`\ (\ ) |virtual|                                                                                                                                                                                                                                                                                                                                                                                                              |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                | :ref:`_is_initialized<class_XRInterfaceExtension_private_method__is_initialized>`\ (\ ) |virtual| |const|                                                                                                                                                                                                                                                                                                                                                                                              |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                 | :ref:`_post_draw_viewport<class_XRInterfaceExtension_private_method__post_draw_viewport>`\ (\ render_target\: :ref:`RID<class_RID>`, screen_rect\: :ref:`Rect2<class_Rect2>`\ ) |virtual|                                                                                                                                                                                                                                                                                                              |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                | :ref:`_pre_draw_viewport<class_XRInterfaceExtension_private_method__pre_draw_viewport>`\ (\ render_target\: :ref:`RID<class_RID>`\ ) |virtual|                                                                                                                                                                                                                                                                                                                                                         |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                 | :ref:`_pre_render<class_XRInterfaceExtension_private_method__pre_render>`\ (\ ) |virtual|                                                                                                                                                                                                                                                                                                                                                                                                              |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                 | :ref:`_process<class_XRInterfaceExtension_private_method__process>`\ (\ ) |virtual|                                                                                                                                                                                                                                                                                                                                                                                                                    |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                 | :ref:`_set_anchor_detection_is_enabled<class_XRInterfaceExtension_private_method__set_anchor_detection_is_enabled>`\ (\ enabled\: :ref:`bool<class_bool>`\ ) |virtual|                                                                                                                                                                                                                                                                                                                                 |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                | :ref:`_set_play_area_mode<class_XRInterfaceExtension_private_method__set_play_area_mode>`\ (\ mode\: :ref:`PlayAreaMode<enum_XRInterface_PlayAreaMode>`\ ) |virtual| |const|                                                                                                                                                                                                                                                                                                                           |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`bool<class_bool>`                                | :ref:`_supports_play_area_mode<class_XRInterfaceExtension_private_method__supports_play_area_mode>`\ (\ mode\: :ref:`PlayAreaMode<enum_XRInterface_PlayAreaMode>`\ ) |virtual| |const|                                                                                                                                                                                                                                                                                                                 |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                 | :ref:`_trigger_haptic_pulse<class_XRInterfaceExtension_private_method__trigger_haptic_pulse>`\ (\ action_name\: :ref:`String<class_String>`, tracker_name\: :ref:`StringName<class_StringName>`, frequency\: :ref:`float<class_float>`, amplitude\: :ref:`float<class_float>`, duration_sec\: :ref:`float<class_float>`, delay_sec\: :ref:`float<class_float>`\ ) |virtual|                                                                                                                            |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                 | :ref:`_uninitialize<class_XRInterfaceExtension_private_method__uninitialize>`\ (\ ) |virtual|                                                                                                                                                                                                                                                                                                                                                                                                          |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | |void|                                                 | :ref:`add_blit<class_XRInterfaceExtension_method_add_blit>`\ (\ render_target\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, dst_rect\: :ref:`Rect2i<class_Rect2i>`, use_layer\: :ref:`bool<class_bool>`, layer\: :ref:`int<class_int>`, apply_lens_distortion\: :ref:`bool<class_bool>`, eye_center\: :ref:`Vector2<class_Vector2>`, k1\: :ref:`float<class_float>`, k2\: :ref:`float<class_float>`, upscale\: :ref:`float<class_float>`, aspect_ratio\: :ref:`float<class_float>`\ ) |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`RID<class_RID>`                                  | :ref:`get_color_texture<class_XRInterfaceExtension_method_get_color_texture>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                    |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`RID<class_RID>`                                  | :ref:`get_depth_texture<class_XRInterfaceExtension_method_get_depth_texture>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                                    |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`RID<class_RID>`                                  | :ref:`get_render_target_texture<class_XRInterfaceExtension_method_get_render_target_texture>`\ (\ render_target\: :ref:`RID<class_RID>`\ )                                                                                                                                                                                                                                                                                                                                                             |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
   | :ref:`RID<class_RID>`                                  | :ref:`get_velocity_texture<class_XRInterfaceExtension_method_get_velocity_texture>`\ (\ )                                                                                                                                                                                                                                                                                                                                                                                                              |
   +--------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

----

.. rst-class:: classref-descriptions-group

Method Descriptions
-------------------

.. _class_XRInterfaceExtension_private_method__end_frame:

.. rst-class:: classref-method

|void| **_end_frame**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__end_frame>`

Called if interface is active and queues have been submitted.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_anchor_detection_is_enabled:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **_get_anchor_detection_is_enabled**\ (\ ) |virtual| |const| :ref:`🔗<class_XRInterfaceExtension_private_method__get_anchor_detection_is_enabled>`

Return ``true`` if anchor detection is enabled for this interface.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_camera_feed_id:

.. rst-class:: classref-method

:ref:`int<class_int>` **_get_camera_feed_id**\ (\ ) |virtual| |const| :ref:`🔗<class_XRInterfaceExtension_private_method__get_camera_feed_id>`

Returns the camera feed ID for the :ref:`CameraFeed<class_CameraFeed>` registered with the :ref:`CameraServer<class_CameraServer>` that should be presented as the background on an AR capable device (if applicable).

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_camera_transform:

.. rst-class:: classref-method

:ref:`Transform3D<class_Transform3D>` **_get_camera_transform**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__get_camera_transform>`

Returns the :ref:`Transform3D<class_Transform3D>` that positions the :ref:`XRCamera3D<class_XRCamera3D>` in the world.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_capabilities:

.. rst-class:: classref-method

:ref:`int<class_int>` **_get_capabilities**\ (\ ) |virtual| |const| :ref:`🔗<class_XRInterfaceExtension_private_method__get_capabilities>`

Returns the capabilities of this interface.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_color_texture:

.. rst-class:: classref-method

:ref:`RID<class_RID>` **_get_color_texture**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__get_color_texture>`

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

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_depth_texture:

.. rst-class:: classref-method

:ref:`RID<class_RID>` **_get_depth_texture**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__get_depth_texture>`

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

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_name:

.. rst-class:: classref-method

:ref:`StringName<class_StringName>` **_get_name**\ (\ ) |virtual| |const| :ref:`🔗<class_XRInterfaceExtension_private_method__get_name>`

Returns the name of this interface.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_play_area:

.. rst-class:: classref-method

:ref:`PackedVector3Array<class_PackedVector3Array>` **_get_play_area**\ (\ ) |virtual| |const| :ref:`🔗<class_XRInterfaceExtension_private_method__get_play_area>`

Returns a :ref:`PackedVector3Array<class_PackedVector3Array>` that represents the play areas boundaries (if applicable).

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_play_area_mode:

.. rst-class:: classref-method

:ref:`PlayAreaMode<enum_XRInterface_PlayAreaMode>` **_get_play_area_mode**\ (\ ) |virtual| |const| :ref:`🔗<class_XRInterfaceExtension_private_method__get_play_area_mode>`

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

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_projection_for_view:

.. rst-class:: classref-method

:ref:`PackedFloat64Array<class_PackedFloat64Array>` **_get_projection_for_view**\ (\ view\: :ref:`int<class_int>`, aspect\: :ref:`float<class_float>`, z_near\: :ref:`float<class_float>`, z_far\: :ref:`float<class_float>`\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__get_projection_for_view>`

Returns the projection matrix for the given view as a :ref:`PackedFloat64Array<class_PackedFloat64Array>`.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_render_target_size:

.. rst-class:: classref-method

:ref:`Vector2<class_Vector2>` **_get_render_target_size**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__get_render_target_size>`

Returns the size of our render target for this interface, this overrides the size of the :ref:`Viewport<class_Viewport>` marked as the xr viewport.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_suggested_pose_names:

.. rst-class:: classref-method

:ref:`PackedStringArray<class_PackedStringArray>` **_get_suggested_pose_names**\ (\ tracker_name\: :ref:`StringName<class_StringName>`\ ) |virtual| |const| :ref:`🔗<class_XRInterfaceExtension_private_method__get_suggested_pose_names>`

Returns a :ref:`PackedStringArray<class_PackedStringArray>` with pose names configured by this interface. Note that user configuration can override this list.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_suggested_tracker_names:

.. rst-class:: classref-method

:ref:`PackedStringArray<class_PackedStringArray>` **_get_suggested_tracker_names**\ (\ ) |virtual| |const| :ref:`🔗<class_XRInterfaceExtension_private_method__get_suggested_tracker_names>`

Returns a :ref:`PackedStringArray<class_PackedStringArray>` with tracker names configured by this interface. Note that user configuration can override this list.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_system_info:

.. rst-class:: classref-method

:ref:`Dictionary<class_Dictionary>` **_get_system_info**\ (\ ) |virtual| |const| :ref:`🔗<class_XRInterfaceExtension_private_method__get_system_info>`

Returns a :ref:`Dictionary<class_Dictionary>` with system information related to this interface.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_tracking_status:

.. rst-class:: classref-method

:ref:`TrackingStatus<enum_XRInterface_TrackingStatus>` **_get_tracking_status**\ (\ ) |virtual| |const| :ref:`🔗<class_XRInterfaceExtension_private_method__get_tracking_status>`

Returns a :ref:`TrackingStatus<enum_XRInterface_TrackingStatus>` specifying the current status of our tracking.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_transform_for_view:

.. rst-class:: classref-method

:ref:`Transform3D<class_Transform3D>` **_get_transform_for_view**\ (\ view\: :ref:`int<class_int>`, cam_transform\: :ref:`Transform3D<class_Transform3D>`\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__get_transform_for_view>`

Returns a :ref:`Transform3D<class_Transform3D>` for a given view.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_velocity_texture:

.. rst-class:: classref-method

:ref:`RID<class_RID>` **_get_velocity_texture**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__get_velocity_texture>`

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

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_view_count:

.. rst-class:: classref-method

:ref:`int<class_int>` **_get_view_count**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__get_view_count>`

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

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__get_vrs_texture:

.. rst-class:: classref-method

:ref:`RID<class_RID>` **_get_vrs_texture**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__get_vrs_texture>`

.. container:: contribute

	There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__initialize:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **_initialize**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__initialize>`

Initializes the interface, returns ``true`` on success.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__is_initialized:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **_is_initialized**\ (\ ) |virtual| |const| :ref:`🔗<class_XRInterfaceExtension_private_method__is_initialized>`

Returns ``true`` if this interface has been initialized.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__post_draw_viewport:

.. rst-class:: classref-method

|void| **_post_draw_viewport**\ (\ render_target\: :ref:`RID<class_RID>`, screen_rect\: :ref:`Rect2<class_Rect2>`\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__post_draw_viewport>`

Called after the XR :ref:`Viewport<class_Viewport>` draw logic has completed.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__pre_draw_viewport:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **_pre_draw_viewport**\ (\ render_target\: :ref:`RID<class_RID>`\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__pre_draw_viewport>`

Called if this is our primary **XRInterfaceExtension** before we start processing a :ref:`Viewport<class_Viewport>` for every active XR :ref:`Viewport<class_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.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__pre_render:

.. rst-class:: classref-method

|void| **_pre_render**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__pre_render>`

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

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__process:

.. rst-class:: classref-method

|void| **_process**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__process>`

Called if this **XRInterfaceExtension** is active before our physics and game process is called. Most XR interfaces will update its :ref:`XRPositionalTracker<class_XRPositionalTracker>`\ s at this point in time.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__set_anchor_detection_is_enabled:

.. rst-class:: classref-method

|void| **_set_anchor_detection_is_enabled**\ (\ enabled\: :ref:`bool<class_bool>`\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__set_anchor_detection_is_enabled>`

Enables anchor detection on this interface if supported.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__set_play_area_mode:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **_set_play_area_mode**\ (\ mode\: :ref:`PlayAreaMode<enum_XRInterface_PlayAreaMode>`\ ) |virtual| |const| :ref:`🔗<class_XRInterfaceExtension_private_method__set_play_area_mode>`

Set the play area mode for this interface.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__supports_play_area_mode:

.. rst-class:: classref-method

:ref:`bool<class_bool>` **_supports_play_area_mode**\ (\ mode\: :ref:`PlayAreaMode<enum_XRInterface_PlayAreaMode>`\ ) |virtual| |const| :ref:`🔗<class_XRInterfaceExtension_private_method__supports_play_area_mode>`

Returns ``true`` if this interface supports this play area mode.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__trigger_haptic_pulse:

.. rst-class:: classref-method

|void| **_trigger_haptic_pulse**\ (\ action_name\: :ref:`String<class_String>`, tracker_name\: :ref:`StringName<class_StringName>`, frequency\: :ref:`float<class_float>`, amplitude\: :ref:`float<class_float>`, duration_sec\: :ref:`float<class_float>`, delay_sec\: :ref:`float<class_float>`\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__trigger_haptic_pulse>`

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

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_private_method__uninitialize:

.. rst-class:: classref-method

|void| **_uninitialize**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__uninitialize>`

Uninitialize the interface.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_method_add_blit:

.. rst-class:: classref-method

|void| **add_blit**\ (\ render_target\: :ref:`RID<class_RID>`, src_rect\: :ref:`Rect2<class_Rect2>`, dst_rect\: :ref:`Rect2i<class_Rect2i>`, use_layer\: :ref:`bool<class_bool>`, layer\: :ref:`int<class_int>`, apply_lens_distortion\: :ref:`bool<class_bool>`, eye_center\: :ref:`Vector2<class_Vector2>`, k1\: :ref:`float<class_float>`, k2\: :ref:`float<class_float>`, upscale\: :ref:`float<class_float>`, aspect_ratio\: :ref:`float<class_float>`\ ) :ref:`🔗<class_XRInterfaceExtension_method_add_blit>`

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

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_method_get_color_texture:

.. rst-class:: classref-method

:ref:`RID<class_RID>` **get_color_texture**\ (\ ) :ref:`🔗<class_XRInterfaceExtension_method_get_color_texture>`

.. container:: contribute

	There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_method_get_depth_texture:

.. rst-class:: classref-method

:ref:`RID<class_RID>` **get_depth_texture**\ (\ ) :ref:`🔗<class_XRInterfaceExtension_method_get_depth_texture>`

.. container:: contribute

	There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_method_get_render_target_texture:

.. rst-class:: classref-method

:ref:`RID<class_RID>` **get_render_target_texture**\ (\ render_target\: :ref:`RID<class_RID>`\ ) :ref:`🔗<class_XRInterfaceExtension_method_get_render_target_texture>`

Returns a valid :ref:`RID<class_RID>` for a texture to which we should render the current frame if supported by the interface.

.. rst-class:: classref-item-separator

----

.. _class_XRInterfaceExtension_method_get_velocity_texture:

.. rst-class:: classref-method

:ref:`RID<class_RID>` **get_velocity_texture**\ (\ ) :ref:`🔗<class_XRInterfaceExtension_method_get_velocity_texture>`

.. container:: contribute

	There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
.. |void| replace:: :abbr:`void (No return value.)`