public Class FBKeyboardTracking

The extension name.

The extension specification version.

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. Mutally 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. Mutally 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

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. Mutally 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. Mutally 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

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. Mutally 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. Mutally 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

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. Mutally 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. Mutally exclusive with 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. Mutally 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. Mutally exclusive with XR_KEYBOARD_TRACKING_QUERY_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. Mutally 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. Mutally 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

XR_MAX_KEYBOARD_TRACKING_NAME_SIZE_FB

Extends XrStructureType.

Enum values:

• TYPE_KEYBOARD_SPACE_CREATE_INFO_FB
• TYPE_KEYBOARD_TRACKING_QUERY_FB
• 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

Extends XrStructureType.

Enum values:

• TYPE_KEYBOARD_SPACE_CREATE_INFO_FB
• TYPE_KEYBOARD_TRACKING_QUERY_FB
• TYPE_SYSTEM_KEYBOARD_TRACKING_PROPERTIES_FB

Unsafe version of: CreateKeyboardSpaceFB

Unsafe version of: QuerySystemTrackedKeyboardFB

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:XrSession

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

createInfo:XrKeyboardSpaceCreateInfoFB

the XrKeyboardSpaceCreateInfoFB that describes the type of keyboard to track.

keyboardSpace:PointerBuffer

the XrSpace output structure.

Annotations

@NativeType:XrResult

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:XrSession

the session that will be associated with a keyboard space.

queryInfo:XrKeyboardTrackingQueryFB

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:XrKeyboardTrackingDescriptionFB

the XrKeyboardTrackingDescriptionFB output structure.

Annotations

@NativeType:XrResult