Class FBRenderModel
- java.lang.Object
-
- org.lwjgl.openxr.FBRenderModel
-
public class FBRenderModel extends java.lang.ObjectThe FB_render_model extension.
-
-
Field Summary
Fields Modifier and Type Field Description static intXR_ERROR_RENDER_MODEL_KEY_INVALID_FBExtendsXrResult.static java.lang.StringXR_FB_RENDER_MODEL_EXTENSION_NAMEThe extension name.static intXR_FB_render_model_SPEC_VERSIONThe extension specification version.static intXR_MAX_RENDER_MODEL_NAME_SIZE_FBXR_MAX_RENDER_MODEL_NAME_SIZE_FBstatic longXR_NULL_RENDER_MODEL_KEY_FBAPI Constantsstatic intXR_RENDER_MODEL_UNAVAILABLE_FBExtendsXrResult.static intXR_TYPE_RENDER_MODEL_BUFFER_FB
XR_TYPE_RENDER_MODEL_LOAD_INFO_FB
XR_TYPE_RENDER_MODEL_PATH_INFO_FB
XR_TYPE_RENDER_MODEL_PROPERTIES_FB
XR_TYPE_SYSTEM_RENDER_MODEL_PROPERTIES_FBExtendsXrStructureType.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static intnxrEnumerateRenderModelPathsFB(XrSession session, int pathCapacityInput, long pathCountOutput, long paths)Unsafe version of:EnumerateRenderModelPathsFBstatic intnxrGetRenderModelPropertiesFB(XrSession session, long path, long properties)Unsafe version of:GetRenderModelPropertiesFBstatic intnxrLoadRenderModelFB(XrSession session, long info, long buffer)Unsafe version of:LoadRenderModelFBstatic intxrEnumerateRenderModelPathsFB(XrSession session, java.nio.IntBuffer pathCountOutput, XrRenderModelPathInfoFB.Buffer paths)Enumerate supported render model paths.static intxrGetRenderModelPropertiesFB(XrSession session, long path, XrRenderModelPropertiesFB properties)Get information for a render model.static intxrLoadRenderModelFB(XrSession session, XrRenderModelLoadInfoFB info, XrRenderModelBufferFB buffer)Load binary data for a render model.
-
-
-
Field Detail
-
XR_FB_render_model_SPEC_VERSION
The extension specification version.
-
XR_FB_RENDER_MODEL_EXTENSION_NAME
The extension name.
-
XR_MAX_RENDER_MODEL_NAME_SIZE_FB
XR_MAX_RENDER_MODEL_NAME_SIZE_FB
-
XR_TYPE_RENDER_MODEL_PATH_INFO_FB, XR_TYPE_RENDER_MODEL_PROPERTIES_FB, XR_TYPE_RENDER_MODEL_BUFFER_FB, XR_TYPE_RENDER_MODEL_LOAD_INFO_FB, XR_TYPE_SYSTEM_RENDER_MODEL_PROPERTIES_FB
ExtendsXrStructureType.Enum values:
-
XR_NULL_RENDER_MODEL_KEY_FB
API Constants
-
-
Method Detail
-
nxrEnumerateRenderModelPathsFB
public static int nxrEnumerateRenderModelPathsFB(XrSession session, int pathCapacityInput, long pathCountOutput, long paths)
Unsafe version of:EnumerateRenderModelPathsFB- Parameters:
pathCapacityInput- the capacity of thepaths, or 0 to retrieve the required capacity.
-
xrEnumerateRenderModelPathsFB
public static int xrEnumerateRenderModelPathsFB(XrSession session, java.nio.IntBuffer pathCountOutput, @Nullable XrRenderModelPathInfoFB.Buffer paths)
Enumerate supported render model paths.C Specification
The
EnumerateRenderModelPathsFBfunction is defined as:XrResult xrEnumerateRenderModelPathsFB( XrSession session, uint32_t pathCapacityInput, uint32_t* pathCountOutput, XrRenderModelPathInfoFB* paths);Description
The application must call
EnumerateRenderModelPathsFBto enumerate the valid render model paths that are supported by the runtime before callingGetRenderModelPropertiesFB. The paths returned may be used later inGetRenderModelPropertiesFB.Valid Usage (Implicit)
- The
XR_FB_render_modelextension must be enabled prior to callingEnumerateRenderModelPathsFB sessionmust be a validXrSessionhandlepathCountOutputmust be a pointer to auint32_tvalue- If
pathCapacityInputis not 0,pathsmust be a pointer to an array ofpathCapacityInputXrRenderModelPathInfoFBstructures
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
session- the specifiedXrSession.pathCountOutput- a pointer to the count offloatpathswritten, or a pointer to the required capacity in the case thatpathCapacityInputis 0.paths- a pointer to an application-allocated array that will be filled withXrRenderModelPathInfoFBvalues that are supported by the runtime, but can beNULLifpathCapacityInputis 0
- The
-
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
GetRenderModelPropertiesFBfunction is defined as:XrResult xrGetRenderModelPropertiesFB( XrSession session, XrPath path, XrRenderModelPropertiesFB* properties);Description
GetRenderModelPropertiesFBis used for getting information for a render model using a path retrieved fromEnumerateRenderModelPathsFB. 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_INVALIDifGetRenderModelPropertiesFBis called with render model paths before callingEnumerateRenderModelPathsFB. The runtime must returnERROR_PATH_INVALIDif a path not given byEnumerateRenderModelPathsFBis used.If
GetRenderModelPropertiesFBreturns a success code ofRENDER_MODEL_UNAVAILABLE_FBand has amodelKeyofNULL_RENDER_MODEL_KEY_FB, this indicates that the model for the device is unavailable. The application may keep callingGetRenderModelPropertiesFBbecause the model may become available later when a device is connected.Valid Usage (Implicit)
- The
XR_FB_render_modelextension must be enabled prior to callingGetRenderModelPropertiesFB sessionmust be a validXrSessionhandlepropertiesmust be a pointer to anXrRenderModelPropertiesFBstructure
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
session- the specifiedXrSession.path- the path of the render model to get the properties for.properties- a pointer to theXrRenderModelPropertiesFBto write the render model information to.
- The
-
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
LoadRenderModelFBfunction is defined as:XrResult xrLoadRenderModelFB( XrSession session, const XrRenderModelLoadInfoFB* info, XrRenderModelBufferFB* buffer);Description
LoadRenderModelFBis used to load the GLTF model data using a validmodelKey.LoadRenderModelFBloads 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://github.com/KhronosGroup/glTF/tree/master/specification/2.0. The GLB may contain texture data in a format that requires the use of theKHR_texture_basisuGLTF extension defined at https://github.com/KhronosGroup/glTF/tree/master/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
modelKeyprovided,LoadRenderModelFBmust returnRENDER_MODEL_UNAVAILABLE_FBas well as abufferCountOutputvalue of 0 indicating that the model was not available.The
LoadRenderModelFBfunction may be slow, therefore applications should call it from a non-time sensitive thread.Valid Usage (Implicit)
- The
XR_FB_render_modelextension must be enabled prior to callingLoadRenderModelFB sessionmust be a validXrSessionhandleinfomust be a pointer to a validXrRenderModelLoadInfoFBstructurebuffermust be a pointer to anXrRenderModelBufferFBstructure
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
session- the specifiedXrSession.info- a pointer to theXrRenderModelLoadInfoFBstructure.buffer- a pointer to theXrRenderModelBufferFBstructure to write the binary data into.
- The
-
-