#orby

#API

#Usage

import {
  "Nanaloveyuki/orby",
}

struct Example {
  mut window : @orby.Window?
}

pub impl @orby.App for Example with fn started(self, app) {
  self.window = Some(
    try! app.create_window(@orby.WindowOptions::new(title="Orby example")),
  )
}

pub impl @orby.App for Example with fn window_event(self, _app, _id, event) {
  match event {
    @orby.WindowEvent::CloseRequested =>
      match self.window {
        Some(window) => window.destroy()
        None => ()
      }
    _ => ()
  }
}

fn main raise {
  let event_loop = @orby.EventLoop::new()
  ignore(event_loop.run_app({ window: None }))
}

#Status

#Documentation

• Development: local setup, project requirements, and validation.
• Root package guide: complete consumer API, lifecycle, window, input, display, and WebView-host documentation.
• MoonView integration: versioned desktop host setup, lifecycle, resize, failure, and teardown requirements.
• Contributing: pull request process.
• Releasing: version and package release checklist.

#Orby Root Package

#Platform and Thread Model

#Minimal Application

import {
  "Nanaloveyuki/orby",
}

struct Example {
  mut window : @orby.Window?
}

pub impl @orby.App for Example with fn started(self, app) {
  self.window = Some(
    try! app.create_window(
      @orby.WindowOptions::new(
        title="Orby example",
        size=@orby.Size::new(width=960, height=640),
      ),
    ),
  )
}

pub impl @orby.App for Example with fn window_event(self, _app, _id, event) {
  match event {
    @orby.WindowEvent::CloseRequested =>
      match self.window {
        Some(window) => window.destroy()
        None => ()
      }
    _ => ()
  }
}

fn main raise {
  let loop = @orby.EventLoop::new()
  ignore(loop.run_app({ window: None }))
}

#Lifecycle and Failures

1. started runs after native callback installation and can create windows.
2. window_event receives per-window activity; about_to_wait runs after a native event batch.
3. proxy_message receives worker-submitted byte messages on the UI thread.
4. exiting runs exactly once after native loop cleanup.

pub impl @orby.App for Example with fn about_to_wait(self, app) {
  if startup_work_failed() {
    app.fail("initial runtime setup failed")
  }
}

fn run_example() raise {
  let loop = @orby.EventLoop::new()
  let app = { window: None }
  try ignore(loop.run_app(app)) catch {
    @orby.AppError::StartupFailed(reason) => println("startup: \{reason}")
    @orby.AppError::RuntimeFailed(reason) => println("runtime: \{reason}")
  }
}

#Windows, Geometry, and Displays

#Events and Input

#WebView Hosts

#Public API Map

• EventLoop initializes the host, runs App, and queries displays.
• ActiveApp creates windows, controls loop scheduling, exits, or reports a checked runtime failure.
• Window owns one native window; WebViewHost exposes its live child host.
• WindowOptions, Size, LogicalSize, Position, Monitor, and MonitorId describe creation and display state.
• WindowEvent, NativeKeyEvent, Modifiers, MouseButton, and ScrollDelta describe input and native window activity.
• InitError, GeometryError, WindowError, and AppError describe checked failures.