Struct XrMetaVirtualKeyboardStepper 

pub struct XrMetaVirtualKeyboardStepper { /* private fields */ }

IStepper implementation for XR_META_virtual_keyboard integration with StereoKit

This stepper provides virtual keyboard functionality using the OpenXR XR_META_virtual_keyboard extension.

Events this stepper is listening to:

• KEYBOARD_SHOW - Event that triggers showing (“1”) or hiding (“0”) the virtual keyboard.

Examples

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

number_of_steps = 50;
test_steps!( // !!!! Get a proper main loop !!!!
    if iter == 10 {
        // Create and test virtual keyboard functionality
        if is_meta_virtual_keyboard_extension_available() {
            let mut keyboard_stepper = XrMetaVirtualKeyboardStepper::new(true);
            sk.send_event(StepperAction::add("keyboard_test", keyboard_stepper));
             
            // Show the keyboard
            sk.send_event(StepperAction::event("keyboard_test", KEYBOARD_SHOW, "1"));
            Log::info("✅ Virtual keyboard shown");
        }
    }
     
    if iter == 30 {
        // Hide the keyboard
        sk.send_event(StepperAction::event("keyboard_test", KEYBOARD_SHOW, "0"));
        Log::info("✅ Virtual keyboard hidden");
    }
);

Implementations

impl XrMetaVirtualKeyboardStepper

pub fn new(enable_on_init: bool) -> Self

Creates a new virtual keyboard stepper

Arguments

• enable_on_init - If true, keyboard will be enabled immediately upon initialization

Returns

A new XrMetaVirtualKeyboardStepper instance ready for integration with StereoKit

Examples

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

number_of_steps = 40;
test_steps!( // !!!! Get a proper main loop !!!!
    if iter == 10 {
        // Test creating keyboard stepper with different configurations
        let keyboard1 = XrMetaVirtualKeyboardStepper::new(false);
         
        // Add steppers to StereoKit for testing
        sk.send_event(StepperAction::add("keyboard_test1", keyboard1));
    } else if iter == 30 {
        // Test keyboard control events
        sk.send_event(StepperAction::event("keyboard_test1", KEYBOARD_SHOW, "false"));
    } else if iter == 35 {
        // Clean up steppers
        sk.send_event(StepperAction::remove("keyboard_test1"));
    }
);

Trait Implementations

impl Default for XrMetaVirtualKeyboardStepper

fn default() -> Self

Returns the “default value” for a type.

impl IStepper for XrMetaVirtualKeyboardStepper

fn enabled(&self) -> bool

Is this IStepper enabled? When false, StereoKit will not call Step. This can be a good way to temporarily disable the IStepper without removing or shutting it down. https://stereokit.net/Pages/StereoKit.Framework/IStepper/Enabled.html

fn initialize(&mut self, id: StepperId, sk_info: Rc<RefCell<SkInfo>>) -> bool

This is called by StereoKit at the start of the next frame, and on the main thread. This happens before StereoKit’s main Step callback, and always after Sk.initialize. https://stereokit.net/Pages/StereoKit.Framework/IStepper/Initialize.html id : The id of the stepper sk : The SkInfo of the runnin Sk instance.

fn step(&mut self, token: &MainThreadToken)

This Step method will be called every frame of the application, as long as Enabled is true. This happens immediately before the main application’s Step callback. https://stereokit.net/Pages/StereoKit.Framework/IStepper/Step.html

fn shutdown(&mut self)

This is called when the IStepper is removed, or the application shuts down. This is always called on the main thread, and happens at the start of the next frame, before the main application’s Step callback. https://stereokit.net/Pages/StereoKit.Framework/IStepper/Shutdown.html

fn shutdown_done(&mut self) -> bool

If shutdown is to be performed in multiple steps, with or without threads and in order to avoid black or frozen screens, write the on going shutdown here

fn initialize_done(&mut self) -> bool

If initialization is to be performed in multiple steps, with or without threads and in order to avoid black or frozen screens, write the on going initialization here

impl Send for XrMetaVirtualKeyboardStepper