Package org.lwjgl.openxr

Class FBRenderModel

java.lang.Object

org.lwjgl.openxr.FBRenderModel

public class FBRenderModel
extends Object

The XR_FB_render_model extension.

This extension allows applications to request GLTF models for certain connected devices supported by the runtime. Paths that correspond to these devices will be provided through the extension and can be used to get information about the models as well as loading them.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_ERROR_RENDER_MODEL_KEY_INVALID_FB	Extends XrResult.
static final String	XR_FB_RENDER_MODEL_EXTENSION_NAME	The extension name.
static final int	XR_FB_render_model_SPEC_VERSION	The extension specification version.
static final int	XR_MAX_RENDER_MODEL_NAME_SIZE_FB	XR_MAX_RENDER_MODEL_NAME_SIZE_FB
static final long	XR_NULL_RENDER_MODEL_KEY_FB	API Constants
static final int	XR_RENDER_MODEL_SUPPORTS_GLTF_2_0_SUBSET_1_BIT_FB	XrRenderModelFlagBitsFB - XrRenderModelFlagBitsFB
static final int	XR_RENDER_MODEL_SUPPORTS_GLTF_2_0_SUBSET_2_BIT_FB	XrRenderModelFlagBitsFB - XrRenderModelFlagBitsFB
static final int	XR_RENDER_MODEL_UNAVAILABLE_FB	Extends XrResult.
static final int	XR_TYPE_RENDER_MODEL_BUFFER_FB	Extends XrStructureType.
static final int	XR_TYPE_RENDER_MODEL_CAPABILITIES_REQUEST_FB	Extends XrStructureType.
static final int	XR_TYPE_RENDER_MODEL_LOAD_INFO_FB	Extends XrStructureType.
static final int	XR_TYPE_RENDER_MODEL_PATH_INFO_FB	Extends XrStructureType.
static final int	XR_TYPE_RENDER_MODEL_PROPERTIES_FB	Extends XrStructureType.
static final int	XR_TYPE_SYSTEM_RENDER_MODEL_PROPERTIES_FB	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrEnumerateRenderModelPathsFB(XrSession session, int pathCapacityInput, long pathCountOutput, long paths)	Unsafe version of: EnumerateRenderModelPathsFB
static int	nxrGetRenderModelPropertiesFB(XrSession session, long path, long properties)	Unsafe version of: GetRenderModelPropertiesFB
static int	nxrLoadRenderModelFB(XrSession session, long info, long buffer)	Unsafe version of: LoadRenderModelFB
static int	xrEnumerateRenderModelPathsFB(XrSession session, IntBuffer pathCountOutput, @Nullable XrRenderModelPathInfoFB.Buffer paths)	Enumerate supported render model paths.
static int	xrGetRenderModelPropertiesFB(XrSession session, long path, XrRenderModelPropertiesFB properties)	Get information for a render model.
static int	xrLoadRenderModelFB(XrSession session, XrRenderModelLoadInfoFB info, XrRenderModelBufferFB buffer)	Load binary data for a render model.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_render_model_SPEC_VERSION

public static final int XR_FB_render_model_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_RENDER_MODEL_EXTENSION_NAME

public static final String XR_FB_RENDER_MODEL_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_MAX_RENDER_MODEL_NAME_SIZE_FB

public static final int XR_MAX_RENDER_MODEL_NAME_SIZE_FB

XR_MAX_RENDER_MODEL_NAME_SIZE_FB

See Also:

• Constant Field Values

XR_TYPE_RENDER_MODEL_PATH_INFO_FB

public static final int XR_TYPE_RENDER_MODEL_PATH_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_RENDER_MODEL_PATH_INFO_FB
• TYPE_RENDER_MODEL_PROPERTIES_FB
• TYPE_RENDER_MODEL_BUFFER_FB
• TYPE_RENDER_MODEL_LOAD_INFO_FB
• TYPE_SYSTEM_RENDER_MODEL_PROPERTIES_FB
• TYPE_RENDER_MODEL_CAPABILITIES_REQUEST_FB

See Also:

• Constant Field Values

XR_TYPE_RENDER_MODEL_PROPERTIES_FB

public static final int XR_TYPE_RENDER_MODEL_PROPERTIES_FB

Extends XrStructureType.

Enum values:

• TYPE_RENDER_MODEL_PATH_INFO_FB
• TYPE_RENDER_MODEL_PROPERTIES_FB
• TYPE_RENDER_MODEL_BUFFER_FB
• TYPE_RENDER_MODEL_LOAD_INFO_FB
• TYPE_SYSTEM_RENDER_MODEL_PROPERTIES_FB
• TYPE_RENDER_MODEL_CAPABILITIES_REQUEST_FB

