mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2025-12-31 09:49:22 +03:00
673 lines
36 KiB
ReStructuredText
673 lines
36 KiB
ReStructuredText
:github_url: hide
|
||
|
||
.. _class_OpenXRCompositionLayer:
|
||
|
||
OpenXRCompositionLayer
|
||
======================
|
||
|
||
**Экспериментальное:** This class may be changed or removed in future versions.
|
||
|
||
**Наследует:** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
||
|
||
**Наследуется от:** :ref:`OpenXRCompositionLayerCylinder<class_OpenXRCompositionLayerCylinder>`, :ref:`OpenXRCompositionLayerEquirect<class_OpenXRCompositionLayerEquirect>`, :ref:`OpenXRCompositionLayerQuad<class_OpenXRCompositionLayerQuad>`
|
||
|
||
Родительский класс всех узлов композиционного слоя OpenXR.
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
Описание
|
||
----------------
|
||
|
||
Слои композиции позволяют отображать 2D-окна просмотра внутри гарнитуры с помощью XR-композитора с помощью специальных проекций, которые сохраняют свое качество. Это позволяет визуализировать чистый текст, сохраняя при этом исходное разрешение слоя.
|
||
|
||
\ **Примечание:** Если среда выполнения OpenXR не поддерживает заданный тип слоя композиции, можно сгенерировать резервную сетку с помощью :ref:`ViewportTexture<class_ViewportTexture>`, чтобы эмулировать слой композиции.
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
Свойства
|
||
----------------
|
||
|
||
.. 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:`bool<class_bool>` | :ref:`protected_content<class_OpenXRCompositionLayer_property_protected_content>` | ``false`` |
|
||
+-----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------+--------------------------+
|
||
| :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
|
||
|
||
Методы
|
||
------------
|
||
|
||
.. table::
|
||
:widths: auto
|
||
|
||
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`JavaObject<class_JavaObject>` | :ref:`get_android_surface<class_OpenXRCompositionLayer_method_get_android_surface>`\ (\ ) |
|
||
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector2<class_Vector2>` | :ref:`intersects_ray<class_OpenXRCompositionLayer_method_intersects_ray>`\ (\ origin\: :ref:`Vector3<class_Vector3>`, direction\: :ref:`Vector3<class_Vector3>`\ ) |const| |
|
||
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`is_natively_supported<class_OpenXRCompositionLayer_method_is_natively_supported>`\ (\ ) |const| |
|
||
+-------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Перечисления
|
||
------------------------
|
||
|
||
.. _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``
|
||
|
||
При выборке текстуры следует выполнять фильтрацию ближайшего соседа.
|
||
|
||
.. _class_OpenXRCompositionLayer_constant_FILTER_LINEAR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Filter<enum_OpenXRCompositionLayer_Filter>` **FILTER_LINEAR** = ``1``
|
||
|
||
Выполняйте линейную фильтрацию при выборке текстуры.
|
||
|
||
.. _class_OpenXRCompositionLayer_constant_FILTER_CUBIC:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Filter<enum_OpenXRCompositionLayer_Filter>` **FILTER_CUBIC** = ``2``
|
||
|
||
При выборке текстуры выполняйте кубическую фильтрацию.
|
||
|
||
.. 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``
|
||
|
||
Отключить MIP-текстурирование.
|
||
|
||
\ **Примечание:** MIP-текстурирование можно отключить только в режиме совместимости.
|
||
|
||
.. _class_OpenXRCompositionLayer_constant_MIPMAP_MODE_NEAREST:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MipmapMode<enum_OpenXRCompositionLayer_MipmapMode>` **MIPMAP_MODE_NEAREST** = ``1``
|
||
|
||
Используйте mipmap ближайшего разрешения.
|
||
|
||
.. _class_OpenXRCompositionLayer_constant_MIPMAP_MODE_LINEAR:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`MipmapMode<enum_OpenXRCompositionLayer_MipmapMode>` **MIPMAP_MODE_LINEAR** = ``2``
|
||
|
||
Использовать линейную интерполяцию двух MIP-карт ближайшего разрешения.
|
||
|
||
.. 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``
|
||
|
||
Закрепите текстуру по указанному цвету границы.
|
||
|
||
.. _class_OpenXRCompositionLayer_constant_WRAP_CLAMP_TO_EDGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>` **WRAP_CLAMP_TO_EDGE** = ``1``
|
||
|
||
Закрепите текстуру по цвету ее кромки.
|
||
|
||
.. _class_OpenXRCompositionLayer_constant_WRAP_REPEAT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>` **WRAP_REPEAT** = ``2``
|
||
|
||
Повторяйте текстуру бесконечно.
|
||
|
||
.. _class_OpenXRCompositionLayer_constant_WRAP_MIRRORED_REPEAT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>` **WRAP_MIRRORED_REPEAT** = ``3``
|
||
|
||
Повторяйте текстуру бесконечно, зеркально отображая ее при каждом повторе.
|
||
|
||
.. _class_OpenXRCompositionLayer_constant_WRAP_MIRROR_CLAMP_TO_EDGE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Wrap<enum_OpenXRCompositionLayer_Wrap>` **WRAP_MIRROR_CLAMP_TO_EDGE** = ``4``
|
||
|
||
Отразите текстуру один раз, а затем прикрепите её к цвету края.
|
||
|
||
\ **Примечание:** Этот режим обтекания недоступен в рендере совместимости.
|
||
|
||
.. 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``
|
||
|
||
Сопоставляет цветовой канал со значением красного канала.
|
||
|
||
.. _class_OpenXRCompositionLayer_constant_SWIZZLE_GREEN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **SWIZZLE_GREEN** = ``1``
|
||
|
||
Сопоставляет цветовой канал со значением зеленого канала.
|
||
|
||
.. _class_OpenXRCompositionLayer_constant_SWIZZLE_BLUE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **SWIZZLE_BLUE** = ``2``
|
||
|
||
Сопоставляет цветовой канал со значением синего канала.
|
||
|
||
.. _class_OpenXRCompositionLayer_constant_SWIZZLE_ALPHA:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **SWIZZLE_ALPHA** = ``3``
|
||
|
||
Сопоставляет цветовой канал со значением альфа-канала.
|
||
|
||
.. _class_OpenXRCompositionLayer_constant_SWIZZLE_ZERO:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **SWIZZLE_ZERO** = ``4``
|
||
|
||
Сопоставляет цветовой канал со значением ноль.
|
||
|
||
.. _class_OpenXRCompositionLayer_constant_SWIZZLE_ONE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Swizzle<enum_OpenXRCompositionLayer_Swizzle>` **SWIZZLE_ONE** = ``5``
|
||
|
||
Сопоставляет цветовой канал со значением единицы.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Описания свойств
|
||
--------------------------------
|
||
|
||
.. _class_OpenXRCompositionLayer_property_alpha_blend:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **alpha_blend** = ``false`` :ref:`🔗<class_OpenXRCompositionLayer_property_alpha_blend>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_alpha_blend**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **get_alpha_blend**\ (\ )
|
||
|
||
Позволяет смешивать слой с использованием его альфа-канала.
|
||
|
||
Можно комбинировать с :ref:`Viewport.transparent_bg<class_Viewport_property_transparent_bg>`, чтобы придать слою прозрачный фон.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRCompositionLayer_property_android_surface_size:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`Vector2i<class_Vector2i>` **android_surface_size** = ``Vector2i(1024, 1024)`` :ref:`🔗<class_OpenXRCompositionLayer_property_android_surface_size>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_android_surface_size**\ (\ value\: :ref:`Vector2i<class_Vector2i>`\ )
|
||
- :ref:`Vector2i<class_Vector2i>` **get_android_surface_size**\ (\ )
|
||
|
||
Размер создаваемой поверхности Android, если включен :ref:`use_android_surface<class_OpenXRCompositionLayer_property_use_android_surface>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRCompositionLayer_property_enable_hole_punch:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **enable_hole_punch** = ``false`` :ref:`🔗<class_OpenXRCompositionLayer_property_enable_hole_punch>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_enable_hole_punch**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **get_enable_hole_punch**\ (\ )
|
||
|
||
Позволяет использовать технику, называемую «дырокол», которая позволяет размещать слой композиции за основным проекционным слоем (т. е. устанавливать :ref:`sort_order<class_OpenXRCompositionLayer_property_sort_order>` на отрицательное значение), одновременно «пробивая дыру» через все, что визуализируется Godot, так что слой все еще виден.
|
||
|
||
Это можно использовать для создания иллюзии того, что слой композиции существует в том же трехмерном пространстве, что и все, что визуализируется Godot, позволяя объектам казаться проходящими как позади, так и перед слоем композиции.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRCompositionLayer_property_layer_viewport:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`SubViewport<class_SubViewport>` **layer_viewport** :ref:`🔗<class_OpenXRCompositionLayer_property_layer_viewport>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_layer_viewport**\ (\ value\: :ref:`SubViewport<class_SubViewport>`\ )
|
||
- :ref:`SubViewport<class_SubViewport>` **get_layer_viewport**\ (\ )
|
||
|
||
:ref:`SubViewport<class_SubViewport>` для рендеринга на слое композиции.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRCompositionLayer_property_protected_content:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **protected_content** = ``false`` :ref:`🔗<class_OpenXRCompositionLayer_property_protected_content>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_protected_content**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_protected_content**\ (\ )
|
||
|
||
If enabled, the OpenXR swapchain will be created with the ``XR_SWAPCHAIN_CREATE_PROTECTED_CONTENT_BIT`` flag, which will protect its contents from CPU access.
|
||
|
||
When used with an Android Surface, this may allow DRM content to be presented, and will only take effect when the Surface is first created; later changes to this property will have no effect.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRCompositionLayer_property_sort_order:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`int<class_int>` **sort_order** = ``1`` :ref:`🔗<class_OpenXRCompositionLayer_property_sort_order>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_sort_order**\ (\ value\: :ref:`int<class_int>`\ )
|
||
- :ref:`int<class_int>` **get_sort_order**\ (\ )
|
||
|
||
Порядок сортировки для этого слоя композиции. Более высокие числа будут показаны перед более низкими числами.
|
||
|
||
\ **Примечание:** Это не будет иметь никакого эффекта, если используется резервная сетка.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _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**\ (\ )
|
||
|
||
Значение swizzle для альфа-канала состояния swapchain.
|
||
|
||
\ **Примечание:** Это свойство влияет только на устройства, которые поддерживают расширения OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan.
|
||
|
||
.. 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**\ (\ )
|
||
|
||
Значение swizzle для синего канала состояния swapchain.
|
||
|
||
\ **Примечание:** Это свойство влияет только на устройства, которые поддерживают расширения OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan.
|
||
|
||
.. 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**\ (\ )
|
||
|
||
Цвет границы состояния цепочки обмена, который используется, когда режим переноса привязывается к границе.
|
||
|
||
\ **Примечание:** Это свойство действует только на устройствах, поддерживающих расширения OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan.
|
||
|
||
.. 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**\ (\ )
|
||
|
||
Значение swizzle для зеленого канала состояния swapchain.
|
||
|
||
\ **Примечание:** Это свойство влияет только на устройства, которые поддерживают расширения OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan.
|
||
|
||
.. 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**\ (\ )
|
||
|
||
Режим горизонтального переноса состояния цепочки обмена.
|
||
|
||
\ **Примечание:** Это свойство действует только на устройствах, которые поддерживают расширения OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan.
|
||
|
||
.. 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**\ (\ )
|
||
|
||
Фильтр увеличения состояния цепочки обмена.
|
||
|
||
\ **Примечание:** Это свойство действует только на устройствах, которые поддерживают расширения OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan.
|
||
|
||
.. 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**\ (\ )
|
||
|
||
Максимальная анизотропия состояния swapchain.
|
||
|
||
\ **Примечание:** Это свойство влияет только на устройства, которые поддерживают расширения OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan.
|
||
|
||
.. 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**\ (\ )
|
||
|
||
Фильтр минификации состояния swapchain.
|
||
|
||
\ **Примечание:** Это свойство действует только на устройствах, которые поддерживают расширения OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan.
|
||
|
||
.. 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**\ (\ )
|
||
|
||
Режим mipmap состояния swapchain.
|
||
|
||
\ **Примечание:** Это свойство действует только на устройствах, которые поддерживают расширения OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan.
|
||
|
||
.. 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**\ (\ )
|
||
|
||
Значение swizzle для красного канала состояния swapchain.
|
||
|
||
\ **Примечание:** Это свойство влияет только на устройства, которые поддерживают расширения OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan.
|
||
|
||
.. 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**\ (\ )
|
||
|
||
Режим вертикального переноса состояния цепочки обмена.
|
||
|
||
\ **Примечание:** Это свойство действует только на устройствах, которые поддерживают расширения OpenXR XR_FB_swapchain_update_state OpenGLES/Vulkan.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRCompositionLayer_property_use_android_surface:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **use_android_surface** = ``false`` :ref:`🔗<class_OpenXRCompositionLayer_property_use_android_surface>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_use_android_surface**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **get_use_android_surface**\ (\ )
|
||
|
||
Если включено, будет создана поверхность Android (с размерами из :ref:`android_surface_size<class_OpenXRCompositionLayer_property_android_surface_size>`), которая предоставит 2D-контент для слоя композиции, а не будет использовать :ref:`layer_viewport<class_OpenXRCompositionLayer_property_layer_viewport>`.
|
||
|
||
См. :ref:`get_android_surface()<class_OpenXRCompositionLayer_method_get_android_surface>` для получения информации о том, как получить поверхность, чтобы ваше приложение могло рисовать на ней.
|
||
|
||
\ **Примечание:** Это будет работать только в сборках Android.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Описания метода
|
||
------------------------------
|
||
|
||
.. _class_OpenXRCompositionLayer_method_get_android_surface:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`JavaObject<class_JavaObject>` **get_android_surface**\ (\ ) :ref:`🔗<class_OpenXRCompositionLayer_method_get_android_surface>`
|
||
|
||
Возвращает :ref:`JavaObject<class_JavaObject>`, представляющий ``android.view.Surface``, если :ref:`use_android_surface<class_OpenXRCompositionLayer_property_use_android_surface>` включен и OpenXR создал поверхность. В противном случае будет возвращен ``null``.
|
||
|
||
\ **Примечание:** Поверхность может быть создана только во время активного сеанса OpenXR. Таким образом, если :ref:`use_android_surface<class_OpenXRCompositionLayer_property_use_android_surface>` включен вне сеанса OpenXR, она не будет создана, пока полностью не начнется новый сеанс.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRCompositionLayer_method_intersects_ray:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector2<class_Vector2>` **intersects_ray**\ (\ origin\: :ref:`Vector3<class_Vector3>`, direction\: :ref:`Vector3<class_Vector3>`\ ) |const| :ref:`🔗<class_OpenXRCompositionLayer_method_intersects_ray>`
|
||
|
||
Возвращает UV-координаты, где заданный луч пересекается со слоем композиции. ``origin`` и ``direction`` должны быть в глобальном пространстве.
|
||
|
||
Возвращает ``Vector2(-1.0, -1.0)``, если луч не пересекается.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRCompositionLayer_method_is_natively_supported:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **is_natively_supported**\ (\ ) |const| :ref:`🔗<class_OpenXRCompositionLayer_method_is_natively_supported>`
|
||
|
||
Возвращает ``true``, если среда выполнения OpenXR изначально поддерживает этот тип слоя композиции.
|
||
|
||
\ **Примечание:** Это вернет точный результат только после начала сеанса OpenXR.
|
||
|
||
.. |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 (Нет возвращаемого значения.)`
|