classref: Sync with current master branch (bbac8198f)

This commit is contained in:
Rémi Verschelde
2022-10-08 13:57:16 +02:00
parent 8a540a9b36
commit b69855897a
122 changed files with 5387 additions and 2909 deletions

View File

@@ -33,6 +33,10 @@ Methods
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`_get_capabilities<class_XRInterfaceExtension_method__get_capabilities>` **(** **)** |virtual| |const| |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`_get_color_texture<class_XRInterfaceExtension_method__get_color_texture>` **(** **)** |virtual| |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`_get_depth_texture<class_XRInterfaceExtension_method__get_depth_texture>` **(** **)** |virtual| |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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| |
@@ -51,6 +55,8 @@ Methods
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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:`RID<class_RID>` | :ref:`_get_velocity_texture<class_XRInterfaceExtension_method__get_velocity_texture>` **(** **)** |virtual| |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`_get_view_count<class_XRInterfaceExtension_method__get_view_count>` **(** **)** |virtual| |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`_get_vrs_texture<class_XRInterfaceExtension_method__get_vrs_texture>` **(** **)** |virtual| |
@@ -81,8 +87,14 @@ Methods
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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_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>` **(** :ref:`RID<class_RID>` render_target **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`RID<class_RID>` | :ref:`get_velocity_texture<class_XRInterfaceExtension_method_get_velocity_texture>` **(** **)** |
+-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Method Descriptions
-------------------
@@ -127,6 +139,22 @@ Returns the capabilities of this interface.
----
.. _class_XRInterfaceExtension_method__get_color_texture:
- :ref:`RID<class_RID>` **_get_color_texture** **(** **)** |virtual|
Return color texture into which to render (if applicable).
----
.. _class_XRInterfaceExtension_method__get_depth_texture:
- :ref:`RID<class_RID>` **_get_depth_texture** **(** **)** |virtual|
Return depth texture into which to render (if applicable).
----
.. _class_XRInterfaceExtension_method__get_name:
- :ref:`StringName<class_StringName>` **_get_name** **(** **)** |virtual| |const|
@@ -199,6 +227,14 @@ Returns a :ref:`Transform3D<class_Transform3D>` for a given view.
----
.. _class_XRInterfaceExtension_method__get_velocity_texture:
- :ref:`RID<class_RID>` **_get_velocity_texture** **(** **)** |virtual|
Return velocity texture into which to render (if applicable).
----
.. _class_XRInterfaceExtension_method__get_view_count:
- :ref:`int<class_int>` **_get_view_count** **(** **)** |virtual|
@@ -317,12 +353,30 @@ Blits our render results to screen optionally applying lens distortion. This can
----
.. _class_XRInterfaceExtension_method_get_color_texture:
- :ref:`RID<class_RID>` **get_color_texture** **(** **)**
----
.. _class_XRInterfaceExtension_method_get_depth_texture:
- :ref:`RID<class_RID>` **get_depth_texture** **(** **)**
----
.. _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.
----
.. _class_XRInterfaceExtension_method_get_velocity_texture:
- :ref:`RID<class_RID>` **get_velocity_texture** **(** **)**
.. |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.)`