OpenXR.Extensions.XR_MSFT_spatial_graph_bridge

Name

XR_MSFT_spatial_graph_bridge - instance extension

Specification

See XR_MSFT_spatial_graph_bridge in the main specification for complete information.

Registered Extension Number

50

Revision

1

Extension and Version Dependencies

• Requires OpenXR 1.0

See Also

SpatialGraphNodeSpaceCreateInfoMSFT, SpatialGraphNodeTypeMSFT, createSpatialGraphNodeSpaceMSFT

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

createSpatialGraphNodeSpaceMSFT

Arguments

:: forall io. MonadIO io

=> Session

session is the Session which will use the created space.

-> SpatialGraphNodeSpaceCreateInfoMSFT

createInfo is an SpatialGraphNodeSpaceCreateInfoMSFT specifying the space to be created.

-> io Space

xrCreateSpatialGraphNodeSpaceMSFT - Create an Space from a spatial graph node.

Valid Usage (Implicit)

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

• session must be a valid Session handle
• createInfo must be a pointer to a valid SpatialGraphNodeSpaceCreateInfoMSFT 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_SESSION_LOST
• SESSION_LOSS_PENDING
• ERROR_POSE_INVALID

See Also

Session, Space, SpatialGraphNodeSpaceCreateInfoMSFT

withSpatialGraphNodeSpaceMSFT :: forall io r. MonadIO io => Session -> SpatialGraphNodeSpaceCreateInfoMSFT -> (io Space -> (Space -> io ()) -> r) -> r

A convenience wrapper to make a compatible pair of calls to createSpatialGraphNodeSpaceMSFT 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.

data SpatialGraphNodeSpaceCreateInfoMSFT

XrSpatialGraphNodeSpaceCreateInfoMSFT - The information to create space from a spatial graph node.

Valid Usage (Implicit)

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

• type must be TYPE_SPATIAL_GRAPH_NODE_SPACE_CREATE_INFO_MSFT
• next must be NULL or a valid pointer to the next structure in a structure chain
• nodeType must be a valid SpatialGraphNodeTypeMSFT value

See Also

Posef, SpatialGraphNodeTypeMSFT, StructureType, createSpatialGraphNodeSpaceMSFT

Constructors

SpatialGraphNodeSpaceCreateInfoMSFT

Fields

• nodeType :: SpatialGraphNodeTypeMSFT

  nodeType is an SpatialGraphNodeTypeMSFT specifying the spatial node type.

• nodeId :: ByteString

  nodeId is a global unique identifier (a.k.a. GUID or 16 byte array), representing the spatial node that is being tracked.

• pose :: Posef

  pose is an Posef defining the position and orientation of the new space’s origin within the natural reference frame of the spatial graph node.

Instances

Show SpatialGraphNodeSpaceCreateInfoMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_graph_bridge

Methods

showsPrec :: Int -> SpatialGraphNodeSpaceCreateInfoMSFT -> ShowS

show :: SpatialGraphNodeSpaceCreateInfoMSFT -> String

showList :: [SpatialGraphNodeSpaceCreateInfoMSFT] -> ShowS

Storable SpatialGraphNodeSpaceCreateInfoMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_graph_bridge

Methods

sizeOf :: SpatialGraphNodeSpaceCreateInfoMSFT -> Int

alignment :: SpatialGraphNodeSpaceCreateInfoMSFT -> Int

peekElemOff :: Ptr SpatialGraphNodeSpaceCreateInfoMSFT -> Int -> IO SpatialGraphNodeSpaceCreateInfoMSFT

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

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

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

peek :: Ptr SpatialGraphNodeSpaceCreateInfoMSFT -> IO SpatialGraphNodeSpaceCreateInfoMSFT

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

Zero SpatialGraphNodeSpaceCreateInfoMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_graph_bridge

Methods

zero :: SpatialGraphNodeSpaceCreateInfoMSFT

ToCStruct SpatialGraphNodeSpaceCreateInfoMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_graph_bridge

Methods

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

pokeCStruct :: Ptr SpatialGraphNodeSpaceCreateInfoMSFT -> SpatialGraphNodeSpaceCreateInfoMSFT -> IO b -> IO b

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

pokeZeroCStruct :: Ptr SpatialGraphNodeSpaceCreateInfoMSFT -> IO b -> IO b

cStructSize :: Int

cStructAlignment :: Int

FromCStruct SpatialGraphNodeSpaceCreateInfoMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_graph_bridge

Methods

