godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with current master branch (215acd5)

Browse Source
This commit is contained in:
Godot Organization
2025-04-12 03:23:36 +00:00
parent 8c18714228
commit fd1c63103f
157 changed files with 10283 additions and 2474 deletions
Download Patch File Download Diff File Expand all files Collapse all files

442
classes/class_openxrcompositionlayer.rst
View File

@@ -35,19 +35,41 @@ Properties
.. table::
:widths: auto
+---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+
| :ref:`bool<class_bool>` | :ref:`alpha_blend<class_OpenXRCompositionLayer_property_alpha_blend>` | ``false`` |
+---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`android_surface_size<class_OpenXRCompositionLayer_property_android_surface_size>` | ``Vector2i(1024, 1024)`` |
+---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+
| :ref:`bool<class_bool>` | :ref:`enable_hole_punch<class_OpenXRCompositionLayer_property_enable_hole_punch>` | ``false`` |
+---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+
| :ref:`SubViewport<class_SubViewport>` | :ref:`layer_viewport<class_OpenXRCompositionLayer_property_layer_viewport>` | |
+---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+
| :ref:`int<class_int>` | :ref:`sort_order<class_OpenXRCompositionLayer_property_sort_order>` | ``1`` |
+---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+
| :ref:`bool<class_bool>` | :ref:`use_android_surface<class_OpenXRCompositionLayer_property_use_android_surface>` | ``false`` |
+---------------------------------------+-----------------------------------------------------------------------------------------+--------------------------+
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`bool<class_bool>` | :ref:`alpha_blend<class_OpenXRCompositionLayer_property_alpha_blend>` | ``false`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`Vector2i<class_Vector2i>` | :ref:`android_surface_size<class_OpenXRCompositionLayer_property_android_surface_size>` | ``Vector2i(1024, 1024)`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`bool<class_bool>` | :ref:`enable_hole_punch<class_OpenXRCompositionLayer_property_enable_hole_punch>` | ``false`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`SubViewport<class_SubViewport>` | :ref:`layer_viewport<class_OpenXRCompositionLayer_property_layer_viewport>` | |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`int<class_int>` | :ref:`sort_order<class_OpenXRCompositionLayer_property_sort_order>` | ``1`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` | :ref:`swapchain_state_alpha_swizzle<class_OpenXRCompositionLayer_property_swapchain_state_alpha_swizzle>` | ``3`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` | :ref:`swapchain_state_blue_swizzle<class_OpenXRCompositionLayer_property_swapchain_state_blue_swizzle>` | ``2`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`Color<class_Color>` | :ref:`swapchain_state_border_color<class_OpenXRCompositionLayer_property_swapchain_state_border_color>` | ``Color(0, 0, 0, 0)`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` | :ref:`swapchain_state_green_swizzle<class_OpenXRCompositionLayer_property_swapchain_state_green_swizzle>` | ``1`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>` | :ref:`swapchain_state_horizontal_wrap<class_OpenXRCompositionLayer_property_swapchain_state_horizontal_wrap>` | ``0`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`Filter<enum_OpenXRCompositionLayer_Filter>` | :ref:`swapchain_state_mag_filter<class_OpenXRCompositionLayer_property_swapchain_state_mag_filter>` | ``1`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`float<class_float>` | :ref:`swapchain_state_max_anisotropy<class_OpenXRCompositionLayer_property_swapchain_state_max_anisotropy>` | ``1.0`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`Filter<enum_OpenXRCompositionLayer_Filter>` | :ref:`swapchain_state_min_filter<class_OpenXRCompositionLayer_property_swapchain_state_min_filter>` | ``1`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`MipmapMode<enum_OpenXRCompositionLayer_MipmapMode>` | :ref:`swapchain_state_mipmap_mode<class_OpenXRCompositionLayer_property_swapchain_state_mipmap_mode>` | ``2`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` | :ref:`swapchain_state_red_swizzle<class_OpenXRCompositionLayer_property_swapchain_state_red_swizzle>` | ``0`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>` | :ref:`swapchain_state_vertical_wrap<class_OpenXRCompositionLayer_property_swapchain_state_vertical_wrap>` | ``0`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
| :ref:`bool<class_bool>` | :ref:`use_android_surface<class_OpenXRCompositionLayer_property_use_android_surface>` | ``false`` |
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
.. rst-class:: classref-reftable-group
@@ -71,6 +93,191 @@ Methods
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_OpenXRCompositionLayer_Filter:
.. rst-class:: classref-enumeration
enum **Filter**: :ref:`🔗<enum_OpenXRCompositionLayer_Filter>`
.. _class_OpenXRCompositionLayer_constant_FILTER_NEAREST:
.. rst-class:: classref-enumeration-constant
:ref:`Filter<enum_OpenXRCompositionLayer_Filter>` **FILTER_NEAREST** = ``0``
Perform nearest-neighbor filtering when sampling the texture.
.. _class_OpenXRCompositionLayer_constant_FILTER_LINEAR:
.. rst-class:: classref-enumeration-constant
:ref:`Filter<enum_OpenXRCompositionLayer_Filter>` **FILTER_LINEAR** = ``1``
Perform linear filtering when sampling the texture.
.. _class_OpenXRCompositionLayer_constant_FILTER_CUBIC:
.. rst-class:: classref-enumeration-constant
:ref:`Filter<enum_OpenXRCompositionLayer_Filter>` **FILTER_CUBIC** = ``2``
Perform cubic filtering when sampling the texture.
.. rst-class:: classref-item-separator
----
.. _enum_OpenXRCompositionLayer_MipmapMode:
.. rst-class:: classref-enumeration
enum **MipmapMode**: :ref:`🔗<enum_OpenXRCompositionLayer_MipmapMode>`
.. _class_OpenXRCompositionLayer_constant_MIPMAP_MODE_DISABLED:
.. rst-class:: classref-enumeration-constant
:ref:`MipmapMode<enum_OpenXRCompositionLayer_MipmapMode>` **MIPMAP_MODE_DISABLED** = ``0``
Disable mipmapping.
\ **Note:** Mipmapping can only be disabled in the compatibility renderer.
.. _class_OpenXRCompositionLayer_constant_MIPMAP_MODE_NEAREST:
.. rst-class:: classref-enumeration-constant
:ref:`MipmapMode<enum_OpenXRCompositionLayer_MipmapMode>` **MIPMAP_MODE_NEAREST** = ``1``
Use the mipmap of the nearest resolution.
.. _class_OpenXRCompositionLayer_constant_MIPMAP_MODE_LINEAR:
.. rst-class:: classref-enumeration-constant
:ref:`MipmapMode<enum_OpenXRCompositionLayer_MipmapMode>` **MIPMAP_MODE_LINEAR** = ``2``
Use linear interpolation of the two mipmaps of the nearest resolution.
.. rst-class:: classref-item-separator
----
.. _enum_OpenXRCompositionLayer_Wrap:
.. rst-class:: classref-enumeration
enum **Wrap**: :ref:`🔗<enum_OpenXRCompositionLayer_Wrap>`
.. _class_OpenXRCompositionLayer_constant_WRAP_CLAMP_TO_BORDER:
.. rst-class:: classref-enumeration-constant
:ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>` **WRAP_CLAMP_TO_BORDER** = ``0``
Clamp the texture to its specified border color.
.. _class_OpenXRCompositionLayer_constant_WRAP_CLAMP_TO_EDGE:
.. rst-class:: classref-enumeration-constant
:ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>` **WRAP_CLAMP_TO_EDGE** = ``1``
Clamp the texture to its edge color.
.. _class_OpenXRCompositionLayer_constant_WRAP_REPEAT:
.. rst-class:: classref-enumeration-constant
:ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>` **WRAP_REPEAT** = ``2``
Repeat the texture infinitely.
.. _class_OpenXRCompositionLayer_constant_WRAP_MIRRORED_REPEAT:
.. rst-class:: classref-enumeration-constant
:ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>` **WRAP_MIRRORED_REPEAT** = ``3``
Repeat the texture infinitely, mirroring it on each repeat.
.. _class_OpenXRCompositionLayer_constant_WRAP_MIRROR_CLAMP_TO_EDGE:
.. rst-class:: classref-enumeration-constant
:ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>` **WRAP_MIRROR_CLAMP_TO_EDGE** = ``4``
Mirror the texture once and then clamp the texture to its edge color.
\ **Note:** This wrap mode is not available in the compatibility renderer.
.. rst-class:: classref-item-separator
----
.. _enum_OpenXRCompositionLayer_Swizzle:
.. rst-class:: classref-enumeration
enum **Swizzle**: :ref:`🔗<enum_OpenXRCompositionLayer_Swizzle>`
.. _class_OpenXRCompositionLayer_constant_SWIZZLE_RED:
.. rst-class:: classref-enumeration-constant
:ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **SWIZZLE_RED** = ``0``
Maps a color channel to the value of the red channel.
.. _class_OpenXRCompositionLayer_constant_SWIZZLE_GREEN:
.. rst-class:: classref-enumeration-constant
:ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **SWIZZLE_GREEN** = ``1``
Maps a color channel to the value of the green channel.
.. _class_OpenXRCompositionLayer_constant_SWIZZLE_BLUE:
.. rst-class:: classref-enumeration-constant
:ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **SWIZZLE_BLUE** = ``2``
Maps a color channel to the value of the blue channel.
.. _class_OpenXRCompositionLayer_constant_SWIZZLE_ALPHA:
.. rst-class:: classref-enumeration-constant
:ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **SWIZZLE_ALPHA** = ``3``
Maps a color channel to the value of the alpha channel.
.. _class_OpenXRCompositionLayer_constant_SWIZZLE_ZERO:
.. rst-class:: classref-enumeration-constant
:ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **SWIZZLE_ZERO** = ``4``
Maps a color channel to the value of zero.
.. _class_OpenXRCompositionLayer_constant_SWIZZLE_ONE:
.. rst-class:: classref-enumeration-constant
:ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **SWIZZLE_ONE** = ``5``
Maps a color channel to the value of one.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
@@ -165,6 +372,215 @@ The sort order for this composition layer. Higher numbers will be shown in front
----
.. _class_OpenXRCompositionLayer_property_swapchain_state_alpha_swizzle:
.. rst-class:: classref-property
:ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **swapchain_state_alpha_swizzle** = ``3`` :ref:`🔗<class_OpenXRCompositionLayer_property_swapchain_state_alpha_swizzle>`
.. rst-class:: classref-property-setget
- |void| **set_alpha_swizzle**\ (\ value\: :ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>`\ )
- :ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **get_alpha_swizzle**\ (\ )
The swizzle value for the alpha channel of the swapchain state.
\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRCompositionLayer_property_swapchain_state_blue_swizzle:
.. rst-class:: classref-property
:ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **swapchain_state_blue_swizzle** = ``2`` :ref:`🔗<class_OpenXRCompositionLayer_property_swapchain_state_blue_swizzle>`
.. rst-class:: classref-property-setget
- |void| **set_blue_swizzle**\ (\ value\: :ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>`\ )
- :ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **get_blue_swizzle**\ (\ )
The swizzle value for the blue channel of the swapchain state.
\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRCompositionLayer_property_swapchain_state_border_color:
.. rst-class:: classref-property
:ref:`Color<class_Color>` **swapchain_state_border_color** = ``Color(0, 0, 0, 0)`` :ref:`🔗<class_OpenXRCompositionLayer_property_swapchain_state_border_color>`
.. rst-class:: classref-property-setget
- |void| **set_border_color**\ (\ value\: :ref:`Color<class_Color>`\ )
- :ref:`Color<class_Color>` **get_border_color**\ (\ )
The border color of the swapchain state that is used when the wrap mode clamps to the border.
\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRCompositionLayer_property_swapchain_state_green_swizzle:
.. rst-class:: classref-property
:ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **swapchain_state_green_swizzle** = ``1`` :ref:`🔗<class_OpenXRCompositionLayer_property_swapchain_state_green_swizzle>`
.. rst-class:: classref-property-setget
- |void| **set_green_swizzle**\ (\ value\: :ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>`\ )
- :ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **get_green_swizzle**\ (\ )
The swizzle value for the green channel of the swapchain state.
\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRCompositionLayer_property_swapchain_state_horizontal_wrap:
.. rst-class:: classref-property
:ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>` **swapchain_state_horizontal_wrap** = ``0`` :ref:`🔗<class_OpenXRCompositionLayer_property_swapchain_state_horizontal_wrap>`
.. rst-class:: classref-property-setget
- |void| **set_horizontal_wrap**\ (\ value\: :ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>`\ )
- :ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>` **get_horizontal_wrap**\ (\ )
The horizontal wrap mode of the swapchain state.
\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRCompositionLayer_property_swapchain_state_mag_filter:
.. rst-class:: classref-property
:ref:`Filter<enum_OpenXRCompositionLayer_Filter>` **swapchain_state_mag_filter** = ``1`` :ref:`🔗<class_OpenXRCompositionLayer_property_swapchain_state_mag_filter>`
.. rst-class:: classref-property-setget
- |void| **set_mag_filter**\ (\ value\: :ref:`Filter<enum_OpenXRCompositionLayer_Filter>`\ )
- :ref:`Filter<enum_OpenXRCompositionLayer_Filter>` **get_mag_filter**\ (\ )
The magnification filter of the swapchain state.
\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRCompositionLayer_property_swapchain_state_max_anisotropy:
.. rst-class:: classref-property
:ref:`float<class_float>` **swapchain_state_max_anisotropy** = ``1.0`` :ref:`🔗<class_OpenXRCompositionLayer_property_swapchain_state_max_anisotropy>`
.. rst-class:: classref-property-setget
- |void| **set_max_anisotropy**\ (\ value\: :ref:`float<class_float>`\ )
- :ref:`float<class_float>` **get_max_anisotropy**\ (\ )
The max anisotropy of the swapchain state.
\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRCompositionLayer_property_swapchain_state_min_filter:
.. rst-class:: classref-property
:ref:`Filter<enum_OpenXRCompositionLayer_Filter>` **swapchain_state_min_filter** = ``1`` :ref:`🔗<class_OpenXRCompositionLayer_property_swapchain_state_min_filter>`
.. rst-class:: classref-property-setget
- |void| **set_min_filter**\ (\ value\: :ref:`Filter<enum_OpenXRCompositionLayer_Filter>`\ )
- :ref:`Filter<enum_OpenXRCompositionLayer_Filter>` **get_min_filter**\ (\ )
The minification filter of the swapchain state.
\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRCompositionLayer_property_swapchain_state_mipmap_mode:
.. rst-class:: classref-property
:ref:`MipmapMode<enum_OpenXRCompositionLayer_MipmapMode>` **swapchain_state_mipmap_mode** = ``2`` :ref:`🔗<class_OpenXRCompositionLayer_property_swapchain_state_mipmap_mode>`
.. rst-class:: classref-property-setget
- |void| **set_mipmap_mode**\ (\ value\: :ref:`MipmapMode<enum_OpenXRCompositionLayer_MipmapMode>`\ )
- :ref:`MipmapMode<enum_OpenXRCompositionLayer_MipmapMode>` **get_mipmap_mode**\ (\ )
The mipmap mode of the swapchain state.
\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRCompositionLayer_property_swapchain_state_red_swizzle:
.. rst-class:: classref-property
:ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **swapchain_state_red_swizzle** = ``0`` :ref:`🔗<class_OpenXRCompositionLayer_property_swapchain_state_red_swizzle>`
.. rst-class:: classref-property-setget
- |void| **set_red_swizzle**\ (\ value\: :ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>`\ )
- :ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **get_red_swizzle**\ (\ )
The swizzle value for the red channel of the swapchain state.
\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRCompositionLayer_property_swapchain_state_vertical_wrap:
.. rst-class:: classref-property
:ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>` **swapchain_state_vertical_wrap** = ``0`` :ref:`🔗<class_OpenXRCompositionLayer_property_swapchain_state_vertical_wrap>`
.. rst-class:: classref-property-setget
- |void| **set_vertical_wrap**\ (\ value\: :ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>`\ )
- :ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>` **get_vertical_wrap**\ (\ )
The vertical wrap mode of the swapchain state.
\ **Note:** This property only has an effect on devices that support the OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan extensions.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRCompositionLayer_property_use_android_surface:
.. rst-class:: classref-property