Struct ScreenBuffer 

pub struct ScreenBuffer {
    pub width: usize,
    pub height: usize,
    /* private fields */
}

Fields

width: usize

height: usize

Implementations

impl ScreenBuffer

pub fn new(width: usize, height: usize, style: Option<Style>) -> Self

pub fn get(&self, x: usize, y: usize) -> &Cell

pub fn get_mut(&mut self, x: usize, y: usize) -> &mut Cell

pub fn as_plain_lines(&self) -> Vec<String>

pub fn from_renderable( console: &Console, options: &ConsoleOptions, renderable: &dyn Renderable, style: Option<Style>, ) -> Self

Render a renderable to a ScreenBuffer.

This uses Console::render_lines and then converts the rendered lines to cells.

pub fn from_lines( lines: &[Vec<Segment>], width: usize, height: usize, default_style: Option<Style>, ) -> Self

Build a ScreenBuffer from pre-rendered lines.

The caller is expected to provide lines already padded/cropped to width × height.

pub fn blit_lines( &mut self, x: usize, y: usize, width: usize, lines: &[Vec<Segment>], )

Blit pre-rendered lines into the buffer at an offset.

Lines should be padded/cropped to the region width. This method will clip to the screen bounds.

pub fn to_styled_lines(&self) -> Vec<Vec<Segment>>

Convert the buffer to styled lines (no newlines).

pub fn diff_to_segments(&self, previous: &ScreenBuffer) -> Segments

Compute an update sequence that transforms previous into self.

The returned segments:

• Start with Home (cursor to 0,0)
• Use cursor controls (no \n) for positioning
• Emit styled text for changed spans

pub fn diff_to_segments_from_origin(&self, previous: &ScreenBuffer) -> Segments

Compute an update sequence relative to the current cursor origin.

Unlike diff_to_segments, this does not emit Home and is intended for embedding in larger cursor-positioned render flows (e.g. Live updates).

Trait Implementations

impl Clone for ScreenBuffer

fn clone(&self) -> ScreenBuffer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ScreenBuffer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ScreenBuffer

fn eq(&self, other: &ScreenBuffer) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ScreenBuffer

impl StructuralPartialEq for ScreenBuffer