44 lines
2.2 KiB
XML
44 lines
2.2 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="OpenXRFutureExtension" inherits="OpenXRExtensionWrapper" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
|
|
<brief_description>
|
|
The OpenXR Future extension allows for asynchronous APIs to be used.
|
|
</brief_description>
|
|
<description>
|
|
This is a support extension in OpenXR that allows other OpenXR extensions to start asynchronous functions and get a callback after this function finishes. It is not intended for consumption within GDScript but can be accessed from GDExtension.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="cancel_future">
|
|
<return type="void" />
|
|
<param index="0" name="future" type="int" />
|
|
<description>
|
|
Cancels an in-progress future. [param future] must be an [code]XrFutureEXT[/code] value previously returned by an API that started an asynchronous function.
|
|
</description>
|
|
</method>
|
|
<method name="is_active" qualifiers="const">
|
|
<return type="bool" />
|
|
<description>
|
|
Returns [code]true[/code] if futures are available in the OpenXR runtime used. This function will only return a usable result after OpenXR has been initialized.
|
|
</description>
|
|
</method>
|
|
<method name="register_future">
|
|
<return type="OpenXRFutureResult" />
|
|
<param index="0" name="future" type="int" />
|
|
<param index="1" name="on_success" type="Callable" default="Callable()" />
|
|
<description>
|
|
Register an OpenXR Future object so we monitor for completion. [param future] must be an [code]XrFutureEXT[/code] value previously returned by an API that started an asynchronous function.
|
|
You can optionally specify [param on_success], it will be invoked on successful completion of the future.
|
|
Or you can use the returned [OpenXRFutureResult] object to [code]await[/code] its [signal OpenXRFutureResult.completed] signal.
|
|
[codeblock]
|
|
var future_result = OpenXRFutureExtension.register_future(future)
|
|
await future_result.completed
|
|
if future_result.get_status() == OpenXRFutureResult.RESULT_FINISHED:
|
|
# Handle your success
|
|
pass
|
|
[/codeblock]
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
</class>
|