Package org.lwjgl.openxr

Class FBKeyboardTracking

java.lang.Object

org.lwjgl.openxr.FBKeyboardTracking

public class FBKeyboardTracking
extends Object

The XR_FB_keyboard_tracking extension.

This extension allows the application to query the system for a supported trackable keyboard type and obtain an XrSpace handle to track it. It also provides relevant metadata about the keyboard itself, including bounds and a human readable identifier.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	XR_FB_KEYBOARD_TRACKING_EXTENSION_NAME	The extension name.
static final int	XR_FB_keyboard_tracking_SPEC_VERSION	The extension specification version.
static final int	XR_KEYBOARD_TRACKING_CONNECTED_BIT_FB	XrKeyboardTrackingFlagBitsFB - XrKeyboardTrackingFlagBitsFB
static final int	XR_KEYBOARD_TRACKING_EXISTS_BIT_FB	XrKeyboardTrackingFlagBitsFB - XrKeyboardTrackingFlagBitsFB
static final int	XR_KEYBOARD_TRACKING_LOCAL_BIT_FB	XrKeyboardTrackingFlagBitsFB - XrKeyboardTrackingFlagBitsFB
static final int	XR_KEYBOARD_TRACKING_QUERY_LOCAL_BIT_FB	XrKeyboardTrackingQueryFlagBitsFB - XrKeyboardTrackingQueryFlagBitsFB
static final int	XR_KEYBOARD_TRACKING_QUERY_REMOTE_BIT_FB	XrKeyboardTrackingQueryFlagBitsFB - XrKeyboardTrackingQueryFlagBitsFB
static final int	XR_KEYBOARD_TRACKING_REMOTE_BIT_FB	XrKeyboardTrackingFlagBitsFB - XrKeyboardTrackingFlagBitsFB
static final int	XR_MAX_KEYBOARD_TRACKING_NAME_SIZE_FB	XR_MAX_KEYBOARD_TRACKING_NAME_SIZE_FB
static final int	XR_TYPE_KEYBOARD_SPACE_CREATE_INFO_FB	Extends XrStructureType.
static final int	XR_TYPE_KEYBOARD_TRACKING_QUERY_FB	Extends XrStructureType.
static final int	XR_TYPE_SYSTEM_KEYBOARD_TRACKING_PROPERTIES_FB	Extends XrStructureType.

Method Summary

Modifier and Type	Method	Description
static int	nxrCreateKeyboardSpaceFB(XrSession session, long createInfo, long keyboardSpace)	Unsafe version of: CreateKeyboardSpaceFB
static int	nxrQuerySystemTrackedKeyboardFB(XrSession session, long queryInfo, long keyboard)	Unsafe version of: QuerySystemTrackedKeyboardFB
static int	xrCreateKeyboardSpaceFB(XrSession session, XrKeyboardSpaceCreateInfoFB createInfo, org.lwjgl.PointerBuffer keyboardSpace)	Create a foveation profile.
static int	xrQuerySystemTrackedKeyboardFB(XrSession session, XrKeyboardTrackingQueryFB queryInfo, XrKeyboardTrackingDescriptionFB keyboard)	Queries the system keyboard.

Methods inherited from class java.lang.Object

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

Field Details

XR_FB_keyboard_tracking_SPEC_VERSION

public static final int XR_FB_keyboard_tracking_SPEC_VERSION

The extension specification version.

See Also:

• Constant Field Values

XR_FB_KEYBOARD_TRACKING_EXTENSION_NAME

public static final String XR_FB_KEYBOARD_TRACKING_EXTENSION_NAME

The extension name.

See Also:

• Constant Field Values

XR_MAX_KEYBOARD_TRACKING_NAME_SIZE_FB

public static final int XR_MAX_KEYBOARD_TRACKING_NAME_SIZE_FB

XR_MAX_KEYBOARD_TRACKING_NAME_SIZE_FB

See Also:

• Constant Field Values

XR_TYPE_KEYBOARD_SPACE_CREATE_INFO_FB

