Package org.lwjgl.openxr

Class FBPassthrough

java.lang.Object

org.lwjgl.openxr.FBPassthrough

public class FBPassthrough
extends Object

The XR_FB_passthrough extension.

Passthrough is a way to show a user their physical environment in a light-blocking VR headset. Applications may use passthrough in a multitude of ways, including:

• Creating AR-like experiences, where virtual objects augment the user’s environment.
• Bringing real objects into a VR experience.
• Mapping the playspace such that a VR experience is customized to it.

This extension allows:

• An application to request passthrough to be composited with the application content.
• An application to specify the compositing and blending rules between passthrough and VR content.
• An application to apply styles, such as color mapping and edge rendering, to passthrough.
• An application to provide a geometry to be used in place of the user’s physical environment. Camera images will be projected onto the surface provided by the application. In some cases where a part of the environment, such as a desk, can be approximated well, this provides better visual experience.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	XR_ERROR_FEATURE_ALREADY_CREATED_PASSTHROUGH_FB	Extends XrResult.
static final int	XR_ERROR_FEATURE_REQUIRED_PASSTHROUGH_FB	Extends XrResult.
static final int	XR_ERROR_INSUFFICIENT_RESOURCES_PASSTHROUGH_FB	Extends XrResult.
static final int	XR_ERROR_NOT_PERMITTED_PASSTHROUGH_FB	Extends XrResult.
static final int	XR_ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB	Extends XrResult.
static final int	XR_ERROR_UNKNOWN_PASSTHROUGH_FB	Extends XrResult.
static final String	XR_FB_PASSTHROUGH_EXTENSION_NAME	The extension name.
static final int	XR_FB_passthrough_SPEC_VERSION	The extension specification version.
static final int	XR_OBJECT_TYPE_GEOMETRY_INSTANCE_FB	Extends XrObjectType.
static final int	XR_OBJECT_TYPE_PASSTHROUGH_FB	Extends XrObjectType.
static final int	XR_OBJECT_TYPE_PASSTHROUGH_LAYER_FB	Extends XrObjectType.
static final int	XR_PASSTHROUGH_CAPABILITY_BIT_FB	XrPassthroughCapabilityFlagBitsFB - XrPassthroughCapabilityFlagBitsFB
static final int	XR_PASSTHROUGH_CAPABILITY_COLOR_BIT_FB	XrPassthroughCapabilityFlagBitsFB - XrPassthroughCapabilityFlagBitsFB
static final int	XR_PASSTHROUGH_CAPABILITY_LAYER_DEPTH_BIT_FB	XrPassthroughCapabilityFlagBitsFB - XrPassthroughCapabilityFlagBitsFB
static final int	XR_PASSTHROUGH_COLOR_MAP_MONO_SIZE_FB	XR_PASSTHROUGH_COLOR_MAP_MONO_SIZE_FB
static final int	XR_PASSTHROUGH_IS_RUNNING_AT_CREATION_BIT_FB	XrPassthroughFlagBitsFB - XrPassthroughFlagBitsFB
static final int	XR_PASSTHROUGH_LAYER_DEPTH_BIT_FB	XrPassthroughFlagBitsFB - XrPassthroughFlagBitsFB
static final int	XR_PASSTHROUGH_LAYER_PURPOSE_PROJECTED_FB	XrPassthroughLayerPurposeFB - Layer purpose
static final int	XR_PASSTHROUGH_LAYER_PURPOSE_RECONSTRUCTION_FB	XrPassthroughLayerPurposeFB - Layer purpose
static final int	XR_PASSTHROUGH_STATE_CHANGED_NON_RECOVERABLE_ERROR_BIT_FB	XrPassthroughStateChangedFlagBitsFB - XrPassthroughStateChangedFlagBitsFB
static final int	XR_PASSTHROUGH_STATE_CHANGED_RECOVERABLE_ERROR_BIT_FB	XrPassthroughStateChangedFlagBitsFB - XrPassthroughStateChangedFlagBitsFB
static final int	XR_PASSTHROUGH_STATE_CHANGED_REINIT_REQUIRED_BIT_FB	XrPassthroughStateChangedFlagBitsFB - XrPassthroughStateChangedFlagBitsFB
static final int	XR_PASSTHROUGH_STATE_CHANGED_RESTORED_ERROR_BIT_FB	XrPassthroughStateChangedFlagBitsFB - XrPassthroughStateChangedFlagBitsFB
static final int	XR_TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB	Extends XrStructureType.
static final int	XR_TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB	Extends XrStructureType.
static final int	XR_TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB	Extends XrStructureType.
static final int	XR_TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB	Extends XrStructureType.
static final int	XR_TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB	Extends XrStructureType.
static final int	XR_TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB	Extends XrStructureType.
static final int	XR_TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB	Extends XrStructureType.
static final int	XR_TYPE_PASSTHROUGH_CREATE_INFO_FB	Extends XrStructureType.
static final int	XR_TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB	Extends XrStructureType.
static final int	XR_TYPE_PASSTHROUGH_STYLE_FB	Extends XrStructureType.
static final int	XR_TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB	Extends XrStructureType.
static final int	XR_TYPE_SYSTEM_PASSTHROUGH_PROPERTIES2_FB	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrCreateGeometryInstanceFB(XrSession session, long createInfo, long outGeometryInstance)	Unsafe version of: CreateGeometryInstanceFB
static int	nxrCreatePassthroughFB(XrSession session, long createInfo, long outPassthrough)	Unsafe version of: CreatePassthroughFB
static int	nxrCreatePassthroughLayerFB(XrSession session, long createInfo, long outLayer)	Unsafe version of: CreatePassthroughLayerFB
static int	nxrGeometryInstanceSetTransformFB(XrGeometryInstanceFB instance, long transformation)	Unsafe version of: GeometryInstanceSetTransformFB
static int	nxrPassthroughLayerSetStyleFB(XrPassthroughLayerFB layer, long style)	Unsafe version of: PassthroughLayerSetStyleFB
static int	xrCreateGeometryInstanceFB(XrSession session, XrGeometryInstanceCreateInfoFB createInfo, org.lwjgl.PointerBuffer outGeometryInstance)	Create a triangle mesh.
static int	xrCreatePassthroughFB(XrSession session, XrPassthroughCreateInfoFB createInfo, org.lwjgl.PointerBuffer outPassthrough)	Create a passthrough feature.
static int	xrCreatePassthroughLayerFB(XrSession session, XrPassthroughLayerCreateInfoFB createInfo, org.lwjgl.PointerBuffer outLayer)	Create a passthrough layer.
static int	xrDestroyGeometryInstanceFB(XrGeometryInstanceFB instance)	Destroy a geometry instance.
static int	xrDestroyPassthroughFB(XrPassthroughFB passthrough)	Destroy a passthrough feature.
static int	xrDestroyPassthroughLayerFB(XrPassthroughLayerFB layer)	Destroy a passthrough layer.
static int	xrGeometryInstanceSetTransformFB(XrGeometryInstanceFB instance, XrGeometryInstanceTransformFB transformation)	Create a triangle mesh.
static int	xrPassthroughLayerPauseFB(XrPassthroughLayerFB layer)	Pause a passthrough layer.
static int	xrPassthroughLayerResumeFB(XrPassthroughLayerFB layer)	Resume a passthrough layer.
static int	xrPassthroughLayerSetStyleFB(XrPassthroughLayerFB layer, XrPassthroughStyleFB style)	Set style on a passthrough layer.
static int	xrPassthroughPauseFB(XrPassthroughFB passthrough)	Pause a passthrough feature.
static int	xrPassthroughStartFB(XrPassthroughFB passthrough)	Start a passthrough feature.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_passthrough_SPEC_VERSION

