Package org.lwjgl.openxr

Class MSFTSpatialGraphBridge

java.lang.Object

org.lwjgl.openxr.MSFTSpatialGraphBridge

public class MSFTSpatialGraphBridge
extends Object

The XR_MSFT_spatial_graph_bridge extension.

This extension enables applications to interop between XrSpace handles and other Windows Mixed Reality device platform libraries or APIs. These libraries represent a spatially tracked point, also known as a "spatial graph node", with a GUID value. This extension enables applications to create XrSpace handles from spatial graph nodes. Applications can also try to get a spatial graph node from an XrSpace handle.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_GUID_SIZE_MSFT	XR_GUID_SIZE_MSFT
static final String	XR_MSFT_SPATIAL_GRAPH_BRIDGE_EXTENSION_NAME	The extension name.
static final int	XR_MSFT_spatial_graph_bridge_SPEC_VERSION	The extension specification version.
static final int	XR_OBJECT_TYPE_SPATIAL_GRAPH_NODE_BINDING_MSFT	Extends XrObjectType.
static final int	XR_SPATIAL_GRAPH_NODE_TYPE_DYNAMIC_MSFT	XrSpatialGraphNodeTypeMSFT - The type of spatial graph node.
static final int	XR_SPATIAL_GRAPH_NODE_TYPE_STATIC_MSFT	XrSpatialGraphNodeTypeMSFT - The type of spatial graph node.
static final int	XR_TYPE_SPATIAL_GRAPH_NODE_BINDING_PROPERTIES_GET_INFO_MSFT	Extends XrStructureType.
static final int	XR_TYPE_SPATIAL_GRAPH_NODE_BINDING_PROPERTIES_MSFT	Extends XrStructureType.
static final int	XR_TYPE_SPATIAL_GRAPH_NODE_SPACE_CREATE_INFO_MSFT	Extends XrStructureType.
static final int	XR_TYPE_SPATIAL_GRAPH_STATIC_NODE_BINDING_CREATE_INFO_MSFT	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrCreateSpatialGraphNodeSpaceMSFT(XrSession session, long createInfo, long space)	Unsafe version of: CreateSpatialGraphNodeSpaceMSFT
static int	nxrGetSpatialGraphNodeBindingPropertiesMSFT(XrSpatialGraphNodeBindingMSFT nodeBinding, long getInfo, long properties)	Unsafe version of: GetSpatialGraphNodeBindingPropertiesMSFT
static int	nxrTryCreateSpatialGraphStaticNodeBindingMSFT(XrSession session, long createInfo, long nodeBinding)	Unsafe version of: TryCreateSpatialGraphStaticNodeBindingMSFT
static int	xrCreateSpatialGraphNodeSpaceMSFT(XrSession session, XrSpatialGraphNodeSpaceCreateInfoMSFT createInfo, org.lwjgl.PointerBuffer space)	Create an XrSpace from a spatial graph node.
static int	xrDestroySpatialGraphNodeBindingMSFT(XrSpatialGraphNodeBindingMSFT nodeBinding)	Destroy a spatial graph node handle.
static int	xrGetSpatialGraphNodeBindingPropertiesMSFT(XrSpatialGraphNodeBindingMSFT nodeBinding, @Nullable XrSpatialGraphNodeBindingPropertiesGetInfoMSFT getInfo, XrSpatialGraphNodeBindingPropertiesMSFT properties)	Destroy a spatial graph node handle.
static int	xrTryCreateSpatialGraphStaticNodeBindingMSFT(XrSession session, XrSpatialGraphStaticNodeBindingCreateInfoMSFT createInfo, org.lwjgl.PointerBuffer nodeBinding)	Try create spatial graph static node binding.

Methods inherited from class java.lang.Object

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

Field Details

XR_MSFT_spatial_graph_bridge_SPEC_VERSION

public static final int XR_MSFT_spatial_graph_bridge_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_MSFT_SPATIAL_GRAPH_BRIDGE_EXTENSION_NAME

public static final String XR_MSFT_SPATIAL_GRAPH_BRIDGE_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_GUID_SIZE_MSFT

public static final int XR_GUID_SIZE_MSFT

XR_GUID_SIZE_MSFT

See Also:

• Constant Field Values

XR_OBJECT_TYPE_SPATIAL_GRAPH_NODE_BINDING_MSFT

public static final int XR_OBJECT_TYPE_SPATIAL_GRAPH_NODE_BINDING_MSFT

Extends XrObjectType.

See Also:

• Constant Field Values

XR_TYPE_SPATIAL_GRAPH_NODE_SPACE_CREATE_INFO_MSFT

public static final int XR_TYPE_SPATIAL_GRAPH_NODE_SPACE_CREATE_INFO_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SPATIAL_GRAPH_NODE_SPACE_CREATE_INFO_MSFT
• TYPE_SPATIAL_GRAPH_STATIC_NODE_BINDING_CREATE_INFO_MSFT
• TYPE_SPATIAL_GRAPH_NODE_BINDING_PROPERTIES_GET_INFO_MSFT
• TYPE_SPATIAL_GRAPH_NODE_BINDING_PROPERTIES_MSFT

