XrCreateSpatialPersistenceContextCompletionEXT(3)

C Specification

The XrCreateSpatialPersistenceContextCompletionEXT structure is defined as:

// Provided by XR_EXT_spatial_persistence
typedef struct XrCreateSpatialPersistenceContextCompletionEXT {
    XrStructureType                         type;
    void*                                   next;
    XrResult                                futureResult;
    XrSpatialPersistenceContextResultEXT    createResult;
    XrSpatialPersistenceContextEXT          persistenceContext;
} XrCreateSpatialPersistenceContextCompletionEXT;

Members

Member Descriptions

type is the XrStructureType of this structure.
next is NULL or a pointer to the next structure in a structure chain.
futureResult is the XrResult of the spatial persistence context creation operation.
createResult is the XrSpatialPersistenceContextResultEXT of the spatial persistence context creation operation.
persistenceContext is an XrSpatialPersistenceContextEXT created using the data and configuration in xrCreateSpatialPersistenceContextAsyncEXT::createInfo.

Description

Future Return Codes

futureResult values:

Success

XR_SUCCESS
XR_SESSION_LOSS_PENDING

Failure

XR_ERROR_RUNTIME_FAILURE
XR_ERROR_INSTANCE_LOST
XR_ERROR_SESSION_LOST
XR_ERROR_OUT_OF_MEMORY
XR_ERROR_LIMIT_REACHED
XR_ERROR_PERMISSION_INSUFFICIENT

If futureResult and createResult are both success codes, persistenceContext must be valid. If persistenceContext is valid, it must remain so within the lifecycle of xrCreateSpatialPersistenceContextAsyncEXT::session or until the application uses xrDestroySpatialPersistenceContextEXT with persistenceContext, whichever comes first.

The runtime must set createResult only if futureResult is a success code.

Valid Usage (Implicit)

The XR_EXT_spatial_persistence extension must be enabled prior to using XrCreateSpatialPersistenceContextCompletionEXT
type must be XR_TYPE_CREATE_SPATIAL_PERSISTENCE_CONTEXT_COMPLETION_EXT
next must be NULL or a valid pointer to the next structure in a structure chain
futureResult must be a valid XrResult value
createResult must be a valid XrSpatialPersistenceContextResultEXT value
persistenceContext must be a valid XrSpatialPersistenceContextEXT handle

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

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

XrCreateSpatialPersistenceContextCompletionEXT(3) Manual Page

Name

C Specification

Members

Description

See Also

Document Notes

Copyright