Package org.lwjgl.openxr

Class FBScene

java.lang.Object

org.lwjgl.openxr.FBScene

public class FBScene
extends Object

The XR_FB_scene extension.

This extension expands on the concept of spatial entities to include a way for a spatial entity to represent rooms, objects, or other boundaries in a scene.

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_SCENE_EXTENSION_NAME	The extension name.
static final int	XR_FB_scene_SPEC_VERSION	The extension specification version.
static final int	XR_SEMANTIC_LABELS_SUPPORT_ACCEPT_DESK_TO_TABLE_MIGRATION_BIT_FB	XrSemanticLabelsSupportFlagBitsFB - XrSemanticLabelsSupportFlagBitsFB
static final int	XR_SEMANTIC_LABELS_SUPPORT_ACCEPT_INVISIBLE_WALL_FACE_BIT_FB	XrSemanticLabelsSupportFlagBitsFB - XrSemanticLabelsSupportFlagBitsFB
static final int	XR_SEMANTIC_LABELS_SUPPORT_MULTIPLE_SEMANTIC_LABELS_BIT_FB	XrSemanticLabelsSupportFlagBitsFB - XrSemanticLabelsSupportFlagBitsFB
static final int	XR_TYPE_BOUNDARY_2D_FB	Extends XrStructureType.
static final int	XR_TYPE_ROOM_LAYOUT_FB	Extends XrStructureType.
static final int	XR_TYPE_SEMANTIC_LABELS_FB	Extends XrStructureType.
static final int	XR_TYPE_SEMANTIC_LABELS_SUPPORT_INFO_FB	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrGetSpaceBoundary2DFB(XrSession session, XrSpace space, long boundary2DOutput)	Unsafe version of: GetSpaceBoundary2DFB
static int	nxrGetSpaceBoundingBox2DFB(XrSession session, XrSpace space, long boundingBox2DOutput)	Unsafe version of: GetSpaceBoundingBox2DFB
static int	nxrGetSpaceBoundingBox3DFB(XrSession session, XrSpace space, long boundingBox3DOutput)	Unsafe version of: GetSpaceBoundingBox3DFB
static int	nxrGetSpaceRoomLayoutFB(XrSession session, XrSpace space, long roomLayoutOutput)	Unsafe version of: GetSpaceRoomLayoutFB
static int	nxrGetSpaceSemanticLabelsFB(XrSession session, XrSpace space, long semanticLabelsOutput)	Unsafe version of: GetSpaceSemanticLabelsFB
static int	xrGetSpaceBoundary2DFB(XrSession session, XrSpace space, XrBoundary2DFB boundary2DOutput)	Gets the 2D boundary for a spatial entity.
static int	xrGetSpaceBoundingBox2DFB(XrSession session, XrSpace space, XrRect2Df boundingBox2DOutput)	Gets the 2D bounding box for a spatial entity.
static int	xrGetSpaceBoundingBox3DFB(XrSession session, XrSpace space, XrRect3DfFB boundingBox3DOutput)	Gets the 3D bounding box for a spatial entity.
static int	xrGetSpaceRoomLayoutFB(XrSession session, XrSpace space, XrRoomLayoutFB roomLayoutOutput)	Gets the room layout for a spatial entity.
static int	xrGetSpaceSemanticLabelsFB(XrSession session, XrSpace space, XrSemanticLabelsFB semanticLabelsOutput)	Gets the semantic labels for a spatial entity.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_scene_SPEC_VERSION

public static final int XR_FB_scene_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_SCENE_EXTENSION_NAME

public static final String XR_FB_SCENE_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_SEMANTIC_LABELS_FB

public static final int XR_TYPE_SEMANTIC_LABELS_FB

Extends XrStructureType.

Enum values:

• TYPE_SEMANTIC_LABELS_FB
• TYPE_ROOM_LAYOUT_FB
• TYPE_BOUNDARY_2D_FB
• TYPE_SEMANTIC_LABELS_SUPPORT_INFO_FB

See Also:

• Constant Field Values

XR_TYPE_ROOM_LAYOUT_FB

public static final int XR_TYPE_ROOM_LAYOUT_FB

Extends XrStructureType.

Enum values:

• TYPE_SEMANTIC_LABELS_FB
• TYPE_ROOM_LAYOUT_FB
• TYPE_BOUNDARY_2D_FB
• TYPE_SEMANTIC_LABELS_SUPPORT_INFO_FB

See Also:

• Constant Field Values

XR_TYPE_BOUNDARY_2D_FB

public static final int XR_TYPE_BOUNDARY_2D_FB

Extends XrStructureType.

Enum values:

• TYPE_SEMANTIC_LABELS_FB
• TYPE_ROOM_LAYOUT_FB
• TYPE_BOUNDARY_2D_FB
• TYPE_SEMANTIC_LABELS_SUPPORT_INFO_FB

See Also:

• Constant Field Values

XR_TYPE_SEMANTIC_LABELS_SUPPORT_INFO_FB

public static final int XR_TYPE_SEMANTIC_LABELS_SUPPORT_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_SEMANTIC_LABELS_FB
• TYPE_ROOM_LAYOUT_FB
• TYPE_BOUNDARY_2D_FB
• TYPE_SEMANTIC_LABELS_SUPPORT_INFO_FB

See Also:

• Constant Field Values

XR_SEMANTIC_LABELS_SUPPORT_MULTIPLE_SEMANTIC_LABELS_BIT_FB

public static final int XR_SEMANTIC_LABELS_SUPPORT_MULTIPLE_SEMANTIC_LABELS_BIT_FB

XrSemanticLabelsSupportFlagBitsFB - XrSemanticLabelsSupportFlagBitsFB

Flag Descriptions

• SEMANTIC_LABELS_SUPPORT_MULTIPLE_SEMANTIC_LABELS_BIT_FB — If set, and the runtime reports the extensionVersion as 2 or greater, the runtime may return multiple semantic labels separated by a comma without spaces. Otherwise, the runtime must return a single semantic label.
• SEMANTIC_LABELS_SUPPORT_ACCEPT_DESK_TO_TABLE_MIGRATION_BIT_FB — If set, and the runtime reports the extensionVersion as 3 or greater, the runtime must return "TABLE" instead of "DESK" as a semantic label to the application. Otherwise, the runtime must return "DESK" instead of "TABLE" as a semantic label to the application, when applicable.
• SEMANTIC_LABELS_SUPPORT_ACCEPT_INVISIBLE_WALL_FACE_BIT_FB — If set, and the runtime reports the extensionVersion as 4 or greater, the runtime may return "INVISIBLE_WALL_FACE" instead of "WALL_FACE" as a semantic label to the application in order to represent an invisible wall used to conceptually separate a space (e.g., separate a living space from a kitchen space in an open floor plan house even though there is no real wall between the two spaces) instead of a real wall. Otherwise, the runtime must return "WALL_FACE" as a semantic label to the application in order to represent both an invisible and real wall, when applicable.

See Also:

• Constant Field Values

XR_SEMANTIC_LABELS_SUPPORT_ACCEPT_DESK_TO_TABLE_MIGRATION_BIT_FB

public static final int XR_SEMANTIC_LABELS_SUPPORT_ACCEPT_DESK_TO_TABLE_MIGRATION_BIT_FB

XrSemanticLabelsSupportFlagBitsFB - XrSemanticLabelsSupportFlagBitsFB

Flag Descriptions

• SEMANTIC_LABELS_SUPPORT_MULTIPLE_SEMANTIC_LABELS_BIT_FB — If set, and the runtime reports the extensionVersion as 2 or greater, the runtime may return multiple semantic labels separated by a comma without spaces. Otherwise, the runtime must return a single semantic label.
• SEMANTIC_LABELS_SUPPORT_ACCEPT_DESK_TO_TABLE_MIGRATION_BIT_FB — If set, and the runtime reports the extensionVersion as 3 or greater, the runtime must return "TABLE" instead of "DESK" as a semantic label to the application. Otherwise, the runtime must return "DESK" instead of "TABLE" as a semantic label to the application, when applicable.
• SEMANTIC_LABELS_SUPPORT_ACCEPT_INVISIBLE_WALL_FACE_BIT_FB — If set, and the runtime reports the extensionVersion as 4 or greater, the runtime may return "INVISIBLE_WALL_FACE" instead of "WALL_FACE" as a semantic label to the application in order to represent an invisible wall used to conceptually separate a space (e.g., separate a living space from a kitchen space in an open floor plan house even though there is no real wall between the two spaces) instead of a real wall. Otherwise, the runtime must return "WALL_FACE" as a semantic label to the application in order to represent both an invisible and real wall, when applicable.

See Also:

• Constant Field Values

XR_SEMANTIC_LABELS_SUPPORT_ACCEPT_INVISIBLE_WALL_FACE_BIT_FB

public static final int XR_SEMANTIC_LABELS_SUPPORT_ACCEPT_INVISIBLE_WALL_FACE_BIT_FB

XrSemanticLabelsSupportFlagBitsFB - XrSemanticLabelsSupportFlagBitsFB

Flag Descriptions