See Also:

• Constant Field Values

XR_TYPE_SPATIAL_GRAPH_STATIC_NODE_BINDING_CREATE_INFO_MSFT

public static final int XR_TYPE_SPATIAL_GRAPH_STATIC_NODE_BINDING_CREATE_INFO_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SPATIAL_GRAPH_NODE_SPACE_CREATE_INFO_MSFT
• TYPE_SPATIAL_GRAPH_STATIC_NODE_BINDING_CREATE_INFO_MSFT
• TYPE_SPATIAL_GRAPH_NODE_BINDING_PROPERTIES_GET_INFO_MSFT
• TYPE_SPATIAL_GRAPH_NODE_BINDING_PROPERTIES_MSFT

See Also:

• Constant Field Values

XR_TYPE_SPATIAL_GRAPH_NODE_BINDING_PROPERTIES_GET_INFO_MSFT

public static final int XR_TYPE_SPATIAL_GRAPH_NODE_BINDING_PROPERTIES_GET_INFO_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SPATIAL_GRAPH_NODE_SPACE_CREATE_INFO_MSFT
• TYPE_SPATIAL_GRAPH_STATIC_NODE_BINDING_CREATE_INFO_MSFT
• TYPE_SPATIAL_GRAPH_NODE_BINDING_PROPERTIES_GET_INFO_MSFT
• TYPE_SPATIAL_GRAPH_NODE_BINDING_PROPERTIES_MSFT

See Also:

• Constant Field Values

XR_TYPE_SPATIAL_GRAPH_NODE_BINDING_PROPERTIES_MSFT

public static final int XR_TYPE_SPATIAL_GRAPH_NODE_BINDING_PROPERTIES_MSFT

Extends XrStructureType.

Enum values:

• TYPE_SPATIAL_GRAPH_NODE_SPACE_CREATE_INFO_MSFT
• TYPE_SPATIAL_GRAPH_STATIC_NODE_BINDING_CREATE_INFO_MSFT
• TYPE_SPATIAL_GRAPH_NODE_BINDING_PROPERTIES_GET_INFO_MSFT
• TYPE_SPATIAL_GRAPH_NODE_BINDING_PROPERTIES_MSFT

See Also:

• Constant Field Values

XR_SPATIAL_GRAPH_NODE_TYPE_STATIC_MSFT

public static final int XR_SPATIAL_GRAPH_NODE_TYPE_STATIC_MSFT

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

XrSpatialGraphNodeSpaceCreateInfoMSFT, CreateSpatialGraphNodeSpaceMSFT

See Also:

• Constant Field Values

XR_SPATIAL_GRAPH_NODE_TYPE_DYNAMIC_MSFT

public static final int XR_SPATIAL_GRAPH_NODE_TYPE_DYNAMIC_MSFT

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

XrSpatialGraphNodeSpaceCreateInfoMSFT, CreateSpatialGraphNodeSpaceMSFT

See Also:

• Constant Field Values

Method Details

nxrCreateSpatialGraphNodeSpaceMSFT

public static int nxrCreateSpatialGraphNodeSpaceMSFT(XrSession session,
 long createInfo,
 long space)

Unsafe version of: CreateSpatialGraphNodeSpaceMSFT

xrCreateSpatialGraphNodeSpaceMSFT

public static int xrCreateSpatialGraphNodeSpaceMSFT(XrSession session,
 XrSpatialGraphNodeSpaceCreateInfoMSFT createInfo,
 org.lwjgl.PointerBuffer space)

Create an XrSpace from a spatial graph node.

C Specification

The CreateSpatialGraphNodeSpaceMSFT function creates an XrSpace handle for a given spatial graph node type and ID.

 XrResult xrCreateSpatialGraphNodeSpaceMSFT(
     XrSession                                   session,
     const XrSpatialGraphNodeSpaceCreateInfoMSFT* createInfo,
     XrSpace*                                    space);

Valid Usage (Implicit)

• The XR_MSFT_spatial_graph_bridge extension must be enabled prior to calling CreateSpatialGraphNodeSpaceMSFT
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrSpatialGraphNodeSpaceCreateInfoMSFT 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

XrSpatialGraphNodeSpaceCreateInfoMSFT

Parameters:

session - the XrSession which will use the created space.

createInfo - an XrSpatialGraphNodeSpaceCreateInfoMSFT specifying the space to be created.

space - the returned XrSpace handle for the given spatial node ID.

nxrTryCreateSpatialGraphStaticNodeBindingMSFT

public static int nxrTryCreateSpatialGraphStaticNodeBindingMSFT(XrSession session,
 long createInfo,
 long nodeBinding)

Unsafe version of: TryCreateSpatialGraphStaticNodeBindingMSFT

xrTryCreateSpatialGraphStaticNodeBindingMSFT

public static int xrTryCreateSpatialGraphStaticNodeBindingMSFT(XrSession session,
 XrSpatialGraphStaticNodeBindingCreateInfoMSFT createInfo,
 org.lwjgl.PointerBuffer nodeBinding)

Try create spatial graph static node binding.

C Specification

