Package org.lwjgl.openxr

Class MSFTSpatialAnchorPersistence

java.lang.Object

org.lwjgl.openxr.MSFTSpatialAnchorPersistence

public class MSFTSpatialAnchorPersistence
extends Object

The XR_MSFT_spatial_anchor_persistence extension.

This extension allows persistence and retrieval of spatial anchors sharing and localization across application sessions on a device. Spatial anchors persisted during an application session on a device will only be able to be retrieved during sessions of that same application on the same device. This extension requires XR_MSFT_spatial_anchor to also be enabled.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_ERROR_SPATIAL_ANCHOR_NAME_INVALID_MSFT	Extends XrResult.
static final int	XR_ERROR_SPATIAL_ANCHOR_NAME_NOT_FOUND_MSFT	Extends XrResult.
static final int	XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT	XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT
static final String	XR_MSFT_SPATIAL_ANCHOR_PERSISTENCE_EXTENSION_NAME	The extension name.
static final int	XR_MSFT_spatial_anchor_persistence_SPEC_VERSION	The extension specification version.
static final int	XR_OBJECT_TYPE_SPATIAL_ANCHOR_STORE_CONNECTION_MSFT	Extends XrObjectType.
static final int	XR_TYPE_SPATIAL_ANCHOR_FROM_PERSISTED_ANCHOR_CREATE_INFO_MSFT	Extends XrStructureType.
static final int	XR_TYPE_SPATIAL_ANCHOR_PERSISTENCE_INFO_MSFT	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrCreateSpatialAnchorFromPersistedNameMSFT(XrSession session, long spatialAnchorCreateInfo, long spatialAnchor)	Unsafe version of: CreateSpatialAnchorFromPersistedNameMSFT
static int	nxrCreateSpatialAnchorStoreConnectionMSFT(XrSession session, long spatialAnchorStore)	Unsafe version of: CreateSpatialAnchorStoreConnectionMSFT
static int	nxrEnumeratePersistedSpatialAnchorNamesMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore, int spatialAnchorNameCapacityInput, long spatialAnchorNameCountOutput, long spatialAnchorNames)	Unsafe version of: EnumeratePersistedSpatialAnchorNamesMSFT
static int	nxrPersistSpatialAnchorMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore, long spatialAnchorPersistenceInfo)	Unsafe version of: PersistSpatialAnchorMSFT
static int	nxrUnpersistSpatialAnchorMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore, long spatialAnchorPersistenceName)	Unsafe version of: UnpersistSpatialAnchorMSFT
static int	xrClearSpatialAnchorStoreMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore)	Clear all spatial anchors from the spatial anchor store.
static int	xrCreateSpatialAnchorFromPersistedNameMSFT(XrSession session, XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT spatialAnchorCreateInfo, org.lwjgl.PointerBuffer spatialAnchor)	Create a spatial anchor from the spatial anchor store by name.
static int	xrCreateSpatialAnchorStoreConnectionMSFT(XrSession session, org.lwjgl.PointerBuffer spatialAnchorStore)	Create a handle to track a connection to the spatial anchor store.
static int	xrDestroySpatialAnchorStoreConnectionMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore)	Destroys the anchor store handle.
static int	xrEnumeratePersistedSpatialAnchorNamesMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore, IntBuffer spatialAnchorNameCountOutput, @Nullable XrSpatialAnchorPersistenceNameMSFT.Buffer spatialAnchorNames)	Enumerate the names of currently persisted spatial anchors in the spatial anchor store.
static int	xrPersistSpatialAnchorMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore, XrSpatialAnchorPersistenceInfoMSFT spatialAnchorPersistenceInfo)	Persist the spatial anchor in the spatial anchor store.
static int	xrUnpersistSpatialAnchorMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore, XrSpatialAnchorPersistenceNameMSFT spatialAnchorPersistenceName)	Removes an anchor from the store.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

XR_MSFT_spatial_anchor_persistence_SPEC_VERSION

public static final int XR_MSFT_spatial_anchor_persistence_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_MSFT_SPATIAL_ANCHOR_PERSISTENCE_EXTENSION_NAME

public static final String XR_MSFT_SPATIAL_ANCHOR_PERSISTENCE_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_OBJECT_TYPE_SPATIAL_ANCHOR_STORE_CONNECTION_MSFT

public static final int XR_OBJECT_TYPE_SPATIAL_ANCHOR_STORE_CONNECTION_MSFT

Extends XrObjectType.

See Also:

• Constant Field Values

XR_TYPE_SPATIAL_ANCHOR_PERSISTENCE_INFO_MSFT

public static final int XR_TYPE_SPATIAL_ANCHOR_PERSISTENCE_INFO_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SPATIAL_ANCHOR_PERSISTENCE_INFO_MSFT
• TYPE_SPATIAL_ANCHOR_FROM_PERSISTED_ANCHOR_CREATE_INFO_MSFT

See Also:

• Constant Field Values

XR_TYPE_SPATIAL_ANCHOR_FROM_PERSISTED_ANCHOR_CREATE_INFO_MSFT

public static final int XR_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

See Also:

• Constant Field Values

XR_ERROR_SPATIAL_ANCHOR_NAME_NOT_FOUND_MSFT

public static final int XR_ERROR_SPATIAL_ANCHOR_NAME_NOT_FOUND_MSFT

Extends XrResult.

Enum values:

• ERROR_SPATIAL_ANCHOR_NAME_NOT_FOUND_MSFT
• ERROR_SPATIAL_ANCHOR_NAME_INVALID_MSFT