public static final int XR_TYPE_KEYBOARD_SPACE_CREATE_INFO_FB

Extends XrStructureType.

Enum values:

• TYPE_KEYBOARD_SPACE_CREATE_INFO_FB
• TYPE_KEYBOARD_TRACKING_QUERY_FB
• TYPE_SYSTEM_KEYBOARD_TRACKING_PROPERTIES_FB

See Also:

• Constant Field Values

XR_TYPE_KEYBOARD_TRACKING_QUERY_FB

public static final int XR_TYPE_KEYBOARD_TRACKING_QUERY_FB

Extends XrStructureType.

Enum values:

• TYPE_KEYBOARD_SPACE_CREATE_INFO_FB
• TYPE_KEYBOARD_TRACKING_QUERY_FB
• TYPE_SYSTEM_KEYBOARD_TRACKING_PROPERTIES_FB

See Also:

• Constant Field Values

XR_TYPE_SYSTEM_KEYBOARD_TRACKING_PROPERTIES_FB

public static final int XR_TYPE_SYSTEM_KEYBOARD_TRACKING_PROPERTIES_FB

Extends XrStructureType.

Enum values:

• TYPE_KEYBOARD_SPACE_CREATE_INFO_FB
• TYPE_KEYBOARD_TRACKING_QUERY_FB
• TYPE_SYSTEM_KEYBOARD_TRACKING_PROPERTIES_FB

See Also:

• Constant Field Values

XR_KEYBOARD_TRACKING_EXISTS_BIT_FB

public static final int XR_KEYBOARD_TRACKING_EXISTS_BIT_FB

XrKeyboardTrackingFlagBitsFB - XrKeyboardTrackingFlagBitsFB

Flag Descriptions

• KEYBOARD_TRACKING_EXISTS_BIT_FB — indicates that the system has a physically tracked keyboard to report. If not set then no other bits should be considered to be valid or meaningful. If set either XR_KEYBOARD_TRACKING_LOCAL_BIT_FB or XR_KEYBOARD_TRACKING_REMOTE_BIT_FB must also be set.
• KEYBOARD_TRACKING_LOCAL_BIT_FB — indicates that the physically tracked keyboard is intended to be used in a local pairing with the system. Mutually exclusive with XR_KEYBOARD_TRACKING_REMOTE_BIT_FB.
• KEYBOARD_TRACKING_REMOTE_BIT_FB — indicates that the physically tracked keyboard is intended to be used while paired to a separate remote computing device. Mutually exclusive with XR_KEYBOARD_TRACKING_LOCAL_BIT_FB.
• KEYBOARD_TRACKING_CONNECTED_BIT_FB — indicates that the physically tracked keyboard is actively connected to the headset and capable of sending key data

See Also:

• Constant Field Values

XR_KEYBOARD_TRACKING_LOCAL_BIT_FB

public static final int XR_KEYBOARD_TRACKING_LOCAL_BIT_FB

XrKeyboardTrackingFlagBitsFB - XrKeyboardTrackingFlagBitsFB

Flag Descriptions

• KEYBOARD_TRACKING_EXISTS_BIT_FB — indicates that the system has a physically tracked keyboard to report. If not set then no other bits should be considered to be valid or meaningful. If set either XR_KEYBOARD_TRACKING_LOCAL_BIT_FB or XR_KEYBOARD_TRACKING_REMOTE_BIT_FB must also be set.
• KEYBOARD_TRACKING_LOCAL_BIT_FB — indicates that the physically tracked keyboard is intended to be used in a local pairing with the system. Mutually exclusive with XR_KEYBOARD_TRACKING_REMOTE_BIT_FB.
• KEYBOARD_TRACKING_REMOTE_BIT_FB — indicates that the physically tracked keyboard is intended to be used while paired to a separate remote computing device. Mutually exclusive with XR_KEYBOARD_TRACKING_LOCAL_BIT_FB.
• KEYBOARD_TRACKING_CONNECTED_BIT_FB — indicates that the physically tracked keyboard is actively connected to the headset and capable of sending key data