The TryCreateSpatialGraphStaticNodeBindingMSFT function tries to create a binding to the best spatial graph static node relative to the given location and returns an XrSpatialGraphNodeBindingMSFT handle.

 XrResult xrTryCreateSpatialGraphStaticNodeBindingMSFT(
     XrSession                                   session,
     const XrSpatialGraphStaticNodeBindingCreateInfoMSFT* createInfo,
     XrSpatialGraphNodeBindingMSFT*              nodeBinding);

Description

The runtime may return SUCCESS and set nodeBinding to NULL_HANDLE if it is unable to create a spatial graph static node binding. This may happen when the given XrSpace cannot be properly tracked at the moment. The application can retry creating the XrSpatialGraphNodeBindingMSFT handle again after a reasonable period of time when tracking is regained.

The TryCreateSpatialGraphStaticNodeBindingMSFT function may be a slow operation and therefore should be invoked from a non-timing critical thread.

Valid Usage (Implicit)

• The XR_MSFT_spatial_graph_bridge extension must be enabled prior to calling TryCreateSpatialGraphStaticNodeBindingMSFT
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrSpatialGraphStaticNodeBindingCreateInfoMSFT structure
• nodeBinding must be a pointer to an XrSpatialGraphNodeBindingMSFT handle

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED
• ERROR_TIME_INVALID
• ERROR_POSE_INVALID

See Also

XrSpatialGraphStaticNodeBindingCreateInfoMSFT, DestroySpatialGraphNodeBindingMSFT

Parameters:

session - the specified XrSession.

createInfo - the XrSpatialGraphStaticNodeBindingCreateInfoMSFT input structure.

nodeBinding - the XrSpatialGraphNodeBindingMSFT output structure.

xrDestroySpatialGraphNodeBindingMSFT

public static int xrDestroySpatialGraphNodeBindingMSFT(XrSpatialGraphNodeBindingMSFT nodeBinding)

Destroy a spatial graph node handle.

C Specification

The DestroySpatialGraphNodeBindingMSFT function releases the nodeBinding and the underlying resources.

 XrResult xrDestroySpatialGraphNodeBindingMSFT(
     XrSpatialGraphNodeBindingMSFT               nodeBinding);

Valid Usage (Implicit)

• The XR_MSFT_spatial_graph_bridge extension must be enabled prior to calling DestroySpatialGraphNodeBindingMSFT
• nodeBinding must be a valid XrSpatialGraphNodeBindingMSFT handle

Thread Safety

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

TryCreateSpatialGraphStaticNodeBindingMSFT

Parameters:

nodeBinding - an XrSpatialGraphNodeBindingMSFT previously created by TryCreateSpatialGraphStaticNodeBindingMSFT.

nxrGetSpatialGraphNodeBindingPropertiesMSFT

public static int nxrGetSpatialGraphNodeBindingPropertiesMSFT(XrSpatialGraphNodeBindingMSFT nodeBinding,
 long getInfo,
 long properties)

Unsafe version of: GetSpatialGraphNodeBindingPropertiesMSFT

xrGetSpatialGraphNodeBindingPropertiesMSFT

public static int xrGetSpatialGraphNodeBindingPropertiesMSFT(XrSpatialGraphNodeBindingMSFT nodeBinding,
 @Nullable XrSpatialGraphNodeBindingPropertiesGetInfoMSFT getInfo,
 XrSpatialGraphNodeBindingPropertiesMSFT properties)

Destroy a spatial graph node handle.

C Specification

The GetSpatialGraphNodeBindingPropertiesMSFT function retrieves the spatial graph node GUID and the pose in the node space from an XrSpatialGraphNodeBindingMSFT handle.

 XrResult xrGetSpatialGraphNodeBindingPropertiesMSFT(
     XrSpatialGraphNodeBindingMSFT               nodeBinding,
     const XrSpatialGraphNodeBindingPropertiesGetInfoMSFT* getInfo,
     XrSpatialGraphNodeBindingPropertiesMSFT*    properties);

Valid Usage (Implicit)

• The XR_MSFT_spatial_graph_bridge extension must be enabled prior to calling GetSpatialGraphNodeBindingPropertiesMSFT
• nodeBinding must be a valid XrSpatialGraphNodeBindingMSFT handle
• If getInfo is not NULL, getInfo must be a pointer to a valid XrSpatialGraphNodeBindingPropertiesGetInfoMSFT structure
• properties must be a pointer to an XrSpatialGraphNodeBindingPropertiesMSFT structure

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_VALIDATION_FAILURE
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_OUT_OF_MEMORY

See Also

XrSpatialGraphNodeBindingPropertiesGetInfoMSFT, XrSpatialGraphNodeBindingPropertiesMSFT, TryCreateSpatialGraphStaticNodeBindingMSFT

Parameters:

nodeBinding - an XrSpatialGraphNodeBindingMSFT previously created by TryCreateSpatialGraphStaticNodeBindingMSFT.

getInfo - a pointer to an XrSpatialGraphNodeBindingPropertiesGetInfoMSFT input structure.

properties - a pointer to an XrSpatialGraphNodeBindingPropertiesMSFT output structure.