See Also:

• Constant Field Values

XR_TYPE_RENDER_MODEL_BUFFER_FB

public static final int XR_TYPE_RENDER_MODEL_BUFFER_FB

Extends XrStructureType.

Enum values:

• TYPE_RENDER_MODEL_PATH_INFO_FB
• TYPE_RENDER_MODEL_PROPERTIES_FB
• TYPE_RENDER_MODEL_BUFFER_FB
• TYPE_RENDER_MODEL_LOAD_INFO_FB
• TYPE_SYSTEM_RENDER_MODEL_PROPERTIES_FB
• TYPE_RENDER_MODEL_CAPABILITIES_REQUEST_FB

See Also:

• Constant Field Values

XR_TYPE_RENDER_MODEL_LOAD_INFO_FB

public static final int XR_TYPE_RENDER_MODEL_LOAD_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_RENDER_MODEL_PATH_INFO_FB
• TYPE_RENDER_MODEL_PROPERTIES_FB
• TYPE_RENDER_MODEL_BUFFER_FB
• TYPE_RENDER_MODEL_LOAD_INFO_FB
• TYPE_SYSTEM_RENDER_MODEL_PROPERTIES_FB
• TYPE_RENDER_MODEL_CAPABILITIES_REQUEST_FB

See Also:

• Constant Field Values

XR_TYPE_SYSTEM_RENDER_MODEL_PROPERTIES_FB

public static final int XR_TYPE_SYSTEM_RENDER_MODEL_PROPERTIES_FB

Extends XrStructureType.

Enum values:

• TYPE_RENDER_MODEL_PATH_INFO_FB
• TYPE_RENDER_MODEL_PROPERTIES_FB
• TYPE_RENDER_MODEL_BUFFER_FB
• TYPE_RENDER_MODEL_LOAD_INFO_FB
• TYPE_SYSTEM_RENDER_MODEL_PROPERTIES_FB
• TYPE_RENDER_MODEL_CAPABILITIES_REQUEST_FB

See Also:

• Constant Field Values

XR_TYPE_RENDER_MODEL_CAPABILITIES_REQUEST_FB

public static final int XR_TYPE_RENDER_MODEL_CAPABILITIES_REQUEST_FB

Extends XrStructureType.

Enum values:

• TYPE_RENDER_MODEL_PATH_INFO_FB
• TYPE_RENDER_MODEL_PROPERTIES_FB
• TYPE_RENDER_MODEL_BUFFER_FB
• TYPE_RENDER_MODEL_LOAD_INFO_FB
• TYPE_SYSTEM_RENDER_MODEL_PROPERTIES_FB
• TYPE_RENDER_MODEL_CAPABILITIES_REQUEST_FB

See Also:

• Constant Field Values

XR_ERROR_RENDER_MODEL_KEY_INVALID_FB

public static final int XR_ERROR_RENDER_MODEL_KEY_INVALID_FB

Extends XrResult.

Enum values:

• ERROR_RENDER_MODEL_KEY_INVALID_FB
• RENDER_MODEL_UNAVAILABLE_FB

See Also:

• Constant Field Values

XR_RENDER_MODEL_UNAVAILABLE_FB

public static final int XR_RENDER_MODEL_UNAVAILABLE_FB

Extends XrResult.

Enum values:

• ERROR_RENDER_MODEL_KEY_INVALID_FB
• RENDER_MODEL_UNAVAILABLE_FB

See Also:

• Constant Field Values

XR_RENDER_MODEL_SUPPORTS_GLTF_2_0_SUBSET_1_BIT_FB

public static final int XR_RENDER_MODEL_SUPPORTS_GLTF_2_0_SUBSET_1_BIT_FB

XrRenderModelFlagBitsFB - XrRenderModelFlagBitsFB

Flag Descriptions

• RENDER_MODEL_SUPPORTS_GLTF_2_0_SUBSET_1_BIT_FB — Minimal level of support. Can only contain a single mesh. Can only contain a single texture. Can not contain transparency. Assumes unlit rendering. Requires Extension KHR_texturebasisu.
• RENDER_MODEL_SUPPORTS_GLTF_2_0_SUBSET_2_BIT_FB — All of XR_RENDER_MODEL_SUPPORTS_GLTF_2_0_SUBSET_1_BIT_FB support plus: Multiple meshes. Multiple Textures. Texture Transparency.

