ratatu-image 1.0.0

Renamed to ratatui-image
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

//! Backends for the widgets

use dyn_clone::DynClone;
use image::Rgb;
use ratatui::{buffer::Buffer, layout::Rect};

use crate::ImageSource;

use super::Resize;

pub mod halfblocks;
pub mod kitty;
#[cfg(feature = "sixel")]
pub mod sixel;

/// A fixed image backend for the [crate::FixedImage] widget.
pub trait FixedBackend: Send + Sync {
    fn rect(&self) -> Rect;
    fn render(&self, area: Rect, buf: &mut Buffer);
}

/// A resizing image backend for the [crate::ResizeImage] widget.
pub trait ResizeBackend: Send + Sync + DynClone {
    fn rect(&self) -> Rect;
    fn render(
        &mut self,
        source: &ImageSource,
        resize: &Resize,
        background_color: Option<Rgb<u8>>,
        area: Rect,
        buf: &mut Buffer,
    );
    /// This method is optional.
    fn reset(&mut self) {}
}

dyn_clone::clone_trait_object!(ResizeBackend);