mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-04 14:11:02 +03:00
145 lines
4.9 KiB
ReStructuredText
145 lines
4.9 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. DO NOT EDIT THIS FILE!!!
|
|
.. Generated automatically from Godot engine sources.
|
|
.. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
|
|
.. XML source: https://github.com/godotengine/godot/tree/master/modules/openxr/doc_classes/OpenXRFutureResult.xml.
|
|
|
|
.. _class_OpenXRFutureResult:
|
|
|
|
OpenXRFutureResult
|
|
==================
|
|
|
|
**Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
|
|
|
Result object tracking the asynchronous result of an OpenXR Future object.
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
Description
|
|
-----------
|
|
|
|
Result object tracking the asynchronous result of an OpenXR Future object, you can use this object to track the result status.
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
Methods
|
|
-------
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-----------------------------------------------------------+-----------------------------------------------------------------------------+
|
|
| |void| | :ref:`cancel_future<class_OpenXRFutureResult_method_cancel_future>`\ (\ ) |
|
|
+-----------------------------------------------------------+-----------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_future<class_OpenXRFutureResult_method_get_future>`\ (\ ) |const| |
|
|
+-----------------------------------------------------------+-----------------------------------------------------------------------------+
|
|
| :ref:`ResultStatus<enum_OpenXRFutureResult_ResultStatus>` | :ref:`get_status<class_OpenXRFutureResult_method_get_status>`\ (\ ) |const| |
|
|
+-----------------------------------------------------------+-----------------------------------------------------------------------------+
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Signals
|
|
-------
|
|
|
|
.. _class_OpenXRFutureResult_signal_completed:
|
|
|
|
.. rst-class:: classref-signal
|
|
|
|
**completed**\ (\ result\: :ref:`OpenXRFutureResult<class_OpenXRFutureResult>`\ ) :ref:`🔗<class_OpenXRFutureResult_signal_completed>`
|
|
|
|
Emitted when the asynchronous function is finished or has been cancelled.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Enumerations
|
|
------------
|
|
|
|
.. _enum_OpenXRFutureResult_ResultStatus:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **ResultStatus**: :ref:`🔗<enum_OpenXRFutureResult_ResultStatus>`
|
|
|
|
.. _class_OpenXRFutureResult_constant_RESULT_RUNNING:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ResultStatus<enum_OpenXRFutureResult_ResultStatus>` **RESULT_RUNNING** = ``0``
|
|
|
|
The asynchronous function is running.
|
|
|
|
.. _class_OpenXRFutureResult_constant_RESULT_FINISHED:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ResultStatus<enum_OpenXRFutureResult_ResultStatus>` **RESULT_FINISHED** = ``1``
|
|
|
|
The asynchronous function has finished.
|
|
|
|
.. _class_OpenXRFutureResult_constant_RESULT_CANCELLED:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`ResultStatus<enum_OpenXRFutureResult_ResultStatus>` **RESULT_CANCELLED** = ``2``
|
|
|
|
The asynchronous function has been cancelled.
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
Method Descriptions
|
|
-------------------
|
|
|
|
.. _class_OpenXRFutureResult_method_cancel_future:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
|void| **cancel_future**\ (\ ) :ref:`🔗<class_OpenXRFutureResult_method_cancel_future>`
|
|
|
|
Cancel this future, this will interrupt and stop the asynchronous function.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_OpenXRFutureResult_method_get_future:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`int<class_int>` **get_future**\ (\ ) |const| :ref:`🔗<class_OpenXRFutureResult_method_get_future>`
|
|
|
|
Return the ``XrFutureEXT`` value this result relates to.
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_OpenXRFutureResult_method_get_status:
|
|
|
|
.. rst-class:: classref-method
|
|
|
|
:ref:`ResultStatus<enum_OpenXRFutureResult_ResultStatus>` **get_status**\ (\ ) |const| :ref:`🔗<class_OpenXRFutureResult_method_get_status>`
|
|
|
|
Returns the status of this result.
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
|
|
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
|
|
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
|
|
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
|
|
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
|
|
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
|
.. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
|
|
.. |void| replace:: :abbr:`void (No return value.)`
|