| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the XRInterfaceExtension.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_XRInterfaceExtension:
- XRInterfaceExtension
- ====================
- **Inherits:** :ref:`XRInterface<class_XRInterface>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
- Base class for XR interface extensions (plugins).
- Description
- -----------
- External XR interface plugins should inherit from this class.
- Methods
- -------
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`_end_frame<class_XRInterfaceExtension_method__end_frame>` **(** **)** |virtual| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`_get_anchor_detection_is_enabled<class_XRInterfaceExtension_method__get_anchor_detection_is_enabled>` **(** **)** |virtual| |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`_get_camera_feed_id<class_XRInterfaceExtension_method__get_camera_feed_id>` **(** **)** |virtual| |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Transform3D<class_Transform3D>` | :ref:`_get_camera_transform<class_XRInterfaceExtension_method__get_camera_transform>` **(** **)** |virtual| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`_get_capabilities<class_XRInterfaceExtension_method__get_capabilities>` **(** **)** |virtual| |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`StringName<class_StringName>` | :ref:`_get_name<class_XRInterfaceExtension_method__get_name>` **(** **)** |virtual| |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PackedVector3Array<class_PackedVector3Array>` | :ref:`_get_play_area<class_XRInterfaceExtension_method__get_play_area>` **(** **)** |virtual| |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`_get_play_area_mode<class_XRInterfaceExtension_method__get_play_area_mode>` **(** **)** |virtual| |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PackedFloat64Array<class_PackedFloat64Array>` | :ref:`_get_projection_for_view<class_XRInterfaceExtension_method__get_projection_for_view>` **(** :ref:`int<class_int>` view, :ref:`float<class_float>` aspect, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |virtual| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Vector2<class_Vector2>` | :ref:`_get_render_target_size<class_XRInterfaceExtension_method__get_render_target_size>` **(** **)** |virtual| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`_get_suggested_pose_names<class_XRInterfaceExtension_method__get_suggested_pose_names>` **(** :ref:`StringName<class_StringName>` tracker_name **)** |virtual| |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`_get_suggested_tracker_names<class_XRInterfaceExtension_method__get_suggested_tracker_names>` **(** **)** |virtual| |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`_get_tracking_status<class_XRInterfaceExtension_method__get_tracking_status>` **(** **)** |virtual| |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Transform3D<class_Transform3D>` | :ref:`_get_transform_for_view<class_XRInterfaceExtension_method__get_transform_for_view>` **(** :ref:`int<class_int>` view, :ref:`Transform3D<class_Transform3D>` cam_transform **)** |virtual| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`_get_view_count<class_XRInterfaceExtension_method__get_view_count>` **(** **)** |virtual| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`_initialize<class_XRInterfaceExtension_method__initialize>` **(** **)** |virtual| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`_is_initialized<class_XRInterfaceExtension_method__is_initialized>` **(** **)** |virtual| |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`_notification<class_XRInterfaceExtension_method__notification>` **(** :ref:`int<class_int>` what **)** |virtual| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`_post_draw_viewport<class_XRInterfaceExtension_method__post_draw_viewport>` **(** :ref:`RID<class_RID>` render_target, :ref:`Rect2<class_Rect2>` screen_rect **)** |virtual| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`_pre_draw_viewport<class_XRInterfaceExtension_method__pre_draw_viewport>` **(** :ref:`RID<class_RID>` render_target **)** |virtual| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`_pre_render<class_XRInterfaceExtension_method__pre_render>` **(** **)** |virtual| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`_process<class_XRInterfaceExtension_method__process>` **(** **)** |virtual| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`_set_anchor_detection_is_enabled<class_XRInterfaceExtension_method__set_anchor_detection_is_enabled>` **(** :ref:`bool<class_bool>` enabled **)** |virtual| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`_set_play_area_mode<class_XRInterfaceExtension_method__set_play_area_mode>` **(** :ref:`int<class_int>` mode **)** |virtual| |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`_supports_play_area_mode<class_XRInterfaceExtension_method__supports_play_area_mode>` **(** :ref:`PlayAreaMode<enum_XRInterface_PlayAreaMode>` mode **)** |virtual| |const| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`_trigger_haptic_pulse<class_XRInterfaceExtension_method__trigger_haptic_pulse>` **(** :ref:`String<class_String>` action_name, :ref:`StringName<class_StringName>` tracker_name, :ref:`float<class_float>` frequency, :ref:`float<class_float>` amplitude, :ref:`float<class_float>` duration_sec, :ref:`float<class_float>` delay_sec **)** |virtual| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`_uninitialize<class_XRInterfaceExtension_method__uninitialize>` **(** **)** |virtual| |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_blit<class_XRInterfaceExtension_method_add_blit>` **(** :ref:`RID<class_RID>` render_target, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Rect2i<class_Rect2i>` dst_rect, :ref:`bool<class_bool>` use_layer, :ref:`int<class_int>` layer, :ref:`bool<class_bool>` apply_lens_distortion, :ref:`Vector2<class_Vector2>` eye_center, :ref:`float<class_float>` k1, :ref:`float<class_float>` k2, :ref:`float<class_float>` upscale, :ref:`float<class_float>` aspect_ratio **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`RID<class_RID>` | :ref:`get_render_target_texture<class_XRInterfaceExtension_method_get_render_target_texture>` **(** :ref:`RID<class_RID>` render_target **)** |
- +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Method Descriptions
- -------------------
- .. _class_XRInterfaceExtension_method__end_frame:
- - void **_end_frame** **(** **)** |virtual|
- Called if interface is active and queues have been submitted.
- ----
- .. _class_XRInterfaceExtension_method__get_anchor_detection_is_enabled:
- - :ref:`bool<class_bool>` **_get_anchor_detection_is_enabled** **(** **)** |virtual| |const|
- Return ``true`` if anchor detection is enabled for this interface.
- ----
- .. _class_XRInterfaceExtension_method__get_camera_feed_id:
- - :ref:`int<class_int>` **_get_camera_feed_id** **(** **)** |virtual| |const|
- 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).
- ----
- .. _class_XRInterfaceExtension_method__get_camera_transform:
- - :ref:`Transform3D<class_Transform3D>` **_get_camera_transform** **(** **)** |virtual|
- Returns the :ref:`Transform3D<class_Transform3D>` that positions the :ref:`XRCamera3D<class_XRCamera3D>` in the world.
- ----
- .. _class_XRInterfaceExtension_method__get_capabilities:
- - :ref:`int<class_int>` **_get_capabilities** **(** **)** |virtual| |const|
- Returns the capabilities of this interface.
- ----
- .. _class_XRInterfaceExtension_method__get_name:
- - :ref:`StringName<class_StringName>` **_get_name** **(** **)** |virtual| |const|
- Returns the name of this interface.
- ----
- .. _class_XRInterfaceExtension_method__get_play_area:
- - :ref:`PackedVector3Array<class_PackedVector3Array>` **_get_play_area** **(** **)** |virtual| |const|
- Returns an :ref:`PackedVector3Array<class_PackedVector3Array>` that denotes the play areas boundaries (if applicable).
- ----
- .. _class_XRInterfaceExtension_method__get_play_area_mode:
- - :ref:`int<class_int>` **_get_play_area_mode** **(** **)** |virtual| |const|
- Returns the :ref:`PlayAreaMode<enum_XRInterface_PlayAreaMode>` that sets up our play area.
- ----
- .. _class_XRInterfaceExtension_method__get_projection_for_view:
- - :ref:`PackedFloat64Array<class_PackedFloat64Array>` **_get_projection_for_view** **(** :ref:`int<class_int>` view, :ref:`float<class_float>` aspect, :ref:`float<class_float>` z_near, :ref:`float<class_float>` z_far **)** |virtual|
- Returns the projection matrix for the given view as a :ref:`PackedFloat64Array<class_PackedFloat64Array>`.
- ----
- .. _class_XRInterfaceExtension_method__get_render_target_size:
- - :ref:`Vector2<class_Vector2>` **_get_render_target_size** **(** **)** |virtual|
- 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.
- ----
- .. _class_XRInterfaceExtension_method__get_suggested_pose_names:
- - :ref:`PackedStringArray<class_PackedStringArray>` **_get_suggested_pose_names** **(** :ref:`StringName<class_StringName>` tracker_name **)** |virtual| |const|
- Returns a :ref:`PackedStringArray<class_PackedStringArray>` with pose names configured by this interface. Note that user configuration can override this list.
- ----
- .. _class_XRInterfaceExtension_method__get_suggested_tracker_names:
- - :ref:`PackedStringArray<class_PackedStringArray>` **_get_suggested_tracker_names** **(** **)** |virtual| |const|
- Returns a :ref:`PackedStringArray<class_PackedStringArray>` with tracker names configured by this interface. Note that user configuration can override this list.
- ----
- .. _class_XRInterfaceExtension_method__get_tracking_status:
- - :ref:`int<class_int>` **_get_tracking_status** **(** **)** |virtual| |const|
- Returns a :ref:`TrackingStatus<enum_XRInterface_TrackingStatus>` specifying the current status of our tracking.
- ----
- .. _class_XRInterfaceExtension_method__get_transform_for_view:
- - :ref:`Transform3D<class_Transform3D>` **_get_transform_for_view** **(** :ref:`int<class_int>` view, :ref:`Transform3D<class_Transform3D>` cam_transform **)** |virtual|
- Returns a :ref:`Transform3D<class_Transform3D>` for a given view.
- ----
- .. _class_XRInterfaceExtension_method__get_view_count:
- - :ref:`int<class_int>` **_get_view_count** **(** **)** |virtual|
- Returns the number of views this interface requires, 1 for mono, 2 for stereoscopic.
- ----
- .. _class_XRInterfaceExtension_method__initialize:
- - :ref:`bool<class_bool>` **_initialize** **(** **)** |virtual|
- Initializes the interface, returns ``true`` on success.
- ----
- .. _class_XRInterfaceExtension_method__is_initialized:
- - :ref:`bool<class_bool>` **_is_initialized** **(** **)** |virtual| |const|
- Returns ``true`` if this interface has been initialised.
- ----
- .. _class_XRInterfaceExtension_method__notification:
- - void **_notification** **(** :ref:`int<class_int>` what **)** |virtual|
- Informs the interface of an applicable system notification.
- ----
- .. _class_XRInterfaceExtension_method__post_draw_viewport:
- - void **_post_draw_viewport** **(** :ref:`RID<class_RID>` render_target, :ref:`Rect2<class_Rect2>` screen_rect **)** |virtual|
- Called after the XR :ref:`Viewport<class_Viewport>` draw logic has completed.
- ----
- .. _class_XRInterfaceExtension_method__pre_draw_viewport:
- - :ref:`bool<class_bool>` **_pre_draw_viewport** **(** :ref:`RID<class_RID>` render_target **)** |virtual|
- 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.
- ----
- .. _class_XRInterfaceExtension_method__pre_render:
- - void **_pre_render** **(** **)** |virtual|
- Called if this ``XRInterfaceExtension`` is active before rendering starts, most XR interfaces will sync tracking at this point in time.
- ----
- .. _class_XRInterfaceExtension_method__process:
- - void **_process** **(** **)** |virtual|
- 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.
- ----
- .. _class_XRInterfaceExtension_method__set_anchor_detection_is_enabled:
- - void **_set_anchor_detection_is_enabled** **(** :ref:`bool<class_bool>` enabled **)** |virtual|
- Enables anchor detection on this interface if supported.
- ----
- .. _class_XRInterfaceExtension_method__set_play_area_mode:
- - :ref:`bool<class_bool>` **_set_play_area_mode** **(** :ref:`int<class_int>` mode **)** |virtual| |const|
- Set the play area mode for this interface.
- ----
- .. _class_XRInterfaceExtension_method__supports_play_area_mode:
- - :ref:`bool<class_bool>` **_supports_play_area_mode** **(** :ref:`PlayAreaMode<enum_XRInterface_PlayAreaMode>` mode **)** |virtual| |const|
- Returns ``true`` if this interface supports this play area mode.
- ----
- .. _class_XRInterfaceExtension_method__trigger_haptic_pulse:
- - void **_trigger_haptic_pulse** **(** :ref:`String<class_String>` action_name, :ref:`StringName<class_StringName>` tracker_name, :ref:`float<class_float>` frequency, :ref:`float<class_float>` amplitude, :ref:`float<class_float>` duration_sec, :ref:`float<class_float>` delay_sec **)** |virtual|
- Triggers a haptic pulse to be emitted on the specified tracker.
- ----
- .. _class_XRInterfaceExtension_method__uninitialize:
- - void **_uninitialize** **(** **)** |virtual|
- Uninitialize the interface.
- ----
- .. _class_XRInterfaceExtension_method_add_blit:
- - void **add_blit** **(** :ref:`RID<class_RID>` render_target, :ref:`Rect2<class_Rect2>` src_rect, :ref:`Rect2i<class_Rect2i>` dst_rect, :ref:`bool<class_bool>` use_layer, :ref:`int<class_int>` layer, :ref:`bool<class_bool>` apply_lens_distortion, :ref:`Vector2<class_Vector2>` eye_center, :ref:`float<class_float>` k1, :ref:`float<class_float>` k2, :ref:`float<class_float>` upscale, :ref:`float<class_float>` aspect_ratio **)**
- Blits our render results to screen optionally applying lens distortion. This can only be called while processing ``_commit_views``.
- ----
- .. _class_XRInterfaceExtension_method_get_render_target_texture:
- - :ref:`RID<class_RID>` **get_render_target_texture** **(** :ref:`RID<class_RID>` render_target **)**
- Returns a valid :ref:`RID<class_RID>` for a texture to which we should render the current frame if supported by the interface.
- .. |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.)`
|