public static final int XR_FB_passthrough_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_PASSTHROUGH_EXTENSION_NAME

public static final String XR_FB_PASSTHROUGH_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB

public static final int XR_TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB
• TYPE_PASSTHROUGH_CREATE_INFO_FB
• TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB
• TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB
• TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB
• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES2_FB
• TYPE_PASSTHROUGH_STYLE_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB
• TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB
• TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB

See Also:

• Constant Field Values

XR_TYPE_PASSTHROUGH_CREATE_INFO_FB

public static final int XR_TYPE_PASSTHROUGH_CREATE_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB
• TYPE_PASSTHROUGH_CREATE_INFO_FB
• TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB
• TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB
• TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB
• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES2_FB
• TYPE_PASSTHROUGH_STYLE_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB
• TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB
• TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB

See Also:

• Constant Field Values

XR_TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB

public static final int XR_TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB
• TYPE_PASSTHROUGH_CREATE_INFO_FB
• TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB
• TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB
• TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB
• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES2_FB
• TYPE_PASSTHROUGH_STYLE_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB
• TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB
• TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB

See Also:

• Constant Field Values

XR_TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB

public static final int XR_TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB
• TYPE_PASSTHROUGH_CREATE_INFO_FB
• TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB
• TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB
• TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB
• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES2_FB
• TYPE_PASSTHROUGH_STYLE_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB
• TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB
• TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB

See Also:

• Constant Field Values

XR_TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB

public static final int XR_TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB
• TYPE_PASSTHROUGH_CREATE_INFO_FB
• TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB
• TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB
• TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB
• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES2_FB
• TYPE_PASSTHROUGH_STYLE_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB
• TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB
• TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB

See Also:

• Constant Field Values

XR_TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB

public static final int XR_TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB
• TYPE_PASSTHROUGH_CREATE_INFO_FB
• TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB
• TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB
• TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB
• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES2_FB
• TYPE_PASSTHROUGH_STYLE_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB
• TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB
• TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB

