Package org.lwjgl.openxr

Class FBPassthroughKeyboardHands

java.lang.Object

org.lwjgl.openxr.FBPassthroughKeyboardHands

public class FBPassthroughKeyboardHands
extends Object

The XR_FB_passthrough_keyboard_hands extension.

This extension enables applications to show passthrough hands when hands are placed over the tracked keyboard. It enables users to see their hands over the keyboard in a mixed reality application. This extension is dependent on XR_FB_passthrough extension which can be used to create a passthrough layer for hand presence use-case.

The extension supports a single pair of hands (one left and one right hand), multiple pair of hands are not supported.

This extension allows:

• Creation of keyboard hands passthrough layer using CreatePassthroughLayerFB
• Setting the level of intensity for the hand mask in a passthrough layer with purpose XrPassthroughLayerPurposeFB as PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_HANDS_FB or PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_MASKED_HANDS_FB

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_FB_PASSTHROUGH_KEYBOARD_HANDS_EXTENSION_NAME	The extension name.
static final int	XR_FB_passthrough_keyboard_hands_SPEC_VERSION	The extension specification version.
static final int	XR_PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_HANDS_FB	Extends XrPassthroughLayerPurposeFB.
static final int	XR_PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_MASKED_HANDS_FB	Extends XrPassthroughLayerPurposeFB.
static final int	XR_TYPE_PASSTHROUGH_KEYBOARD_HANDS_INTENSITY_FB	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrPassthroughLayerSetKeyboardHandsIntensityFB(XrPassthroughLayerFB layer, long intensity)	Unsafe version of: PassthroughLayerSetKeyboardHandsIntensityFB
static int	xrPassthroughLayerSetKeyboardHandsIntensityFB(XrPassthroughLayerFB layer, XrPassthroughKeyboardHandsIntensityFB intensity)	Renders hands over the keyboard (keyboard hands) with a specific intensity of hands passthrough layer.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_passthrough_keyboard_hands_SPEC_VERSION

public static final int XR_FB_passthrough_keyboard_hands_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_PASSTHROUGH_KEYBOARD_HANDS_EXTENSION_NAME

public static final String XR_FB_PASSTHROUGH_KEYBOARD_HANDS_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_HANDS_FB

public static final int XR_PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_HANDS_FB

Extends XrPassthroughLayerPurposeFB.

Enum values:

• PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_HANDS_FB
• PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_MASKED_HANDS_FB

See Also:

• Constant Field Values

XR_PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_MASKED_HANDS_FB

public static final int XR_PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_MASKED_HANDS_FB

Extends XrPassthroughLayerPurposeFB.

Enum values:

• PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_HANDS_FB
• PASSTHROUGH_LAYER_PURPOSE_TRACKED_KEYBOARD_MASKED_HANDS_FB

See Also:

• Constant Field Values

XR_TYPE_PASSTHROUGH_KEYBOARD_HANDS_INTENSITY_FB

public static final int XR_TYPE_PASSTHROUGH_KEYBOARD_HANDS_INTENSITY_FB

Extends XrStructureType.

See Also:

• Constant Field Values

Method Details

nxrPassthroughLayerSetKeyboardHandsIntensityFB

public static int nxrPassthroughLayerSetKeyboardHandsIntensityFB(XrPassthroughLayerFB layer,
 long intensity)

Unsafe version of: PassthroughLayerSetKeyboardHandsIntensityFB

xrPassthroughLayerSetKeyboardHandsIntensityFB

public static int xrPassthroughLayerSetKeyboardHandsIntensityFB(XrPassthroughLayerFB layer,
 XrPassthroughKeyboardHandsIntensityFB intensity)

Renders hands over the keyboard (keyboard hands) with a specific intensity of hands passthrough layer.

C Specification

The PassthroughLayerSetKeyboardHandsIntensityFB function is defined as:

 XrResult xrPassthroughLayerSetKeyboardHandsIntensityFB(
     XrPassthroughLayerFB                        layer,
     const XrPassthroughKeyboardHandsIntensityFB* intensity);

Description

Sets an XrPassthroughKeyboardHandsIntensityFB intensity on an XrPassthroughLayerFB layer.

Valid Usage (Implicit)

• The XR_FB_passthrough_keyboard_hands extension must be enabled prior to calling PassthroughLayerSetKeyboardHandsIntensityFB
• layer must be a valid XrPassthroughLayerFB handle
• intensity must be a pointer to a valid XrPassthroughKeyboardHandsIntensityFB 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

XrPassthroughKeyboardHandsIntensityFB

Parameters:

layer - the XrPassthroughLayerFB to apply the intensity.

intensity - the XrPassthroughKeyboardHandsIntensityFB to be set.