Package org.lwjgl.openxr

Class FBSpatialEntityContainer

java.lang.Object

org.lwjgl.openxr.FBSpatialEntityContainer

public class FBSpatialEntityContainer
extends Object

The XR_FB_spatial_entity_container extension.

This extension expands on the concept of spatial entities to include a way for one spatial entity to contain multiple child spatial entities, forming a hierarchy.

In order to enable the functionality of this extension, you must pass the name of the extension into CreateInstance via the XrInstanceCreateInfo::enabledExtensionNames parameter as indicated in the extension section.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_FB_SPATIAL_ENTITY_CONTAINER_EXTENSION_NAME	The extension name.
static final int	XR_FB_spatial_entity_container_SPEC_VERSION	The extension specification version.
static final int	XR_TYPE_SPACE_CONTAINER_FB	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrGetSpaceContainerFB(XrSession session, XrSpace space, long spaceContainerOutput)	Unsafe version of: GetSpaceContainerFB
static int	xrGetSpaceContainerFB(XrSession session, XrSpace space, XrSpaceContainerFB spaceContainerOutput)	Gets a XrSpaceContainerFB which lists contained spaces.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_spatial_entity_container_SPEC_VERSION

public static final int XR_FB_spatial_entity_container_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_SPATIAL_ENTITY_CONTAINER_EXTENSION_NAME

public static final String XR_FB_SPATIAL_ENTITY_CONTAINER_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_SPACE_CONTAINER_FB

public static final int XR_TYPE_SPACE_CONTAINER_FB

Extends XrStructureType.

See Also:

• Constant Field Values

Method Details

nxrGetSpaceContainerFB

public static int nxrGetSpaceContainerFB(XrSession session,
 XrSpace space,
 long spaceContainerOutput)

Unsafe version of: GetSpaceContainerFB

xrGetSpaceContainerFB

public static int xrGetSpaceContainerFB(XrSession session,
 XrSpace space,
 XrSpaceContainerFB spaceContainerOutput)

Gets a XrSpaceContainerFB which lists contained spaces.

C Specification

The GetSpaceContainerFB function is defined as:

 XrResult xrGetSpaceContainerFB(
     XrSession                                   session,
     XrSpace                                     space,
     XrSpaceContainerFB*                         spaceContainerOutput);

Description

The GetSpaceContainerFB function is used by an application to perform the two calls required to obtain information about which spatial entities are contained by a specified spatial entity.

The SPACE_COMPONENT_TYPE_SPACE_CONTAINER_FB component type must be enabled, otherwise this function will return ERROR_SPACE_COMPONENT_NOT_ENABLED_FB.

Valid Usage (Implicit)

• The XR_FB_spatial_entity_container extension must be enabled prior to calling GetSpaceContainerFB
• session must be a valid XrSession handle
• space must be a valid XrSpace handle
• spaceContainerOutput must be a pointer to an XrSpaceContainerFB structure
• space 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_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_INSTANCE_LOST
• ERROR_SESSION_LOST
• ERROR_SIZE_INSUFFICIENT
• ERROR_SPACE_COMPONENT_NOT_ENABLED_FB
• ERROR_FEATURE_UNSUPPORTED

See Also

XrSpaceContainerFB

Parameters:

session - a handle to an XrSession.

space - a handle to an XrSpace.

spaceContainerOutput - the output parameter that points to an XrSpaceContainerFB containing information about which spaces are contained by space.