public Class MSFTPerceptionAnchorInterop

The extension name.

The extension specification version.

Unsafe version of: CreateSpatialAnchorFromPerceptionAnchorMSFT

Unsafe version of: TryGetPerceptionAnchorFromSpatialAnchorMSFT

Create an XrSpatialAnchorMSFT from a Windows SpatialAnchor pointer.

C Specification

The CreateSpatialAnchorFromPerceptionAnchorMSFT function creates a XrSpatialAnchorMSFT handle from an IUnknown pointer to Windows.Perception.Spatial.SpatialAnchor.

XrResult xrCreateSpatialAnchorFromPerceptionAnchorMSFT(
    XrSession                                   session,
    IUnknown*                                   perceptionAnchor,
    XrSpatialAnchorMSFT*                        anchor);

Description

The input perceptionAnchor must support successful QueryInterface to Windows.Perception.Spatial.SpatialAnchor , otherwise the runtime must return ERROR_VALIDATION_FAILURE.

If the function successfully returned, the output anchor must be a valid handle. This also increments the refcount of the perceptionAnchor object.

When application is done with the anchor handle, it can be destroyed using DestroySpatialAnchorMSFT function. This also decrements the refcount of underlying windows perception anchor object.

Valid Usage (Implicit)

• The XR_MSFT_perception_anchor_interop extension must be enabled prior to calling CreateSpatialAnchorFromPerceptionAnchorMSFT
• session must be a valid XrSession handle
• perceptionAnchor must be a pointer to an IUnknown value
• 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

Parameters

session:XrSession

the specified XrSession.

perceptionAnchor:long

an IUnknown pointer to a Windows.Perception.Spatial.SpatialAnchor object.

anchor:PointerBuffer

a pointer to XrSpatialAnchorMSFT to receive the returned anchor handle.

Annotations

@NativeType:XrResult

Convert an XrSpatialAnchorMSFT to a Windows SpatialAnchor.

C Specification

The TryGetPerceptionAnchorFromSpatialAnchorMSFT function converts a XrSpatialAnchorMSFT handle into an IUnknown pointer to Windows.Perception.Spatial.SpatialAnchor.

XrResult xrTryGetPerceptionAnchorFromSpatialAnchorMSFT(
    XrSession                                   session,
    XrSpatialAnchorMSFT                         anchor,
    IUnknown**                                  perceptionAnchor);

Description

If the runtime can convert the anchor to a Windows.Perception.Spatial.SpatialAnchor object, this function must return SUCCESS, and the output IUnknown in the pointer of perceptionAnchor must be not NULL. This also increments the refcount of the object. The application can then use QueryInterface to get the pointer for Windows.Perception.Spatial.SpatialAnchor object. The application should release the COM pointer after done with the object, or attach it to a smart COM pointer such as winrt::com_ptr.

If the runtime cannot convert the anchor to a Windows.Perception.Spatial.SpatialAnchor object, the function must return SUCCESS, and the output IUnknown in the pointer of perceptionAnchor must be NULL.

Valid Usage (Implicit)

• The XR_MSFT_perception_anchor_interop extension must be enabled prior to calling TryGetPerceptionAnchorFromSpatialAnchorMSFT
• session must be a valid XrSession handle
• anchor must be a valid XrSpatialAnchorMSFT handle
• perceptionAnchor must be a pointer to a pointer to an IUnknown value
• anchor must have been created, allocated, or retrieved from session

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

session:XrSession

the specified XrSession.

anchor:XrSpatialAnchorMSFT

a valid XrSpatialAnchorMSFT handle.

perceptionAnchor:PointerBuffer

a valid pointer to IUnknown pointer to receive the output Windows.Perception.Spatial.SpatialAnchor object.

Annotations

@NativeType:XrResult