Skip to main content

RenderBatch

Struct RenderBatch 

Source
pub struct RenderBatch { /* private fields */ }
Expand description

Batched render operations

Implementations§

Source§

impl RenderBatch

Source

pub fn new() -> Self

Create a new render batch

Source

pub fn with_capacity(capacity: usize) -> Self

Create a batch with pre-allocated capacity

Source

pub fn set_optimize(&mut self, optimize: bool)

Enable/disable operation optimization

Source

pub fn len(&self) -> usize

Get number of queued operations

Source

pub fn is_empty(&self) -> bool

Check if batch is empty

Source

pub fn clear(&mut self)

Clear all queued operations

Source

pub fn push(&mut self, op: RenderOp)

Add an operation to the batch

Source

pub fn set_cell( &mut self, x: u16, y: u16, ch: char, fg: Option<Color>, bg: Option<Color>, )

Set a single cell

Source

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

Set a cell with full styling

Source

pub fn fill_rect( &mut self, rect: Rect, ch: char, fg: Option<Color>, bg: Option<Color>, )

Fill a rectangular region

Source

pub fn hline(&mut self, x: u16, y: u16, len: u16, ch: char, fg: Option<Color>)

Draw a horizontal line

Source

pub fn vline(&mut self, x: u16, y: u16, len: u16, ch: char, fg: Option<Color>)

Draw a vertical line

Source

pub fn text( &mut self, x: u16, y: u16, text: impl Into<String>, fg: Option<Color>, bg: Option<Color>, )

Draw text

Source

pub fn styled_text( &mut self, x: u16, y: u16, text: impl Into<String>, fg: Option<Color>, bg: Option<Color>, modifier: Modifier, )

Draw styled text

Source

pub fn clear_screen(&mut self)

Clear screen

Source

pub fn move_cursor(&mut self, x: u16, y: u16)

Move cursor

Source

pub fn show_cursor(&mut self, show: bool)

Show/hide cursor

Source

pub fn dirty_regions(&self) -> &[Rect]

Get dirty regions

Source

pub fn optimize(&mut self)

Optimize the batch by merging/reordering operations

Source

pub fn apply_to_buffer(&self, buffer: &mut Buffer)

Apply batch to a buffer

Source

pub fn iter(&self) -> impl Iterator<Item = &RenderOp>

Get iterator over operations

Source

pub fn take(&mut self) -> Vec<RenderOp>

Take all operations, leaving the batch empty

Trait Implementations§

Source§

impl Debug for RenderBatch

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RenderBatch

Source§

fn default() -> RenderBatch

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.