virtual-machine 0.2.1 → 0.3.0

package/build/index.d.ts

@@ -14,6 +14,18 @@ declare enum NetworkStatus {
 declare class WasmVm {
   free(): void;
   [Symbol.dispose](): void;
+  /**
+   * Enable VirtIO GPU device for graphics rendering.
+   *
+   * The GPU device allows the kernel to render to a framebuffer which can
+   * then be displayed in a Canvas element. Use `get_gpu_frame()` to retrieve
+   * the rendered frame pixels.
+   *
+   * # Arguments
+   * * `width` - Display width in pixels (default 800 if 0)
+   * * `height` - Display height in pixels (default 600 if 0)
+   */
+  enable_gpu(width: number, height: number): void;
   /**
    * Get a byte from the UART output buffer, if available.
    *
@@ -21,6 +33,18 @@ declare class WasmVm {
    * and the local UART buffer (for hart 0 output).
    */
   get_output(): number | undefined;
+  /**
+   * Enable VirtIO Input device for keyboard input.
+   *
+   * After calling this, use `send_key_event()` to forward keyboard events
+   * from JavaScript to the guest kernel.
+   */
+  enable_input(): void;
+  /**
+   * Get GPU display dimensions.
+   * Returns [width, height] or null if GPU is not enabled.
+   */
+  get_gpu_size(): Uint32Array | undefined;
   /**
    * Print the VM banner to UART output (visible in browser).
    * Call this after creating the VM to show a boot banner.
@@ -34,10 +58,27 @@ declare class WasmVm {
    * Get CPU count (from kernel-reported value).
    */
   get_cpu_count(): number;
+  /**
+   * Get GPU frame data as RGBA pixels.
+   * Returns a Uint8Array of pixel data, or null if no frame is available.
+   *
+   * The frame data is in RGBA format with 4 bytes per pixel (800x600 = 1,920,000 bytes).
+   * 
+   * This reads from a fixed framebuffer address in guest memory (0x8100_0000).
+   * The kernel GPU driver writes pixels there, and we read them here.
+   */
+  get_gpu_frame(): Uint8Array | undefined;
   /**
    * Get system uptime in milliseconds (from kernel-reported value).
    */
   get_uptime_ms(): bigint;
+  /**
+   * Check if there's a GPU frame ready for rendering.
+   *
+   * With direct memory framebuffer, this always returns true when GPU is enabled.
+   * The framebuffer at FRAMEBUFFER_ADDR always contains the current frame.
+   */
+  has_gpu_frame(): boolean;
   /**
    * Start worker threads for secondary harts (1..num_harts).
    *
@@ -71,10 +112,32 @@ declare class WasmVm {
    * * `num_harts` - Number of harts (0 = auto-detect)
    */
   static new_with_harts(kernel: Uint8Array, num_harts: number): WasmVm;
+  /**
+   * Send a keyboard event to the guest.
+   *
+   * # Arguments
+   * * `key_code` - JavaScript keyCode (e.g., 65 for 'A')
+   * * `pressed` - true for keydown, false for keyup
+   *
+   * Returns true if the event was sent successfully.
+   */
+  send_key_event(key_code: number, pressed: boolean): boolean;
   /**
    * Get current memory usage (DRAM size) in bytes.
    */
   get_memory_usage(): bigint;
+  /**
+   * Send a mouse event to the guest.
+   *
+   * # Arguments
+   * * `x` - X position (0-799)
+   * * `y` - Y position (0-599)
+   * * `buttons` - Button state bitmask (bit 0 = left, bit 1 = right, bit 2 = middle)
+   * * `prev_buttons` - Previous button state to detect changes
+   *
+   * Returns true if the event was sent successfully.
+   */
+  send_mouse_event(x: number, y: number, buttons: number): boolean;
   /**
    * Get the total disk capacity from attached VirtIO block devices.
    * Returns total bytes across all block devices.
@@ -85,6 +148,14 @@ declare class WasmVm {
    * Returns None if not in SMP mode.
    */
   get_shared_buffer(): SharedArrayBuffer | undefined;
+  /**
+   * Send a mouse button event to the guest.
+   *
+   * # Arguments
+   * * `button` - Button number (0 = left, 1 = right, 2 = middle)
+   * * `pressed` - true for press, false for release
+   */
+  send_mouse_button(button: number, pressed: boolean): boolean;
   /**
    * Terminate all workers.
    */
@@ -289,6 +360,8 @@ interface InitOutput {
   readonly wasmvm_allow_workers_to_start: (a: number) => void;
   readonly wasmvm_connect_webtransport: (a: number, b: number, c: number, d: number, e: number) => [number, number];
   readonly wasmvm_disconnect_network: (a: number) => void;
+  readonly wasmvm_enable_gpu: (a: number, b: number, c: number) => void;
+  readonly wasmvm_enable_input: (a: number) => void;
   readonly wasmvm_entry_pc: (a: number) => bigint;
   readonly wasmvm_external_network_rx_pending: (a: number) => number;
   readonly wasmvm_external_network_tx_pending: (a: number) => number;
@@ -297,12 +370,15 @@ interface InitOutput {
   readonly wasmvm_get_cpu_count: (a: number) => number;
   readonly wasmvm_get_disk_capacity: (a: number) => bigint;
   readonly wasmvm_get_disk_usage: (a: number) => any;
+  readonly wasmvm_get_gpu_frame: (a: number) => any;
+  readonly wasmvm_get_gpu_size: (a: number) => any;
   readonly wasmvm_get_heap_usage: (a: number) => any;
   readonly wasmvm_get_memory_usage: (a: number) => bigint;
   readonly wasmvm_get_output: (a: number) => number;
   readonly wasmvm_get_shared_buffer: (a: number) => any;
   readonly wasmvm_get_uptime_ms: (a: number) => bigint;
   readonly wasmvm_halt_code: (a: number) => bigint;
+  readonly wasmvm_has_gpu_frame: (a: number) => number;
   readonly wasmvm_inject_network_packet: (a: number, b: any) => number;
   readonly wasmvm_input: (a: number, b: number) => void;
   readonly wasmvm_is_external_network_connected: (a: number) => number;
@@ -315,6 +391,9 @@ interface InitOutput {
   readonly wasmvm_num_harts: (a: number) => number;
   readonly wasmvm_print_banner: (a: number) => void;
   readonly wasmvm_print_status: (a: number, b: number, c: number) => void;
+  readonly wasmvm_send_key_event: (a: number, b: number, c: number) => number;
+  readonly wasmvm_send_mouse_button: (a: number, b: number, c: number) => number;
+  readonly wasmvm_send_mouse_event: (a: number, b: number, c: number, d: number) => number;
   readonly wasmvm_set_external_network_ip: (a: number, b: any) => number;
   readonly wasmvm_setup_external_network: (a: number, b: any) => [number, number];
   readonly wasmvm_start_workers: (a: number, b: number, c: number) => [number, number];
@@ -328,12 +407,12 @@ interface InitOutput {
   readonly workerstate_new: (a: number, b: any, c: bigint) => number;
   readonly workerstate_step_batch: (a: number, b: number) => number;
   readonly workerstate_step_count: (a: number) => bigint;
-  readonly wasm_bindgen__convert__closures_____invoke__h68f644bdb48dd813: (a: number, b: number, c: any) => void;
-  readonly wasm_bindgen__closure__destroy__h534978b8728125b3: (a: number, b: number) => void;
-  readonly wasm_bindgen__convert__closures_____invoke__h5c64d96786ac00c5: (a: number, b: number) => void;
-  readonly wasm_bindgen__convert__closures_____invoke__h39d3e89751b07765: (a: number, b: number, c: any) => void;
-  readonly wasm_bindgen__closure__destroy__hf225e18fc5ab9bc1: (a: number, b: number) => void;
-  readonly wasm_bindgen__convert__closures_____invoke__h2a4d868e42b21102: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__he00a4f55faf9050f: (a: number, b: number) => void;
+  readonly wasm_bindgen__closure__destroy__h2f2b52f94c430d4b: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__h260170fb96639bcf: (a: number, b: number, c: any) => void;
+  readonly wasm_bindgen__closure__destroy__h612f8e24953b61d5: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__hd159192dfee36a06: (a: number, b: number) => void;
+  readonly wasm_bindgen__convert__closures_____invoke__hedae94b906f728f2: (a: number, b: number, c: any) => void;
   readonly __wbindgen_malloc: (a: number, b: number) => number;
   readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
   readonly __wbindgen_exn_store: (a: number) => void;