OpenXR.Extensions.XR_MSFT_spatial_anchor

Name

XR_MSFT_spatial_anchor - instance extension

Specification

See XR_MSFT_spatial_anchor in the main specification for complete information.

Registered Extension Number

40

Revision

1

Extension and Version Dependencies

• Requires OpenXR 1.0

See Also

createSpatialAnchorMSFT, createSpatialAnchorSpaceMSFT, destroySpatialAnchorMSFT

Document Notes

For more information, see the OpenXR Specification

This page is a generated document. Fixes and changes should be made to the generator scripts, not directly.

Documentation

createSpatialAnchorMSFT

Arguments

:: forall io. MonadIO io

=> Session

session is a handle to an Session.

-> SpatialAnchorCreateInfoMSFT

createInfo is a pointer to an SpatialAnchorCreateInfoMSFT structure containing information about how to create the anchor.

-> io SpatialAnchorMSFT

xrCreateSpatialAnchorMSFT - Creates a spatial anchor

Parameter Descriptions

Description

Creates an SpatialAnchorMSFT 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.

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 @@ extension must be enabled prior to calling createSpatialAnchorMSFT

• session must be a valid Session handle
• createInfo must be a pointer to a valid SpatialAnchorCreateInfoMSFT structure
• anchor must be a pointer to an SpatialAnchorMSFT handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_INSTANCE_LOST
• ERROR_OUT_OF_MEMORY
• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_POSE_INVALID
• ERROR_CREATE_SPATIAL_ANCHOR_FAILED_MSFT
• ERROR_TIME_INVALID
• ERROR_SESSION_LOST
• SESSION_LOSS_PENDING

See Also

Session, SpatialAnchorCreateInfoMSFT, SpatialAnchorMSFT

