Struct FrameBuffer 

pub struct FrameBuffer { /* private fields */ }

A mutable RGBA pixel canvas.

Implementations

impl FrameBuffer

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

A width × height buffer, initially fully transparent.

pub fn width(&self) -> u32

Buffer width in pixels.

pub fn height(&self) -> u32

Buffer height in pixels.

pub fn as_rgba(&self) -> &[u8]

The raw RGBA bytes (row-major), for the graphics protocols.

pub fn pixel(&self, x: u32, y: u32) -> Rgba

The pixel at (x, y), or TRANSPARENT if out of bounds.

pub fn set(&mut self, x: u32, y: u32, color: Rgba)

Overwrite the pixel at (x, y) (no blending); out-of-bounds is ignored.

pub fn blend(&mut self, x: u32, y: u32, color: Rgba)

Alpha-composite color over the pixel at (x, y).

pub fn clear(&mut self, color: Rgba)

Set every pixel to color (overwrite).

pub fn fill_rect(&mut self, x: u32, y: u32, w: u32, h: u32, color: Rgba)

Alpha-composite color over a rectangle (clipped to the buffer).

pub fn blit(&mut self, src: &FrameBuffer, dx: i32, dy: i32)

Alpha-composite the whole of src onto this buffer at (dx, dy).

pub fn blit_region( &mut self, src: &FrameBuffer, sx: u32, sy: u32, sw: u32, sh: u32, dx: i32, dy: i32, )

Alpha-composite a sw × sh region of src (from (sx, sy)) onto this buffer at (dx, dy). Everything is clipped to both buffers.

pub fn shade(&mut self, f: impl Fn(u32, u32, Rgba) -> Rgba)

Apply a per-pixel shader post-pass: f(x, y, current) returns the new pixel. This is the terminal analog of a fragment shader — invert, tint, fade, scanlines, etc.

pub fn to_image_data(&self) -> Option<ImageData>

Snapshot as ImageData for the Kitty/iTerm2/Sixel graphics path, or None for a zero-sized buffer.

Trait Implementations

impl Clone for FrameBuffer

fn clone(&self) -> FrameBuffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FrameBuffer

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

Formats the value using the given formatter.