Render Model Support Levels: An application should request a model of a certain complexity via the XrRenderModelCapabilitiesRequestFB on the structure chain of XrRenderModelPropertiesFB passed into GetRenderModelPropertiesFB. The flags on the XrRenderModelCapabilitiesRequestFB are an acknowledgement of the application’s ability to render such a model. Multiple values of XrRenderModelFlagBitsFB can be set on this variable to indicate acceptance of different support levels. The flags parameter on the XrRenderModelPropertiesFB will indicate what capabilities the model in the runtime actually requires. It will be set to a single value of XrRenderModelFlagBitsFB.

See Also:

• Constant Field Values

XR_RENDER_MODEL_SUPPORTS_GLTF_2_0_SUBSET_2_BIT_FB

public static final int XR_RENDER_MODEL_SUPPORTS_GLTF_2_0_SUBSET_2_BIT_FB

XrRenderModelFlagBitsFB - XrRenderModelFlagBitsFB

Flag Descriptions

• RENDER_MODEL_SUPPORTS_GLTF_2_0_SUBSET_1_BIT_FB — Minimal level of support. Can only contain a single mesh. Can only contain a single texture. Can not contain transparency. Assumes unlit rendering. Requires Extension KHR_texturebasisu.
• RENDER_MODEL_SUPPORTS_GLTF_2_0_SUBSET_2_BIT_FB — All of XR_RENDER_MODEL_SUPPORTS_GLTF_2_0_SUBSET_1_BIT_FB support plus: Multiple meshes. Multiple Textures. Texture Transparency.

Render Model Support Levels: An application should request a model of a certain complexity via the XrRenderModelCapabilitiesRequestFB on the structure chain of XrRenderModelPropertiesFB passed into GetRenderModelPropertiesFB. The flags on the XrRenderModelCapabilitiesRequestFB are an acknowledgement of the application’s ability to render such a model. Multiple values of XrRenderModelFlagBitsFB can be set on this variable to indicate acceptance of different support levels. The flags parameter on the XrRenderModelPropertiesFB will indicate what capabilities the model in the runtime actually requires. It will be set to a single value of XrRenderModelFlagBitsFB.

See Also:

• Constant Field Values

XR_NULL_RENDER_MODEL_KEY_FB

public static final long XR_NULL_RENDER_MODEL_KEY_FB

API Constants

See Also:

• Constant Field Values

Method Details

nxrEnumerateRenderModelPathsFB

public static int nxrEnumerateRenderModelPathsFB(XrSession session,
 int pathCapacityInput,
 long pathCountOutput,
 long paths)

Unsafe version of: EnumerateRenderModelPathsFB

Parameters:

pathCapacityInput - the capacity of the paths, or 0 to retrieve the required capacity.

xrEnumerateRenderModelPathsFB

public static int xrEnumerateRenderModelPathsFB(XrSession session,
 IntBuffer pathCountOutput,
 @Nullable XrRenderModelPathInfoFB.Buffer paths)

Enumerate supported render model paths.

C Specification

The EnumerateRenderModelPathsFB function is defined as:

 XrResult xrEnumerateRenderModelPathsFB(
     XrSession                                   session,
     uint32_t                                    pathCapacityInput,
     uint32_t*                                   pathCountOutput,
     XrRenderModelPathInfoFB*                    paths);

Description

The application must call EnumerateRenderModelPathsFB to enumerate the valid render model paths that are supported by the runtime before calling GetRenderModelPropertiesFB. The paths returned may be used later in GetRenderModelPropertiesFB.

Valid Usage (Implicit)

• The XR_FB_render_model extension must be enabled prior to calling EnumerateRenderModelPathsFB
• session must be a valid XrSession handle
• pathCountOutput must be a pointer to a uint32_t value
• If pathCapacityInput is not 0, paths must be a pointer to an array of pathCapacityInput XrRenderModelPathInfoFB structures

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

See Also

XrRenderModelPathInfoFB

Parameters:

session - the specified XrSession.

pathCountOutput - a pointer to the count of float paths written, or a pointer to the required capacity in the case that pathCapacityInput is insufficient.

paths - a pointer to an application-allocated array that will be filled with XrRenderModelPathInfoFB values that are supported by the runtime, but can be NULL if pathCapacityInput is 0

nxrGetRenderModelPropertiesFB

public static int nxrGetRenderModelPropertiesFB(XrSession session,
 long path,
 long properties)

