C Specification

The XrFuturePollResultProgressBD structure is defined as:

// Provided by XR_BD_future_progress
typedef struct XrFuturePollResultProgressBD {
    XrStructureType    type;
    void*              next;
    XrBool32           isSupported;
    uint32_t           progressPercentage;
} XrFuturePollResultProgressBD;

Members

Member Descriptions

  • type is the XrStructureType of this structure.

  • next is NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.

  • isSupported is a boolean value indicating whether reporting progress is supported for this future.

  • progressPercentage is the progress percentage of the future.

Description

As defined in XR_EXT_future, an XrFutureEXT is returned by a successful call to an asynchronous function.

Applications can use xrPollFutureEXT to check the current state of a future, typically while waiting for the async operation to complete and the future to become "ready" to complete. An XrFuturePollResultEXT structure is used to return the result of xrPollFutureEXT.

With this extension, the application can chain an XrFuturePollResultProgressBD to XrFuturePollResultEXT::next to get a rough progress percentage of the asynchronous operation.

If the runtime does not support reporting progress for a specific future, it must set isSupported to false. And in this case, the application should ignore the value of progressPercentage. If the runtime supports reporting progress for the specific future, it must set isSupported to true. The progressPercentage is only valid when the future is in either the XR_FUTURE_STATE_PENDING_EXT or XR_FUTURE_STATE_READY_EXT state.

The runtime must not set progressPercentage to a value less than 0 or greater than 100. The runtime must set progressPercentage to 100 if the future is in the state XR_FUTURE_STATE_READY_EXT.

Valid Usage (Implicit)

See Also

XR_BD_future_progress, XrBool32, XrFuturePollResultEXT, XrStructureType, xrPollFutureEXT

Document Notes

For more information, see the OpenXR Specification

This page is extracted from the OpenXR Specification. Fixes and changes should be made to the Specification, not directly.

Copyright

Copyright 2014-2025 The Khronos Group Inc.

This work is licensed under a Creative Commons Attribution 4.0 International License.