See Also:

• Constant Field Values

XR_TYPE_SYSTEM_PASSTHROUGH_PROPERTIES2_FB

public static final int XR_TYPE_SYSTEM_PASSTHROUGH_PROPERTIES2_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB
• TYPE_PASSTHROUGH_CREATE_INFO_FB
• TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB
• TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB
• TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB
• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES2_FB
• TYPE_PASSTHROUGH_STYLE_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB
• TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB
• TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB

See Also:

• Constant Field Values

XR_TYPE_PASSTHROUGH_STYLE_FB

public static final int XR_TYPE_PASSTHROUGH_STYLE_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB
• TYPE_PASSTHROUGH_CREATE_INFO_FB
• TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB
• TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB
• TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB
• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES2_FB
• TYPE_PASSTHROUGH_STYLE_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB
• TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB
• TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB

See Also:

• Constant Field Values

XR_TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB

public static final int XR_TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB
• TYPE_PASSTHROUGH_CREATE_INFO_FB
• TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB
• TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB
• TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB
• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES2_FB
• TYPE_PASSTHROUGH_STYLE_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB
• TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB
• TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB

See Also:

• Constant Field Values

XR_TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB

public static final int XR_TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB
• TYPE_PASSTHROUGH_CREATE_INFO_FB
• TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB
• TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB
• TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB
• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES2_FB
• TYPE_PASSTHROUGH_STYLE_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB
• TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB
• TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB

See Also:

• Constant Field Values

XR_TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB

public static final int XR_TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB
• TYPE_PASSTHROUGH_CREATE_INFO_FB
• TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB
• TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB
• TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB
• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES2_FB
• TYPE_PASSTHROUGH_STYLE_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB
• TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB
• TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB

See Also:

• Constant Field Values

XR_TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB

public static final int XR_TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB

Extends XrStructureType.

Enum values:

• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES_FB
• TYPE_PASSTHROUGH_CREATE_INFO_FB
• TYPE_PASSTHROUGH_LAYER_CREATE_INFO_FB
• TYPE_COMPOSITION_LAYER_PASSTHROUGH_FB
• TYPE_GEOMETRY_INSTANCE_CREATE_INFO_FB
• TYPE_GEOMETRY_INSTANCE_TRANSFORM_FB
• TYPE_SYSTEM_PASSTHROUGH_PROPERTIES2_FB
• TYPE_PASSTHROUGH_STYLE_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_RGBA_FB
• TYPE_PASSTHROUGH_COLOR_MAP_MONO_TO_MONO_FB
• TYPE_PASSTHROUGH_BRIGHTNESS_CONTRAST_SATURATION_FB
• TYPE_EVENT_DATA_PASSTHROUGH_STATE_CHANGED_FB

See Also:

• Constant Field Values

XR_ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB

public static final int XR_ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB

Extends XrResult.

Enum values:

• ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB
• ERROR_FEATURE_ALREADY_CREATED_PASSTHROUGH_FB
• ERROR_FEATURE_REQUIRED_PASSTHROUGH_FB
• ERROR_NOT_PERMITTED_PASSTHROUGH_FB
• ERROR_INSUFFICIENT_RESOURCES_PASSTHROUGH_FB
• ERROR_UNKNOWN_PASSTHROUGH_FB

See Also:

• Constant Field Values

XR_ERROR_FEATURE_ALREADY_CREATED_PASSTHROUGH_FB

public static final int XR_ERROR_FEATURE_ALREADY_CREATED_PASSTHROUGH_FB

Extends XrResult.

Enum values:

• ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB
• ERROR_FEATURE_ALREADY_CREATED_PASSTHROUGH_FB
• ERROR_FEATURE_REQUIRED_PASSTHROUGH_FB
• ERROR_NOT_PERMITTED_PASSTHROUGH_FB
• ERROR_INSUFFICIENT_RESOURCES_PASSTHROUGH_FB
• ERROR_UNKNOWN_PASSTHROUGH_FB

See Also:

• Constant Field Values

XR_ERROR_FEATURE_REQUIRED_PASSTHROUGH_FB

public static final int XR_ERROR_FEATURE_REQUIRED_PASSTHROUGH_FB

Extends XrResult.

Enum values:

• ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB
• ERROR_FEATURE_ALREADY_CREATED_PASSTHROUGH_FB
• ERROR_FEATURE_REQUIRED_PASSTHROUGH_FB
• ERROR_NOT_PERMITTED_PASSTHROUGH_FB
• ERROR_INSUFFICIENT_RESOURCES_PASSTHROUGH_FB
• ERROR_UNKNOWN_PASSTHROUGH_FB

See Also:

• Constant Field Values

XR_ERROR_NOT_PERMITTED_PASSTHROUGH_FB