See Also:

• Constant Field Values

XR_KEYBOARD_TRACKING_REMOTE_BIT_FB

public static final int XR_KEYBOARD_TRACKING_REMOTE_BIT_FB

XrKeyboardTrackingFlagBitsFB - XrKeyboardTrackingFlagBitsFB

Flag Descriptions

• KEYBOARD_TRACKING_EXISTS_BIT_FB — indicates that the system has a physically tracked keyboard to report. If not set then no other bits should be considered to be valid or meaningful. If set either XR_KEYBOARD_TRACKING_LOCAL_BIT_FB or XR_KEYBOARD_TRACKING_REMOTE_BIT_FB must also be set.
• KEYBOARD_TRACKING_LOCAL_BIT_FB — indicates that the physically tracked keyboard is intended to be used in a local pairing with the system. Mutually exclusive with XR_KEYBOARD_TRACKING_REMOTE_BIT_FB.
• KEYBOARD_TRACKING_REMOTE_BIT_FB — indicates that the physically tracked keyboard is intended to be used while paired to a separate remote computing device. Mutually exclusive with XR_KEYBOARD_TRACKING_LOCAL_BIT_FB.
• KEYBOARD_TRACKING_CONNECTED_BIT_FB — indicates that the physically tracked keyboard is actively connected to the headset and capable of sending key data

See Also:

• Constant Field Values

XR_KEYBOARD_TRACKING_CONNECTED_BIT_FB

public static final int XR_KEYBOARD_TRACKING_CONNECTED_BIT_FB

XrKeyboardTrackingFlagBitsFB - XrKeyboardTrackingFlagBitsFB

Flag Descriptions

• KEYBOARD_TRACKING_EXISTS_BIT_FB — indicates that the system has a physically tracked keyboard to report. If not set then no other bits should be considered to be valid or meaningful. If set either XR_KEYBOARD_TRACKING_LOCAL_BIT_FB or XR_KEYBOARD_TRACKING_REMOTE_BIT_FB must also be set.
• KEYBOARD_TRACKING_LOCAL_BIT_FB — indicates that the physically tracked keyboard is intended to be used in a local pairing with the system. Mutually exclusive with XR_KEYBOARD_TRACKING_REMOTE_BIT_FB.
• KEYBOARD_TRACKING_REMOTE_BIT_FB — indicates that the physically tracked keyboard is intended to be used while paired to a separate remote computing device. Mutually exclusive with XR_KEYBOARD_TRACKING_LOCAL_BIT_FB.
• KEYBOARD_TRACKING_CONNECTED_BIT_FB — indicates that the physically tracked keyboard is actively connected to the headset and capable of sending key data

See Also:

• Constant Field Values

XR_KEYBOARD_TRACKING_QUERY_LOCAL_BIT_FB

public static final int XR_KEYBOARD_TRACKING_QUERY_LOCAL_BIT_FB

XrKeyboardTrackingQueryFlagBitsFB - XrKeyboardTrackingQueryFlagBitsFB

Flag Descriptions

• KEYBOARD_TRACKING_QUERY_LOCAL_BIT_FB — indicates the query is for the physically tracked keyboard that is intended to be used in a local pairing with the System. Mutually exclusive with XR_KEYBOARD_TRACKING_QUERY_REMOTE_BIT_FB.
• KEYBOARD_TRACKING_QUERY_REMOTE_BIT_FB — indicates the query is for the physically tracked keyboard that may be connected to a separate remote computing device. Mutually exclusive with XR_KEYBOARD_TRACKING_QUERY_LOCAL_BIT_FB.

See Also:

• Constant Field Values

XR_KEYBOARD_TRACKING_QUERY_REMOTE_BIT_FB

public static final int XR_KEYBOARD_TRACKING_QUERY_REMOTE_BIT_FB

XrKeyboardTrackingQueryFlagBitsFB - XrKeyboardTrackingQueryFlagBitsFB

Flag Descriptions

