Top Description Fields Constructors Methods
org.lwjgl.openxr

public Class FBScene

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

Field Summary

Modifier and TypeField and Description
public static final String
XR_FB_SCENE_EXTENSION_NAME

The extension name.

public static final int
XR_FB_scene_SPEC_VERSION

The extension specification version.

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.
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.
public static final int
XR_TYPE_BOUNDARY_2D_FB

Extends XrStructureType.

public static final int
XR_TYPE_ROOM_LAYOUT_FB

Extends XrStructureType.

public static final int
XR_TYPE_SEMANTIC_LABELS_FB

Extends XrStructureType.

public static final int
XR_TYPE_SEMANTIC_LABELS_SUPPORT_INFO_FB

Extends XrStructureType.

Constructor Summary

AccessConstructor and Description
protected
FBScene()

Method Summary

Modifier and TypeMethod and Description
public static int
nxrGetSpaceBoundary2DFB(XrSession session, XrSpace space, long boundary2DOutput)

Unsafe version of: GetSpaceBoundary2DFB

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

Unsafe version of: GetSpaceBoundingBox2DFB

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

Unsafe version of: GetSpaceBoundingBox3DFB

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

Unsafe version of: GetSpaceRoomLayoutFB

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

Unsafe version of: GetSpaceSemanticLabelsFB

public static int
xrGetSpaceBoundary2DFB(XrSession
a handle to an XrSession.
session, XrSpace
the XrSpace handle to the spatial entity.
space, XrBoundary2DFB
an output parameter pointing to the structure containing the XrBoundary2DFB for space.
boundary2DOutput)

Gets the 2D boundary for a spatial entity.

public static int
xrGetSpaceBoundingBox2DFB(XrSession
a handle to an XrSession.
session, XrSpace
the XrSpace handle to the spatial entity.
space, XrRect2Df
an output parameter pointing to the structure containing the 2D bounding box for space.
boundingBox2DOutput)

Gets the 2D bounding box for a spatial entity.

public static int
xrGetSpaceBoundingBox3DFB(XrSession
a handle to an XrSession.
session, XrSpace
the XrSpace handle to the spatial entity.
space, XrRect3DfFB
an output parameter pointing to the structure containing the 3D bounding box for space.
boundingBox3DOutput)

Gets the 3D bounding box for a spatial entity.

public static int
xrGetSpaceRoomLayoutFB(XrSession
a handle to an XrSession.
session, XrSpace
the XrSpace handle to the spatial entity.
space, XrRoomLayoutFB
an output parameter pointing to the structure containing the XrRoomLayoutFB for space.
roomLayoutOutput)

Gets the room layout for a spatial entity.

public static int
xrGetSpaceSemanticLabelsFB(XrSession
a handle to an XrSession.
session, XrSpace
the XrSpace handle to the spatial entity.
space, XrSemanticLabelsFB
an output parameter pointing to the structure containing the XrSemanticLabelsFB for space.
semanticLabelsOutput)

Gets the semantic labels for a spatial entity.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

XR_FB_SCENE_EXTENSION_NAMEback to summary
public static final String XR_FB_SCENE_EXTENSION_NAME

The extension name.

XR_FB_scene_SPEC_VERSIONback to summary
public static final int XR_FB_scene_SPEC_VERSION

The extension specification version.

XR_SEMANTIC_LABELS_SUPPORT_ACCEPT_DESK_TO_TABLE_MIGRATION_BIT_FBback to summary
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.
XR_SEMANTIC_LABELS_SUPPORT_MULTIPLE_SEMANTIC_LABELS_BIT_FBback to summary
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.
XR_TYPE_BOUNDARY_2D_FBback to summary
public static final int XR_TYPE_BOUNDARY_2D_FB

Extends XrStructureType.

Enum values:
XR_TYPE_ROOM_LAYOUT_FBback to summary
public static final int XR_TYPE_ROOM_LAYOUT_FB

Extends XrStructureType.

Enum values:
XR_TYPE_SEMANTIC_LABELS_FBback to summary
public static final int XR_TYPE_SEMANTIC_LABELS_FB

Extends XrStructureType.

Enum values:
XR_TYPE_SEMANTIC_LABELS_SUPPORT_INFO_FBback to summary
public static final int XR_TYPE_SEMANTIC_LABELS_SUPPORT_INFO_FB

Extends XrStructureType.

Enum values:

Constructor Detail

FBSceneback to summary
protected FBScene()

Method Detail

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

Unsafe version of: GetSpaceBoundary2DFB

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

Unsafe version of: GetSpaceBoundingBox2DFB

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

Unsafe version of: GetSpaceBoundingBox3DFB

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

Unsafe version of: GetSpaceRoomLayoutFB

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

Unsafe version of: GetSpaceSemanticLabelsFB

xrGetSpaceBoundary2DFBback to summary
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
On failure, this command returns
See Also

XrBoundary2DFB

Parameters
session:XrSession

a handle to an XrSession.

space:XrSpace

the XrSpace handle to the spatial entity.

boundary2DOutput:XrBoundary2DFB

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

Annotations
@NativeType:XrResult
xrGetSpaceBoundingBox2DFBback to summary
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 offset and extent. The 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 extent refers to the dimensions of the box along each axis. The maximum corner can therefore be computed as offset 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
On failure, this command returns
See Also

XrRect2Df

Parameters
session:XrSession

a handle to an XrSession.

space:XrSpace

the XrSpace handle to the spatial entity.

boundingBox2DOutput:XrRect2Df

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

Annotations
@NativeType:XrResult
xrGetSpaceBoundingBox3DFBback to summary
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
On failure, this command returns
See Also

XrRect3DfFB

Parameters
session:XrSession

a handle to an XrSession.

space:XrSpace

the XrSpace handle to the spatial entity.

boundingBox3DOutput:XrRect3DfFB

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

Annotations
@NativeType:XrResult
xrGetSpaceRoomLayoutFBback to summary
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
On failure, this command returns
See Also

XrRoomLayoutFB

Parameters
session:XrSession

a handle to an XrSession.

space:XrSpace

the XrSpace handle to the spatial entity.

roomLayoutOutput:XrRoomLayoutFB

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

Annotations
@NativeType:XrResult
xrGetSpaceSemanticLabelsFBback to summary
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
On failure, this command returns
See Also

XrSemanticLabelsFB

Parameters
session:XrSession

a handle to an XrSession.

space:XrSpace

the XrSpace handle to the spatial entity.

semanticLabelsOutput:XrSemanticLabelsFB

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

Annotations
@NativeType:XrResult