Class METAVirtualKeyboard
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.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intXR_MAX_VIRTUAL_KEYBOARD_COMMIT_TEXT_SIZE_METAstatic final StringThe extension name.static final intThe extension specification version.static final intExtendsXrObjectType.static final intExtendsXrStructureType.static final intExtendsXrStructureType.static final intExtendsXrStructureType.static final intExtendsXrStructureType.static final intExtendsXrStructureType.static final intExtendsXrStructureType.static final intExtendsXrStructureType.static final intExtendsXrStructureType.static final intExtendsXrStructureType.static final intExtendsXrStructureType.static final intExtendsXrStructureType.static final intExtendsXrStructureType.static final intExtendsXrStructureType.static final intExtendsXrStructureType.static final intExtendsXrStructureType.static final intXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesstatic final intXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesstatic final intXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesstatic final intXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesstatic final intXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesstatic final intXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesstatic final intXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesstatic final intXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesstatic final intXrVirtualKeyboardInputStateFlagBitsMETA - XrVirtualKeyboardInputStateFlagBitsMETAstatic final intXrVirtualKeyboardLocationTypeMETA - Enum describing keyboard placement typesstatic final intXrVirtualKeyboardLocationTypeMETA - Enum describing keyboard placement typesstatic final intXrVirtualKeyboardLocationTypeMETA - Enum describing keyboard placement types -
Method Summary
Modifier and TypeMethodDescriptionstatic intnxrChangeVirtualKeyboardTextContextMETA(XrVirtualKeyboardMETA keyboard, long changeInfo) Unsafe version of:ChangeVirtualKeyboardTextContextMETAstatic intnxrCreateVirtualKeyboardMETA(XrSession session, long createInfo, long keyboard) Unsafe version of:CreateVirtualKeyboardMETAstatic intnxrCreateVirtualKeyboardSpaceMETA(XrSession session, XrVirtualKeyboardMETA keyboard, long createInfo, long keyboardSpace) Unsafe version of:CreateVirtualKeyboardSpaceMETAstatic intnxrGetVirtualKeyboardDirtyTexturesMETA(XrVirtualKeyboardMETA keyboard, int textureIdCapacityInput, long textureIdCountOutput, long textureIds) Unsafe version of:GetVirtualKeyboardDirtyTexturesMETAstatic intnxrGetVirtualKeyboardModelAnimationStatesMETA(XrVirtualKeyboardMETA keyboard, long animationStates) Unsafe version of:GetVirtualKeyboardModelAnimationStatesMETAstatic intnxrGetVirtualKeyboardScaleMETA(XrVirtualKeyboardMETA keyboard, long scale) Unsafe version of:GetVirtualKeyboardScaleMETAstatic intnxrGetVirtualKeyboardTextureDataMETA(XrVirtualKeyboardMETA keyboard, long textureId, long textureData) Unsafe version of:GetVirtualKeyboardTextureDataMETAstatic intnxrSendVirtualKeyboardInputMETA(XrVirtualKeyboardMETA keyboard, long info, long interactorRootPose) Unsafe version of:SendVirtualKeyboardInputMETAstatic intnxrSetVirtualKeyboardModelVisibilityMETA(XrVirtualKeyboardMETA keyboard, long modelVisibility) Unsafe version of:SetVirtualKeyboardModelVisibilityMETAstatic intnxrSuggestVirtualKeyboardLocationMETA(XrVirtualKeyboardMETA keyboard, long locationInfo) Unsafe version of:SuggestVirtualKeyboardLocationMETAstatic intxrChangeVirtualKeyboardTextContextMETA(XrVirtualKeyboardMETA keyboard, XrVirtualKeyboardTextContextChangeInfoMETA changeInfo) Change virtual keyboard text context.static intxrCreateVirtualKeyboardMETA(XrSession session, XrVirtualKeyboardCreateInfoMETA createInfo, org.lwjgl.PointerBuffer keyboard) Create a virtual keyboard.static intxrCreateVirtualKeyboardSpaceMETA(XrSession session, XrVirtualKeyboardMETA keyboard, XrVirtualKeyboardSpaceCreateInfoMETA createInfo, org.lwjgl.PointerBuffer keyboardSpace) Create a virtual keyboard space.static intDestroy a virtual keyboard.static intxrGetVirtualKeyboardDirtyTexturesMETA(XrVirtualKeyboardMETA keyboard, IntBuffer textureIdCountOutput, @Nullable LongBuffer textureIds) Get model textures that are dirty.static intxrGetVirtualKeyboardModelAnimationStatesMETA(XrVirtualKeyboardMETA keyboard, XrVirtualKeyboardModelAnimationStatesMETA animationStates) Get model animation states.static intxrGetVirtualKeyboardScaleMETA(XrVirtualKeyboardMETA keyboard, FloatBuffer scale) Get virtual keyboard scale.static intxrGetVirtualKeyboardTextureDataMETA(XrVirtualKeyboardMETA keyboard, long textureId, XrVirtualKeyboardTextureDataMETA textureData) Get the data to update a model texture.static intxrSendVirtualKeyboardInputMETA(XrVirtualKeyboardMETA keyboard, XrVirtualKeyboardInputInfoMETA info, XrPosef interactorRootPose) Send virtual keyboard input.static intxrSetVirtualKeyboardModelVisibilityMETA(XrVirtualKeyboardMETA keyboard, XrVirtualKeyboardModelVisibilitySetInfoMETA modelVisibility) Set virtual keyboard model visibility.static intxrSuggestVirtualKeyboardLocationMETA(XrVirtualKeyboardMETA keyboard, XrVirtualKeyboardLocationInfoMETA locationInfo) Suggest a virtual keyboard location.
-
Field Details
-
XR_META_virtual_keyboard_SPEC_VERSION
public static final int XR_META_virtual_keyboard_SPEC_VERSIONThe extension specification version.- See Also:
-
XR_META_VIRTUAL_KEYBOARD_EXTENSION_NAME
The extension name.- See Also:
-
XR_MAX_VIRTUAL_KEYBOARD_COMMIT_TEXT_SIZE_META
public static final int XR_MAX_VIRTUAL_KEYBOARD_COMMIT_TEXT_SIZE_METAXR_MAX_VIRTUAL_KEYBOARD_COMMIT_TEXT_SIZE_META- See Also:
-
XR_OBJECT_TYPE_VIRTUAL_KEYBOARD_META
public static final int XR_OBJECT_TYPE_VIRTUAL_KEYBOARD_METAExtendsXrObjectType.- See Also:
-
XR_TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_META
public static final int XR_TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METAExtendsXrStructureType.Enum values:
TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METATYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METATYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METATYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METATYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METATYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METATYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METATYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
- See Also:
-
XR_TYPE_VIRTUAL_KEYBOARD_CREATE_INFO_META
public static final int XR_TYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METAExtendsXrStructureType.Enum values:
TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METATYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METATYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METATYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METATYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METATYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METATYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METATYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
- See Also:
-
XR_TYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_META
public static final int XR_TYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METAExtendsXrStructureType.Enum values:
TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METATYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METATYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METATYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METATYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METATYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METATYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METATYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
- See Also:
-
XR_TYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_META
public static final int XR_TYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METAExtendsXrStructureType.Enum values:
TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METATYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METATYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METATYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METATYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METATYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METATYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METATYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
- See Also:
-
XR_TYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_META
public static final int XR_TYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METAExtendsXrStructureType.Enum values:
TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METATYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METATYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METATYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METATYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METATYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METATYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METATYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
- See Also:
-
XR_TYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_META
public static final int XR_TYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METAExtendsXrStructureType.Enum values:
TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METATYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METATYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METATYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METATYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METATYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METATYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METATYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
- See Also:
-
XR_TYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_META
public static final int XR_TYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METAExtendsXrStructureType.Enum values:
TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METATYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METATYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METATYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METATYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METATYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METATYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METATYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
- See Also:
-
XR_TYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_META
public static final int XR_TYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METAExtendsXrStructureType.Enum values:
TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METATYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METATYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METATYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METATYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METATYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METATYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METATYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
- See Also:
-
XR_TYPE_VIRTUAL_KEYBOARD_INPUT_INFO_META
public static final int XR_TYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METAExtendsXrStructureType.Enum values:
TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METATYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METATYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METATYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METATYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METATYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METATYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METATYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
- See Also:
-
XR_TYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_META
public static final int XR_TYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METAExtendsXrStructureType.Enum values:
TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METATYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METATYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METATYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METATYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METATYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METATYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METATYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
- See Also:
-
XR_TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_META
public static final int XR_TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METAExtendsXrStructureType.Enum values:
TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METATYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METATYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METATYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METATYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METATYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METATYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METATYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
- See Also:
-
XR_TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_META
public static final int XR_TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METAExtendsXrStructureType.Enum values:
TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METATYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METATYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METATYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METATYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METATYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METATYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METATYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
- See Also:
-
XR_TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_META
public static final int XR_TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METAExtendsXrStructureType.Enum values:
TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METATYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METATYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METATYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METATYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METATYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METATYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METATYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
- See Also:
-
XR_TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_META
public static final int XR_TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METAExtendsXrStructureType.Enum values:
TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METATYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METATYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METATYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METATYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METATYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METATYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METATYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
- See Also:
-
XR_TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
public static final int XR_TYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_METAExtendsXrStructureType.Enum values:
TYPE_SYSTEM_VIRTUAL_KEYBOARD_PROPERTIES_METATYPE_VIRTUAL_KEYBOARD_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_SPACE_CREATE_INFO_METATYPE_VIRTUAL_KEYBOARD_LOCATION_INFO_METATYPE_VIRTUAL_KEYBOARD_MODEL_VISIBILITY_SET_INFO_METATYPE_VIRTUAL_KEYBOARD_ANIMATION_STATE_METATYPE_VIRTUAL_KEYBOARD_MODEL_ANIMATION_STATES_METATYPE_VIRTUAL_KEYBOARD_TEXTURE_DATA_METATYPE_VIRTUAL_KEYBOARD_INPUT_INFO_METATYPE_VIRTUAL_KEYBOARD_TEXT_CONTEXT_CHANGE_INFO_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_COMMIT_TEXT_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_BACKSPACE_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_ENTER_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_SHOWN_METATYPE_EVENT_DATA_VIRTUAL_KEYBOARD_HIDDEN_META
- See Also:
-
XR_VIRTUAL_KEYBOARD_LOCATION_TYPE_CUSTOM_META
public static final int XR_VIRTUAL_KEYBOARD_LOCATION_TYPE_CUSTOM_METAXrVirtualKeyboardLocationTypeMETA - Enum describing keyboard placement typesEnumerant Descriptions
VIRTUAL_KEYBOARD_LOCATION_TYPE_CUSTOM_METAIndicates that the application will provide the position and scale of the keyboard.VIRTUAL_KEYBOARD_LOCATION_TYPE_FAR_METAIndicates that the runtime will set the position and scale for far field keyboard.VIRTUAL_KEYBOARD_LOCATION_TYPE_DIRECT_METAIndicates that the runtime will set the position and scale for direct interaction keyboard.
See Also
XrVirtualKeyboardLocationInfoMETA,XrVirtualKeyboardSpaceCreateInfoMETA- See Also:
-
XR_VIRTUAL_KEYBOARD_LOCATION_TYPE_FAR_META
public static final int XR_VIRTUAL_KEYBOARD_LOCATION_TYPE_FAR_METAXrVirtualKeyboardLocationTypeMETA - Enum describing keyboard placement typesEnumerant Descriptions
VIRTUAL_KEYBOARD_LOCATION_TYPE_CUSTOM_METAIndicates that the application will provide the position and scale of the keyboard.VIRTUAL_KEYBOARD_LOCATION_TYPE_FAR_METAIndicates that the runtime will set the position and scale for far field keyboard.VIRTUAL_KEYBOARD_LOCATION_TYPE_DIRECT_METAIndicates that the runtime will set the position and scale for direct interaction keyboard.
See Also
XrVirtualKeyboardLocationInfoMETA,XrVirtualKeyboardSpaceCreateInfoMETA- See Also:
-
XR_VIRTUAL_KEYBOARD_LOCATION_TYPE_DIRECT_META
public static final int XR_VIRTUAL_KEYBOARD_LOCATION_TYPE_DIRECT_METAXrVirtualKeyboardLocationTypeMETA - Enum describing keyboard placement typesEnumerant Descriptions
VIRTUAL_KEYBOARD_LOCATION_TYPE_CUSTOM_METAIndicates that the application will provide the position and scale of the keyboard.VIRTUAL_KEYBOARD_LOCATION_TYPE_FAR_METAIndicates that the runtime will set the position and scale for far field keyboard.VIRTUAL_KEYBOARD_LOCATION_TYPE_DIRECT_METAIndicates that the runtime will set the position and scale for direct interaction keyboard.
See Also
XrVirtualKeyboardLocationInfoMETA,XrVirtualKeyboardSpaceCreateInfoMETA- See Also:
-
XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_LEFT_META
public static final int XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_LEFT_METAXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesDescription
Enum Description VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_LEFT_METALeft controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_RIGHT_METARight controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_LEFT_METALeft hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_RIGHT_METARight hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_LEFT_METALeft controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_RIGHT_METARight controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_LEFT_METALeft hand direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_RIGHT_METARight hand direct touch. See Also
- See Also:
-
XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_RIGHT_META
public static final int XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_RIGHT_METAXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesDescription
Enum Description VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_LEFT_METALeft controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_RIGHT_METARight controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_LEFT_METALeft hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_RIGHT_METARight hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_LEFT_METALeft controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_RIGHT_METARight controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_LEFT_METALeft hand direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_RIGHT_METARight hand direct touch. See Also
- See Also:
-
XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_LEFT_META
public static final int XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_LEFT_METAXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesDescription
Enum Description VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_LEFT_METALeft controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_RIGHT_METARight controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_LEFT_METALeft hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_RIGHT_METARight hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_LEFT_METALeft controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_RIGHT_METARight controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_LEFT_METALeft hand direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_RIGHT_METARight hand direct touch. See Also
- See Also:
-
XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_RIGHT_META
public static final int XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_RIGHT_METAXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesDescription
Enum Description VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_LEFT_METALeft controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_RIGHT_METARight controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_LEFT_METALeft hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_RIGHT_METARight hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_LEFT_METALeft controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_RIGHT_METARight controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_LEFT_METALeft hand direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_RIGHT_METARight hand direct touch. See Also
- See Also:
-
XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_LEFT_META
public static final int XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_LEFT_METAXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesDescription
Enum Description VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_LEFT_METALeft controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_RIGHT_METARight controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_LEFT_METALeft hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_RIGHT_METARight hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_LEFT_METALeft controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_RIGHT_METARight controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_LEFT_METALeft hand direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_RIGHT_METARight hand direct touch. See Also
- See Also:
-
XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_RIGHT_META
public static final int XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_RIGHT_METAXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesDescription
Enum Description VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_LEFT_METALeft controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_RIGHT_METARight controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_LEFT_METALeft hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_RIGHT_METARight hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_LEFT_METALeft controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_RIGHT_METARight controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_LEFT_METALeft hand direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_RIGHT_METARight hand direct touch. See Also
- See Also:
-
XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_LEFT_META
public static final int XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_LEFT_METAXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesDescription
Enum Description VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_LEFT_METALeft controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_RIGHT_METARight controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_LEFT_METALeft hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_RIGHT_METARight hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_LEFT_METALeft controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_RIGHT_METARight controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_LEFT_METALeft hand direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_RIGHT_METARight hand direct touch. See Also
- See Also:
-
XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_RIGHT_META
public static final int XR_VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_RIGHT_METAXrVirtualKeyboardInputSourceMETA - Enum describing keyboard input source typesDescription
Enum Description VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_LEFT_METALeft controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_RIGHT_METARight controller ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_LEFT_METALeft hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_RIGHT_METARight hand ray. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_LEFT_METALeft controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_RIGHT_METARight controller direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_LEFT_METALeft hand direct touch. VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_RIGHT_METARight hand direct touch. See Also
- See Also:
-
XR_VIRTUAL_KEYBOARD_INPUT_STATE_PRESSED_BIT_META
public static final int XR_VIRTUAL_KEYBOARD_INPUT_STATE_PRESSED_BIT_METAXrVirtualKeyboardInputStateFlagBitsMETA - XrVirtualKeyboardInputStateFlagBitsMETAFlag Descriptions
VIRTUAL_KEYBOARD_INPUT_STATE_PRESSED_BIT_META— If the input source is considered 'pressed' at all. Pinch for hands, Primary button for controllers.
- See Also:
-
-
Method Details
-
nxrCreateVirtualKeyboardMETA
Unsafe version of:CreateVirtualKeyboardMETA -
xrCreateVirtualKeyboardMETA
public static int xrCreateVirtualKeyboardMETA(XrSession session, XrVirtualKeyboardCreateInfoMETA createInfo, org.lwjgl.PointerBuffer keyboard) Create a virtual keyboard.C Specification
The
CreateVirtualKeyboardMETAfunction is defined as:XrResult xrCreateVirtualKeyboardMETA( XrSession session, const XrVirtualKeyboardCreateInfoMETA* createInfo, XrVirtualKeyboardMETA* keyboard);Description
CreateVirtualKeyboardMETAcreates anXrVirtualKeyboardMETAhandle and establishes a keyboard within the runtimeXrSession. The returned virtual keyboard handle may be subsequently used in API calls.Valid Usage (Implicit)
- The
XR_META_virtual_keyboardextension must be enabled prior to callingCreateVirtualKeyboardMETA sessionmust be a validXrSessionhandlecreateInfomust be a pointer to a validXrVirtualKeyboardCreateInfoMETAstructurekeyboardmust be a pointer to anXrVirtualKeyboardMETAhandle
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
session- theXrSession.createInfo- theXrVirtualKeyboardCreateInfoMETA.keyboard- the returnedXrVirtualKeyboardMETA.
- The
-
xrDestroyVirtualKeyboardMETA
Destroy a virtual keyboard.C Specification
The
DestroyVirtualKeyboardMETAfunction is defined as:XrResult xrDestroyVirtualKeyboardMETA( XrVirtualKeyboardMETA keyboard);Valid Usage (Implicit)
- The
XR_META_virtual_keyboardextension must be enabled prior to callingDestroyVirtualKeyboardMETA keyboardmust be a validXrVirtualKeyboardMETAhandle
Thread Safety
- Access to
keyboard, and any child handles, must be externally synchronized
Return Codes
- On success, this command returns
- On failure, this command returns
- Parameters:
keyboard- theXrVirtualKeyboardMETAhandle to the keyboard to destroy.
- The
-
nxrCreateVirtualKeyboardSpaceMETA
public static int nxrCreateVirtualKeyboardSpaceMETA(XrSession session, XrVirtualKeyboardMETA keyboard, long createInfo, long keyboardSpace) Unsafe version of:CreateVirtualKeyboardSpaceMETA -
xrCreateVirtualKeyboardSpaceMETA
public static int xrCreateVirtualKeyboardSpaceMETA(XrSession session, XrVirtualKeyboardMETA keyboard, XrVirtualKeyboardSpaceCreateInfoMETA createInfo, org.lwjgl.PointerBuffer keyboardSpace) Create a virtual keyboard space.C Specification
The
CreateVirtualKeyboardSpaceMETAfunction is defined as:XrResult xrCreateVirtualKeyboardSpaceMETA( XrSession session, XrVirtualKeyboardMETA keyboard, const XrVirtualKeyboardSpaceCreateInfoMETA* createInfo, XrSpace* keyboardSpace);Description
Creates an
XrSpacehandle and places the keyboard in this space. The returned space handle may be subsequently used in API calls.Once placed, the application should query the keyboard’s location each frame using
LocateSpace. It is important to do this every frame as the runtime is in control of the keyboard’s movement.The runtime must return
ERROR_HANDLE_INVALIDifsessionis different than what is used to createkeyboard.Valid Usage (Implicit)
- The
XR_META_virtual_keyboardextension must be enabled prior to callingCreateVirtualKeyboardSpaceMETA sessionmust be a validXrSessionhandlekeyboardmust be a validXrVirtualKeyboardMETAhandlecreateInfomust be a pointer to a validXrVirtualKeyboardSpaceCreateInfoMETAstructurekeyboardSpacemust be a pointer to anXrSpacehandlekeyboardmust have been created, allocated, or retrieved fromsession
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
session- theXrSession.keyboard- theXrVirtualKeyboardMETAhandle.createInfo- theXrVirtualKeyboardSpaceCreateInfoMETA.keyboardSpace- the returned space handle.
- The
-
nxrSuggestVirtualKeyboardLocationMETA
public static int nxrSuggestVirtualKeyboardLocationMETA(XrVirtualKeyboardMETA keyboard, long locationInfo) Unsafe version of:SuggestVirtualKeyboardLocationMETA -
xrSuggestVirtualKeyboardLocationMETA
public static int xrSuggestVirtualKeyboardLocationMETA(XrVirtualKeyboardMETA keyboard, XrVirtualKeyboardLocationInfoMETA locationInfo) Suggest a virtual keyboard location.C Specification
The
SuggestVirtualKeyboardLocationMETAfunction is defined as:XrResult xrSuggestVirtualKeyboardLocationMETA( XrVirtualKeyboardMETA keyboard, const XrVirtualKeyboardLocationInfoMETA* locationInfo);Valid Usage (Implicit)
- The
XR_META_virtual_keyboardextension must be enabled prior to callingSuggestVirtualKeyboardLocationMETA keyboardmust be a validXrVirtualKeyboardMETAhandlelocationInfomust be a pointer to a validXrVirtualKeyboardLocationInfoMETAstructure
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
keyboard- theXrVirtualKeyboardMETAhandle.locationInfo- the desiredXrVirtualKeyboardLocationInfoMETA.
- The
-
nxrGetVirtualKeyboardScaleMETA
Unsafe version of:GetVirtualKeyboardScaleMETA -
xrGetVirtualKeyboardScaleMETA
Get virtual keyboard scale.C Specification
The
GetVirtualKeyboardScaleMETAfunction is defined as:XrResult xrGetVirtualKeyboardScaleMETA( XrVirtualKeyboardMETA keyboard, float* scale);Description
With both the pose and scale, the application has all the information to draw the virtual keyboard render model.
Valid Usage (Implicit)
- The
XR_META_virtual_keyboardextension must be enabled prior to callingGetVirtualKeyboardScaleMETA keyboardmust be a validXrVirtualKeyboardMETAhandlescalemust be a pointer to afloatvalue
Return Codes
- On success, this command returns
- On failure, this command returns
- Parameters:
keyboard- theXrVirtualKeyboardMETAhandle.scale- a float value of the current scale of the keyboard.
- The
-
nxrSetVirtualKeyboardModelVisibilityMETA
public static int nxrSetVirtualKeyboardModelVisibilityMETA(XrVirtualKeyboardMETA keyboard, long modelVisibility) Unsafe version of:SetVirtualKeyboardModelVisibilityMETA -
xrSetVirtualKeyboardModelVisibilityMETA
public static int xrSetVirtualKeyboardModelVisibilityMETA(XrVirtualKeyboardMETA keyboard, XrVirtualKeyboardModelVisibilitySetInfoMETA modelVisibility) Set virtual keyboard model visibility.C Specification
The
SetVirtualKeyboardModelVisibilityMETAfunction is defined as:XrResult xrSetVirtualKeyboardModelVisibilityMETA( XrVirtualKeyboardMETA keyboard, const XrVirtualKeyboardModelVisibilitySetInfoMETA* modelVisibility);Description
Note that the runtime has final control of the model visibility. The runtime may also change the visible state in certain situations. To get the actual visibility state of the render model, the application should wait for the
XrEventDataVirtualKeyboardShownMETAandXrEventDataVirtualKeyboardHiddenMETAevents.Valid Usage (Implicit)
- The
XR_META_virtual_keyboardextension must be enabled prior to callingSetVirtualKeyboardModelVisibilityMETA keyboardmust be a validXrVirtualKeyboardMETAhandlemodelVisibilitymust be a pointer to a validXrVirtualKeyboardModelVisibilitySetInfoMETAstructure
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
keyboard- theXrVirtualKeyboardMETAhandle.modelVisibility- theXrVirtualKeyboardModelVisibilitySetInfoMETA.
- The
-
nxrGetVirtualKeyboardModelAnimationStatesMETA
public static int nxrGetVirtualKeyboardModelAnimationStatesMETA(XrVirtualKeyboardMETA keyboard, long animationStates) Unsafe version of:GetVirtualKeyboardModelAnimationStatesMETA -
xrGetVirtualKeyboardModelAnimationStatesMETA
public static int xrGetVirtualKeyboardModelAnimationStatesMETA(XrVirtualKeyboardMETA keyboard, XrVirtualKeyboardModelAnimationStatesMETA animationStates) Get model animation states.C Specification
The
GetVirtualKeyboardModelAnimationStatesMETAfunction is defined as:XrResult xrGetVirtualKeyboardModelAnimationStatesMETA( XrVirtualKeyboardMETA keyboard, XrVirtualKeyboardModelAnimationStatesMETA* animationStates);Description
This function follows the two-call idiom for filling the
animationStatesarray in theXrVirtualKeyboardModelAnimationStatesMETAstructure. Note that new animations may be added after the runtime processes inputs fromSendVirtualKeyboardInputMETA. Therefore, after sending new keyboard inputs the application should query the buffer size again before getting any animation data.Valid Usage (Implicit)
- The
XR_META_virtual_keyboardextension must be enabled prior to callingGetVirtualKeyboardModelAnimationStatesMETA keyboardmust be a validXrVirtualKeyboardMETAhandleanimationStatesmust be a pointer to anXrVirtualKeyboardModelAnimationStatesMETAstructure
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
keyboard- theXrVirtualKeyboardMETAhandle.animationStates- theXrVirtualKeyboardModelAnimationStatesMETA.
- The
-
nxrGetVirtualKeyboardDirtyTexturesMETA
public static int nxrGetVirtualKeyboardDirtyTexturesMETA(XrVirtualKeyboardMETA keyboard, int textureIdCapacityInput, long textureIdCountOutput, long textureIds) Unsafe version of:GetVirtualKeyboardDirtyTexturesMETA- Parameters:
textureIdCapacityInput- the capacity of thetextureIdsarray, or 0 to indicate a request to retrieve the required capacity.
-
xrGetVirtualKeyboardDirtyTexturesMETA
public static int xrGetVirtualKeyboardDirtyTexturesMETA(XrVirtualKeyboardMETA keyboard, IntBuffer textureIdCountOutput, @Nullable LongBuffer textureIds) Get model textures that are dirty.C Specification
The
GetVirtualKeyboardDirtyTexturesMETAfunction is defined as:XrResult xrGetVirtualKeyboardDirtyTexturesMETA( XrVirtualKeyboardMETA keyboard, uint32_t textureIdCapacityInput, uint32_t* textureIdCountOutput, uint64_t* textureIds);Description
This function follows the two-call idiom for filling the
textureIdsarray. Note that new texture data may be added after the runtime processes inputs fromSendVirtualKeyboardInputMETA. Therefore, after sending new keyboard inputs the application should query the buffer size again before getting any texture data.Valid Usage (Implicit)
- The
XR_META_virtual_keyboardextension must be enabled prior to callingGetVirtualKeyboardDirtyTexturesMETA keyboardmust be a validXrVirtualKeyboardMETAhandletextureIdCountOutputmust be a pointer to auint32_tvalue- If
textureIdCapacityInputis not 0,textureIdsmust be a pointer to an array oftextureIdCapacityInputuint64_tvalues
Return Codes
- On success, this command returns
- On failure, this command returns
- Parameters:
keyboard- theXrVirtualKeyboardMETAhandle.textureIdCountOutput- filled in by the runtime with the count of texture IDs written or the required capacity in the case thattextureIdCapacityInputis insufficient.textureIds- the array of texture IDs that need to be updated.
- The
-
nxrGetVirtualKeyboardTextureDataMETA
public static int nxrGetVirtualKeyboardTextureDataMETA(XrVirtualKeyboardMETA keyboard, long textureId, long textureData) Unsafe version of:GetVirtualKeyboardTextureDataMETA -
xrGetVirtualKeyboardTextureDataMETA
public static int xrGetVirtualKeyboardTextureDataMETA(XrVirtualKeyboardMETA keyboard, long textureId, XrVirtualKeyboardTextureDataMETA textureData) Get the data to update a model texture.C Specification
The
GetVirtualKeyboardTextureDataMETAfunction is defined as:XrResult xrGetVirtualKeyboardTextureDataMETA( XrVirtualKeyboardMETA keyboard, uint64_t textureId, XrVirtualKeyboardTextureDataMETA* textureData);Description
This function follows the two-call idiom for filling the
textureDataarray in theXrVirtualKeyboardTextureDataMETAstructure. Note that new texture data may be added after the runtime processes inputs fromSendVirtualKeyboardInputMETA. Therefore, after sending new keyboard inputs the application should query the buffer size again before getting any texture data.Valid Usage (Implicit)
- The
XR_META_virtual_keyboardextension must be enabled prior to callingGetVirtualKeyboardTextureDataMETA keyboardmust be a validXrVirtualKeyboardMETAhandletextureDatamust be a pointer to anXrVirtualKeyboardTextureDataMETAstructure
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
keyboard- theXrVirtualKeyboardMETAhandle.textureId- the ID of the texture that the application is querying data for.textureData- the returnedXrVirtualKeyboardTextureDataMETA.
- The
-
nxrSendVirtualKeyboardInputMETA
public static int nxrSendVirtualKeyboardInputMETA(XrVirtualKeyboardMETA keyboard, long info, long interactorRootPose) Unsafe version of:SendVirtualKeyboardInputMETA -
xrSendVirtualKeyboardInputMETA
public static int xrSendVirtualKeyboardInputMETA(XrVirtualKeyboardMETA keyboard, XrVirtualKeyboardInputInfoMETA info, XrPosef interactorRootPose) Send virtual keyboard input.C Specification
The
SendVirtualKeyboardInputMETAfunction is defined as:XrResult xrSendVirtualKeyboardInputMETA( XrVirtualKeyboardMETA keyboard, const XrVirtualKeyboardInputInfoMETA* info, XrPosef* interactorRootPose);Description
The application can use values like a pointer pose as the
interactorRootPoseforXR_VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_RAY_*orXR_VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_RAY_*input sources, a point on a controller model forXR_VIRTUAL_KEYBOARD_INPUT_SOURCE_CONTROLLER_DIRECT_*input sources and the hand index tip pose forXR_VIRTUAL_KEYBOARD_INPUT_SOURCE_HAND_DIRECT_INDEX_TIP_*. Different input poses can be used to accommodate application specific controller or hand models.Valid Usage (Implicit)
- The
XR_META_virtual_keyboardextension must be enabled prior to callingSendVirtualKeyboardInputMETA keyboardmust be a validXrVirtualKeyboardMETAhandleinfomust be a pointer to a validXrVirtualKeyboardInputInfoMETAstructureinteractorRootPosemust be a pointer to anXrPosefstructure
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
keyboard- theXrVirtualKeyboardMETAhandle.info- theXrVirtualKeyboardInputInfoMETAdetailing the input being sent to the runtime.interactorRootPose- anXrPosefdefining the root pose of the input source. The runtime may modify this value to aid keyboard input perception.
- The
-
nxrChangeVirtualKeyboardTextContextMETA
public static int nxrChangeVirtualKeyboardTextContextMETA(XrVirtualKeyboardMETA keyboard, long changeInfo) Unsafe version of:ChangeVirtualKeyboardTextContextMETA -
xrChangeVirtualKeyboardTextContextMETA
public static int xrChangeVirtualKeyboardTextContextMETA(XrVirtualKeyboardMETA keyboard, XrVirtualKeyboardTextContextChangeInfoMETA changeInfo) Change virtual keyboard text context.C Specification
The
ChangeVirtualKeyboardTextContextMETAfunction is defined as:XrResult xrChangeVirtualKeyboardTextContextMETA( XrVirtualKeyboardMETA keyboard, const XrVirtualKeyboardTextContextChangeInfoMETA* changeInfo);Valid Usage (Implicit)
- The
XR_META_virtual_keyboardextension must be enabled prior to callingChangeVirtualKeyboardTextContextMETA keyboardmust be a validXrVirtualKeyboardMETAhandlechangeInfomust be a pointer to a validXrVirtualKeyboardTextContextChangeInfoMETAstructure
Return Codes
- On success, this command returns
- On failure, this command returns
See Also
- Parameters:
keyboard- theXrVirtualKeyboardMETAhandle.changeInfo- theXrVirtualKeyboardTextContextChangeInfoMETAdetailing prior input text context to the runtime.
- The
-