C Specification

The XrPersistSpatialEntityCompletionEXT structure is defined as:

// Provided by XR_EXT_spatial_persistence_operations
typedef struct XrPersistSpatialEntityCompletionEXT {
    XrStructureType                         type;
    void*                                   next;
    XrResult                                futureResult;
    XrSpatialPersistenceContextResultEXT    persistResult;
    XrUuid                                  persistUuid;
} XrPersistSpatialEntityCompletionEXT;

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 entity persist operation.

  • persistResult is the XrSpatialPersistenceContextResultEXT of the spatial entity persist operation.

  • persistUuid is an XrUuid that the application can use to identify the persisted spatial entity across sessions.

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

If futureResult and persistResult are both success codes, persistUuid must be valid and the application can use it to identify the persisted spatial entity across sessions.

The runtime must set persistResult to XR_SPATIAL_PERSISTENCE_CONTEXT_RESULT_ENTITY_NOT_TRACKING_EXT if it lost tracking of the entity represented by XrSpatialEntityPersistInfoEXT::spatialEntityId before it could be successfully persisted.

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

Valid Usage (Implicit)

See Also

XR_EXT_spatial_persistence_operations, XrResult, XrSpatialPersistenceContextResultEXT, XrStructureType, XrUuid, xrPersistSpatialEntityAsyncEXT, xrPersistSpatialEntityCompleteEXT

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.