:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/XRInterfaceExtension.xml. .. _class_XRInterfaceExtension: XRInterfaceExtension ==================== **Inherits:** :ref:`XRInterface` **<** :ref:`RefCounted` **<** :ref:`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`\ (\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_get_anchor_detection_is_enabled`\ (\ ) |virtual| |const| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_camera_feed_id`\ (\ ) |virtual| |const| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`_get_camera_transform`\ (\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_capabilities`\ (\ ) |virtual| |const| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`_get_color_texture`\ (\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`_get_depth_texture`\ (\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`_get_name`\ (\ ) |virtual| |const| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedVector3Array` | :ref:`_get_play_area`\ (\ ) |virtual| |const| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PlayAreaMode` | :ref:`_get_play_area_mode`\ (\ ) |virtual| |const| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedFloat64Array` | :ref:`_get_projection_for_view`\ (\ view\: :ref:`int`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Vector2` | :ref:`_get_render_target_size`\ (\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`_get_suggested_pose_names`\ (\ tracker_name\: :ref:`StringName`\ ) |virtual| |const| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`_get_suggested_tracker_names`\ (\ ) |virtual| |const| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Dictionary` | :ref:`_get_system_info`\ (\ ) |virtual| |const| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TrackingStatus` | :ref:`_get_tracking_status`\ (\ ) |virtual| |const| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Transform3D` | :ref:`_get_transform_for_view`\ (\ view\: :ref:`int`, cam_transform\: :ref:`Transform3D`\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`_get_velocity_texture`\ (\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_view_count`\ (\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`_get_vrs_texture`\ (\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`VRSTextureFormat` | :ref:`_get_vrs_texture_format`\ (\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_initialize`\ (\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_is_initialized`\ (\ ) |virtual| |const| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_post_draw_viewport`\ (\ render_target\: :ref:`RID`, screen_rect\: :ref:`Rect2`\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_pre_draw_viewport`\ (\ render_target\: :ref:`RID`\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_pre_render`\ (\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_process`\ (\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_set_anchor_detection_is_enabled`\ (\ enabled\: :ref:`bool`\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_set_play_area_mode`\ (\ mode\: :ref:`PlayAreaMode`\ ) |virtual| |const| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`_supports_play_area_mode`\ (\ mode\: :ref:`PlayAreaMode`\ ) |virtual| |const| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_trigger_haptic_pulse`\ (\ action_name\: :ref:`String`, tracker_name\: :ref:`StringName`, frequency\: :ref:`float`, amplitude\: :ref:`float`, duration_sec\: :ref:`float`, delay_sec\: :ref:`float`\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_uninitialize`\ (\ ) |virtual| | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_blit`\ (\ render_target\: :ref:`RID`, src_rect\: :ref:`Rect2`, dst_rect\: :ref:`Rect2i`, use_layer\: :ref:`bool`, layer\: :ref:`int`, apply_lens_distortion\: :ref:`bool`, eye_center\: :ref:`Vector2`, k1\: :ref:`float`, k2\: :ref:`float`, upscale\: :ref:`float`, aspect_ratio\: :ref:`float`\ ) | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_color_texture`\ (\ ) | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_depth_texture`\ (\ ) | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`get_render_target_texture`\ (\ render_target\: :ref:`RID`\ ) | +------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`RID` | :ref:`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:`🔗` 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` **_get_anchor_detection_is_enabled**\ (\ ) |virtual| |const| :ref:`🔗` 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` **_get_camera_feed_id**\ (\ ) |virtual| |const| :ref:`🔗` Returns the camera feed ID for the :ref:`CameraFeed` registered with the :ref:`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` **_get_camera_transform**\ (\ ) |virtual| :ref:`🔗` Returns the :ref:`Transform3D` that positions the :ref:`XRCamera3D` in the world. .. rst-class:: classref-item-separator ---- .. _class_XRInterfaceExtension_private_method__get_capabilities: .. rst-class:: classref-method :ref:`int` **_get_capabilities**\ (\ ) |virtual| |const| :ref:`🔗` Returns the capabilities of this interface. .. rst-class:: classref-item-separator ---- .. _class_XRInterfaceExtension_private_method__get_color_texture: .. rst-class:: classref-method :ref:`RID` **_get_color_texture**\ (\ ) |virtual| :ref:`🔗` 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` **_get_depth_texture**\ (\ ) |virtual| :ref:`🔗` 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` **_get_name**\ (\ ) |virtual| |const| :ref:`🔗` Returns the name of this interface. .. rst-class:: classref-item-separator ---- .. _class_XRInterfaceExtension_private_method__get_play_area: .. rst-class:: classref-method :ref:`PackedVector3Array` **_get_play_area**\ (\ ) |virtual| |const| :ref:`🔗` Returns a :ref:`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` **_get_play_area_mode**\ (\ ) |virtual| |const| :ref:`🔗` 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` **_get_projection_for_view**\ (\ view\: :ref:`int`, aspect\: :ref:`float`, z_near\: :ref:`float`, z_far\: :ref:`float`\ ) |virtual| :ref:`🔗` Returns the projection matrix for the given view as a :ref:`PackedFloat64Array`. .. rst-class:: classref-item-separator ---- .. _class_XRInterfaceExtension_private_method__get_render_target_size: .. rst-class:: classref-method :ref:`Vector2` **_get_render_target_size**\ (\ ) |virtual| :ref:`🔗` Returns the size of our render target for this interface, this overrides the size of the :ref:`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` **_get_suggested_pose_names**\ (\ tracker_name\: :ref:`StringName`\ ) |virtual| |const| :ref:`🔗` Returns a :ref:`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` **_get_suggested_tracker_names**\ (\ ) |virtual| |const| :ref:`🔗` Returns a :ref:`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` **_get_system_info**\ (\ ) |virtual| |const| :ref:`🔗` Returns a :ref:`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` **_get_tracking_status**\ (\ ) |virtual| |const| :ref:`🔗` Returns an :ref:`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` **_get_transform_for_view**\ (\ view\: :ref:`int`, cam_transform\: :ref:`Transform3D`\ ) |virtual| :ref:`🔗` Returns a :ref:`Transform3D` for a given view. .. rst-class:: classref-item-separator ---- .. _class_XRInterfaceExtension_private_method__get_velocity_texture: .. rst-class:: classref-method :ref:`RID` **_get_velocity_texture**\ (\ ) |virtual| :ref:`🔗` 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` **_get_view_count**\ (\ ) |virtual| :ref:`🔗` 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` **_get_vrs_texture**\ (\ ) |virtual| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterfaceExtension_private_method__get_vrs_texture_format: .. rst-class:: classref-method :ref:`VRSTextureFormat` **_get_vrs_texture_format**\ (\ ) |virtual| :ref:`🔗` Returns the format of the texture returned by :ref:`_get_vrs_texture()`. .. rst-class:: classref-item-separator ---- .. _class_XRInterfaceExtension_private_method__initialize: .. rst-class:: classref-method :ref:`bool` **_initialize**\ (\ ) |virtual| :ref:`🔗` Initializes the interface, returns ``true`` on success. .. rst-class:: classref-item-separator ---- .. _class_XRInterfaceExtension_private_method__is_initialized: .. rst-class:: classref-method :ref:`bool` **_is_initialized**\ (\ ) |virtual| |const| :ref:`🔗` 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`, screen_rect\: :ref:`Rect2`\ ) |virtual| :ref:`🔗` Called after the XR :ref:`Viewport` draw logic has completed. .. rst-class:: classref-item-separator ---- .. _class_XRInterfaceExtension_private_method__pre_draw_viewport: .. rst-class:: classref-method :ref:`bool` **_pre_draw_viewport**\ (\ render_target\: :ref:`RID`\ ) |virtual| :ref:`🔗` Called if this is our primary **XRInterfaceExtension** before we start processing a :ref:`Viewport` for every active XR :ref:`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:`🔗` 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:`🔗` Called if this **XRInterfaceExtension** is active before our physics and game process is called. Most XR interfaces will update its :ref:`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`\ ) |virtual| :ref:`🔗` 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` **_set_play_area_mode**\ (\ mode\: :ref:`PlayAreaMode`\ ) |virtual| |const| :ref:`🔗` 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` **_supports_play_area_mode**\ (\ mode\: :ref:`PlayAreaMode`\ ) |virtual| |const| :ref:`🔗` 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`, tracker_name\: :ref:`StringName`, frequency\: :ref:`float`, amplitude\: :ref:`float`, duration_sec\: :ref:`float`, delay_sec\: :ref:`float`\ ) |virtual| :ref:`🔗` 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:`🔗` Uninitialize the interface. .. rst-class:: classref-item-separator ---- .. _class_XRInterfaceExtension_method_add_blit: .. rst-class:: classref-method |void| **add_blit**\ (\ render_target\: :ref:`RID`, src_rect\: :ref:`Rect2`, dst_rect\: :ref:`Rect2i`, use_layer\: :ref:`bool`, layer\: :ref:`int`, apply_lens_distortion\: :ref:`bool`, eye_center\: :ref:`Vector2`, k1\: :ref:`float`, k2\: :ref:`float`, upscale\: :ref:`float`, aspect_ratio\: :ref:`float`\ ) :ref:`🔗` 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` **get_color_texture**\ (\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterfaceExtension_method_get_depth_texture: .. rst-class:: classref-method :ref:`RID` **get_depth_texture**\ (\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_XRInterfaceExtension_method_get_render_target_texture: .. rst-class:: classref-method :ref:`RID` **get_render_target_texture**\ (\ render_target\: :ref:`RID`\ ) :ref:`🔗` Returns a valid :ref:`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` **get_velocity_texture**\ (\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)`