public Class MSFTSpatialAnchor

Extends XrResult.

The extension name.

The extension specification version.

Extends XrObjectType.

Extends XrStructureType.

Enum values:

• TYPE_SPATIAL_ANCHOR_CREATE_INFO_MSFT
• TYPE_SPATIAL_ANCHOR_SPACE_CREATE_INFO_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SPATIAL_ANCHOR_CREATE_INFO_MSFT
• TYPE_SPATIAL_ANCHOR_SPACE_CREATE_INFO_MSFT

Unsafe version of: CreateSpatialAnchorMSFT

Unsafe version of: CreateSpatialAnchorSpaceMSFT

Creates a spatial anchor.

C Specification

The CreateSpatialAnchorMSFT function is defined as:

XrResult xrCreateSpatialAnchorMSFT(
    XrSession                                   session,
    const XrSpatialAnchorCreateInfoMSFT*        createInfo,
    XrSpatialAnchorMSFT*                        anchor);

Description

Creates an XrSpatialAnchorMSFT handle representing a spatial anchor that will track a fixed location in the physical world over time. That real-world location is specified by the position and orientation of the specified pose within space at time.

The runtime must avoid long blocking operations such as networking or disk operations for CreateSpatialAnchorMSFT function. The application may safely use this function in UI thread. Though, the created anchor handle may not be ready immediately for certain operations yet. For example, the corresponding anchor space may not return valid location, or its location may not be successfully saved in anchor store.

If space cannot be located relative to the environment at the moment of the call to CreateSpatialAnchorMSFT, the runtime must return ERROR_CREATE_SPATIAL_ANCHOR_FAILED_MSFT.

After the anchor is created, the runtime should then adjust its position and orientation over time relative to other spaces so as to maintain maximum alignment to its original real-world location, even if that changes the anchor’s relationship to the original space used to initialize it.

Valid Usage (Implicit)

• The XR_MSFT_spatial_anchor extension must be enabled prior to calling CreateSpatialAnchorMSFT
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrSpatialAnchorCreateInfoMSFT structure
• anchor 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_TIME_INVALID
• ERROR_POSE_INVALID
• ERROR_CREATE_SPATIAL_ANCHOR_FAILED_MSFT

See Also

XrSpatialAnchorCreateInfoMSFT

Parameters

session:XrSession

a handle to an XrSession.

createInfo:XrSpatialAnchorCreateInfoMSFT

a pointer to an XrSpatialAnchorCreateInfoMSFT structure containing information about how to create the anchor.

anchor:PointerBuffer

a pointer to a handle in which the created XrSpatialAnchorMSFT is returned.

Annotations

@NativeType:XrResult

Creates a space from a spatial anchor.

C Specification

The CreateSpatialAnchorSpaceMSFT function is defined as:

XrResult xrCreateSpatialAnchorSpaceMSFT(
    XrSession                                   session,
    const XrSpatialAnchorSpaceCreateInfoMSFT*   createInfo,
    XrSpace*                                    space);

Description

Creates an XrSpace handle based on a spatial anchor. Application can provide an XrPosef to define the position and orientation of the new space’s origin relative to the anchor’s natural origin.

Multiple XrSpace handles may exist for a given XrSpatialAnchorMSFT simultaneously, up to some limit imposed by the runtime. The XrSpace handle must be eventually freed via the DestroySpace function or by destroying the parent XrSpatialAnchorMSFT handle.

Valid Usage (Implicit)

• The XR_MSFT_spatial_anchor extension must be enabled prior to calling CreateSpatialAnchorSpaceMSFT
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrSpatialAnchorSpaceCreateInfoMSFT structure
• space must be a pointer to an XrSpace 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_POSE_INVALID

See Also

XrSpatialAnchorSpaceCreateInfoMSFT

Parameters

session:XrSession

a handle to an XrSession.

createInfo:XrSpatialAnchorSpaceCreateInfoMSFT

a pointer to an XrSpatialAnchorSpaceCreateInfoMSFT structure containing information about how to create the anchor.

space:PointerBuffer

a pointer to a handle in which the created XrSpace is returned.

Annotations

@NativeType:XrResult

Destroys a spatial anchor.

C Specification

The DestroySpatialAnchorMSFT function is defined as:

XrResult xrDestroySpatialAnchorMSFT(
    XrSpatialAnchorMSFT                         anchor);

Description

XrSpatialAnchorMSFT handles are destroyed using DestroySpatialAnchorMSFT. By destroying an anchor, the runtime can stop spending resources used to maintain tracking for that anchor’s origin.

Valid Usage (Implicit)

• The XR_MSFT_spatial_anchor extension must be enabled prior to calling DestroySpatialAnchorMSFT
• anchor must be a valid XrSpatialAnchorMSFT handle

Thread Safety

• Access to anchor, 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

See Also

CreateSpatialAnchorMSFT

Parameters

anchor:XrSpatialAnchorMSFT

a handle to an XrSpatialAnchorMSFT previously created by CreateSpatialAnchorMSFT.

Annotations

@NativeType:XrResult