Top Description Fields Constructors Methods
org.lwjgl.openxr

public Class FBSpatialEntityContainer

extends Object
Class Inheritance
Imports
org.lwjgl.system.*
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 extensions section.

Field Summary

Modifier and TypeField and Description
public static final String
XR_FB_SPATIAL_ENTITY_CONTAINER_EXTENSION_NAME

The extension name.

public static final int
XR_FB_spatial_entity_container_SPEC_VERSION

The extension specification version.

public static final int
XR_TYPE_SPACE_CONTAINER_FB

Extends XrStructureType.

Constructor Summary

AccessConstructor and Description
protected
FBSpatialEntityContainer()

Method Summary

Modifier and TypeMethod and Description
public static int
nxrGetSpaceContainerFB(XrSession session, XrSpace space, long spaceContainerOutput)

Unsafe version of: GetSpaceContainerFB

public static int
xrGetSpaceContainerFB(XrSession
a handle to an XrSession.
session, XrSpace
a handle to an XrSpace.
space, XrSpaceContainerFB
the output parameter that points to an XrSpaceContainerFB containing information about which spaces are contained by space.
spaceContainerOutput)

Gets a XrSpaceContainerFB which lists contained spaces.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

XR_FB_SPATIAL_ENTITY_CONTAINER_EXTENSION_NAMEback to summary
public static final String XR_FB_SPATIAL_ENTITY_CONTAINER_EXTENSION_NAME

The extension name.

XR_FB_spatial_entity_container_SPEC_VERSIONback to summary
public static final int XR_FB_spatial_entity_container_SPEC_VERSION

The extension specification version.

XR_TYPE_SPACE_CONTAINER_FBback to summary
public static final int XR_TYPE_SPACE_CONTAINER_FB

Extends XrStructureType.

Constructor Detail

FBSpatialEntityContainerback to summary
protected FBSpatialEntityContainer()

Method Detail

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

Unsafe version of: GetSpaceContainerFB

xrGetSpaceContainerFBback to summary
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)
Return Codes
On success, this command returns
On failure, this command returns
See Also

XrSpaceContainerFB

Parameters
session:XrSession

a handle to an XrSession.

space:XrSpace

a handle to an XrSpace.

spaceContainerOutput:XrSpaceContainerFB

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

Annotations
@NativeType:XrResult