withSpatialAnchorMSFT :: forall io r. MonadIO io => Session -> SpatialAnchorCreateInfoMSFT -> (io SpatialAnchorMSFT -> (SpatialAnchorMSFT -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createSpatialAnchorMSFT and destroySpatialAnchorMSFT

To ensure that destroySpatialAnchorMSFT is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

createSpatialAnchorSpaceMSFT

Arguments

:: forall io. MonadIO io

=> Session

session is a handle to an Session.

-> SpatialAnchorSpaceCreateInfoMSFT

createInfo is a pointer to an SpatialAnchorSpaceCreateInfoMSFT structure containing information about how to create the anchor.

-> io Space

xrCreateSpatialAnchorSpaceMSFT - Creates a space from a spatial anchor

Parameter Descriptions

Description

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

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

Valid Usage (Implicit)

• The @@ extension must be enabled prior to calling createSpatialAnchorSpaceMSFT

• session must be a valid Session handle
• createInfo must be a pointer to a valid SpatialAnchorSpaceCreateInfoMSFT structure
• space must be a pointer to an Space handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_INSTANCE_LOST
• ERROR_OUT_OF_MEMORY
• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_POSE_INVALID
• ERROR_SESSION_LOST
• SESSION_LOSS_PENDING

See Also

Session, Space, SpatialAnchorMSFT, SpatialAnchorSpaceCreateInfoMSFT

withSpatialAnchorSpaceMSFT :: forall io r. MonadIO io => Session -> SpatialAnchorSpaceCreateInfoMSFT -> (io Space -> (Space -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createSpatialAnchorSpaceMSFT and destroySpace

To ensure that destroySpace is always called: pass bracket (or the allocate function from your favourite resource management library) as the last argument. To just extract the pair pass (,) as the last argument.

destroySpatialAnchorMSFT

Arguments

:: forall io. MonadIO io

=> SpatialAnchorMSFT

anchor is a handle to an SpatialAnchorMSFT previously created by createSpatialAnchorMSFT.

-> io ()

xrDestroySpatialAnchorMSFT - Destroys a spatial anchor

Parameter Descriptions

Description

SpatialAnchorMSFT 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 @@ extension must be enabled prior to calling destroySpatialAnchorMSFT

• anchor must be a valid SpatialAnchorMSFT handle

Return Codes

Success

• SUCCESS

Failure

• ERROR_HANDLE_INVALID
• ERROR_FUNCTION_UNSUPPORTED

See Also

SpatialAnchorMSFT, createSpatialAnchorMSFT

data SpatialAnchorCreateInfoMSFT

XrSpatialAnchorCreateInfoMSFT - Information to create a spatial anchor

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using SpatialAnchorCreateInfoMSFT

• type must be TYPE_SPATIAL_ANCHOR_CREATE_INFO_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• space must be a valid Space handle

See Also

Posef, Space, SpatialAnchorMSFT, StructureType, https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime, createSpatialAnchorMSFT

Constructors

SpatialAnchorCreateInfoMSFT

Fields

• space :: Ptr Space_T

  space is a handle to the Space in which pose is specified.

• pose :: Posef

  pose is the Posef within space at time that specifies the point in the real world used to initialize the new anchor.

• time :: Time

  time is the https://www.khronos.org/registry/OpenXR/specs/1.0/html/xrspec.html#XrTime at which pose will be evaluated within space.

Instances

Show SpatialAnchorCreateInfoMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_anchor

Methods

showsPrec :: Int -> SpatialAnchorCreateInfoMSFT -> ShowS

show :: SpatialAnchorCreateInfoMSFT -> String

showList :: [SpatialAnchorCreateInfoMSFT] -> ShowS

Storable SpatialAnchorCreateInfoMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_anchor

Methods

sizeOf :: SpatialAnchorCreateInfoMSFT -> Int

alignment :: SpatialAnchorCreateInfoMSFT -> Int

peekElemOff :: Ptr SpatialAnchorCreateInfoMSFT -> Int -> IO SpatialAnchorCreateInfoMSFT

pokeElemOff :: Ptr SpatialAnchorCreateInfoMSFT -> Int -> SpatialAnchorCreateInfoMSFT -> IO ()

peekByteOff :: Ptr b -> Int -> IO SpatialAnchorCreateInfoMSFT

pokeByteOff :: Ptr b -> Int -> SpatialAnchorCreateInfoMSFT -> IO ()

peek :: Ptr SpatialAnchorCreateInfoMSFT -> IO SpatialAnchorCreateInfoMSFT

poke :: Ptr SpatialAnchorCreateInfoMSFT -> SpatialAnchorCreateInfoMSFT -> IO ()

Zero SpatialAnchorCreateInfoMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_anchor

Methods

zero :: SpatialAnchorCreateInfoMSFT

ToCStruct SpatialAnchorCreateInfoMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_anchor

Methods

withCStruct :: SpatialAnchorCreateInfoMSFT -> (Ptr SpatialAnchorCreateInfoMSFT -> IO b) -> IO b

pokeCStruct :: Ptr SpatialAnchorCreateInfoMSFT -> SpatialAnchorCreateInfoMSFT -> IO b -> IO b

withZeroCStruct :: (Ptr SpatialAnchorCreateInfoMSFT -> IO b) -> IO b

pokeZeroCStruct :: Ptr SpatialAnchorCreateInfoMSFT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct SpatialAnchorCreateInfoMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_anchor

Methods

peekCStruct :: Ptr SpatialAnchorCreateInfoMSFT -> IO SpatialAnchorCreateInfoMSFT

data SpatialAnchorSpaceCreateInfoMSFT

XrSpatialAnchorSpaceCreateInfoMSFT - Information to create a space from a spatial anchor

Valid Usage (Implicit)

• The @@ extension must be enabled prior to using SpatialAnchorSpaceCreateInfoMSFT

• type must be TYPE_SPATIAL_ANCHOR_SPACE_CREATE_INFO_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• anchor must be a valid SpatialAnchorMSFT handle

See Also

Posef, Space, SpatialAnchorMSFT, StructureType, createSpatialAnchorSpaceMSFT

Constructors

SpatialAnchorSpaceCreateInfoMSFT

Fields

• anchor :: Ptr SpatialAnchorMSFT_T

  anchor is a handle to an SpatialAnchorMSFT previously created with createSpatialAnchorMSFT.

• poseInAnchorSpace :: Posef

  poseInAnchorSpace is an Posef defining the position and orientation of the new space’s origin relative to the anchor’s natural origin.

Instances

Show SpatialAnchorSpaceCreateInfoMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_anchor

Methods

showsPrec :: Int -> SpatialAnchorSpaceCreateInfoMSFT -> ShowS

show :: SpatialAnchorSpaceCreateInfoMSFT -> String

showList :: [SpatialAnchorSpaceCreateInfoMSFT] -> ShowS

Storable SpatialAnchorSpaceCreateInfoMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_anchor

Methods

sizeOf :: SpatialAnchorSpaceCreateInfoMSFT -> Int

alignment :: SpatialAnchorSpaceCreateInfoMSFT -> Int

peekElemOff :: Ptr SpatialAnchorSpaceCreateInfoMSFT -> Int -> IO SpatialAnchorSpaceCreateInfoMSFT

pokeElemOff :: Ptr SpatialAnchorSpaceCreateInfoMSFT -> Int -> SpatialAnchorSpaceCreateInfoMSFT -> IO ()

peekByteOff :: Ptr b -> Int -> IO SpatialAnchorSpaceCreateInfoMSFT

pokeByteOff :: Ptr b -> Int -> SpatialAnchorSpaceCreateInfoMSFT -> IO ()

peek :: Ptr SpatialAnchorSpaceCreateInfoMSFT -> IO SpatialAnchorSpaceCreateInfoMSFT

poke :: Ptr SpatialAnchorSpaceCreateInfoMSFT -> SpatialAnchorSpaceCreateInfoMSFT -> IO ()

Zero SpatialAnchorSpaceCreateInfoMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_anchor

Methods

zero :: SpatialAnchorSpaceCreateInfoMSFT

ToCStruct SpatialAnchorSpaceCreateInfoMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_anchor

Methods

withCStruct :: SpatialAnchorSpaceCreateInfoMSFT -> (Ptr SpatialAnchorSpaceCreateInfoMSFT -> IO b) -> IO b

pokeCStruct :: Ptr SpatialAnchorSpaceCreateInfoMSFT -> SpatialAnchorSpaceCreateInfoMSFT -> IO b -> IO b

withZeroCStruct :: (Ptr SpatialAnchorSpaceCreateInfoMSFT -> IO b) -> IO b

pokeZeroCStruct :: Ptr SpatialAnchorSpaceCreateInfoMSFT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct SpatialAnchorSpaceCreateInfoMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_anchor

Methods

peekCStruct :: Ptr SpatialAnchorSpaceCreateInfoMSFT -> IO SpatialAnchorSpaceCreateInfoMSFT

type MSFT_spatial_anchor_SPEC_VERSION = 1

pattern MSFT_spatial_anchor_SPEC_VERSION :: forall a. Integral a => a

type MSFT_SPATIAL_ANCHOR_EXTENSION_NAME = "XR_MSFT_spatial_anchor"

pattern MSFT_SPATIAL_ANCHOR_EXTENSION_NAME :: forall a. (Eq a, IsString a) => a

data SpatialAnchorMSFT

XrSpatialAnchorMSFT - Represents a spatial anchor

Description

Spatial anchors are often used in combination with an UNBOUNDED_MSFT reference space. UNBOUNDED_MSFT reference spaces adjust their origin as necessary to keep the viewer’s coordinates relative to the space’s origin stable. Such adjustments maintain the visual stability of content currently near the viewer, but may cause content placed far from the viewer to drift in its alignment to the real world by the time the user moves close again. By creating an SpatialAnchorMSFT where a piece of content is placed and then always rendering that content relative to its anchor’s space, an application can ensure that each piece of content stays at a fixed location in the environment.

See Also

SpatialAnchorSpaceCreateInfoMSFT, createSpatialAnchorFromPerceptionAnchorMSFT, createSpatialAnchorMSFT, destroySpatialAnchorMSFT, tryGetPerceptionAnchorFromSpatialAnchorMSFT

Constructors

SpatialAnchorMSFT

Fields

• spatialAnchorMSFTHandle :: Ptr SpatialAnchorMSFT_T
• instanceCmds :: InstanceCmds

Instances

Eq SpatialAnchorMSFT

Defined in OpenXR.Extensions.Handles

Methods

(==) :: SpatialAnchorMSFT -> SpatialAnchorMSFT -> Bool

(/=) :: SpatialAnchorMSFT -> SpatialAnchorMSFT -> Bool

Show SpatialAnchorMSFT

Defined in OpenXR.Extensions.Handles

Methods

showsPrec :: Int -> SpatialAnchorMSFT -> ShowS

show :: SpatialAnchorMSFT -> String

showList :: [SpatialAnchorMSFT] -> ShowS

Zero SpatialAnchorMSFT

Defined in OpenXR.Extensions.Handles

Methods

zero :: SpatialAnchorMSFT

HasObjectType SpatialAnchorMSFT

Defined in OpenXR.Extensions.Handles

Methods

objectTypeAndHandle :: SpatialAnchorMSFT -> (ObjectType, Word64)

IsHandle SpatialAnchorMSFT

Defined in OpenXR.Extensions.Handles