public static final int XR_ERROR_NOT_PERMITTED_PASSTHROUGH_FB

Extends XrResult.

Enum values:

• ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB
• ERROR_FEATURE_ALREADY_CREATED_PASSTHROUGH_FB
• ERROR_FEATURE_REQUIRED_PASSTHROUGH_FB
• ERROR_NOT_PERMITTED_PASSTHROUGH_FB
• ERROR_INSUFFICIENT_RESOURCES_PASSTHROUGH_FB
• ERROR_UNKNOWN_PASSTHROUGH_FB

See Also:

• Constant Field Values

XR_ERROR_INSUFFICIENT_RESOURCES_PASSTHROUGH_FB

public static final int XR_ERROR_INSUFFICIENT_RESOURCES_PASSTHROUGH_FB

Extends XrResult.

Enum values:

• ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB
• ERROR_FEATURE_ALREADY_CREATED_PASSTHROUGH_FB
• ERROR_FEATURE_REQUIRED_PASSTHROUGH_FB
• ERROR_NOT_PERMITTED_PASSTHROUGH_FB
• ERROR_INSUFFICIENT_RESOURCES_PASSTHROUGH_FB
• ERROR_UNKNOWN_PASSTHROUGH_FB

See Also:

• Constant Field Values

XR_ERROR_UNKNOWN_PASSTHROUGH_FB

public static final int XR_ERROR_UNKNOWN_PASSTHROUGH_FB

Extends XrResult.

Enum values:

• ERROR_UNEXPECTED_STATE_PASSTHROUGH_FB
• ERROR_FEATURE_ALREADY_CREATED_PASSTHROUGH_FB
• ERROR_FEATURE_REQUIRED_PASSTHROUGH_FB
• ERROR_NOT_PERMITTED_PASSTHROUGH_FB
• ERROR_INSUFFICIENT_RESOURCES_PASSTHROUGH_FB
• ERROR_UNKNOWN_PASSTHROUGH_FB

See Also:

• Constant Field Values

XR_PASSTHROUGH_COLOR_MAP_MONO_SIZE_FB

public static final int XR_PASSTHROUGH_COLOR_MAP_MONO_SIZE_FB

XR_PASSTHROUGH_COLOR_MAP_MONO_SIZE_FB

See Also:

• Constant Field Values

XR_OBJECT_TYPE_PASSTHROUGH_FB

public static final int XR_OBJECT_TYPE_PASSTHROUGH_FB

Extends XrObjectType.

Enum values:

• OBJECT_TYPE_PASSTHROUGH_FB
• OBJECT_TYPE_PASSTHROUGH_LAYER_FB
• OBJECT_TYPE_GEOMETRY_INSTANCE_FB

See Also:

• Constant Field Values

XR_OBJECT_TYPE_PASSTHROUGH_LAYER_FB

public static final int XR_OBJECT_TYPE_PASSTHROUGH_LAYER_FB

Extends XrObjectType.

Enum values:

• OBJECT_TYPE_PASSTHROUGH_FB
• OBJECT_TYPE_PASSTHROUGH_LAYER_FB
• OBJECT_TYPE_GEOMETRY_INSTANCE_FB

See Also:

• Constant Field Values

XR_OBJECT_TYPE_GEOMETRY_INSTANCE_FB

public static final int XR_OBJECT_TYPE_GEOMETRY_INSTANCE_FB

Extends XrObjectType.

Enum values:

• OBJECT_TYPE_PASSTHROUGH_FB
• OBJECT_TYPE_PASSTHROUGH_LAYER_FB
• OBJECT_TYPE_GEOMETRY_INSTANCE_FB

See Also:

• Constant Field Values

XR_PASSTHROUGH_CAPABILITY_BIT_FB

public static final int XR_PASSTHROUGH_CAPABILITY_BIT_FB

XrPassthroughCapabilityFlagBitsFB - XrPassthroughCapabilityFlagBitsFB

Flag Descriptions

• PASSTHROUGH_CAPABILITY_BIT_FB — The system supports passthrough.
• PASSTHROUGH_CAPABILITY_COLOR_BIT_FB — The system can show passthrough with realistic colors. PASSTHROUGH_CAPABILITY_BIT_FB must be set if PASSTHROUGH_CAPABILITY_COLOR_BIT_FB is set.
• PASSTHROUGH_CAPABILITY_LAYER_DEPTH_BIT_FB — The system supports passthrough layers composited using depth testing. PASSTHROUGH_CAPABILITY_BIT_FB must be set if PASSTHROUGH_CAPABILITY_LAYER_DEPTH_BIT_FB is set.

See Also:

• Constant Field Values

XR_PASSTHROUGH_CAPABILITY_COLOR_BIT_FB

public static final int XR_PASSTHROUGH_CAPABILITY_COLOR_BIT_FB

