Struct ScreenBuffer 

pub struct ScreenBuffer { /* private fields */ }

A buffer representing the entire terminal screen as a 2D grid of cells.

This buffer maintains a complete snapshot of what should be displayed on the terminal, allowing for efficient diffing between frames.

Implementations

impl ScreenBuffer

pub fn new(width: u16, height: u16) -> Self

Creates a new screen buffer with the given dimensions.

All cells are initialized as empty (spaces with no styling).

pub fn get_cell(&self, x: u16, y: u16) -> Option<&Cell>

Gets a reference to the cell at the given position.

Returns None if the position is out of bounds.

pub fn get_cell_mut(&mut self, x: u16, y: u16) -> Option<&mut Cell>

Gets a mutable reference to the cell at the given position.

Returns None if the position is out of bounds.

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

Sets the cell at the given position.

Does nothing if the position is out of bounds.

pub fn clear(&mut self)

Clears the buffer by setting all cells to empty.

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

Resizes the buffer to new dimensions.

If the new size is larger, new cells are filled with empty cells. If the new size is smaller, cells are truncated.

pub fn dimensions(&self) -> (u16, u16)

Gets the dimensions of the buffer.

pub fn fill_rect(&mut self, x: u16, y: u16, width: u16, height: u16, cell: Cell)

Fills a rectangular region with the given cell.

pub fn write_str( &mut self, x: u16, y: u16, text: &str, fg: Option<Color>, bg: Option<Color>, )

Writes a string starting at the given position.

The string is written horizontally. If it extends beyond the buffer width, it is truncated. Properly handles wide characters (CJK, emoji) that take 2 columns.

pub fn write_styled_str( &mut self, x: u16, y: u16, text: &str, text_style: Option<&TextStyle>, )

Writes a string with full text styling starting at the given position.

The string is written horizontally. If it extends beyond the buffer width, it is truncated. Properly handles wide characters (CJK, emoji) that take 2 columns.