Struct broot::kitty::KittyImageRenderer

pub struct KittyImageRenderer { /* private fields */ }

The image renderer, with knowledge of the console cells dimensions, and built only on a compatible terminal

Implementations

impl KittyImageRenderer

pub fn new() -> Option<Self>

Called only once (at most) by the KittyManager

Examples found in repository

src/kitty/mod.rs (line 75)

    pub fn renderer(&mut self) -> Option<&mut KittyImageRenderer> {
        if matches!(self.renderer, MaybeRenderer::Disabled) {
            return None;
        }
        if matches!(self.renderer, MaybeRenderer::Enabled { .. }) {
            return self.renderer_if_tested();
        }
        // we're in the Untested branch
        match KittyImageRenderer::new() {
            Some(renderer) => {
                self.renderer = MaybeRenderer::Enabled { renderer };
                self.renderer_if_tested()
            }
            None => {
                self.renderer = MaybeRenderer::Disabled;
                None
            }
        }
    }

pub fn print(
    &mut self,
    w: &mut W,
    src: &DynamicImage,
    area: &Area,
    bg: Color
) -> Result<usize, ProgramError>

Clean the area, then print the dynamicImage and return the KittyImageId for later removal from screen

Examples found in repository

src/kitty/mod.rs (line 106)

    pub fn try_print_image(
        &mut self,
        w: &mut W,
        src: &DynamicImage,
        area: &Area,
        bg: Color,
        drawing_count: usize,
    ) -> Result<Option<KittyImageId>, ProgramError> {
        if let Some(renderer) = self.renderer() {
            let new_id = renderer.print(w, src, area, bg)?;
            self.rendered_images.push(RenderedImage {
                image_id: new_id,
                drawing_count,
            });
            Ok(Some(new_id))
        } else {
            Ok(None)
        }
    }

Trait Implementations

impl Debug for KittyImageRenderer

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

Formats the value using the given formatter.