mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2025-12-31 09:49:22 +03:00
576 lines
58 KiB
ReStructuredText
576 lines
58 KiB
ReStructuredText
:github_url: hide
|
||
|
||
.. _class_XRInterfaceExtension:
|
||
|
||
XRInterfaceExtension
|
||
====================
|
||
|
||
**继承:** :ref:`XRInterface<class_XRInterface>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
||
|
||
XR 接口扩展(插件)的基类。
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
描述
|
||
----
|
||
|
||
外部 XR 接口插件应继承自这个类。
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
教程
|
||
----
|
||
|
||
- :doc:`XR 文档索引 <../tutorials/xr/index>`
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
方法
|
||
----
|
||
|
||
.. 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:`VRSTextureFormat<enum_XRInterface_VRSTextureFormat>` | :ref:`_get_vrs_texture_format<class_XRInterfaceExtension_private_method__get_vrs_texture_format>`\ (\ ) |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
|
||
|
||
方法说明
|
||
--------
|
||
|
||
.. _class_XRInterfaceExtension_private_method__end_frame:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **_end_frame**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__end_frame>`
|
||
|
||
如果该接口处于活动状态,并且已提交队列,则调用此方法。
|
||
|
||
.. 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>`
|
||
|
||
如果此接口启用了锚点检测,则返回 ``true``\ 。
|
||
|
||
.. 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>`
|
||
|
||
返回在 :ref:`CameraServer<class_CameraServer>` 上注册的 :ref:`CameraFeed<class_CameraFeed>` 的相机源 ID,该 ID 应在支持 AR 的设备(如果适用)上显示为背景。
|
||
|
||
.. 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>`
|
||
|
||
返回将 :ref:`XRCamera3D<class_XRCamera3D>` 放置在世界中的 :ref:`Transform3D<class_Transform3D>`\ 。
|
||
|
||
.. 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>`
|
||
|
||
返回该接口的功能。
|
||
|
||
.. 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>`
|
||
|
||
返回接受渲染结果的颜色纹理(如果适用)。
|
||
|
||
.. 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>`
|
||
|
||
返回接受渲染结果的深度纹理(如果适用)。
|
||
|
||
.. 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>`
|
||
|
||
返回该接口的名称。
|
||
|
||
.. 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>`
|
||
|
||
返回表示游戏区域边界的 :ref:`PackedVector3Array<class_PackedVector3Array>`\ (如果适用)。
|
||
|
||
.. 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>`
|
||
|
||
返回设置游戏区域的模式。
|
||
|
||
.. 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>`
|
||
|
||
返回给定试图的投影矩阵,形式为 :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>`
|
||
|
||
返回我们在这个接口上的渲染目标大小,覆盖标记为 XR 视口的 :ref:`Viewport<class_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>`
|
||
|
||
返回一个 :ref:`PackedStringArray<class_PackedStringArray>`\ ,其中包含由此接口配置的姿势名称。请注意,用户的配置可以覆盖此列表。
|
||
|
||
.. 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>`
|
||
|
||
返回一个 :ref:`PackedStringArray<class_PackedStringArray>`\ ,其中包含由此接口配置的追踪器名称。请注意,用户的配置可以覆盖此列表。
|
||
|
||
.. 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>`
|
||
|
||
返回包含与这个接口相关的系统信息的 :ref:`Dictionary<class_Dictionary>`\ 。
|
||
|
||
.. 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 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>`
|
||
|
||
返回给定视图的 :ref:`Transform3D<class_Transform3D>`\ 。
|
||
|
||
.. 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>`
|
||
|
||
返回作为渲染目标的速度纹理(如果适用)。
|
||
|
||
.. 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>`
|
||
|
||
返回此接口所需的视图数量,1 代表单目平面视图,2 代表双目立体视图。
|
||
|
||
.. 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 `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_XRInterfaceExtension_private_method__get_vrs_texture_format:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`VRSTextureFormat<enum_XRInterface_VRSTextureFormat>` **_get_vrs_texture_format**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__get_vrs_texture_format>`
|
||
|
||
返回 :ref:`_get_vrs_texture()<class_XRInterfaceExtension_private_method__get_vrs_texture>` 所返回纹理的格式。
|
||
|
||
.. 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>`
|
||
|
||
初始化该接口,成功时返回 ``true``\ 。
|
||
|
||
.. 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>`
|
||
|
||
如果这个接口已初始化,则返回 ``true``\ 。
|
||
|
||
.. 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>`
|
||
|
||
在 XR :ref:`Viewport<class_Viewport>` 绘制逻辑完成后调用。
|
||
|
||
.. 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>`
|
||
|
||
如果这是我们的主要 **XRInterfaceExtension**\ ,则在我们开始为每个活动的 XR :ref:`Viewport<class_Viewport>` 处理 :ref:`Viewport<class_Viewport>` 之前调用,如果该视口应该被渲染,则返回 ``true``\ 。如果用户摘下头戴式设备,XR 接口可能会返回 ``false``\ ,我们可以暂停渲染。
|
||
|
||
.. 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>`
|
||
|
||
如果这个 **XRInterfaceExtension** 在渲染开始前处于激活状态,则会调用这个函数,大多数 XR 接口都会在此时进行追踪同步。
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_XRInterfaceExtension_private_method__process:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **_process**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__process>`
|
||
|
||
如果这个 **XRInterfaceExtension** 在调用我们的物理和游戏处理前处于激活状态,则会调用这个函数。大多数 XR 接口都会在此时更新其 :ref:`XRPositionalTracker<class_XRPositionalTracker>`\ 。
|
||
|
||
.. 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>`
|
||
|
||
如果支持,则在此接口上启用锚点检测。
|
||
|
||
.. 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>`
|
||
|
||
设置该接口的游玩区域模式。
|
||
|
||
.. 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>`
|
||
|
||
如果该接口支持该游玩区域模式,则返回 ``true``\ 。
|
||
|
||
.. 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>`
|
||
|
||
在指定的追踪器上触发一次触觉脉冲。
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_XRInterfaceExtension_private_method__uninitialize:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **_uninitialize**\ (\ ) |virtual| :ref:`🔗<class_XRInterfaceExtension_private_method__uninitialize>`
|
||
|
||
将该接口取消初始化。
|
||
|
||
.. 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>`
|
||
|
||
将我们的渲染结果传输到屏幕上,还可以在此过程中应用镜头失真。只能在处理 ``_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 `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
|
||
|
||
.. 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 `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
|
||
|
||
.. 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>`
|
||
|
||
如果接口支持,则返回一个纹理的有效 :ref:`RID<class_RID>`\ ,我们应更将当前帧渲染至该纹理。
|
||
|
||
.. 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 `contributing one <https://contributing.godotengine.org/en/latest/documentation/class_reference.html>`__!
|
||
|
||
.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)`
|
||
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
||
.. |const| replace:: :abbr:`const (本方法无副作用,不会修改该实例的任何成员变量。)`
|
||
.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外,还能够继续接受任意数量的参数。)`
|
||
.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)`
|
||
.. |static| replace:: :abbr:`static (调用本方法无需实例,可直接使用类名进行调用。)`
|
||
.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)`
|
||
.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)`
|
||
.. |void| replace:: :abbr:`void (无返回值。)`
|