Unsafe version of: GetRenderModelPropertiesFB

xrGetRenderModelPropertiesFB

public static int xrGetRenderModelPropertiesFB(XrSession session,
 long path,
 XrRenderModelPropertiesFB properties)

Get information for a render model.

C Specification

The GetRenderModelPropertiesFB function is defined as:

 XrResult xrGetRenderModelPropertiesFB(
     XrSession                                   session,
     XrPath                                      path,
     XrRenderModelPropertiesFB*                  properties);

Description

GetRenderModelPropertiesFB is used for getting information for a render model using a path retrieved from EnumerateRenderModelPathsFB. The information returned will be for the connected device that corresponds to the path given. For example, using pathname:/model_fb/controller/left will return information for the left controller that is currently connected and will change if a different device that also represents a left controller is connected.

The runtime must return ERROR_CALL_ORDER_INVALID if GetRenderModelPropertiesFB is called with render model paths before calling EnumerateRenderModelPathsFB. The runtime must return ERROR_PATH_INVALID if a path not given by EnumerateRenderModelPathsFB is used.

If GetRenderModelPropertiesFB returns a success code of RENDER_MODEL_UNAVAILABLE_FB and has a XrRenderModelPropertiesFB::modelKey of NULL_RENDER_MODEL_KEY_FB, this indicates that the model for the device is unavailable. The application may keep calling GetRenderModelPropertiesFB because the model may become available later when a device is connected.

Valid Usage (Implicit)

• The XR_FB_render_model extension must be enabled prior to calling GetRenderModelPropertiesFB
• session must be a valid XrSession handle
• properties must be a pointer to an XrRenderModelPropertiesFB structure

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING
• RENDER_MODEL_UNAVAILABLE_FB

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_PATH_UNSUPPORTED
• ERROR_PATH_INVALID
• ERROR_CALL_ORDER_INVALID

See Also

XrRenderModelPropertiesFB

Parameters:

session - the specified XrSession.

path - the path of the render model to get the properties for.

properties - a pointer to the XrRenderModelPropertiesFB to write the render model information to.

nxrLoadRenderModelFB

public static int nxrLoadRenderModelFB(XrSession session,
 long info,
 long buffer)

Unsafe version of: LoadRenderModelFB

xrLoadRenderModelFB

public static int xrLoadRenderModelFB(XrSession session,
 XrRenderModelLoadInfoFB info,
 XrRenderModelBufferFB buffer)

Load binary data for a render model.

C Specification

The LoadRenderModelFB function is defined as:

 XrResult xrLoadRenderModelFB(
     XrSession                                   session,
     const XrRenderModelLoadInfoFB*              info,
     XrRenderModelBufferFB*                      buffer);

Description

LoadRenderModelFB is used to load the GLTF model data using a valid XrRenderModelLoadInfoFB::modelKey. LoadRenderModelFB loads the model as a byte buffer containing the GLTF in the binary format (GLB). The GLB data must conform to the glTF 2.0 format defined at https://registry.khronos.org/glTF/specs/2.0/glTF-2.0.html. The GLB may contain texture data in a format that requires the use of the KHR_texture_basisu GLTF extension defined at https://github.com/KhronosGroup/glTF/tree/main/extensions/2.0/Khronos/KHR_texture_basisu. Therefore, the application should ensure it can handle this extension.

If the device for the requested model is disconnected or does not match the XrRenderModelLoadInfoFB::modelKey provided, LoadRenderModelFB must return RENDER_MODEL_UNAVAILABLE_FB as well as an XrRenderModelBufferFB::bufferCountOutput value of 0 indicating that the model was not available.

The LoadRenderModelFB function may be slow, therefore applications should call it from a non-time sensitive thread.

Valid Usage (Implicit)

• The XR_FB_render_model extension must be enabled prior to calling LoadRenderModelFB
• session must be a valid XrSession handle
• info must be a pointer to a valid XrRenderModelLoadInfoFB structure
• buffer must be a pointer to an XrRenderModelBufferFB structure

Return Codes

On success, this command returns

• SUCCESS
• SESSION_LOSS_PENDING
• RENDER_MODEL_UNAVAILABLE_FB

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_RENDER_MODEL_KEY_INVALID_FB

See Also

XrRenderModelBufferFB, XrRenderModelLoadInfoFB

Parameters:

session - the specified XrSession.

info - a pointer to the XrRenderModelLoadInfoFB structure.

buffer - a pointer to the XrRenderModelBufferFB structure to write the binary data into.