mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2025-12-31 09:49:22 +03:00
1233 lines
55 KiB
ReStructuredText
1233 lines
55 KiB
ReStructuredText
:github_url: hide
|
||
|
||
.. _class_OpenXRInterface:
|
||
|
||
OpenXRInterface
|
||
===============
|
||
|
||
**Hérite de :** :ref:`XRInterface<class_XRInterface>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
||
|
||
Notre interface OpenXR.
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
Description
|
||
-----------
|
||
|
||
L'interface OpenXR permet à Godot d'interagir avec OpenXR et de créer des expériences et des jeux XR.
|
||
|
||
En raison des besoins d'OpenXR, cette interface fonctionne légèrement différent des autres plugins d'interfaces XR. Elle doit être initialisée quand Godot démarre. Vous devez activer OpenXR, les paramètres pour cela peuvent être trouvés dans les paramètres du projet de votre jeu sous la rubrique XR. Vous avez besoin de marquer un viewport pour une utilisation XR afin que Godot sache quel résultat de rendu devrait être envoyé vers le casque.
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
Tutoriels
|
||
------------------
|
||
|
||
- :doc:`Configuration de la XR <../tutorials/xr/setting_up_xr>`
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
Propriétés
|
||
--------------------
|
||
|
||
.. table::
|
||
:widths: auto
|
||
|
||
+---------------------------+----------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`float<class_float>` | :ref:`display_refresh_rate<class_OpenXRInterface_property_display_refresh_rate>` | ``0.0`` |
|
||
+---------------------------+----------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`bool<class_bool>` | :ref:`foveation_dynamic<class_OpenXRInterface_property_foveation_dynamic>` | ``false`` |
|
||
+---------------------------+----------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`int<class_int>` | :ref:`foveation_level<class_OpenXRInterface_property_foveation_level>` | ``0`` |
|
||
+---------------------------+----------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`float<class_float>` | :ref:`render_target_size_multiplier<class_OpenXRInterface_property_render_target_size_multiplier>` | ``1.0`` |
|
||
+---------------------------+----------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`float<class_float>` | :ref:`vrs_min_radius<class_OpenXRInterface_property_vrs_min_radius>` | ``20.0`` |
|
||
+---------------------------+----------------------------------------------------------------------------------------------------+-----------+
|
||
| :ref:`float<class_float>` | :ref:`vrs_strength<class_OpenXRInterface_property_vrs_strength>` | ``1.0`` |
|
||
+---------------------------+----------------------------------------------------------------------------------------------------+-----------+
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
Méthodes
|
||
----------------
|
||
|
||
.. table::
|
||
:widths: auto
|
||
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Array<class_Array>` | :ref:`get_action_sets<class_OpenXRInterface_method_get_action_sets>`\ (\ ) |const| |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Array<class_Array>` | :ref:`get_available_display_refresh_rates<class_OpenXRInterface_method_get_available_display_refresh_rates>`\ (\ ) |const| |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector3<class_Vector3>` | :ref:`get_hand_joint_angular_velocity<class_OpenXRInterface_method_get_hand_joint_angular_velocity>`\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`, joint\: :ref:`HandJoints<enum_OpenXRInterface_HandJoints>`\ ) |const| |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |bitfield|\[:ref:`HandJointFlags<enum_OpenXRInterface_HandJointFlags>`\] | :ref:`get_hand_joint_flags<class_OpenXRInterface_method_get_hand_joint_flags>`\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`, joint\: :ref:`HandJoints<enum_OpenXRInterface_HandJoints>`\ ) |const| |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector3<class_Vector3>` | :ref:`get_hand_joint_linear_velocity<class_OpenXRInterface_method_get_hand_joint_linear_velocity>`\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`, joint\: :ref:`HandJoints<enum_OpenXRInterface_HandJoints>`\ ) |const| |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Vector3<class_Vector3>` | :ref:`get_hand_joint_position<class_OpenXRInterface_method_get_hand_joint_position>`\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`, joint\: :ref:`HandJoints<enum_OpenXRInterface_HandJoints>`\ ) |const| |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`get_hand_joint_radius<class_OpenXRInterface_method_get_hand_joint_radius>`\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`, joint\: :ref:`HandJoints<enum_OpenXRInterface_HandJoints>`\ ) |const| |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`Quaternion<class_Quaternion>` | :ref:`get_hand_joint_rotation<class_OpenXRInterface_method_get_hand_joint_rotation>`\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`, joint\: :ref:`HandJoints<enum_OpenXRInterface_HandJoints>`\ ) |const| |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`HandTrackedSource<enum_OpenXRInterface_HandTrackedSource>` | :ref:`get_hand_tracking_source<class_OpenXRInterface_method_get_hand_tracking_source>`\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`\ ) |const| |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`HandMotionRange<enum_OpenXRInterface_HandMotionRange>` | :ref:`get_motion_range<class_OpenXRInterface_method_get_motion_range>`\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`\ ) |const| |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`SessionState<enum_OpenXRInterface_SessionState>` | :ref:`get_session_state<class_OpenXRInterface_method_get_session_state>`\ (\ ) |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`is_action_set_active<class_OpenXRInterface_method_is_action_set_active>`\ (\ name\: :ref:`String<class_String>`\ ) |const| |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`is_eye_gaze_interaction_supported<class_OpenXRInterface_method_is_eye_gaze_interaction_supported>`\ (\ ) |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`is_foveation_supported<class_OpenXRInterface_method_is_foveation_supported>`\ (\ ) |const| |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`is_hand_interaction_supported<class_OpenXRInterface_method_is_hand_interaction_supported>`\ (\ ) |const| |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`is_hand_tracking_supported<class_OpenXRInterface_method_is_hand_tracking_supported>`\ (\ ) |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_action_set_active<class_OpenXRInterface_method_set_action_set_active>`\ (\ name\: :ref:`String<class_String>`, active\: :ref:`bool<class_bool>`\ ) |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_cpu_level<class_OpenXRInterface_method_set_cpu_level>`\ (\ level\: :ref:`PerfSettingsLevel<enum_OpenXRInterface_PerfSettingsLevel>`\ ) |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_gpu_level<class_OpenXRInterface_method_set_gpu_level>`\ (\ level\: :ref:`PerfSettingsLevel<enum_OpenXRInterface_PerfSettingsLevel>`\ ) |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
| |void| | :ref:`set_motion_range<class_OpenXRInterface_method_set_motion_range>`\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`, motion_range\: :ref:`HandMotionRange<enum_OpenXRInterface_HandMotionRange>`\ ) |
|
||
+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Signaux
|
||
--------------
|
||
|
||
.. _class_OpenXRInterface_signal_cpu_level_changed:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**cpu_level_changed**\ (\ sub_domain\: :ref:`int<class_int>`, from_level\: :ref:`int<class_int>`, to_level\: :ref:`int<class_int>`\ ) :ref:`🔗<class_OpenXRInterface_signal_cpu_level_changed>`
|
||
|
||
Informs the device CPU performance level has changed in the specified subdomain.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_signal_gpu_level_changed:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**gpu_level_changed**\ (\ sub_domain\: :ref:`int<class_int>`, from_level\: :ref:`int<class_int>`, to_level\: :ref:`int<class_int>`\ ) :ref:`🔗<class_OpenXRInterface_signal_gpu_level_changed>`
|
||
|
||
Informs the device GPU performance level has changed in the specified subdomain.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_signal_instance_exiting:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**instance_exiting**\ (\ ) :ref:`🔗<class_OpenXRInterface_signal_instance_exiting>`
|
||
|
||
Informe que notre instance OpenXR est en train de quitter.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_signal_pose_recentered:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**pose_recentered**\ (\ ) :ref:`🔗<class_OpenXRInterface_signal_pose_recentered>`
|
||
|
||
Informs the user queued a recenter of the player position.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_signal_refresh_rate_changed:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**refresh_rate_changed**\ (\ refresh_rate\: :ref:`float<class_float>`\ ) :ref:`🔗<class_OpenXRInterface_signal_refresh_rate_changed>`
|
||
|
||
Informs the user the HMD refresh rate has changed.
|
||
|
||
\ **Note:** Only emitted if XR runtime supports the refresh rate extension.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_signal_session_begun:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**session_begun**\ (\ ) :ref:`🔗<class_OpenXRInterface_signal_session_begun>`
|
||
|
||
Informs our OpenXR session has been started.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_signal_session_focussed:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**session_focussed**\ (\ ) :ref:`🔗<class_OpenXRInterface_signal_session_focussed>`
|
||
|
||
Informs our OpenXR session now has focus, for example output is sent to the HMD and we're receiving XR input.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_signal_session_loss_pending:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**session_loss_pending**\ (\ ) :ref:`🔗<class_OpenXRInterface_signal_session_loss_pending>`
|
||
|
||
Informs our OpenXR session is in the process of being lost.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_signal_session_stopping:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**session_stopping**\ (\ ) :ref:`🔗<class_OpenXRInterface_signal_session_stopping>`
|
||
|
||
Informe que notre session OpenXR s'arrête.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_signal_session_synchronized:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**session_synchronized**\ (\ ) :ref:`🔗<class_OpenXRInterface_signal_session_synchronized>`
|
||
|
||
Informe que notre session OpenXR a été synchronisée.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_signal_session_visible:
|
||
|
||
.. rst-class:: classref-signal
|
||
|
||
**session_visible**\ (\ ) :ref:`🔗<class_OpenXRInterface_signal_session_visible>`
|
||
|
||
Informe que notre session OpenXR est maintenant visible, par exemple la sortie est envoyée au HMD mais nous ne recevons pas d'entrée XR.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Énumérations
|
||
------------------------
|
||
|
||
.. _enum_OpenXRInterface_SessionState:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **SessionState**: :ref:`🔗<enum_OpenXRInterface_SessionState>`
|
||
|
||
.. _class_OpenXRInterface_constant_SESSION_STATE_UNKNOWN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SessionState<enum_OpenXRInterface_SessionState>` **SESSION_STATE_UNKNOWN** = ``0``
|
||
|
||
L'état de la session est inconnu, nous n'avons pas encore essayé de configurer OpenXR.
|
||
|
||
.. _class_OpenXRInterface_constant_SESSION_STATE_IDLE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SessionState<enum_OpenXRInterface_SessionState>` **SESSION_STATE_IDLE** = ``1``
|
||
|
||
L'état initial après que la session OpenXR soit créée ou après que la session soit détruite.
|
||
|
||
.. _class_OpenXRInterface_constant_SESSION_STATE_READY:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SessionState<enum_OpenXRInterface_SessionState>` **SESSION_STATE_READY** = ``2``
|
||
|
||
OpenXR est prêt à démarrer notre session. :ref:`session_begun<class_OpenXRInterface_signal_session_begun>` est émis lorsque nous changeons vers cette état.
|
||
|
||
.. _class_OpenXRInterface_constant_SESSION_STATE_SYNCHRONIZED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SessionState<enum_OpenXRInterface_SessionState>` **SESSION_STATE_SYNCHRONIZED** = ``3``
|
||
|
||
The application has synched its frame loop with the runtime but we're not rendering anything. :ref:`session_synchronized<class_OpenXRInterface_signal_session_synchronized>` is emitted when we change to this state.
|
||
|
||
.. _class_OpenXRInterface_constant_SESSION_STATE_VISIBLE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SessionState<enum_OpenXRInterface_SessionState>` **SESSION_STATE_VISIBLE** = ``4``
|
||
|
||
The application has synched its frame loop with the runtime and we're rendering output to the user, however we receive no user input. :ref:`session_visible<class_OpenXRInterface_signal_session_visible>` is emitted when we change to this state.
|
||
|
||
\ **Note:** This is the current state just before we get the focused state, whenever the user opens a system menu, switches to another application, or takes off their headset.
|
||
|
||
.. _class_OpenXRInterface_constant_SESSION_STATE_FOCUSED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SessionState<enum_OpenXRInterface_SessionState>` **SESSION_STATE_FOCUSED** = ``5``
|
||
|
||
The application has synched its frame loop with the runtime, we're rendering output to the user and we're receiving XR input. :ref:`session_focussed<class_OpenXRInterface_signal_session_focussed>` is emitted when we change to this state.
|
||
|
||
\ **Note:** This is the state OpenXR will be in when the user can fully interact with your game.
|
||
|
||
.. _class_OpenXRInterface_constant_SESSION_STATE_STOPPING:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SessionState<enum_OpenXRInterface_SessionState>` **SESSION_STATE_STOPPING** = ``6``
|
||
|
||
Notre session est en train d'être arrêtée. :ref:`session_stopping<class_OpenXRInterface_signal_session_stopping>` est émis lorsque nous changeons vers cet état.
|
||
|
||
.. _class_OpenXRInterface_constant_SESSION_STATE_LOSS_PENDING:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SessionState<enum_OpenXRInterface_SessionState>` **SESSION_STATE_LOSS_PENDING** = ``7``
|
||
|
||
La session va être perdue. :ref:`session_loss_pending<class_OpenXRInterface_signal_session_loss_pending>` est émis lorsque nous changeons vers cet état.
|
||
|
||
.. _class_OpenXRInterface_constant_SESSION_STATE_EXITING:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`SessionState<enum_OpenXRInterface_SessionState>` **SESSION_STATE_EXITING** = ``8``
|
||
|
||
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
|
||
|
||
----
|
||
|
||
.. _enum_OpenXRInterface_Hand:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **Hand**: :ref:`🔗<enum_OpenXRInterface_Hand>`
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_LEFT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Hand<enum_OpenXRInterface_Hand>` **HAND_LEFT** = ``0``
|
||
|
||
Main gauche.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_RIGHT:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Hand<enum_OpenXRInterface_Hand>` **HAND_RIGHT** = ``1``
|
||
|
||
Main droite.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`Hand<enum_OpenXRInterface_Hand>` **HAND_MAX** = ``2``
|
||
|
||
Valeur maximale pour l'énumération de la main.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_OpenXRInterface_HandMotionRange:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **HandMotionRange**: :ref:`🔗<enum_OpenXRInterface_HandMotionRange>`
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_MOTION_RANGE_UNOBSTRUCTED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandMotionRange<enum_OpenXRInterface_HandMotionRange>` **HAND_MOTION_RANGE_UNOBSTRUCTED** = ``0``
|
||
|
||
Full hand range, if user closes their hands, we make a full fist.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_MOTION_RANGE_CONFORM_TO_CONTROLLER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandMotionRange<enum_OpenXRInterface_HandMotionRange>` **HAND_MOTION_RANGE_CONFORM_TO_CONTROLLER** = ``1``
|
||
|
||
Conform to controller, if user closes their hands, the tracked data conforms to the shape of the controller.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_MOTION_RANGE_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandMotionRange<enum_OpenXRInterface_HandMotionRange>` **HAND_MOTION_RANGE_MAX** = ``2``
|
||
|
||
Maximum value for the motion range enum.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_OpenXRInterface_HandTrackedSource:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **HandTrackedSource**: :ref:`🔗<enum_OpenXRInterface_HandTrackedSource>`
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_TRACKED_SOURCE_UNKNOWN:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandTrackedSource<enum_OpenXRInterface_HandTrackedSource>` **HAND_TRACKED_SOURCE_UNKNOWN** = ``0``
|
||
|
||
La source des données du suivi des mains est inconnue (l'extension est probablement non supportée).
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_TRACKED_SOURCE_UNOBSTRUCTED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandTrackedSource<enum_OpenXRInterface_HandTrackedSource>` **HAND_TRACKED_SOURCE_UNOBSTRUCTED** = ``1``
|
||
|
||
La source des données du suivi des mains est non obstruée, cela signifie qu'une méthode précise de suivi des mains est utilisée, par ex. du suivi des mains optique, des gants de données, etc...
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_TRACKED_SOURCE_CONTROLLER:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandTrackedSource<enum_OpenXRInterface_HandTrackedSource>` **HAND_TRACKED_SOURCE_CONTROLLER** = ``2``
|
||
|
||
La source des données du suivi des mains est un contrôleur, les positions des os sont inférées des entrées du contrôleur.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_TRACKED_SOURCE_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandTrackedSource<enum_OpenXRInterface_HandTrackedSource>` **HAND_TRACKED_SOURCE_MAX** = ``3``
|
||
|
||
Représente la taille de l'énumération :ref:`HandTrackedSource<enum_OpenXRInterface_HandTrackedSource>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_OpenXRInterface_HandJoints:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **HandJoints**: :ref:`🔗<enum_OpenXRInterface_HandJoints>`
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_PALM:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_PALM** = ``0``
|
||
|
||
Articulation de la paume.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_WRIST:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_WRIST** = ``1``
|
||
|
||
Articulation du poignet.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_THUMB_METACARPAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_THUMB_METACARPAL** = ``2``
|
||
|
||
Articulation métacarpienne du pouce.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_THUMB_PROXIMAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_THUMB_PROXIMAL** = ``3``
|
||
|
||
Articulation proximale du pouce.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_THUMB_DISTAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_THUMB_DISTAL** = ``4``
|
||
|
||
Articulation distale du pouce.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_THUMB_TIP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_THUMB_TIP** = ``5``
|
||
|
||
Articulation du bout du pouce.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_INDEX_METACARPAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_INDEX_METACARPAL** = ``6``
|
||
|
||
Articulation métacarpienne de l'index.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_INDEX_PROXIMAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_INDEX_PROXIMAL** = ``7``
|
||
|
||
Articulation de la phalange proximale de l'index.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_INDEX_INTERMEDIATE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_INDEX_INTERMEDIATE** = ``8``
|
||
|
||
Articulation de la phalange intermédiaire de l'index.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_INDEX_DISTAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_INDEX_DISTAL** = ``9``
|
||
|
||
Articulation de la phalange distale de l'index.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_INDEX_TIP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_INDEX_TIP** = ``10``
|
||
|
||
Articulation du bout de l'index.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_MIDDLE_METACARPAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_MIDDLE_METACARPAL** = ``11``
|
||
|
||
Articulation métacarpale du majeur.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_MIDDLE_PROXIMAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_MIDDLE_PROXIMAL** = ``12``
|
||
|
||
Articulation de la phalange proximale du majeur.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_MIDDLE_INTERMEDIATE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_MIDDLE_INTERMEDIATE** = ``13``
|
||
|
||
Articulation de la phalange intermédiaire du majeur.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_MIDDLE_DISTAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_MIDDLE_DISTAL** = ``14``
|
||
|
||
Articulation de la phalange distale du majeur.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_MIDDLE_TIP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_MIDDLE_TIP** = ``15``
|
||
|
||
Articulation du bout du majeur.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_RING_METACARPAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_RING_METACARPAL** = ``16``
|
||
|
||
Articulation métacarpienne de l'annulaire.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_RING_PROXIMAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_RING_PROXIMAL** = ``17``
|
||
|
||
Articulation de la phalange proximale de l'annulaire.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_RING_INTERMEDIATE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_RING_INTERMEDIATE** = ``18``
|
||
|
||
Articulation de la phalange intermédiaire de l'annulaire.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_RING_DISTAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_RING_DISTAL** = ``19``
|
||
|
||
Articulation de la phalange distale de l'auriculaire.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_RING_TIP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_RING_TIP** = ``20``
|
||
|
||
Articulation du bout de l'annulaire.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_LITTLE_METACARPAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_LITTLE_METACARPAL** = ``21``
|
||
|
||
Articulation métacarpienne de l'auriculaire.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_LITTLE_PROXIMAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_LITTLE_PROXIMAL** = ``22``
|
||
|
||
Articulation de la phalange proximale de l'auriculaire.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_LITTLE_INTERMEDIATE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_LITTLE_INTERMEDIATE** = ``23``
|
||
|
||
Articulation de la phalange intermédiaire de l'auriculaire.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_LITTLE_DISTAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_LITTLE_DISTAL** = ``24``
|
||
|
||
Articulation de la phalange distale de l'auriculaire.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_LITTLE_TIP:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_LITTLE_TIP** = ``25``
|
||
|
||
Articulation du bout de l'auriculaire.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_MAX:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJoints<enum_OpenXRInterface_HandJoints>` **HAND_JOINT_MAX** = ``26``
|
||
|
||
Représente la taille de l'énumération :ref:`HandJoints<enum_OpenXRInterface_HandJoints>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_OpenXRInterface_PerfSettingsLevel:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **PerfSettingsLevel**: :ref:`🔗<enum_OpenXRInterface_PerfSettingsLevel>`
|
||
|
||
.. _class_OpenXRInterface_constant_PERF_SETTINGS_LEVEL_POWER_SAVINGS:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PerfSettingsLevel<enum_OpenXRInterface_PerfSettingsLevel>` **PERF_SETTINGS_LEVEL_POWER_SAVINGS** = ``0``
|
||
|
||
L'application est entrée dans une section non-XR (écran verrouillé / sans mouvement de tête), au cours de laquelle les économies d'énergie doivent être priorisées.
|
||
|
||
.. _class_OpenXRInterface_constant_PERF_SETTINGS_LEVEL_SUSTAINED_LOW:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PerfSettingsLevel<enum_OpenXRInterface_PerfSettingsLevel>` **PERF_SETTINGS_LEVEL_SUSTAINED_LOW** = ``1``
|
||
|
||
The application has entered a low and stable complexity section, during which reducing power is more important than occasional late rendering frames.
|
||
|
||
.. _class_OpenXRInterface_constant_PERF_SETTINGS_LEVEL_SUSTAINED_HIGH:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PerfSettingsLevel<enum_OpenXRInterface_PerfSettingsLevel>` **PERF_SETTINGS_LEVEL_SUSTAINED_HIGH** = ``2``
|
||
|
||
The application has entered a high or dynamic complexity section, during which the XR Runtime strives for consistent XR compositing and frame rendering within a thermally sustainable range.
|
||
|
||
.. _class_OpenXRInterface_constant_PERF_SETTINGS_LEVEL_BOOST:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PerfSettingsLevel<enum_OpenXRInterface_PerfSettingsLevel>` **PERF_SETTINGS_LEVEL_BOOST** = ``3``
|
||
|
||
The application has entered a section with very high complexity, during which the XR Runtime is allowed to step up beyond the thermally sustainable range.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_OpenXRInterface_PerfSettingsSubDomain:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **PerfSettingsSubDomain**: :ref:`🔗<enum_OpenXRInterface_PerfSettingsSubDomain>`
|
||
|
||
.. _class_OpenXRInterface_constant_PERF_SETTINGS_SUB_DOMAIN_COMPOSITING:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PerfSettingsSubDomain<enum_OpenXRInterface_PerfSettingsSubDomain>` **PERF_SETTINGS_SUB_DOMAIN_COMPOSITING** = ``0``
|
||
|
||
The compositing performance within the runtime has reached a new level.
|
||
|
||
.. _class_OpenXRInterface_constant_PERF_SETTINGS_SUB_DOMAIN_RENDERING:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PerfSettingsSubDomain<enum_OpenXRInterface_PerfSettingsSubDomain>` **PERF_SETTINGS_SUB_DOMAIN_RENDERING** = ``1``
|
||
|
||
The application rendering performance has reached a new level.
|
||
|
||
.. _class_OpenXRInterface_constant_PERF_SETTINGS_SUB_DOMAIN_THERMAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PerfSettingsSubDomain<enum_OpenXRInterface_PerfSettingsSubDomain>` **PERF_SETTINGS_SUB_DOMAIN_THERMAL** = ``2``
|
||
|
||
The temperature of the device has reached a new level.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_OpenXRInterface_PerfSettingsNotificationLevel:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
enum **PerfSettingsNotificationLevel**: :ref:`🔗<enum_OpenXRInterface_PerfSettingsNotificationLevel>`
|
||
|
||
.. _class_OpenXRInterface_constant_PERF_SETTINGS_NOTIF_LEVEL_NORMAL:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PerfSettingsNotificationLevel<enum_OpenXRInterface_PerfSettingsNotificationLevel>` **PERF_SETTINGS_NOTIF_LEVEL_NORMAL** = ``0``
|
||
|
||
The sub-domain has reached a level where no further actions other than currently applied are necessary.
|
||
|
||
.. _class_OpenXRInterface_constant_PERF_SETTINGS_NOTIF_LEVEL_WARNING:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PerfSettingsNotificationLevel<enum_OpenXRInterface_PerfSettingsNotificationLevel>` **PERF_SETTINGS_NOTIF_LEVEL_WARNING** = ``1``
|
||
|
||
The sub-domain has reached an early warning level where the application should start proactive mitigation actions.
|
||
|
||
.. _class_OpenXRInterface_constant_PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`PerfSettingsNotificationLevel<enum_OpenXRInterface_PerfSettingsNotificationLevel>` **PERF_SETTINGS_NOTIF_LEVEL_IMPAIRED** = ``2``
|
||
|
||
The sub-domain has reached a critical level where the application should start drastic mitigation actions.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _enum_OpenXRInterface_HandJointFlags:
|
||
|
||
.. rst-class:: classref-enumeration
|
||
|
||
flags **HandJointFlags**: :ref:`🔗<enum_OpenXRInterface_HandJointFlags>`
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_NONE:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJointFlags<enum_OpenXRInterface_HandJointFlags>` **HAND_JOINT_NONE** = ``0``
|
||
|
||
Aucun drapeau n'est défini.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_ORIENTATION_VALID:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJointFlags<enum_OpenXRInterface_HandJointFlags>` **HAND_JOINT_ORIENTATION_VALID** = ``1``
|
||
|
||
If set, the orientation data is valid, otherwise, the orientation data is unreliable and should not be used.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_ORIENTATION_TRACKED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJointFlags<enum_OpenXRInterface_HandJointFlags>` **HAND_JOINT_ORIENTATION_TRACKED** = ``2``
|
||
|
||
If set, the orientation data comes from tracking data, otherwise, the orientation data contains predicted data.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_POSITION_VALID:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJointFlags<enum_OpenXRInterface_HandJointFlags>` **HAND_JOINT_POSITION_VALID** = ``4``
|
||
|
||
If set, the positional data is valid, otherwise, the positional data is unreliable and should not be used.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_POSITION_TRACKED:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJointFlags<enum_OpenXRInterface_HandJointFlags>` **HAND_JOINT_POSITION_TRACKED** = ``8``
|
||
|
||
If set, the positional data comes from tracking data, otherwise, the positional data contains predicted data.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_LINEAR_VELOCITY_VALID:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJointFlags<enum_OpenXRInterface_HandJointFlags>` **HAND_JOINT_LINEAR_VELOCITY_VALID** = ``16``
|
||
|
||
Si défini, nos données de vitesse linéaire sont valides, sinon, les données de vitesse linéaire sont peu fiables et ne devraient pas être utilisées.
|
||
|
||
.. _class_OpenXRInterface_constant_HAND_JOINT_ANGULAR_VELOCITY_VALID:
|
||
|
||
.. rst-class:: classref-enumeration-constant
|
||
|
||
:ref:`HandJointFlags<enum_OpenXRInterface_HandJointFlags>` **HAND_JOINT_ANGULAR_VELOCITY_VALID** = ``32``
|
||
|
||
Si défini, nos données de vitesse angulaire sont valides, sinon, les données de vitesse angulaire sont peu fiables et ne devraient pas être utilisées.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Descriptions des propriétés
|
||
------------------------------------------------------
|
||
|
||
.. _class_OpenXRInterface_property_display_refresh_rate:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **display_refresh_rate** = ``0.0`` :ref:`🔗<class_OpenXRInterface_property_display_refresh_rate>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_display_refresh_rate**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_display_refresh_rate**\ (\ )
|
||
|
||
The display refresh rate for the current HMD. Only functional if this feature is supported by the OpenXR runtime and after the interface has been initialized.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_property_foveation_dynamic:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **foveation_dynamic** = ``false`` :ref:`🔗<class_OpenXRInterface_property_foveation_dynamic>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_foveation_dynamic**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **get_foveation_dynamic**\ (\ )
|
||
|
||
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.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_property_foveation_level:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`int<class_int>` **foveation_level** = ``0`` :ref:`🔗<class_OpenXRInterface_property_foveation_level>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_foveation_level**\ (\ value\: :ref:`int<class_int>`\ )
|
||
- :ref:`int<class_int>` **get_foveation_level**\ (\ )
|
||
|
||
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.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_property_render_target_size_multiplier:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **render_target_size_multiplier** = ``1.0`` :ref:`🔗<class_OpenXRInterface_property_render_target_size_multiplier>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_render_target_size_multiplier**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_render_target_size_multiplier**\ (\ )
|
||
|
||
The render size multiplier for the current HMD. Must be set before the interface has been initialized.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_property_vrs_min_radius:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **vrs_min_radius** = ``20.0`` :ref:`🔗<class_OpenXRInterface_property_vrs_min_radius>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_vrs_min_radius**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_vrs_min_radius**\ (\ )
|
||
|
||
Le rayon minimal autour du point focal où la pleine qualité est garantie si VRS est utilisé en tant que pourcentage de la taille de l'écran.
|
||
|
||
\ **Note :** Moteurs de rendu Mobile et Forward+ seulement. Nécessite :ref:`Viewport.vrs_mode<class_Viewport_property_vrs_mode>` d'être défini à :ref:`Viewport.VRS_XR<class_Viewport_constant_VRS_XR>`.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_property_vrs_strength:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **vrs_strength** = ``1.0`` :ref:`🔗<class_OpenXRInterface_property_vrs_strength>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_vrs_strength**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_vrs_strength**\ (\ )
|
||
|
||
La force utilisée pour calculer la carte de densité VRS. Plus cette valeur est grande, plus le VRS est notable. Cela améliore la performance au coût de la qualité.
|
||
|
||
\ **Note :** Moteurs de rendu Mobile et Forward+ seulement. Nécessite :ref:`Viewport.vrs_mode<class_Viewport_property_vrs_mode>` d'être défini à :ref:`Viewport.VRS_XR<class_Viewport_constant_VRS_XR>`.
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Descriptions des méthodes
|
||
--------------------------------------------------
|
||
|
||
.. _class_OpenXRInterface_method_get_action_sets:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Array<class_Array>` **get_action_sets**\ (\ ) |const| :ref:`🔗<class_OpenXRInterface_method_get_action_sets>`
|
||
|
||
Renvoie une liste d'ensembles d'actions enregistrés avec Godot (chargés à partir de l'action map durant l'exécution).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_get_available_display_refresh_rates:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Array<class_Array>` **get_available_display_refresh_rates**\ (\ ) |const| :ref:`🔗<class_OpenXRInterface_method_get_available_display_refresh_rates>`
|
||
|
||
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
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_get_hand_joint_angular_velocity:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector3<class_Vector3>` **get_hand_joint_angular_velocity**\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`, joint\: :ref:`HandJoints<enum_OpenXRInterface_HandJoints>`\ ) |const| :ref:`🔗<class_OpenXRInterface_method_get_hand_joint_angular_velocity>`
|
||
|
||
**Obsolète :** Use :ref:`XRHandTracker.get_hand_joint_angular_velocity()<class_XRHandTracker_method_get_hand_joint_angular_velocity>` obtained from :ref:`XRServer.get_tracker()<class_XRServer_method_get_tracker>` instead.
|
||
|
||
Si le suivi des mains est activé, renvoie la vélocité angulaire d'une articulation (``joint``) d'une main (``hand``) comme fourni par OpenXR. Elle est relative à la :ref:`XROrigin3D<class_XROrigin3D>`\ !
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_get_hand_joint_flags:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|bitfield|\[:ref:`HandJointFlags<enum_OpenXRInterface_HandJointFlags>`\] **get_hand_joint_flags**\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`, joint\: :ref:`HandJoints<enum_OpenXRInterface_HandJoints>`\ ) |const| :ref:`🔗<class_OpenXRInterface_method_get_hand_joint_flags>`
|
||
|
||
**Obsolète :** Use :ref:`XRHandTracker.get_hand_joint_flags()<class_XRHandTracker_method_get_hand_joint_flags>` obtained from :ref:`XRServer.get_tracker()<class_XRServer_method_get_tracker>` instead.
|
||
|
||
Si le suivi des mains est activé, renvoie des drapeaux qui nous informent de la validité des données du suivi.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_get_hand_joint_linear_velocity:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector3<class_Vector3>` **get_hand_joint_linear_velocity**\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`, joint\: :ref:`HandJoints<enum_OpenXRInterface_HandJoints>`\ ) |const| :ref:`🔗<class_OpenXRInterface_method_get_hand_joint_linear_velocity>`
|
||
|
||
**Obsolète :** Use :ref:`XRHandTracker.get_hand_joint_linear_velocity()<class_XRHandTracker_method_get_hand_joint_linear_velocity>` obtained from :ref:`XRServer.get_tracker()<class_XRServer_method_get_tracker>` instead.
|
||
|
||
Si le suivi des mains est activé, renvoie la vélocité linéaire d'une articulation (``joint``) d'une main (``hand``) comme fourni par OpenXR. Elle est relative à la :ref:`XROrigin3D<class_XROrigin3D>` sans échelle du monde appliquée !
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_get_hand_joint_position:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Vector3<class_Vector3>` **get_hand_joint_position**\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`, joint\: :ref:`HandJoints<enum_OpenXRInterface_HandJoints>`\ ) |const| :ref:`🔗<class_OpenXRInterface_method_get_hand_joint_position>`
|
||
|
||
**Obsolète :** Use :ref:`XRHandTracker.get_hand_joint_transform()<class_XRHandTracker_method_get_hand_joint_transform>` obtained from :ref:`XRServer.get_tracker()<class_XRServer_method_get_tracker>` instead.
|
||
|
||
Si le suivi des mains est activé, renvoie la position d'une articulation (``joint``) d'une main (``hand``) comme fourni par OpenXR. Elle est relative à la :ref:`XROrigin3D<class_XROrigin3D>` sans échelle du monde appliquée !
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_get_hand_joint_radius:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`float<class_float>` **get_hand_joint_radius**\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`, joint\: :ref:`HandJoints<enum_OpenXRInterface_HandJoints>`\ ) |const| :ref:`🔗<class_OpenXRInterface_method_get_hand_joint_radius>`
|
||
|
||
**Obsolète :** Use :ref:`XRHandTracker.get_hand_joint_radius()<class_XRHandTracker_method_get_hand_joint_radius>` obtained from :ref:`XRServer.get_tracker()<class_XRServer_method_get_tracker>` instead.
|
||
|
||
Si le suivi des mains est activé, renvoie le rayon d'une articulation (``joint``) d'une main (``hand``) comme fourni par OpenXR. Aucune échelle du monde n'est appliquée dessus !
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_get_hand_joint_rotation:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`Quaternion<class_Quaternion>` **get_hand_joint_rotation**\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`, joint\: :ref:`HandJoints<enum_OpenXRInterface_HandJoints>`\ ) |const| :ref:`🔗<class_OpenXRInterface_method_get_hand_joint_rotation>`
|
||
|
||
**Obsolète :** Use :ref:`XRHandTracker.get_hand_joint_transform()<class_XRHandTracker_method_get_hand_joint_transform>` obtained from :ref:`XRServer.get_tracker()<class_XRServer_method_get_tracker>` instead.
|
||
|
||
Si le suivi des mains est activé, renvoie la rotation d'une articulation (``joint``) d'une main (``hand``) comme fourni par OpenXR.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_get_hand_tracking_source:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`HandTrackedSource<enum_OpenXRInterface_HandTrackedSource>` **get_hand_tracking_source**\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`\ ) |const| :ref:`🔗<class_OpenXRInterface_method_get_hand_tracking_source>`
|
||
|
||
**Obsolète :** Use :ref:`XRHandTracker.hand_tracking_source<class_XRHandTracker_property_hand_tracking_source>` obtained from :ref:`XRServer.get_tracker()<class_XRServer_method_get_tracker>` instead.
|
||
|
||
Si le suivi des mains est activé et que la source de suivi des mains est supportée, obtient la source des données de suivi des mains pour la main ``hand``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_get_motion_range:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`HandMotionRange<enum_OpenXRInterface_HandMotionRange>` **get_motion_range**\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`\ ) |const| :ref:`🔗<class_OpenXRInterface_method_get_motion_range>`
|
||
|
||
If handtracking is enabled and motion range is supported, gets the currently configured motion range for ``hand``.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_get_session_state:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`SessionState<enum_OpenXRInterface_SessionState>` **get_session_state**\ (\ ) :ref:`🔗<class_OpenXRInterface_method_get_session_state>`
|
||
|
||
Renvoie l'état actuel de notre session OpenXR.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_is_action_set_active:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **is_action_set_active**\ (\ name\: :ref:`String<class_String>`\ ) |const| :ref:`🔗<class_OpenXRInterface_method_is_action_set_active>`
|
||
|
||
Renvoie ``true`` si l'ensemble d'actions donné est actif.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_is_eye_gaze_interaction_supported:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **is_eye_gaze_interaction_supported**\ (\ ) :ref:`🔗<class_OpenXRInterface_method_is_eye_gaze_interaction_supported>`
|
||
|
||
Returns the capabilities of the eye gaze interaction extension.
|
||
|
||
\ **Note:** This only returns a valid value after OpenXR has been initialized.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_is_foveation_supported:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
: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.
|
||
|
||
\ **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
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_is_hand_interaction_supported:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **is_hand_interaction_supported**\ (\ ) |const| :ref:`🔗<class_OpenXRInterface_method_is_hand_interaction_supported>`
|
||
|
||
Renvoie ``true`` si le profil d'interaction de mains d'OpenXR est pris en charge et activé.
|
||
|
||
\ **Note :** Cela ne renvoie qu'une valeur valide qu'après que OpenXR a été initialisé.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_is_hand_tracking_supported:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
:ref:`bool<class_bool>` **is_hand_tracking_supported**\ (\ ) :ref:`🔗<class_OpenXRInterface_method_is_hand_tracking_supported>`
|
||
|
||
Renvoie ``true`` si le suivi de mains d'OpenXR est pris en charge et activé.
|
||
|
||
\ **Note :** Cela ne renvoie qu'une valeur valide qu'après que OpenXR a été initialisé.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_set_action_set_active:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_action_set_active**\ (\ name\: :ref:`String<class_String>`, active\: :ref:`bool<class_bool>`\ ) :ref:`🔗<class_OpenXRInterface_method_set_action_set_active>`
|
||
|
||
Définit l'ensemble d'actions donné comme actif ou inactif.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_set_cpu_level:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_cpu_level**\ (\ level\: :ref:`PerfSettingsLevel<enum_OpenXRInterface_PerfSettingsLevel>`\ ) :ref:`🔗<class_OpenXRInterface_method_set_cpu_level>`
|
||
|
||
Définit le niveau de performance CPU du périphérique OpenXR.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_set_gpu_level:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_gpu_level**\ (\ level\: :ref:`PerfSettingsLevel<enum_OpenXRInterface_PerfSettingsLevel>`\ ) :ref:`🔗<class_OpenXRInterface_method_set_gpu_level>`
|
||
|
||
Définit le niveau de performance GPU du périphérique OpenXR.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_OpenXRInterface_method_set_motion_range:
|
||
|
||
.. rst-class:: classref-method
|
||
|
||
|void| **set_motion_range**\ (\ hand\: :ref:`Hand<enum_OpenXRInterface_Hand>`, motion_range\: :ref:`HandMotionRange<enum_OpenXRInterface_HandMotionRange>`\ ) :ref:`🔗<class_OpenXRInterface_method_set_motion_range>`
|
||
|
||
If handtracking is enabled and motion range is supported, sets the currently configured motion range for ``hand`` to ``motion_range``.
|
||
|
||
.. |virtual| replace:: :abbr:`virtual (Cette méthode doit typiquement être redéfinie par l'utilisateur pour avoir un effet.)`
|
||
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
||
.. |const| replace:: :abbr:`const (Cette méthode n'a pas d'effets de bord. Elle ne modifie aucune des variables membres de l'instance.)`
|
||
.. |vararg| replace:: :abbr:`vararg (Cette méthode accepte n'importe quel nombre d'arguments après ceux décris ici.)`
|
||
.. |constructor| replace:: :abbr:`constructor (Cette méthode est utilisée pour construire un type.)`
|
||
.. |static| replace:: :abbr:`static (Cette méthode n'a pas besoin d'instance pour être appelée, elle peut donc être directement appelée en utilisant le nom de la classe.)`
|
||
.. |operator| replace:: :abbr:`operator (Cette méthode décrit un opérateur valide à utiliser avec ce type en tant qu'opérande gauche.)`
|
||
.. |bitfield| replace:: :abbr:`BitField (Cette valeur est un nombre entier composé d'un masque de bits des options suivantes.)`
|
||
.. |void| replace:: :abbr:`void (Aucune valeur de retour.)`
|