classref: Sync with current master branch (4b6c88d)

This commit is contained in:
Godot Organization
2025-12-15 22:19:00 +00:00
parent 59228714f0
commit d45f83bf92
119 changed files with 2593 additions and 1638 deletions

View File

@@ -330,7 +330,7 @@ The session is about to be lost. :ref:`session_loss_pending<class_OpenXRInterfac
:ref:`SessionState<enum_OpenXRInterface_SessionState>` **SESSION_STATE_EXITING** = ``8``
The OpenXR instance is about to be destroyed and we're existing. :ref:`instance_exiting<class_OpenXRInterface_signal_instance_exiting>` is emitted when we change to this state.
The OpenXR instance is about to be destroyed and we're exiting. :ref:`instance_exiting<class_OpenXRInterface_signal_instance_exiting>` is emitted when we change to this state.
.. rst-class:: classref-item-separator
@@ -881,7 +881,7 @@ The display refresh rate for the current HMD. Only functional if this feature is
- |void| **set_foveation_dynamic**\ (\ value\: :ref:`bool<class_bool>`\ )
- :ref:`bool<class_bool>` **get_foveation_dynamic**\ (\ )
Enable dynamic foveation adjustment, the interface must be initialized before this is accessible. If enabled foveation will automatically adjusted between low and :ref:`foveation_level<class_OpenXRInterface_property_foveation_level>`.
If ``true``, enables dynamic foveation adjustment. The interface must be initialized before this is accessible. If enabled, foveation will automatically be adjusted between low and :ref:`foveation_level<class_OpenXRInterface_property_foveation_level>`.
\ **Note:** Only works on the Compatibility renderer.
@@ -900,7 +900,7 @@ Enable dynamic foveation adjustment, the interface must be initialized before th
- |void| **set_foveation_level**\ (\ value\: :ref:`int<class_int>`\ )
- :ref:`int<class_int>` **get_foveation_level**\ (\ )
Set foveation level from 0 (off) to 3 (high), the interface must be initialized before this is accessible.
The foveation level, from ``0`` (off) to ``3`` (high). The interface must be initialized before this is accessible.
\ **Note:** Only works on the Compatibility renderer.
@@ -986,7 +986,7 @@ Returns a list of action sets registered with Godot (loaded from the action map
:ref:`Array<class_Array>` **get_available_display_refresh_rates**\ (\ ) |const| :ref:`🔗<class_OpenXRInterface_method_get_available_display_refresh_rates>`
Returns display refresh rates supported by the current HMD. Only returned if this feature is supported by the OpenXR runtime and after the interface has been initialized.
Returns a list of display refresh rates supported by the current HMD. Only returned if this feature is supported by the OpenXR runtime and after the interface has been initialized.
.. rst-class:: classref-item-separator
@@ -1146,9 +1146,9 @@ Returns the capabilities of the eye gaze interaction extension.
:ref:`bool<class_bool>` **is_foveation_supported**\ (\ ) |const| :ref:`🔗<class_OpenXRInterface_method_is_foveation_supported>`
Returns ``true`` if OpenXR's foveation extension is supported, the interface must be initialized before this returns a valid value.
Returns ``true`` if OpenXR's foveation extension is supported. The interface must be initialized before this returns a valid value.
\ **Note:** This feature is only available on the Compatibility renderer and currently only available on some stand alone headsets. For Vulkan set :ref:`Viewport.vrs_mode<class_Viewport_property_vrs_mode>` to ``VRS_XR`` on desktop.
\ **Note:** When using the Vulkan rendering driver, :ref:`Viewport.vrs_mode<class_Viewport_property_vrs_mode>` must be set to :ref:`Viewport.VRS_XR<class_Viewport_constant_VRS_XR>` to support foveation.
.. rst-class:: classref-item-separator