• SEMANTIC_LABELS_SUPPORT_MULTIPLE_SEMANTIC_LABELS_BIT_FB — If set, and the runtime reports the extensionVersion as 2 or greater, the runtime may return multiple semantic labels separated by a comma without spaces. Otherwise, the runtime must return a single semantic label.
• SEMANTIC_LABELS_SUPPORT_ACCEPT_DESK_TO_TABLE_MIGRATION_BIT_FB — If set, and the runtime reports the extensionVersion as 3 or greater, the runtime must return "TABLE" instead of "DESK" as a semantic label to the application. Otherwise, the runtime must return "DESK" instead of "TABLE" as a semantic label to the application, when applicable.
• SEMANTIC_LABELS_SUPPORT_ACCEPT_INVISIBLE_WALL_FACE_BIT_FB — If set, and the runtime reports the extensionVersion as 4 or greater, the runtime may return "INVISIBLE_WALL_FACE" instead of "WALL_FACE" as a semantic label to the application in order to represent an invisible wall used to conceptually separate a space (e.g., separate a living space from a kitchen space in an open floor plan house even though there is no real wall between the two spaces) instead of a real wall. Otherwise, the runtime must return "WALL_FACE" as a semantic label to the application in order to represent both an invisible and real wall, when applicable.

See Also:

• Constant Field Values

Method Details

nxrGetSpaceBoundingBox2DFB

public static int nxrGetSpaceBoundingBox2DFB(XrSession session,
 XrSpace space,
 long boundingBox2DOutput)

Unsafe version of: GetSpaceBoundingBox2DFB

xrGetSpaceBoundingBox2DFB

public static int xrGetSpaceBoundingBox2DFB(XrSession session,
 XrSpace space,
 XrRect2Df boundingBox2DOutput)

Gets the 2D bounding box for a spatial entity.

C Specification

The GetSpaceBoundingBox2DFB function is defined as:

 XrResult xrGetSpaceBoundingBox2DFB(
     XrSession                                   session,
     XrSpace                                     space,
     XrRect2Df*                                  boundingBox2DOutput);

Description

Gets the 2D bounding box for a spatial entity with the SPACE_COMPONENT_TYPE_BOUNDED_2D_FB component type enabled.

The bounding box is defined by an XrRect2Df::offset and XrRect2Df::extent. The XrRect2Df::offset refers to the coordinate of the minimum corner of the box in the x-y plane of the given XrSpace’s coordinate system; that is, the corner whose coordinate has the minimum value on each axis. The XrRect2Df::extent refers to the dimensions of the box along each axis. The maximum corner can therefore be computed as XrRect2Df::offset XrRect2Df::extent.

Valid Usage (Implicit)

• The XR_FB_scene extension must be enabled prior to calling GetSpaceBoundingBox2DFB
• session must be a valid XrSession handle
• space must be a valid XrSpace handle
• boundingBox2DOutput must be a pointer to an XrRect2Df 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_SPACE_COMPONENT_NOT_ENABLED_FB
• ERROR_FEATURE_UNSUPPORTED

See Also

XrRect2Df

Parameters:

session - a handle to an XrSession.

space - the XrSpace handle to the spatial entity.

boundingBox2DOutput - an output parameter pointing to the structure containing the 2D bounding box for space.

nxrGetSpaceBoundingBox3DFB

public static int nxrGetSpaceBoundingBox3DFB(XrSession session,
 XrSpace space,
 long boundingBox3DOutput)

Unsafe version of: GetSpaceBoundingBox3DFB

xrGetSpaceBoundingBox3DFB

public static int xrGetSpaceBoundingBox3DFB(XrSession session,
 XrSpace space,
 XrRect3DfFB boundingBox3DOutput)

Gets the 3D bounding box for a spatial entity.

C Specification

The GetSpaceBoundingBox3DFB function is defined as:

 XrResult xrGetSpaceBoundingBox3DFB(
     XrSession                                   session,
     XrSpace                                     space,
     XrRect3DfFB*                                boundingBox3DOutput);

Description

Gets the 3D bounding box for a spatial entity with the SPACE_COMPONENT_TYPE_BOUNDED_3D_FB component type enabled.

Valid Usage (Implicit)

• The XR_FB_scene extension must be enabled prior to calling GetSpaceBoundingBox3DFB
• session must be a valid XrSession handle
• space must be a valid XrSpace handle
• boundingBox3DOutput must be a pointer to an XrRect3DfFB 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_SPACE_COMPONENT_NOT_ENABLED_FB
• ERROR_FEATURE_UNSUPPORTED

See Also

XrRect3DfFB

Parameters:

session - a handle to an XrSession.

