Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

OpenXRFutureResult

Inherits: RefCounted < Object

Result object tracking the asynchronous result of an OpenXR Future object.

Description

Result object tracking the asynchronous result of an OpenXR Future object, you can use this object to track the result status.

Methods

void

cancel_future()

int

get_future() const

ResultStatus

get_status() const


Signals

completed(result: OpenXRFutureResult) 🔗

Emitted when the asynchronous function is finished or has been cancelled.


Enumerations

enum ResultStatus: 🔗

ResultStatus RESULT_RUNNING = 0

The asynchronous function is running.

ResultStatus RESULT_FINISHED = 1

The asynchronous function has finished.

ResultStatus RESULT_CANCELLED = 2

The asynchronous function has been cancelled.


Method Descriptions

void cancel_future() 🔗

Cancel this future, this will interrupt and stop the asynchronous function.


int get_future() const 🔗

Return the XrFutureEXT value this result relates to.


ResultStatus get_status() const 🔗

Returns the status of this result.


User-contributed notes

Please read the User-contributed notes policy before submitting a comment.