See Also:

• Constant Field Values

XR_ERROR_SPATIAL_ANCHOR_NAME_INVALID_MSFT

public static final int XR_ERROR_SPATIAL_ANCHOR_NAME_INVALID_MSFT

Extends XrResult.

Enum values:

• ERROR_SPATIAL_ANCHOR_NAME_NOT_FOUND_MSFT
• ERROR_SPATIAL_ANCHOR_NAME_INVALID_MSFT

See Also:

• Constant Field Values

XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT

public static final int XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT

XR_MAX_SPATIAL_ANCHOR_NAME_SIZE_MSFT

See Also:

• Constant Field Values

Method Details

nxrCreateSpatialAnchorStoreConnectionMSFT

public static int nxrCreateSpatialAnchorStoreConnectionMSFT(XrSession session,
 long spatialAnchorStore)

Unsafe version of: CreateSpatialAnchorStoreConnectionMSFT

xrCreateSpatialAnchorStoreConnectionMSFT

public static int xrCreateSpatialAnchorStoreConnectionMSFT(XrSession session,
 org.lwjgl.PointerBuffer spatialAnchorStore)

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 - the XrSession the anchor was created with.

spatialAnchorStore - a pointer to the XrSpatialAnchorStoreConnectionMSFT handle.

xrDestroySpatialAnchorStoreConnectionMSFT

public static int xrDestroySpatialAnchorStoreConnectionMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore)

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 - the XrSpatialAnchorStoreConnectionMSFT to be destroyed.

nxrPersistSpatialAnchorMSFT

public static int nxrPersistSpatialAnchorMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore,
 long spatialAnchorPersistenceInfo)

Unsafe version of: PersistSpatialAnchorMSFT

xrPersistSpatialAnchorMSFT

public static int xrPersistSpatialAnchorMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore,
 XrSpatialAnchorPersistenceInfoMSFT spatialAnchorPersistenceInfo)

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 XrSpatialAnchorPersistenceInfoMSFT::spatialAnchorPersistenceName 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 - the XrSpatialAnchorStoreConnectionMSFT with which to persist the XrSpatialAnchorPersistenceInfoMSFT::spatialAnchor.

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

nxrEnumeratePersistedSpatialAnchorNamesMSFT

public static int nxrEnumeratePersistedSpatialAnchorNamesMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore,
 int spatialAnchorNameCapacityInput,
 long spatialAnchorNameCountOutput,
 long spatialAnchorNames)

Unsafe version of: EnumeratePersistedSpatialAnchorNamesMSFT

Parameters:

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

xrEnumeratePersistedSpatialAnchorNamesMSFT

public static int xrEnumeratePersistedSpatialAnchorNamesMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore,
 IntBuffer spatialAnchorNameCountOutput,
 @Nullable XrSpatialAnchorPersistenceNameMSFT.Buffer spatialAnchorNames)

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                                    spatialAnchorNameCapacityInput,
     uint32_t*                                   spatialAnchorNameCountOutput,
     XrSpatialAnchorPersistenceNameMSFT*         spatialAnchorNames);

Valid Usage (Implicit)

• The XR_MSFT_spatial_anchor_persistence extension must be enabled prior to calling EnumeratePersistedSpatialAnchorNamesMSFT
• spatialAnchorStore must be a valid XrSpatialAnchorStoreConnectionMSFT handle
• spatialAnchorNameCountOutput must be a pointer to a uint32_t value
• If spatialAnchorNameCapacityInput is not 0, spatialAnchorNames must be a pointer to an array of spatialAnchorNameCapacityInput 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 - the XrSpatialAnchorStoreConnectionMSFT anchor store to perform the enumeration operation on.

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

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

nxrCreateSpatialAnchorFromPersistedNameMSFT

public static int nxrCreateSpatialAnchorFromPersistedNameMSFT(XrSession session,
 long spatialAnchorCreateInfo,
 long spatialAnchor)

Unsafe version of: CreateSpatialAnchorFromPersistedNameMSFT

xrCreateSpatialAnchorFromPersistedNameMSFT

public static int xrCreateSpatialAnchorFromPersistedNameMSFT(XrSession session,
 XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT spatialAnchorCreateInfo,
 org.lwjgl.PointerBuffer spatialAnchor)

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 XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT::spatialAnchorPersistenceName 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 - a handle to an XrSession previously created with CreateSession.

spatialAnchorCreateInfo - a pointer to the XrSpatialAnchorFromPersistedAnchorCreateInfoMSFT.

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

nxrUnpersistSpatialAnchorMSFT

public static int nxrUnpersistSpatialAnchorMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore,
 long spatialAnchorPersistenceName)

Unsafe version of: UnpersistSpatialAnchorMSFT

xrUnpersistSpatialAnchorMSFT

public static int xrUnpersistSpatialAnchorMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore,
 XrSpatialAnchorPersistenceNameMSFT spatialAnchorPersistenceName)

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 spatialAnchorPersistenceName 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 - an XrSpatialAnchorStoreConnectionMSFT anchor store to perform the unpersist operation on.

spatialAnchorPersistenceName - a pointer to the XrSpatialAnchorPersistenceNameMSFT.

xrClearSpatialAnchorStoreMSFT

public static int xrClearSpatialAnchorStoreMSFT(XrSpatialAnchorStoreConnectionMSFT spatialAnchorStore)

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 to perform the clear operation on.