peekCStruct :: Ptr SpatialGraphNodeSpaceCreateInfoMSFT -> IO SpatialGraphNodeSpaceCreateInfoMSFT

newtype SpatialGraphNodeTypeMSFT

XrSpatialGraphNodeTypeMSFT - The type of spatial graph node.

Description

There are two types of spatial graph nodes: static and dynamic.

Static spatial nodes track the pose of a fixed location in the world relative to reference spaces. The tracking of static nodes may slowly adjust the pose over time for better accuracy but the pose is relatively stable in the short term, such as between rendering frames. For example, a QR code tracking library can use a static node to represent the location of the tracked QR code. Static spatial nodes are represented by SPATIAL_GRAPH_NODE_TYPE_STATIC_MSFT.

Dynamic spatial nodes track the pose of a physical object that moves continuously relative to reference spaces. The pose of dynamic spatial nodes can be very different within the duration of a rendering frame. It is important for the application to use the correct timestamp to query the space location using locateSpace. For example, a color camera mounted in front of a HMD is also tracked by the HMD so a web camera library can use a dynamic node to represent the camera location. Dynamic spatial nodes are represented by SPATIAL_GRAPH_NODE_TYPE_DYNAMIC_MSFT.

See Also

SpatialGraphNodeSpaceCreateInfoMSFT

Constructors

SpatialGraphNodeTypeMSFT Int32

Bundled Patterns

pattern SPATIAL_GRAPH_NODE_TYPE_STATIC_MSFT :: SpatialGraphNodeTypeMSFT

pattern SPATIAL_GRAPH_NODE_TYPE_DYNAMIC_MSFT :: SpatialGraphNodeTypeMSFT

Instances

Eq SpatialGraphNodeTypeMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_graph_bridge

Methods

(==) :: SpatialGraphNodeTypeMSFT -> SpatialGraphNodeTypeMSFT -> Bool

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

Ord SpatialGraphNodeTypeMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_graph_bridge

Methods

compare :: SpatialGraphNodeTypeMSFT -> SpatialGraphNodeTypeMSFT -> Ordering

(<) :: SpatialGraphNodeTypeMSFT -> SpatialGraphNodeTypeMSFT -> Bool

(<=) :: SpatialGraphNodeTypeMSFT -> SpatialGraphNodeTypeMSFT -> Bool

(>) :: SpatialGraphNodeTypeMSFT -> SpatialGraphNodeTypeMSFT -> Bool

(>=) :: SpatialGraphNodeTypeMSFT -> SpatialGraphNodeTypeMSFT -> Bool

max :: SpatialGraphNodeTypeMSFT -> SpatialGraphNodeTypeMSFT -> SpatialGraphNodeTypeMSFT

min :: SpatialGraphNodeTypeMSFT -> SpatialGraphNodeTypeMSFT -> SpatialGraphNodeTypeMSFT

Read SpatialGraphNodeTypeMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_graph_bridge

Methods

readsPrec :: Int -> ReadS SpatialGraphNodeTypeMSFT

readList :: ReadS [SpatialGraphNodeTypeMSFT]

readPrec :: ReadPrec SpatialGraphNodeTypeMSFT

readListPrec :: ReadPrec [SpatialGraphNodeTypeMSFT]

Show SpatialGraphNodeTypeMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_graph_bridge

Methods

showsPrec :: Int -> SpatialGraphNodeTypeMSFT -> ShowS

show :: SpatialGraphNodeTypeMSFT -> String

showList :: [SpatialGraphNodeTypeMSFT] -> ShowS

Storable SpatialGraphNodeTypeMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_graph_bridge

Methods

sizeOf :: SpatialGraphNodeTypeMSFT -> Int

alignment :: SpatialGraphNodeTypeMSFT -> Int

peekElemOff :: Ptr SpatialGraphNodeTypeMSFT -> Int -> IO SpatialGraphNodeTypeMSFT

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

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

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

peek :: Ptr SpatialGraphNodeTypeMSFT -> IO SpatialGraphNodeTypeMSFT

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

Zero SpatialGraphNodeTypeMSFT

Defined in OpenXR.Extensions.XR_MSFT_spatial_graph_bridge

Methods

zero :: SpatialGraphNodeTypeMSFT

type MSFT_spatial_graph_bridge_SPEC_VERSION = 1

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

type MSFT_SPATIAL_GRAPH_BRIDGE_EXTENSION_NAME = "XR_MSFT_spatial_graph_bridge"

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