space - the XrSpace handle to the spatial entity.

boundingBox3DOutput - an output parameter pointing to the structure containing the 3D bounding box for space.

nxrGetSpaceSemanticLabelsFB

public static int nxrGetSpaceSemanticLabelsFB(XrSession session,
 XrSpace space,
 long semanticLabelsOutput)

Unsafe version of: GetSpaceSemanticLabelsFB

xrGetSpaceSemanticLabelsFB

public static int xrGetSpaceSemanticLabelsFB(XrSession session,
 XrSpace space,
 XrSemanticLabelsFB semanticLabelsOutput)

Gets the semantic labels for a spatial entity.

C Specification

The GetSpaceSemanticLabelsFB function is defined as:

 XrResult xrGetSpaceSemanticLabelsFB(
     XrSession                                   session,
     XrSpace                                     space,
     XrSemanticLabelsFB*                         semanticLabelsOutput);

Description

Gets the semantic labels for a spatial entity with the SPACE_COMPONENT_TYPE_SEMANTIC_LABELS_FB component type enabled.

Valid Usage (Implicit)

• The XR_FB_scene extension must be enabled prior to calling GetSpaceSemanticLabelsFB
• session must be a valid XrSession handle
• space must be a valid XrSpace handle
• semanticLabelsOutput must be a pointer to an XrSemanticLabelsFB 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

XrSemanticLabelsFB

Parameters:

session - a handle to an XrSession.

space - the XrSpace handle to the spatial entity.

semanticLabelsOutput - an output parameter pointing to the structure containing the XrSemanticLabelsFB for space.

nxrGetSpaceBoundary2DFB

public static int nxrGetSpaceBoundary2DFB(XrSession session,
 XrSpace space,
 long boundary2DOutput)

Unsafe version of: GetSpaceBoundary2DFB

xrGetSpaceBoundary2DFB

public static int xrGetSpaceBoundary2DFB(XrSession session,
 XrSpace space,
 XrBoundary2DFB boundary2DOutput)

Gets the 2D boundary for a spatial entity.

C Specification

The GetSpaceBoundary2DFB function is defined as:

 XrResult xrGetSpaceBoundary2DFB(
     XrSession                                   session,
     XrSpace                                     space,
     XrBoundary2DFB*                             boundary2DOutput);

Description

Gets the 2D boundary, specified by vertices, for a spatial entity with the SPACE_COMPONENT_TYPE_BOUNDED_2D_FB component type enabled.

Valid Usage (Implicit)

• The XR_FB_scene extension must be enabled prior to calling GetSpaceBoundary2DFB
• session must be a valid XrSession handle
• space must be a valid XrSpace handle
• boundary2DOutput must be a pointer to an XrBoundary2DFB 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

XrBoundary2DFB

Parameters:

session - a handle to an XrSession.

space - the XrSpace handle to the spatial entity.

boundary2DOutput - an output parameter pointing to the structure containing the XrBoundary2DFB for space.

nxrGetSpaceRoomLayoutFB

public static int nxrGetSpaceRoomLayoutFB(XrSession session,
 XrSpace space,
 long roomLayoutOutput)

Unsafe version of: GetSpaceRoomLayoutFB

xrGetSpaceRoomLayoutFB

public static int xrGetSpaceRoomLayoutFB(XrSession session,
 XrSpace space,
 XrRoomLayoutFB roomLayoutOutput)

Gets the room layout for a spatial entity.

C Specification

The GetSpaceRoomLayoutFB function is defined as:

 XrResult xrGetSpaceRoomLayoutFB(
     XrSession                                   session,
     XrSpace                                     space,
     XrRoomLayoutFB*                             roomLayoutOutput);

Description

Gets the room layout, specified by UUIDs for each surface, for a spatial entity with the SPACE_COMPONENT_TYPE_ROOM_LAYOUT_FB component type enabled.

If the XrRoomLayoutFB::wallUuidCapacityInput field is zero (indicating a request to retrieve the required capacity for the XrRoomLayoutFB::wallUuids array), or if GetSpaceRoomLayoutFB returns failure, then the values of floorUuid and ceilingUuid are unspecified and should not be used.

Valid Usage (Implicit)

• The XR_FB_scene extension must be enabled prior to calling GetSpaceRoomLayoutFB
• session must be a valid XrSession handle
• space must be a valid XrSpace handle
• roomLayoutOutput must be a pointer to an XrRoomLayoutFB 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

XrRoomLayoutFB

Parameters:

session - a handle to an XrSession.

space - the XrSpace handle to the spatial entity.

roomLayoutOutput - an output parameter pointing to the structure containing the XrRoomLayoutFB for space.