Struct tui_image::Image

pub struct Image<'a> { /* fields omitted */ }

A tui-rs Widget which displays an image.

Methods

impl<'a> Image<'a>

pub fn with_img(img: RgbaImage) -> Image<'a>

Construct an Image widget with a single image.

pub fn with_img_fn(
    img_fn: impl Fn(usize, usize) -> Result<RgbaImage, Error> + 'static
) -> Image<'a>

Construct an Image widget with a function which can be called to obtain an image of the correct size.

pub fn block(self, block: Block<'a>) -> Image<'a>

Set the widget to use the provided block.

pub fn color_mode(self, color_mode: ColorMode) -> Image<'a>

Set the color mode used to render the image.

pub fn style(self, style: Style) -> Image<'a>

Set the widget style.

pub fn alignment(self, alignment: Alignment) -> Image<'a>

Set the widget alignment.

Trait Implementations

impl<'a> Widget for Image<'a>

fn draw(&mut self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That the only method required to implement a custom widget.

fn background(&self, area: Rect, buf: &mut Buffer, color: Color)

Helper method to quickly set the background of all cells inside the specified area.

fn render<B>(&mut self, f: &mut Frame<B>, area: Rect) where
    B: Backend, 

Helper method that can be chained with a widget's builder methods to render it.