Struct WgpuBackend

pub struct WgpuBackend<'f, 's, P: PostProcessor = DefaultPostProcessor, S: RenderSurface<'s> = Surface<'s>> { /* private fields */ }

A ratatui backend leveraging wgpu for rendering.

Constructed using a Builder.

The first lifetime parameter is the lifetime of the data for referenced Font objects. The second lifetime parameter is the lifetime of the referenced Surface (typically the lifetime of your window object).

Limitations:

• The cursor is tracked but not rendered.
• No builtin accessibilty, although WgpuBackend::get_text is provided to access the screen’s contents.

Implementations

impl<'f, 's, P: PostProcessor, S: RenderSurface<'s>> WgpuBackend<'f, 's, P, S>

pub fn post_processor(&self) -> &P

Get the PostProcessor associated with this backend.

pub fn post_processor_mut(&mut self) -> &mut P

Get a mutable reference to the PostProcessor associated with this backend.

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

Resize the rendering surface. This should be called e.g. to keep the backend in sync with your window size.

pub fn get_text(&self) -> String

Get the text currently displayed on the screen.

pub fn update_fonts(&mut self, new_fonts: Fonts<'f>)

Update the fonts used for rendering. This will cause a full repaint of the screen the next time WgpuBackend::flush is called.

Trait Implementations

impl<'s, P: PostProcessor, S: RenderSurface<'s>> Backend for WgpuBackend<'_, 's, P, S>

fn draw<'a, I>(&mut self, content: I) -> Result<()>

where I: Iterator<Item = (u16, u16, &'a Cell)>,

Draw the given content to the terminal screen.

fn hide_cursor(&mut self) -> Result<()>

Hide the cursor on the terminal screen.

fn show_cursor(&mut self) -> Result<()>

Show the cursor on the terminal screen.

fn get_cursor_position(&mut self) -> Result<Position>

Get the current cursor position on the terminal screen.

fn set_cursor_position<Pos: Into<Position>>( &mut self, position: Pos, ) -> Result<()>

Set the cursor position on the terminal screen to the given x and y coordinates.

fn clear(&mut self) -> Result<()>

Clears the whole terminal screen

fn size(&self) -> Result<Size>

Get the size of the terminal screen in columns/rows as a Size.

fn window_size(&mut self) -> Result<WindowSize>

Get the size of the terminal screen in columns/rows and pixels as a WindowSize.

fn flush(&mut self) -> Result<()>

Flush any buffered content to the terminal screen.

fn clear_region(&mut self, clear_type: ClearType) -> Result<()>

Clears a specific region of the terminal specified by the ClearType parameter

fn append_lines(&mut self, _n: u16) -> Result<(), Error>

Insert n line breaks to the terminal screen.

fn get_cursor(&mut self) -> Result<(u16, u16), Error>

👎Deprecated: the method get_cursor_position indicates more clearly what about the cursor to get

Get the current cursor position on the terminal screen.

fn set_cursor(&mut self, x: u16, y: u16) -> Result<(), Error>

👎Deprecated: the method set_cursor_position indicates more clearly what about the cursor to set

Set the cursor position on the terminal screen to the given x and y coordinates.