Struct XrMetaVirtualKeyboard 

pub struct XrMetaVirtualKeyboard { /* private fields */ }

Main extension handler for Meta virtual keyboard functionality

This struct manages the XR_META_virtual_keyboard extension, providing access to:

• Virtual keyboard creation and destruction
• Spatial positioning and location suggestions
• Input event handling and text input
• Model visibility and animation control
• Texture management and dirty texture tracking

Implementations

impl XrMetaVirtualKeyboard

pub fn new() -> Option<Self>

Creates a new XrMetaVirtualKeyboardExtension instance if the extension is supported

Returns

• Some(Self) if extension is available and initialization succeeds
• None if extension is not available or initialization fails

Examples

use stereokit_rust::tools::xr_meta_virtual_keyboard::*;

number_of_steps = 50;
test_steps!( // !!!! Get a proper main loop !!!!
    if iter == 20 {
        // Test extension creation and functionality
        Log::info("🔧 Testing XR_META_virtual_keyboard extension creation...");
         
        match XrMetaVirtualKeyboard::new() {
            Some(extension) => {
                Log::info("✅ Extension created successfully");
                 
                // Test system support check
                match extension.check_system_support(false) {
                    Ok(_sys_prop) => {
                        Log::info("✅ System supports virtual keyboards");
                         
                        // Test keyboard creation
                        match extension.create_virtual_keyboard() {
                            Ok(keyboard) => {
                                Log::info("✅ Virtual keyboard created!");
                                 
                                // Test visibility control
                                if extension.set_model_visibility(keyboard, true).is_ok() {
                                    Log::info("✅ Keyboard shown");
                                }
                                if extension.set_model_visibility(keyboard, false).is_ok() {
                                    Log::info("✅ Keyboard hidden");
                                }
                                 
                                // Cleanup
                                if extension.destroy_virtual_keyboard(keyboard).is_ok() {
                                    Log::info("✅ Keyboard destroyed");
                                }
                            }
                            Err(e) => Log::err(format!("❌ Keyboard creation failed: {:?}", e)),
                        }
                    }
                    Err(e) => Log::err(format!("❌ System support check failed: {:?}", e)),
                }
            }
            None => Log::warn("⚠️ Extension not available on this system"),
        }
    }
);

pub fn check_system_support( &self, with_log: bool, ) -> Result<SystemProperties, XrResult>

Check if the system supports virtual keyboards

Parameters

• with_log: If true, outputs system properties to diagnostic log

Returns

Ok(true) if virtual keyboards are supported, Ok(false) if not, or error on failure

pub fn create_virtual_keyboard(&self) -> Result<VirtualKeyboardMETA, XrResult>

Create a virtual keyboard

Returns

Handle to the created virtual keyboard or error on failure

pub fn destroy_virtual_keyboard( &self, keyboard: VirtualKeyboardMETA, ) -> Result<(), XrResult>

Destroy a virtual keyboard

Arguments

• keyboard - The virtual keyboard to destroy

Returns

Ok(()) on success or error on failure

pub fn create_virtual_keyboard_space( &self, keyboard: VirtualKeyboardMETA, location_type: VirtualKeyboardLocationTypeMETA, space: Space, pose_in_space: Posef, ) -> Result<Space, XrResult>

Create a space for the virtual keyboard

Arguments

• keyboard - The virtual keyboard handle
• location_type - Type of location (CUSTOM, etc.)
• space - Reference space
• pose_in_space - Pose relative to the reference space

Returns

Handle to the created keyboard space or error on failure

pub fn set_model_visibility( &self, keyboard: VirtualKeyboardMETA, visible: bool, ) -> Result<(), XrResult>

Set the visibility of the virtual keyboard model

Arguments

• keyboard - The virtual keyboard handle
• visible - Whether the keyboard should be visible

Returns

Ok(()) on success or error on failure

pub fn suggest_location( &self, keyboard: VirtualKeyboardMETA, location_info: &VirtualKeyboardSpaceCreateInfoMETA, ) -> Result<(), XrResult>

Suggest a location for the virtual keyboard

Arguments

• keyboard - The virtual keyboard handle
• location_info - Information about the suggested location

Returns

Ok(()) on success or error on failure

Trait Implementations

impl Debug for XrMetaVirtualKeyboard

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.