public Class MSFTSpatialAnchorPersistence

Extends XrResult.

Enum values:

• ERROR_SPATIAL_ANCHOR_NAME_NOT_FOUND_MSFT
• ERROR_SPATIAL_ANCHOR_NAME_INVALID_MSFT

Extends XrResult.

Enum values:

• ERROR_SPATIAL_ANCHOR_NAME_NOT_FOUND_MSFT
• ERROR_SPATIAL_ANCHOR_NAME_INVALID_MSFT

XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT

The extension name.

The extension specification version.

Extends XrObjectType.

Extends XrStructureType.

Enum values:

• TYPE_SPATIAL_ANCHOR_PERSISTENCE_INFO_MSFT
• TYPE_SPATIAL_ANCHOR_FROM_PERSISTED_ANCHOR_CREATE_INFO_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SPATIAL_ANCHOR_PERSISTENCE_INFO_MSFT
• TYPE_SPATIAL_ANCHOR_FROM_PERSISTED_ANCHOR_CREATE_INFO_MSFT

Unsafe version of: CreateSpatialAnchorFromPersistedNameMSFT

Unsafe version of: CreateSpatialAnchorStoreConnectionMSFT

Unsafe version of: EnumeratePersistedSpatialAnchorNamesMSFT

Parameters

spatialAnchorNamesCapacityInput:int

the capacity of the spatialAnchorNames array, or 0 to indicate a request to retrieve the required capacity.

Unsafe version of: PersistSpatialAnchorMSFT

Unsafe version of: UnpersistSpatialAnchorMSFT

Clear all spatial anchors from the spatial anchor store.

C Specification

The application can use the ClearSpatialAnchorStoreMSFT function to remove all spatial anchors from the spatial anchor store for this application. The function only removes the record of the spatial anchors in the store but does not affect any XrSpatialAnchorMSFT handles previously loaded in the current session.

XrResult xrClearSpatialAnchorStoreMSFT(
    XrSpatialAnchorStoreConnectionMSFT          spatialAnchorStore);

Valid Usage (Implicit)

• The XR_MSFT_spatial_anchor_persistence extension must be enabled prior to calling ClearSpatialAnchorStoreMSFT
• spatialAnchorStore must be a valid XrSpatialAnchorStoreConnectionMSFT handle

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_OUT_OF_MEMORY

Parameters

spatialAnchorStore:XrSpatialAnchorStoreConnectionMSFT

XrSpatialAnchorStoreConnectionMSFT to perform the clear operation on.

Annotations

@NativeType:XrResult

Create a spatial anchor from the spatial anchor store by name.

C Specification

The application can use the CreateSpatialAnchorFromPersistedNameMSFT function to create a XrSpatialAnchorMSFT from the spatial anchor store. If the spatialAnchorName provided does not correspond to a currently stored anchor (i.e. the list of spatial anchor names returned from EnumeratePersistedSpatialAnchorNamesMSFT), the function must return ERROR_SPATIAL_ANCHOR_NAME_NOT_FOUND_MSFT.

XrResult xrCreateSpatialAnchorFromPersistedNameMSFT(
    XrSession                                   session,
    const XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT* spatialAnchorCreateInfo,
    XrSpatialAnchorMSFT*                        spatialAnchor);

Valid Usage (Implicit)

• The XR_MSFT_spatial_anchor_persistence extension must be enabled prior to calling CreateSpatialAnchorFromPersistedNameMSFT
• session must be a valid XrSession handle
• spatialAnchorCreateInfo must be a pointer to a valid XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT structure
• spatialAnchor must be a pointer to an XrSpatialAnchorMSFT handle

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED
• ERROR_SPATIAL_ANCHOR_NAME_NOT_FOUND_MSFT
• ERROR_SPATIAL_ANCHOR_NAME_INVALID_MSFT

See Also

XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT

Parameters

session:XrSession

a handle to an XrSession previously created with CreateSession.

spatialAnchorCreateInfo:XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT

a pointer to the XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.

spatialAnchor:PointerBuffer

a pointer to an XrSpatialAnchorMSFT handle that will be set by the runtime on successful load.

Annotations

@NativeType:XrResult

Create a handle to track a connection to the spatial anchor store.

C Specification

The application can use the CreateSpatialAnchorStoreConnectionMSFT function to create an handle to the spatial anchor store. The application can use this handle to interact with the spatial anchor store in order to persist anchors across application sessions.

The CreateSpatialAnchorStoreConnectionMSFT function may be a slow operation and therefore should be invoked from a non-timing critical thread.

XrResult xrCreateSpatialAnchorStoreConnectionMSFT(
    XrSession                                   session,
    XrSpatialAnchorStoreConnectionMSFT*         spatialAnchorStore);

Valid Usage (Implicit)

• The XR_MSFT_spatial_anchor_persistence extension must be enabled prior to calling CreateSpatialAnchorStoreConnectionMSFT
• session must be a valid XrSession handle
• spatialAnchorStore must be a pointer to an XrSpatialAnchorStoreConnectionMSFT handle

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED

Parameters

session:XrSession

the XrSession the anchor was created with.

spatialAnchorStore:PointerBuffer

a pointer to the XrSpatialAnchorStoreConnectionMSFT handle.

Annotations

@NativeType:XrResult

Destroys the anchor store handle.

C Specification

The application can use the DestroySpatialAnchorStoreConnectionMSFT function to destroy an anchor store connection.

XrResult xrDestroySpatialAnchorStoreConnectionMSFT(
    XrSpatialAnchorStoreConnectionMSFT          spatialAnchorStore);

Valid Usage (Implicit)

• The XR_MSFT_spatial_anchor_persistence extension must be enabled prior to calling DestroySpatialAnchorStoreConnectionMSFT
• spatialAnchorStore must be a valid XrSpatialAnchorStoreConnectionMSFT handle

Thread Safety

• Access to spatialAnchorStore, and any child handles, must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_HANDLE_INVALID
• ERROR_OUT_OF_MEMORY

Parameters

spatialAnchorStore:XrSpatialAnchorStoreConnectionMSFT

the XrSpatialAnchorStoreConnectionMSFT to be destroyed.

Annotations

@NativeType:XrResult

Enumerate the names of currently persisted spatial anchors in the spatial anchor store.

C Specification

The application can use the EnumeratePersistedSpatialAnchorNamesMSFT function to enumerate the names of all spatial anchors currently persisted in the spatial anchor store for this application. This function follows the two-call idiom for filling the spatialAnchorNames.

XrResult xrEnumeratePersistedSpatialAnchorNamesMSFT(
    XrSpatialAnchorStoreConnectionMSFT          spatialAnchorStore,
    uint32_t                                    spatialAnchorNamesCapacityInput,
    uint32_t*                                   spatialAnchorNamesCountOutput,
    XrSpatialAnchorPersistenceNameMSFT*         persistedAnchorNames);

Valid Usage (Implicit)

• The XR_MSFT_spatial_anchor_persistence extension must be enabled prior to calling EnumeratePersistedSpatialAnchorNamesMSFT
• spatialAnchorStore must be a valid XrSpatialAnchorStoreConnectionMSFT handle
• If spatialAnchorNamesCountOutput is not NULL, spatialAnchorNamesCountOutput must be a pointer to a uint32_t value
• If spatialAnchorNamesCapacityInput is not 0, persistedAnchorNames must be a pointer to an array of spatialAnchorNamesCapacityInput XrSpatialAnchorPersistenceNameMSFT structures

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_OUT_OF_MEMORY
• ERROR_SIZE_INSUFFICIENT

See Also

XrSpatialAnchorPersistenceNameMSFT

Parameters

spatialAnchorStore:XrSpatialAnchorStoreConnectionMSFT

the XrSpatialAnchorStoreConnectionMSFT anchor store to perform the enumeration operation on.

