The virtual keyboard extension provides a system-driven localized keyboard that the application has full control over in terms of positioning and rendering.
This is achieved by giving the application the data required to drive rendering and animation of the keyboard in response to interaction data passed from the application to the runtime.
This approach is an alternative to a potential system keyboard overlay solution and provides a keyboard that can seamlessly blend into the application environment, since it is rendered by the same system, and avoids input focus issues that might come with a system overlay.
The API is also designed to work with custom hand and/or controller models in various games and applications.
| Modifier and Type | Field and Description |
|---|---|
| public static final int | XR_MAX_VIRTUAL_KEYBOARD_COMMIT_TEXT_SIZE_META
XR_MAX_VIRTUAL_KEYBOARD_COMMIT_TEXT_SIZE_META |
| public static final String | XR_META_VIRTUAL_KEYBOARD_EXTENSION_NAME
The extension name. |
| public static final int | XR_META_virtual_keyboard_SPEC_VERSION
The extension specification version. |
| public static final int | XR_OBJECT_TYPE_VIRTUAL_KEYBOARD_META
Extends |
| public static final int | XR_TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_META
Extends |
| public static final int | XR_TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_META
Extends |
| public static final int | XR_TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_META
Extends |
| public static final int | XR_TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
Extends |
| public static final int | XR_TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_META
Extends |
| public static final int | XR_TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_META
Extends |
| public static final int | XR_TYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_META
Extends |
| public static final int | XR_TYPE_VIRTUAL_KEYBOARD_CREATE_INFO_META
Extends |
| public static final int | XR_TYPE_VIRTUAL_KEYBOARD_INPUT_INFO_META
Extends |
| public static final int | XR_TYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_META
Extends |
| public static final int | XR_TYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_META
Extends |
| public static final int | XR_TYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_META
Extends |
| public static final int | XR_TYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_META
Extends |
| public static final int | XR_TYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_META
Extends |
| public static final int | XR_TYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_META
Extends |
| public static final int | XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_LEFT_META
XrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source types Description |
| public static final int | XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_RIGHT_META
XrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source types Description |
| public static final int | XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_LEFT_META
XrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source types Description |
| public static final int | XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_RIGHT_META
XrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source types Description |
| public static final int | XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_LEFT_META
XrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source types Description |
| public static final int | XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_RIGHT_META
XrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source types Description |
| public static final int | XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_LEFT_META
XrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source types Description |
| public static final int | XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_RIGHT_META
XrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source types Description |
| public static final int | XR_VIRTUAL_KEYBOARD_INPUT_STATE_PRESSED_BIT_META
XrVirtualKeyboardInputStateFlagBitsMETA - XrVirtualKeyboardInputStateFlagBitsMETA Flag Descriptions
|
| public static final int | XR_VIRTUAL_KEYBOARD_LOCATION_TYPE_CUSTOM_META
XrVirtualKeyboardLocationTypeMETA - Enum describing keyboard placement types Enumerant Descriptions
|
| public static final int | XR_VIRTUAL_KEYBOARD_LOCATION_TYPE_DIRECT_META
XrVirtualKeyboardLocationTypeMETA - Enum describing keyboard placement types Enumerant Descriptions
|
| public static final int | XR_VIRTUAL_KEYBOARD_LOCATION_TYPE_FAR_META
XrVirtualKeyboardLocationTypeMETA - Enum describing keyboard placement types Enumerant Descriptions
|
| Access | Constructor and Description |
|---|---|
| protected |
| Modifier and Type | Method and Description |
|---|---|
| public static int | nxrChangeVirtualKeyboardTextContextMETA(XrVirtualKeyboardMETA keyboard, long changeInfo)
Unsafe version of: |
| public static int | nxrCreateVirtualKeyboardMETA(XrSession session, long createInfo, long keyboard)
Unsafe version of: |
| public static int | nxrCreateVirtualKeyboardSpaceMETA(XrSession session, XrVirtualKeyboardMETA keyboard, long createInfo, long keyboardSpace)
Unsafe version of: |
| public static int | nxrGetVirtualKeyboardDirtyTexturesMETA(XrVirtualKeyboardMETA keyboard, int
the capacity of the textureIdCapacityInput, long textureIdCountOutput, long textureIds)textureIds array, or 0 to indicate a request to retrieve the required capacity.Unsafe version of: |
| public static int | nxrGetVirtualKeyboardModelAnimationStatesMETA(XrVirtualKeyboardMETA keyboard, long animationStates)
Unsafe version of: |
| public static int | nxrGetVirtualKeyboardScaleMETA(XrVirtualKeyboardMETA keyboard, long scale)
Unsafe version of: |
| public static int | nxrGetVirtualKeyboardTextureDataMETA(XrVirtualKeyboardMETA keyboard, long textureId, long textureData)
Unsafe version of: |
| public static int | nxrSendVirtualKeyboardInputMETA(XrVirtualKeyboardMETA keyboard, long info, long interactorRootPose)
Unsafe version of: |
| public static int | nxrSetVirtualKeyboardModelVisibilityMETA(XrVirtualKeyboardMETA keyboard, long modelVisibility)
Unsafe version of: |
| public static int | nxrSuggestVirtualKeyboardLocationMETA(XrVirtualKeyboardMETA keyboard, long locationInfo)
Unsafe version of: |
| public static int | xrChangeVirtualKeyboardTextContextMETA(XrVirtualKeyboardMETA
the keyboard, XrVirtualKeyboardTextContextChangeInfoMETA changeInfo)XrVirtualKeyboardMETA handle.Change virtual keyboard text context. |
| public static int | xrCreateVirtualKeyboardMETA(XrSession
the session, XrVirtualKeyboardCreateInfoMETA createInfo, PointerBuffer XrSession.the returned keyboard)XrVirtualKeyboardMETA.Create a virtual keyboard. |
| public static int | xrCreateVirtualKeyboardSpaceMETA(XrSession
the session, XrVirtualKeyboardMETA XrSession.the keyboard, XrVirtualKeyboardSpaceCreateInfoMETA createInfo, PointerBuffer XrVirtualKeyboardMETA handle.the returned space handle. keyboardSpace)Create a virtual keyboard space. |
| public static int | xrDestroyVirtualKeyboardMETA(XrVirtualKeyboardMETA
the keyboard)XrVirtualKeyboardMETA handle to the keyboard to destroy.Destroy a virtual keyboard. |
| public static int | xrGetVirtualKeyboardDirtyTexturesMETA(XrVirtualKeyboardMETA
the keyboard, IntBuffer XrVirtualKeyboardMETA handle.filled in by the runtime with the count of texture IDs written or the required capacity in the case that textureIdCountOutput, LongBuffer textureIdCapacityInput is insufficient.the array of texture IDs that need to be updated. textureIds)Get model textures that are dirty. |
| public static int | xrGetVirtualKeyboardModelAnimationStatesMETA(XrVirtualKeyboardMETA
the keyboard, XrVirtualKeyboardModelAnimationStatesMETA animationStates)XrVirtualKeyboardMETA handle.Get model animation states. |
| public static int | xrGetVirtualKeyboardScaleMETA(XrVirtualKeyboardMETA
the keyboard, FloatBuffer XrVirtualKeyboardMETA handle.a float value of the current scale of the keyboard. scale)Get virtual keyboard scale. |
| public static int | xrGetVirtualKeyboardTextureDataMETA(XrVirtualKeyboardMETA
the keyboard, long XrVirtualKeyboardMETA handle.the ID of the texture that the application is querying data for. textureId, XrVirtualKeyboardTextureDataMETA the returned textureData)XrVirtualKeyboardTextureDataMETA.Get the data to update a model texture. |
| public static int | xrSendVirtualKeyboardInputMETA(XrVirtualKeyboardMETA
the keyboard, XrVirtualKeyboardInputInfoMETA XrVirtualKeyboardMETA handle.the info, XrPosef XrVirtualKeyboardInputInfoMETA detailing the input being sent to the runtime.an interactorRootPose)XrPosef defining the root pose of the input source. The runtime may modify this value to aid keyboard input perception.Send virtual keyboard input. |
| public static int | xrSetVirtualKeyboardModelVisibilityMETA(XrVirtualKeyboardMETA
the keyboard, XrVirtualKeyboardModelVisibilitySetInfoMETA modelVisibility)XrVirtualKeyboardMETA handle.Set virtual keyboard model visibility. |
| public static int | xrSuggestVirtualKeyboardLocationMETA(XrVirtualKeyboardMETA
the keyboard, XrVirtualKeyboardLocationInfoMETA XrVirtualKeyboardMETA handle.the desired locationInfo)XrVirtualKeyboardLocationInfoMETA.Suggest a virtual keyboard location. |