XrPassthroughCapabilityFlagBitsFB - XrPassthroughCapabilityFlagBitsFB

Flag Descriptions

• PASSTHROUGH_CAPABILITY_BIT_FB — The system supports passthrough.
• PASSTHROUGH_CAPABILITY_COLOR_BIT_FB — The system can show passthrough with realistic colors. PASSTHROUGH_CAPABILITY_BIT_FB must be set if PASSTHROUGH_CAPABILITY_COLOR_BIT_FB is set.
• PASSTHROUGH_CAPABILITY_LAYER_DEPTH_BIT_FB — The system supports passthrough layers composited using depth testing. PASSTHROUGH_CAPABILITY_BIT_FB must be set if PASSTHROUGH_CAPABILITY_LAYER_DEPTH_BIT_FB is set.

See Also:

• Constant Field Values

XR_PASSTHROUGH_CAPABILITY_LAYER_DEPTH_BIT_FB

public static final int XR_PASSTHROUGH_CAPABILITY_LAYER_DEPTH_BIT_FB

XrPassthroughCapabilityFlagBitsFB - XrPassthroughCapabilityFlagBitsFB

Flag Descriptions

• PASSTHROUGH_CAPABILITY_BIT_FB — The system supports passthrough.
• PASSTHROUGH_CAPABILITY_COLOR_BIT_FB — The system can show passthrough with realistic colors. PASSTHROUGH_CAPABILITY_BIT_FB must be set if PASSTHROUGH_CAPABILITY_COLOR_BIT_FB is set.
• PASSTHROUGH_CAPABILITY_LAYER_DEPTH_BIT_FB — The system supports passthrough layers composited using depth testing. PASSTHROUGH_CAPABILITY_BIT_FB must be set if PASSTHROUGH_CAPABILITY_LAYER_DEPTH_BIT_FB is set.

See Also:

• Constant Field Values

XR_PASSTHROUGH_IS_RUNNING_AT_CREATION_BIT_FB

public static final int XR_PASSTHROUGH_IS_RUNNING_AT_CREATION_BIT_FB

XrPassthroughFlagBitsFB - XrPassthroughFlagBitsFB

Flag Descriptions

• PASSTHROUGH_IS_RUNNING_AT_CREATION_BIT_FB — The object (passthrough, layer) is running at creation.
• PASSTHROUGH_LAYER_DEPTH_BIT_FB — The passthrough system sends depth information to the compositor. Only applicable to layer objects.

See Also:

• Constant Field Values

XR_PASSTHROUGH_LAYER_DEPTH_BIT_FB

public static final int XR_PASSTHROUGH_LAYER_DEPTH_BIT_FB

XrPassthroughFlagBitsFB - XrPassthroughFlagBitsFB

Flag Descriptions

• PASSTHROUGH_IS_RUNNING_AT_CREATION_BIT_FB — The object (passthrough, layer) is running at creation.
• PASSTHROUGH_LAYER_DEPTH_BIT_FB — The passthrough system sends depth information to the compositor. Only applicable to layer objects.

See Also:

• Constant Field Values

XR_PASSTHROUGH_LAYER_PURPOSE_RECONSTRUCTION_FB

public static final int XR_PASSTHROUGH_LAYER_PURPOSE_RECONSTRUCTION_FB

XrPassthroughLayerPurposeFB - Layer purpose

Enumerant 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. (Added by the XR_FB_passthrough_keyboard_hands extension)
• PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_MASKED_HANDS_FB — Passthrough layer purpose for keyboard hands presence with keyboard masked hand transitions (i.e passthrough hands rendered only when they are over the keyboard). (Added by the XR_FB_passthrough_keyboard_hands extension)

See Also

XrPassthroughLayerCreateInfoFB

See Also:

• Constant Field Values

XR_PASSTHROUGH_LAYER_PURPOSE_PROJECTED_FB

public static final int XR_PASSTHROUGH_LAYER_PURPOSE_PROJECTED_FB

XrPassthroughLayerPurposeFB - Layer purpose

Enumerant 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. (Added by the XR_FB_passthrough_keyboard_hands extension)
• PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_MASKED_HANDS_FB — Passthrough layer purpose for keyboard hands presence with keyboard masked hand transitions (i.e passthrough hands rendered only when they are over the keyboard). (Added by the XR_FB_passthrough_keyboard_hands extension)

See Also

XrPassthroughLayerCreateInfoFB

See Also:

• Constant Field Values

XR_PASSTHROUGH_STATE_CHANGED_REINIT_REQUIRED_BIT_FB

public static final int XR_PASSTHROUGH_STATE_CHANGED_REINIT_REQUIRED_BIT_FB

XrPassthroughStateChangedFlagBitsFB - XrPassthroughStateChangedFlagBitsFB

Flag Descriptions

