Files
godot-docs-l10n/classes/es/class_openxrfutureextension.rst

97 lines
5.4 KiB
ReStructuredText

:github_url: hide
.. _class_OpenXRFutureExtension:
OpenXRFutureExtension
=====================
**Hereda:** :ref:`OpenXRExtensionWrapper<class_OpenXRExtensionWrapper>` **<** :ref:`Object<class_Object>`
La extensión OpenXR Future permite el uso de APIs asíncronas.
.. rst-class:: classref-introduction-group
Descripción
----------------------
Esta es una extensión de soporte en OpenXR que permite a otras extensiones de OpenXR iniciar funciones asíncronas y obtener una devolución de llamada después de que esta función termine. No está destinada al consumo dentro de GDScript, pero se puede acceder a ella desde GDExtension.
.. rst-class:: classref-reftable-group
Métodos
--------------
.. table::
:widths: auto
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`cancel_future<class_OpenXRFutureExtension_method_cancel_future>`\ (\ future\: :ref:`int<class_int>`\ ) |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_active<class_OpenXRFutureExtension_method_is_active>`\ (\ ) |const| |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`OpenXRFutureResult<class_OpenXRFutureResult>` | :ref:`register_future<class_OpenXRFutureExtension_method_register_future>`\ (\ future\: :ref:`int<class_int>`, on_success\: :ref:`Callable<class_Callable>` = Callable()\ ) |
+-----------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Descripciones de Métodos
------------------------------------------------
.. _class_OpenXRFutureExtension_method_cancel_future:
.. rst-class:: classref-method
|void| **cancel_future**\ (\ future\: :ref:`int<class_int>`\ ) :ref:`🔗<class_OpenXRFutureExtension_method_cancel_future>`
Cancela un futuro en curso. ``future`` debe ser un valor ``XrFutureEXT`` devuelto previamente por una API que inició una función asíncrona.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRFutureExtension_method_is_active:
.. rst-class:: classref-method
:ref:`bool<class_bool>` **is_active**\ (\ ) |const| :ref:`🔗<class_OpenXRFutureExtension_method_is_active>`
Returns ``true`` if futures are available in the OpenXR runtime used. This function will only return a usable result after OpenXR has been initialized.
.. rst-class:: classref-item-separator
----
.. _class_OpenXRFutureExtension_method_register_future:
.. rst-class:: classref-method
:ref:`OpenXRFutureResult<class_OpenXRFutureResult>` **register_future**\ (\ future\: :ref:`int<class_int>`, on_success\: :ref:`Callable<class_Callable>` = Callable()\ ) :ref:`🔗<class_OpenXRFutureExtension_method_register_future>`
Registra un objeto Future de OpenXR para que podamos monitorizar su finalización. ``future`` debe ser un valor ``XrFutureEXT`` devuelto previamente por una API que inició una función asíncrona.
Opcionalmente, puedes especificar ``on_success``, que se invocará al finalizar correctamente el futuro.
O puedes utilizar el objeto :ref:`OpenXRFutureResult<class_OpenXRFutureResult>` devuelto para ``await`` su señal :ref:`OpenXRFutureResult.completed<class_OpenXRFutureResult_signal_completed>`.
::
var future_result = OpenXRFutureExtension.register_future(future)
await future_result.completed
if future_result.get_status() == OpenXRFutureResult.RESULT_FINISHED:
# Maneja tu éxito
pass
.. |virtual| replace:: :abbr:`virtual (Normalmente, este método debería ser sobreescrito por el usuario para que tenga algún efecto.)`
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
.. |const| replace:: :abbr:`const (Este método no tiene efectos secundarios. No modifica ninguna de las variables miembro de la instancia.)`
.. |vararg| replace:: :abbr:`vararg (Este método permite agregar cualquier número de argumentos después de los descritos aquí.)`
.. |constructor| replace:: :abbr:`constructor (Este método se utiliza para construir un tipo.)`
.. |static| replace:: :abbr:`static (Este método no necesita una instancia para ser llamado, por lo que puede llamarse directamente utilizando el nombre de la clase.)`
.. |operator| replace:: :abbr:`operator (Este método describe un operador válido para usar con este tipo como operando izquierdo.)`
.. |bitfield| replace:: :abbr:`BitField (Este valor es un entero compuesto como una máscara de bits de las siguientes banderas.)`
.. |void| replace:: :abbr:`void (Sin valor de retorno.)`