• KEYBOARD_TRACKING_QUERY_LOCAL_BIT_FB — indicates the query is for the physically tracked keyboard that is intended to be used in a local pairing with the System. Mutually exclusive with XR_KEYBOARD_TRACKING_QUERY_REMOTE_BIT_FB.
• KEYBOARD_TRACKING_QUERY_REMOTE_BIT_FB — indicates the query is for the physically tracked keyboard that may be connected to a separate remote computing device. Mutually exclusive with XR_KEYBOARD_TRACKING_QUERY_LOCAL_BIT_FB.

See Also:

• Constant Field Values

Method Details

nxrQuerySystemTrackedKeyboardFB

public static int nxrQuerySystemTrackedKeyboardFB(XrSession session,
 long queryInfo,
 long keyboard)

Unsafe version of: QuerySystemTrackedKeyboardFB

xrQuerySystemTrackedKeyboardFB

public static int xrQuerySystemTrackedKeyboardFB(XrSession session,
 XrKeyboardTrackingQueryFB queryInfo,
 XrKeyboardTrackingDescriptionFB keyboard)

Queries the system keyboard.

C Specification

The QuerySystemTrackedKeyboardFB function is defined as:

 XrResult xrQuerySystemTrackedKeyboardFB(
     XrSession                                   session,
     const XrKeyboardTrackingQueryFB*            queryInfo,
     XrKeyboardTrackingDescriptionFB*            keyboard);

Description

The QuerySystemTrackedKeyboardFB function populates an XrKeyboardTrackingDescriptionFB structure with enough information to describe a keyboard that the system can locate.

Valid Usage (Implicit)

• The XR_FB_keyboard_tracking extension must be enabled prior to calling QuerySystemTrackedKeyboardFB
• session must be a valid XrSession handle
• queryInfo must be a pointer to a valid XrKeyboardTrackingQueryFB structure
• keyboard must be a pointer to an XrKeyboardTrackingDescriptionFB 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

XrKeyboardTrackingDescriptionFB, XrKeyboardTrackingQueryFB

Parameters:

session - the session that will be associated with a keyboard space.

queryInfo - the XrKeyboardTrackingQueryFB that describes the type of keyboard to return. queryInfo must have either KEYBOARD_TRACKING_QUERY_LOCAL_BIT_FB or KEYBOARD_TRACKING_QUERY_REMOTE_BIT_FB set.

keyboard - the XrKeyboardTrackingDescriptionFB output structure.

nxrCreateKeyboardSpaceFB

public static int nxrCreateKeyboardSpaceFB(XrSession session,
 long createInfo,
 long keyboardSpace)

Unsafe version of: CreateKeyboardSpaceFB

xrCreateKeyboardSpaceFB

public static int xrCreateKeyboardSpaceFB(XrSession session,
 XrKeyboardSpaceCreateInfoFB createInfo,
 org.lwjgl.PointerBuffer keyboardSpace)

Create a foveation profile.

C Specification

The CreateKeyboardSpaceFB function is defined as:

 XrResult xrCreateKeyboardSpaceFB(
     XrSession                                   session,
     const XrKeyboardSpaceCreateInfoFB*          createInfo,
     XrSpace*                                    keyboardSpace);

Description

The CreateKeyboardSpaceFB function returns an XrSpace that can be used to locate a physical keyboard in space. The origin of the created XrSpace is located in the center of the bounding box in the x and z axes, and at the top of the y axis (meaning the keyboard is located entirely in negative y).

Valid Usage (Implicit)

• The XR_FB_keyboard_tracking extension must be enabled prior to calling CreateKeyboardSpaceFB
• session must be a valid XrSession handle
• createInfo must be a pointer to a valid XrKeyboardSpaceCreateInfoFB structure
• keyboardSpace must be a pointer to an XrSpace 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_FEATURE_UNSUPPORTED

See Also

XrKeyboardSpaceCreateInfoFB

Parameters:

session - the session that will be associated with the returned keyboard space.

createInfo - the XrKeyboardSpaceCreateInfoFB that describes the type of keyboard to track.

keyboardSpace - the XrSpace output structure.