• PASSTHROUGH_STATE_CHANGED_REINIT_REQUIRED_BIT_FB — Passthrough system requires reinitialization.
• PASSTHROUGH_STATE_CHANGED_NON_RECOVERABLE_ERROR_BIT_FB — Non-recoverable error has occurred. A device reboot or a firmware update may be required.
• PASSTHROUGH_STATE_CHANGED_RECOVERABLE_ERROR_BIT_FB — A recoverable error has occurred. The runtime will attempt to recover, but some functionality may be temporarily unavailable.
• PASSTHROUGH_STATE_CHANGED_RESTORED_ERROR_BIT_FB — The runtime has recovered from a previous error and is functioning normally.

See Also:

• Constant Field Values

XR_PASSTHROUGH_STATE_CHANGED_NON_RECOVERABLE_ERROR_BIT_FB

public static final int XR_PASSTHROUGH_STATE_CHANGED_NON_RECOVERABLE_ERROR_BIT_FB

XrPassthroughStateChangedFlagBitsFB - XrPassthroughStateChangedFlagBitsFB

Flag Descriptions

• PASSTHROUGH_STATE_CHANGED_REINIT_REQUIRED_BIT_FB — Passthrough system requires reinitialization.
• PASSTHROUGH_STATE_CHANGED_NON_RECOVERABLE_ERROR_BIT_FB — Non-recoverable error has occurred. A device reboot or a firmware update may be required.
• PASSTHROUGH_STATE_CHANGED_RECOVERABLE_ERROR_BIT_FB — A recoverable error has occurred. The runtime will attempt to recover, but some functionality may be temporarily unavailable.
• PASSTHROUGH_STATE_CHANGED_RESTORED_ERROR_BIT_FB — The runtime has recovered from a previous error and is functioning normally.

See Also:

• Constant Field Values

XR_PASSTHROUGH_STATE_CHANGED_RECOVERABLE_ERROR_BIT_FB

public static final int XR_PASSTHROUGH_STATE_CHANGED_RECOVERABLE_ERROR_BIT_FB

XrPassthroughStateChangedFlagBitsFB - XrPassthroughStateChangedFlagBitsFB

Flag Descriptions

• PASSTHROUGH_STATE_CHANGED_REINIT_REQUIRED_BIT_FB — Passthrough system requires reinitialization.
• PASSTHROUGH_STATE_CHANGED_NON_RECOVERABLE_ERROR_BIT_FB — Non-recoverable error has occurred. A device reboot or a firmware update may be required.
• PASSTHROUGH_STATE_CHANGED_RECOVERABLE_ERROR_BIT_FB — A recoverable error has occurred. The runtime will attempt to recover, but some functionality may be temporarily unavailable.
• PASSTHROUGH_STATE_CHANGED_RESTORED_ERROR_BIT_FB — The runtime has recovered from a previous error and is functioning normally.

See Also:

• Constant Field Values

XR_PASSTHROUGH_STATE_CHANGED_RESTORED_ERROR_BIT_FB

public static final int XR_PASSTHROUGH_STATE_CHANGED_RESTORED_ERROR_BIT_FB

XrPassthroughStateChangedFlagBitsFB - XrPassthroughStateChangedFlagBitsFB

Flag Descriptions

• PASSTHROUGH_STATE_CHANGED_REINIT_REQUIRED_BIT_FB — Passthrough system requires reinitialization.
• PASSTHROUGH_STATE_CHANGED_NON_RECOVERABLE_ERROR_BIT_FB — Non-recoverable error has occurred. A device reboot or a firmware update may be required.
• PASSTHROUGH_STATE_CHANGED_RECOVERABLE_ERROR_BIT_FB — A recoverable error has occurred. The runtime will attempt to recover, but some functionality may be temporarily unavailable.
• PASSTHROUGH_STATE_CHANGED_RESTORED_ERROR_BIT_FB — The runtime has recovered from a previous error and is functioning normally.

See Also:

• Constant Field Values

Method Details

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 CreatePassthroughFB function is defined as:

 XrResult xrCreatePassthroughFB(
     XrSession                                   session,
     const XrPassthroughCreateInfoFB*            createInfo,
     XrPassthroughFB*                            outPassthrough);

Description

Creates an XrPassthroughFB handle. The returned passthrough handle may be subsequently used in API calls.

Valid Usage (Implicit)

• The XR_FB_passthrough extension must be enabled prior to calling CreatePassthroughFB
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrPassthroughCreateInfoFB structure
• outPassthrough must be a pointer to an XrPassthroughFB handle

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_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED
• ERROR_UNKNOWN_PASSTHROUGH_FB
• ERROR_NOT_PERMITTED_PASSTHROUGH_FB
• ERROR_FEATURE_UNSUPPORTED
• ERROR_FEATURE_ALREADY_CREATED_PASSTHROUGH_FB

See Also

XrPassthroughCreateInfoFB

