Class FBPassthrough
- java.lang.Object
-
- org.lwjgl.openxr.FBPassthrough
-
public class FBPassthrough extends java.lang.ObjectThe FB_passthrough extension.
-
-
Field Summary
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static intnxrCreateGeometryInstanceFB(XrSession session, long createInfo, long outGeometryInstance)Unsafe version of:CreateGeometryInstanceFBstatic intnxrCreatePassthroughFB(XrSession session, long createInfo, long outPassthrough)Unsafe version of:CreatePassthroughFBstatic intnxrCreatePassthroughLayerFB(XrSession session, long createInfo, long outLayer)Unsafe version of:CreatePassthroughLayerFBstatic intnxrGeometryInstanceSetTransformFB(XrGeometryInstanceFB instance, long transformation)Unsafe version of:GeometryInstanceSetTransformFBstatic intnxrPassthroughLayerSetStyleFB(XrPassthroughLayerFB layer, long style)Unsafe version of:PassthroughLayerSetStyleFBstatic intxrCreateGeometryInstanceFB(XrSession session, XrGeometryInstanceCreateInfoFB createInfo, org.lwjgl.PointerBuffer outGeometryInstance)Create a triangle mesh.static intxrCreatePassthroughFB(XrSession session, XrPassthroughCreateInfoFB createInfo, org.lwjgl.PointerBuffer outPassthrough)Create a passthrough feature.static intxrCreatePassthroughLayerFB(XrSession session, XrPassthroughLayerCreateInfoFB createInfo, org.lwjgl.PointerBuffer outLayer)Create a passthrough layer.static intxrDestroyGeometryInstanceFB(XrGeometryInstanceFB instance)Destroy a geometry instance.static intxrDestroyPassthroughFB(XrPassthroughFB passthrough)Destroy a passthrough feature.static intxrDestroyPassthroughLayerFB(XrPassthroughLayerFB layer)Destroy a passthrough layer.static intxrGeometryInstanceSetTransformFB(XrGeometryInstanceFB instance, XrGeometryInstanceTransformFB transformation)Create a triangle mesh.static intxrPassthroughLayerPauseFB(XrPassthroughLayerFB layer)Pause a passthrough layer.static intxrPassthroughLayerResumeFB(XrPassthroughLayerFB layer)Resume a passthrough layer.static intxrPassthroughLayerSetStyleFB(XrPassthroughLayerFB layer, XrPassthroughStyleFB style)Set style on a passthrough layer.static intxrPassthroughPauseFB(XrPassthroughFB passthrough)Pause a passthrough feature.static intxrPassthroughStartFB(XrPassthroughFB passthrough)Start a passthrough feature.
-
-
-
Field Detail
-
XR_FB_passthrough_SPEC_VERSION
The extension specification version.
-
XR_FB_PASSTHROUGH_EXTENSION_NAME
The extension name.
-
XR_TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB, XR_TYPE_PASSTHROUGH_CREATE_INFO_FB, XR_TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB, XR_TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB, XR_TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB, XR_TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB, XR_TYPE_PASSTHROUGH_STYLE_FB, XR_TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB, XR_TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB, XR_TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB
ExtendsXrStructureType.Enum values:
TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FBTYPE_PASSTHROUGH_CREATE_INFO_FBTYPE_PASSTHROUGH_LAYER_CREATE_INFO_FBTYPE_COMPOSITION_LAYER_PASSTHROUGH_FBTYPE_GEOMETRY_INSTANCE_CREATE_INFO_FBTYPE_GEOMETRY_INSTANCE_TRANSFORM_FBTYPE_PASSTHROUGH_STYLE_FBTYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FBTYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FBTYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB
-
XR_ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB, XR_ERROR_FEATURE_ALREADY_CREATED_PASSTHROUGH_FB, XR_ERROR_FEATURE_REQUIRED_PASSTHROUGH_FB, XR_ERROR_NOT_PERMITTED_PASSTHROUGH_FB, XR_ERROR_INSUFFICIENT_RESOURCES_PASSTHROUGH_FB, XR_ERROR_UNKNOWN_PASSTHROUGH_FB
-
XR_PASSTHROUGH_COLOR_MAP_MONO_SIZE_FB
XR_PASSTHROUGH_COLOR_MAP_MONO_SIZE_FB
-
XR_OBJECT_TYPE_PASSTHROUGH_FB, XR_OBJECT_TYPE_PASSTHROUGH_LAYER_FB, XR_OBJECT_TYPE_GEOMETRY_INSTANCE_FB
ExtendsXrObjectType.Enum values:
-
XR_PASSTHROUGH_IS_RUNNING_AT_CREATION_BIT_FB
XrPassthroughFlagBitsFB
-
XR_PASSTHROUGH_LAYER_PURPOSE_RECONSTRUCTION_FB, XR_PASSTHROUGH_LAYER_PURPOSE_PROJECTED_FB
XrPassthroughLayerPurposeFB - Layer purposeEnumerant Descriptions
PASSTHROUGH_LAYER_PURPOSE_RECONSTRUCTION_FB— Reconstruction passthrough (full screen environment)PASSTHROUGH_LAYER_PURPOSE_PROJECTED_FB— Projected passthrough (using a custom surface)PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_HANDS_FB— Passthrough layer purpose for keyboard hands presence.
See Also
-
XR_PASSTHROUGH_STATE_CHANGED_REINIT_REQUIRED_BIT_FB, XR_PASSTHROUGH_STATE_CHANGED_NON_RECOVERABLE_ERROR_BIT_FB, XR_PASSTHROUGH_STATE_CHANGED_RECOVERABLE_ERROR_BIT_FB, XR_PASSTHROUGH_STATE_CHANGED_RESTORED_ERROR_BIT_FB
XrPassthroughStateChangedFlagBitsFBEnum values:
-
-
Method Detail
-
nxrCreatePassthroughFB
public static int nxrCreatePassthroughFB(XrSession session, long createInfo, long outPassthrough)
Unsafe version of:CreatePassthroughFB
-
xrCreatePassthroughFB
public static int xrCreatePassthroughFB(XrSession session, XrPassthroughCreateInfoFB createInfo, org.lwjgl.PointerBuffer outPassthrough)
Create a passthrough feature.C Specification
The
CreatePassthroughFBfunction is defined as:XrResult xrCreatePassthroughFB( XrSession session, const XrPassthroughCreateInfoFB* createInfo, XrPassthroughFB* outPassthrough);Description
Creates an
XrPassthroughFBhandle. The returned passthrough handle may be subsequently used in API calls.Valid Usage (Implicit)
- The
XR_FB_passthroughextension must be enabled prior to callingCreatePassthroughFB sessionmust be a validXrSessionhandlecreateInfomust be a pointer to a validXrPassthroughCreateInfoFBstructureoutPassthroughmust be a pointer to anXrPassthroughFBhandle
Return Codes
- On success, this command returns
- On failure, this command returns
ERROR_FUNCTION_UNSUPPORTEDERROR_VALIDATION_FAILUREERROR_RUNTIME_FAILUREERROR_HANDLE_INVALIDERROR_INSTANCE_LOSTERROR_SESSION_LOSTERROR_OUT_OF_MEMORYERROR_LIMIT_REACHEDERROR_UNKNOWN_PASSTHROUGH_FBERROR_NOT_PERMITTED_PASSTHROUGH_FBERROR_FEATURE_UNSUPPORTEDERROR_FEATURE_ALREADY_CREATED_PASSTHROUGH_FB
See Also
- Parameters:
session- theXrSession.createInfo- theXrPassthroughCreateInfoFB.outPassthrough- theXrPassthroughFB.
- The
-
xrDestroyPassthroughFB
public static int xrDestroyPassthroughFB(XrPassthroughFB passthrough)
Destroy a passthrough feature.C Specification
The
DestroyPassthroughFBfunction is defined as:XrResult xrDestroyPassthroughFB( XrPassthroughFB passthrough);Description
Destroys an
XrPassthroughFBhandle.Valid Usage (Implicit)
- The
XR_FB_passthroughextension must be enabled prior to callingDestroyPassthroughFB passthroughmust be a validXrPassthroughFBhandle
Thread Safety
- Access to
passthrough, and any child handles, must be externally synchronized
Return Codes
- On success, this command returns
- On failure, this command returns
- Parameters:
passthrough- theXrPassthroughFBto be destroyed.
- The
-
xrPassthroughStartFB
public static int xrPassthroughStartFB(XrPassthroughFB passthrough)
Start a passthrough feature.C Specification
The
PassthroughStartFBfunction is defined as:XrResult xrPassthroughStartFB( XrPassthroughFB passthrough);Description
Starts an
XrPassthroughFBfeature. If the feature is not started, either explicitly with a call toPassthroughStartFB, or implicitly at creation using the behavior flags, it is considered paused. When the feature is paused, runtime will stop rendering and compositing all passthrough layers produced on behalf of the application, and may free up some or all the resources used to produce passthrough untilPassthroughStartFBis called.Valid Usage (Implicit)
- The
XR_FB_passthroughextension must be enabled prior to callingPassthroughStartFB passthroughmust be a validXrPassthroughFBhandle
Return Codes
- On success, this command returns
- On failure, this command returns
- Parameters:
passthrough- theXrPassthroughFBto be started.
- The
-
xrPassthroughPauseFB
public static int xrPassthroughPauseFB(XrPassthroughFB passthrough)
Pause a passthrough feature.C Specification
The
PassthroughPauseFBfunction is defined as:XrResult xrPassthroughPauseFB( XrPassthroughFB passthrough);Description
Pauses an
XrPassthroughFBfeature. When the feature is paused, runtime will stop rendering and compositing all passthrough layers produced on behalf of the application, and may free up some or all the resources used to produce passthrough untilPassthroughStartFBis called.Valid Usage (Implicit)
- The
XR_FB_passthroughextension must be enabled prior to callingPassthroughPauseFB passthroughmust be a validXrPassthroughFBhandle
Return Codes
- On success, this command returns
- On failure, this command returns
- Parameters:
passthrough- theXrPassthroughFBto be paused.
- The
-
nxrCreatePassthroughLayerFB
public static int nxrCreatePassthroughLayerFB(XrSession session, long createInfo, long outLayer)
Unsafe version of:CreatePassthroughLayerFB
-
xrCreatePassthroughLayerFB
public static int xrCreatePassthroughLayerFB(XrSession session, XrPassthroughLayerCreateInfoFB createInfo, org.lwjgl.PointerBuffer outLayer)
Create a passthrough layer.C Specification
The
CreatePassthroughLayerFBfunction is defined as:XrResult xrCreatePassthroughLayerFB( XrSession session, const XrPassthroughLayerCreateInfoFB* createInfo, XrPassthroughLayerFB* outLayer);Description
Creates an
XrPassthroughLayerFBhandle. The returned layer handle may be subsequently used in API calls. Layer objects may be used to specify rendering properties of the layer, such as styles, and compositing rules.Valid Usage (Implicit)
- The
XR_FB_passthroughextension must be enabled prior to callingCreatePassthroughLayerFB sessionmust be a validXrSessionhandlecreateInfomust be a pointer to a validXrPassthroughLayerCreateInfoFBstructureoutLayermust be a pointer to anXrPassthroughLayerFBhandle
Return Codes
- On success, this command returns
- On failure, this command returns
ERROR_FUNCTION_UNSUPPORTEDERROR_VALIDATION_FAILUREERROR_RUNTIME_FAILUREERROR_HANDLE_INVALIDERROR_INSTANCE_LOSTERROR_SESSION_LOSTERROR_OUT_OF_MEMORYERROR_LIMIT_REACHEDERROR_UNKNOWN_PASSTHROUGH_FBERROR_INSUFFICIENT_RESOURCES_PASSTHROUGH_FBERROR_FEATURE_UNSUPPORTEDERROR_FEATURE_REQUIRED_PASSTHROUGH_FB
See Also
- Parameters:
session- theXrSession.createInfo- theXrPassthroughLayerCreateInfoFB.outLayer- theXrPassthroughLayerFB.
- The
-
xrDestroyPassthroughLayerFB
public static int xrDestroyPassthroughLayerFB(XrPassthroughLayerFB layer)
Destroy a passthrough layer.C Specification
The
DestroyPassthroughLayerFBfunction is defined as:XrResult xrDestroyPassthroughLayerFB( XrPassthroughLayerFB layer);Description
Destroys an
XrPassthroughLayerFBhandle.Valid Usage (Implicit)
- The
XR_FB_passthroughextension must be enabled prior to callingDestroyPassthroughLayerFB layermust be a validXrPassthroughLayerFBhandle
Thread Safety
- Access to
layer, and any child handles, must be externally synchronized
Return Codes
- On success, this command returns
- On failure, this command returns
- Parameters:
layer- theXrPassthroughLayerFBto be destroyed.
- The
-
xrPassthroughLayerPauseFB
public static int xrPassthroughLayerPauseFB(XrPassthroughLayerFB layer)
Pause a passthrough layer.C Specification
The
PassthroughLayerPauseFBfunction is defined as:XrResult xrPassthroughLayerPauseFB( XrPassthroughLayerFB layer);Description
Pauses an
XrPassthroughLayerFBlayer. Runtime will not render or composite paused layers.Valid Usage (Implicit)
- The
XR_FB_passthroughextension must be enabled prior to callingPassthroughLayerPauseFB layermust be a validXrPassthroughLayerFBhandle
Return Codes
- On success, this command returns
- On failure, this command returns
- Parameters:
layer- theXrPassthroughLayerFBto be paused.
- The
-
xrPassthroughLayerResumeFB
public static int xrPassthroughLayerResumeFB(XrPassthroughLayerFB layer)
Resume a passthrough layer.C Specification
The
PassthroughLayerResumeFBfunction is defined as:XrResult xrPassthroughLayerResumeFB( XrPassthroughLayerFB layer);Description
Resumes an
XrPassthroughLayerFBlayer.Valid Usage (Implicit)
- The
XR_FB_passthroughextension must be enabled prior to callingPassthroughLayerResumeFB layermust be a validXrPassthroughLayerFBhandle
Return Codes
- On success, this command returns
- On failure, this command returns
- Parameters:
layer- theXrPassthroughLayerFBto be resumed.
- The
-
nxrPassthroughLayerSetStyleFB
public static int nxrPassthroughLayerSetStyleFB(XrPassthroughLayerFB layer, long style)
Unsafe version of:PassthroughLayerSetStyleFB
-
xrPassthroughLayerSetStyleFB
public static int xrPassthroughLayerSetStyleFB(XrPassthroughLayerFB layer, XrPassthroughStyleFB style)
Set style on a passthrough layer.C Specification
The
PassthroughLayerSetStyleFBfunction is defined as:XrResult xrPassthroughLayerSetStyleFB( XrPassthroughLayerFB layer, const XrPassthroughStyleFB* style);Description
Sets an
XrPassthroughStyleFBstyle on anXrPassthroughLayerFBlayer.Valid Usage (Implicit)
- The
XR_FB_passthroughextension must be enabled prior to callingPassthroughLayerSetStyleFB layermust be a validXrPassthroughLayerFBhandlestylemust be a pointer to a validXrPassthroughStyleFBstructure
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
layer- theXrPassthroughLayerFBto get the style.style- theXrPassthroughStyleFBto be set.
- The
-
nxrCreateGeometryInstanceFB
public static int nxrCreateGeometryInstanceFB(XrSession session, long createInfo, long outGeometryInstance)
Unsafe version of:CreateGeometryInstanceFB
-
xrCreateGeometryInstanceFB
public static int xrCreateGeometryInstanceFB(XrSession session, XrGeometryInstanceCreateInfoFB createInfo, org.lwjgl.PointerBuffer outGeometryInstance)
Create a triangle mesh.C Specification
The
CreateGeometryInstanceFBfunction is defined as:XrResult xrCreateGeometryInstanceFB( XrSession session, const XrGeometryInstanceCreateInfoFB* createInfo, XrGeometryInstanceFB* outGeometryInstance);Description
Creates an
XrGeometryInstanceFBhandle. Geometry instance functionality requires XR_FB_triangle_mesh extension to be enabled. AnXrGeometryInstanceFBconnects a layer, a mesh, and a transformation, with the semantics that a specific mesh will be instantiated in a specific layer with a specific transformation. A mesh can be instantiated multiple times, in the same or in different layers.Valid Usage (Implicit)
- The
XR_FB_passthroughextension must be enabled prior to callingCreateGeometryInstanceFB sessionmust be a validXrSessionhandlecreateInfomust be a pointer to a validXrGeometryInstanceCreateInfoFBstructureoutGeometryInstancemust be a pointer to anXrGeometryInstanceFBhandle
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
session- theXrSession.createInfo- theXrGeometryInstanceCreateInfoFB.outGeometryInstance- theXrGeometryInstanceFB.
- The
-
xrDestroyGeometryInstanceFB
public static int xrDestroyGeometryInstanceFB(XrGeometryInstanceFB instance)
Destroy a geometry instance.C Specification
The
DestroyGeometryInstanceFBfunction is defined as:XrResult xrDestroyGeometryInstanceFB( XrGeometryInstanceFB instance);Description
Destroys an
XrGeometryInstanceFBhandle. Destroying anXrGeometryInstanceFBdoes not destroy a mesh and does not free mesh resources. Destroying a layer invalidates all geometry instances attached to it. Destroying a mesh invalidates all its instances.Valid Usage (Implicit)
- The
XR_FB_passthroughextension must be enabled prior to callingDestroyGeometryInstanceFB instancemust be a validXrGeometryInstanceFBhandle
Thread Safety
- Access to
instance, and any child handles, must be externally synchronized
Return Codes
- On success, this command returns
- On failure, this command returns
- The
-
nxrGeometryInstanceSetTransformFB
public static int nxrGeometryInstanceSetTransformFB(XrGeometryInstanceFB instance, long transformation)
Unsafe version of:GeometryInstanceSetTransformFB
-
xrGeometryInstanceSetTransformFB
public static int xrGeometryInstanceSetTransformFB(XrGeometryInstanceFB instance, XrGeometryInstanceTransformFB transformation)
Create a triangle mesh.C Specification
The
GeometryInstanceSetTransformFBfunction is defined as:XrResult xrGeometryInstanceSetTransformFB( XrGeometryInstanceFB instance, const XrGeometryInstanceTransformFB* transformation);Description
Sets an
XrGeometryInstanceTransformFBtransform on anXrGeometryInstanceFBgeometry instance.Valid Usage (Implicit)
- The
XR_FB_passthroughextension must be enabled prior to callingGeometryInstanceSetTransformFB instancemust be a validXrGeometryInstanceFBhandletransformationmust be a pointer to a validXrGeometryInstanceTransformFBstructure
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- The
-
-