spatialAnchorNamesCountOutput:IntBuffer

filled in by the runtime with the count of anchor names written or the required capacity in the case that spatialAnchorNamesCapacityInput is insufficient.

persistedAnchorNames:XrSpatialAnchorPersistenceNameMSFT.Buffer

a pointer to an array of XrSpatialAnchorPersistenceNameMSFT structures, but can be NULL if propertyCapacityInput is 0.

Annotations

@NativeType:XrResult

Persist the spatial anchor in the spatial anchor store.

C Specification

The application can use the PersistSpatialAnchorMSFT function to persist a spatial anchor in the spatial anchor store for this application. The given spatialAnchorName will be the string to retrieve the spatial anchor from the Spatial Anchor store or subsequently remove the record of this spatial anchor from the store. This name will uniquely identify the spatial anchor for the current application. If there is already a spatial anchor of the same name persisted in the spatial anchor store, the existing spatial anchor will be replaced and PersistSpatialAnchorMSFT must return SUCCESS.

XrResult xrPersistSpatialAnchorMSFT(
    XrSpatialAnchorStoreConnectionMSFT          spatialAnchorStore,
    const XrSpatialAnchorPersistenceInfoMSFT*   spatialAnchorPersistenceInfo);

Valid Usage (Implicit)

• The XR_MSFT_spatial_anchor_persistence extension must be enabled prior to calling PersistSpatialAnchorMSFT
• spatialAnchorStore must be a valid XrSpatialAnchorStoreConnectionMSFT handle
• spatialAnchorPersistenceInfo must be a pointer to a valid XrSpatialAnchorPersistenceInfoMSFT structure

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_OUT_OF_MEMORY
• ERROR_SPATIAL_ANCHOR_NAME_INVALID_MSFT

See Also

XrSpatialAnchorPersistenceInfoMSFT

Parameters

spatialAnchorStore:XrSpatialAnchorStoreConnectionMSFT

the XrSpatialAnchorStoreConnectionMSFT with which to persist the spatialAnchor.

spatialAnchorPersistenceInfo:XrSpatialAnchorPersistenceInfoMSFT

a pointer to XrSpatialAnchorPersistenceInfoMSFT structure to specify the anchor and its name to persist.

Annotations

@NativeType:XrResult

Removes an anchor from the store.

C Specification

The application can use the UnpersistSpatialAnchorMSFT function to remove the record of the anchor in the spatial anchor store. This operation will not affect any XrSpatialAnchorMSFT handles previously created. If the spatialAnchorName provided does not correspond to a currently stored anchor, the function must return ERROR_SPATIAL_ANCHOR_NAME_NOT_FOUND_MSFT.

XrResult xrUnpersistSpatialAnchorMSFT(
    XrSpatialAnchorStoreConnectionMSFT          spatialAnchorStore,
    const XrSpatialAnchorPersistenceNameMSFT*   spatialAnchorPersistenceName);

Valid Usage (Implicit)

• The XR_MSFT_spatial_anchor_persistence extension must be enabled prior to calling UnpersistSpatialAnchorMSFT
• spatialAnchorStore must be a valid XrSpatialAnchorStoreConnectionMSFT handle
• spatialAnchorPersistenceName must be a pointer to a valid XrSpatialAnchorPersistenceNameMSFT structure

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_OUT_OF_MEMORY
• ERROR_SPATIAL_ANCHOR_NAME_NOT_FOUND_MSFT
• ERROR_SPATIAL_ANCHOR_NAME_INVALID_MSFT

See Also

XrSpatialAnchorPersistenceNameMSFT

Parameters

spatialAnchorStore:XrSpatialAnchorStoreConnectionMSFT

an XrSpatialAnchorStoreConnectionMSFT anchor store to perform the unpersist operation on.

spatialAnchorPersistenceName:XrSpatialAnchorPersistenceNameMSFT

a pointer to the XrSpatialAnchorPersistenceNameMSFT.

Annotations

@NativeType:XrResult