Parameters:

session - the XrSession.

createInfo - the XrPassthroughCreateInfoFB.

outPassthrough - the XrPassthroughFB.

xrDestroyPassthroughFB

public static int xrDestroyPassthroughFB(XrPassthroughFB passthrough)

Destroy a passthrough feature.

C Specification

The DestroyPassthroughFB function is defined as:

 XrResult xrDestroyPassthroughFB(
     XrPassthroughFB                             passthrough);

Description

Destroys an XrPassthroughFB handle.

Valid Usage (Implicit)

• The XR_FB_passthrough extension must be enabled prior to calling DestroyPassthroughFB
• passthrough must be a valid XrPassthroughFB handle

Thread Safety

• Access to passthrough, and any child handles, must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_FEATURE_UNSUPPORTED

Parameters:

passthrough - the XrPassthroughFB to be destroyed.

xrPassthroughStartFB

public static int xrPassthroughStartFB(XrPassthroughFB passthrough)

Start a passthrough feature.

C Specification

The PassthroughStartFB function is defined as:

 XrResult xrPassthroughStartFB(
     XrPassthroughFB                             passthrough);

Description

Starts an XrPassthroughFB feature. If the feature is not started, either explicitly with a call to PassthroughStartFB, 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 until PassthroughStartFB is called.

Valid Usage (Implicit)

• The XR_FB_passthrough extension must be enabled prior to calling PassthroughStartFB
• passthrough must be a valid XrPassthroughFB handle

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_UNEXPECTED_STATE_PASSTHROUGH_FB
• ERROR_FEATURE_UNSUPPORTED

Parameters:

passthrough - the XrPassthroughFB to be started.

xrPassthroughPauseFB

public static int xrPassthroughPauseFB(XrPassthroughFB passthrough)

Pause a passthrough feature.

C Specification

The PassthroughPauseFB function is defined as:

 XrResult xrPassthroughPauseFB(
     XrPassthroughFB                             passthrough);

Description

Pauses an XrPassthroughFB feature. 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 until PassthroughStartFB is called.

Valid Usage (Implicit)

• The XR_FB_passthrough extension must be enabled prior to calling PassthroughPauseFB
• passthrough must be a valid XrPassthroughFB handle

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_UNEXPECTED_STATE_PASSTHROUGH_FB
• ERROR_FEATURE_UNSUPPORTED

Parameters:

passthrough - the XrPassthroughFB to be paused.

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 CreatePassthroughLayerFB function is defined as:

 XrResult xrCreatePassthroughLayerFB(
     XrSession                                   session,
     const XrPassthroughLayerCreateInfoFB*       createInfo,
     XrPassthroughLayerFB*                       outLayer);

Description

Creates an XrPassthroughLayerFB handle. 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_passthrough extension must be enabled prior to calling CreatePassthroughLayerFB
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrPassthroughLayerCreateInfoFB structure
• outLayer must be a pointer to an XrPassthroughLayerFB handle

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_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED
• ERROR_UNKNOWN_PASSTHROUGH_FB
• ERROR_INSUFFICIENT_RESOURCES_PASSTHROUGH_FB
• ERROR_FEATURE_UNSUPPORTED
• ERROR_FEATURE_REQUIRED_PASSTHROUGH_FB

See Also

XrPassthroughLayerCreateInfoFB

Parameters:

session - the XrSession.

createInfo - the XrPassthroughLayerCreateInfoFB.

outLayer - the XrPassthroughLayerFB.

xrDestroyPassthroughLayerFB

public static int xrDestroyPassthroughLayerFB(XrPassthroughLayerFB layer)

Destroy a passthrough layer.

C Specification

The DestroyPassthroughLayerFB function is defined as:

 XrResult xrDestroyPassthroughLayerFB(
     XrPassthroughLayerFB                        layer);

Description

Destroys an XrPassthroughLayerFB handle.

Valid Usage (Implicit)

• The XR_FB_passthrough extension must be enabled prior to calling DestroyPassthroughLayerFB
• layer must be a valid XrPassthroughLayerFB handle

Thread Safety

• Access to layer, and any child handles, must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_FEATURE_UNSUPPORTED

Parameters:

layer - the XrPassthroughLayerFB to be destroyed.

xrPassthroughLayerPauseFB

public static int xrPassthroughLayerPauseFB(XrPassthroughLayerFB layer)

Pause a passthrough layer.

C Specification

The PassthroughLayerPauseFB function is defined as:

 XrResult xrPassthroughLayerPauseFB(
     XrPassthroughLayerFB                        layer);

Description

Pauses an XrPassthroughLayerFB layer. Runtime will not render or composite paused layers.

Valid Usage (Implicit)

• The XR_FB_passthrough extension must be enabled prior to calling PassthroughLayerPauseFB
• layer must be a valid XrPassthroughLayerFB handle

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_UNEXPECTED_STATE_PASSTHROUGH_FB
• ERROR_FEATURE_UNSUPPORTED

