Struct Engine 

pub struct Engine { /* private fields */ }

The main Flywheel engine.

This coordinates between the input and render actors, providing a simple interface for applications.

Implementations

impl Engine

pub fn new() -> Result<Self>

Create a new engine with default configuration.

Errors

Returns an error if terminal setup fails (raw mode, alternate screen, etc.).

pub fn with_config(config: EngineConfig) -> Result<Self>

Create a new engine with custom configuration.

Errors

Returns an error if terminal setup fails.

pub const fn width(&self) -> u16

Get the terminal width.

pub const fn height(&self) -> u16

Get the terminal height.

pub const fn buffer(&self) -> &Buffer

Get a reference to the buffer.

pub const fn buffer_mut(&mut self) -> &mut Buffer

Get a mutable reference to the buffer.

pub const fn input_receiver(&self) -> &Receiver<InputEvent>

Get the input receiver for event-driven loops.

pub const fn is_running(&self) -> bool

Check if the engine is still running.

pub const fn stop(&mut self)

Stop the engine.

pub fn poll_input(&self) -> Option<InputEvent>

Poll for the next input event (non-blocking).

Returns None if no event is available.

pub fn wait_input(&self, timeout: Duration) -> Option<InputEvent>

Wait for the next input event (blocking with timeout).

pub fn drain_input(&self) -> Vec<InputEvent>

Drain all pending input events.

pub fn request_redraw(&self)

Request a full redraw.

pub fn request_update(&self)

Request a diff-based update.

pub fn set_cursor(&self, x: Option<u16>, y: u16)

Set the cursor position (or hide it).

pub fn write_raw(&self, bytes: Vec<u8>)

Write raw bytes to the output (Fast Path).

pub fn handle_resize(&mut self, width: u16, height: u16)

Handle a resize event.

pub fn begin_frame(&mut self)

Begin a new frame.

Call this at the start of your render loop.

pub fn end_frame(&mut self)

End a frame and request update.

This will sleep if necessary to maintain the target FPS.

pub const fn frame_count(&self) -> u64

Get the current frame count.

pub fn set_cell(&mut self, x: u16, y: u16, cell: Cell)

Convenience: Set a cell in the buffer.

pub fn set_grapheme( &mut self, x: u16, y: u16, grapheme: &str, fg: Rgb, bg: Rgb, ) -> u8

Convenience: Set a grapheme in the buffer.

pub fn clear(&mut self)

Convenience: Clear the buffer.

pub fn fill_rect(&mut self, rect: Rect, cell: Cell)

Convenience: Fill a rectangle.

pub fn draw_text(&mut self, x: u16, y: u16, text: &str, fg: Rgb, bg: Rgb) -> u16

Draw text at a position.

Returns the number of columns used.

Trait Implementations

impl Drop for Engine

fn drop(&mut self)

Executes the destructor for this type.