Parameters:

layer - the XrPassthroughLayerFB to be paused.

xrPassthroughLayerResumeFB

public static int xrPassthroughLayerResumeFB(XrPassthroughLayerFB layer)

Resume a passthrough layer.

C Specification

The PassthroughLayerResumeFB function is defined as:

 XrResult xrPassthroughLayerResumeFB(
     XrPassthroughLayerFB                        layer);

Description

Resumes an XrPassthroughLayerFB layer.

Valid Usage (Implicit)

• The XR_FB_passthrough extension must be enabled prior to calling PassthroughLayerResumeFB
• layer must be a valid XrPassthroughLayerFB handle

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_UNEXPECTED_STATE_PASSTHROUGH_FB
• ERROR_FEATURE_UNSUPPORTED

Parameters:

layer - the XrPassthroughLayerFB to be resumed.

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 PassthroughLayerSetStyleFB function is defined as:

 XrResult xrPassthroughLayerSetStyleFB(
     XrPassthroughLayerFB                        layer,
     const XrPassthroughStyleFB*                 style);

Description

Sets an XrPassthroughStyleFB style on an XrPassthroughLayerFB layer.

Valid Usage (Implicit)

• The XR_FB_passthrough extension must be enabled prior to calling PassthroughLayerSetStyleFB
• layer must be a valid XrPassthroughLayerFB handle
• style must be a pointer to a valid XrPassthroughStyleFB structure

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_FEATURE_UNSUPPORTED

See Also

XrPassthroughStyleFB

Parameters:

layer - the XrPassthroughLayerFB to get the style.

style - the XrPassthroughStyleFB to be set.

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 CreateGeometryInstanceFB function is defined as:

 XrResult xrCreateGeometryInstanceFB(
     XrSession                                   session,
     const XrGeometryInstanceCreateInfoFB*       createInfo,
     XrGeometryInstanceFB*                       outGeometryInstance);

Description

Creates an XrGeometryInstanceFB handle. Geometry instance functionality requires XR_FB_triangle_mesh extension to be enabled. An XrGeometryInstanceFB connects 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_passthrough extension must be enabled prior to calling CreateGeometryInstanceFB
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrGeometryInstanceCreateInfoFB structure
• outGeometryInstance must be a pointer to an XrGeometryInstanceFB handle

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_OUT_OF_MEMORY
• ERROR_LIMIT_REACHED
• ERROR_POSE_INVALID
• ERROR_INSUFFICIENT_RESOURCES_PASSTHROUGH_FB
• ERROR_FEATURE_UNSUPPORTED

See Also

XrGeometryInstanceCreateInfoFB

Parameters:

session - the XrSession.

createInfo - the XrGeometryInstanceCreateInfoFB.

outGeometryInstance - the XrGeometryInstanceFB.

xrDestroyGeometryInstanceFB

public static int xrDestroyGeometryInstanceFB(XrGeometryInstanceFB instance)

Destroy a geometry instance.

C Specification

The DestroyGeometryInstanceFB function is defined as:

 XrResult xrDestroyGeometryInstanceFB(
     XrGeometryInstanceFB                        instance);

Description

Destroys an XrGeometryInstanceFB handle. Destroying an XrGeometryInstanceFB does 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_passthrough extension must be enabled prior to calling DestroyGeometryInstanceFB
• instance must be a valid XrGeometryInstanceFB handle

Thread Safety

• Access to instance, and any child handles, must be externally synchronized

Return Codes

On success, this command returns

• SUCCESS

On failure, this command returns

• ERROR_FUNCTION_UNSUPPORTED
• ERROR_RUNTIME_FAILURE
• ERROR_HANDLE_INVALID
• ERROR_FEATURE_UNSUPPORTED

Parameters:

instance - the XrGeometryInstanceFB to be destroyed.

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 GeometryInstanceSetTransformFB function is defined as:

 XrResult xrGeometryInstanceSetTransformFB(
     XrGeometryInstanceFB                        instance,
     const XrGeometryInstanceTransformFB*        transformation);

Description

Sets an XrGeometryInstanceTransformFB transform on an XrGeometryInstanceFB geometry instance.

Valid Usage (Implicit)

• The XR_FB_passthrough extension must be enabled prior to calling GeometryInstanceSetTransformFB
• instance must be a valid XrGeometryInstanceFB handle
• transformation must be a pointer to a valid XrGeometryInstanceTransformFB structure

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_TIME_INVALID
• ERROR_POSE_INVALID
• ERROR_FEATURE_UNSUPPORTED

See Also

XrGeometryInstanceTransformFB

Parameters:

instance - the XrGeometryInstanceFB to get the transform.

transformation - the XrGeometryInstanceTransformFB to be set.