termal_core 5.0.0

This library contains implementation for the termal library
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

mod sixel_state;

use sixel_state::SixelState;

use super::Image;

#[derive(Default)]
struct Sixel([u8; 6]);

impl Sixel {
    fn from_img(img: &impl Image, (x, y): (usize, usize)) -> Self {
        let mut data = [Default::default(); 6];

        for yo in y..img.height().min(y + 6) {
            data[yo - y] = img.get_pixel(x, yo).to_332();
        }

        Self(data)
    }

    fn color_char(&self, rgb: u8) -> char {
        let mut code: u8 = 0;
        for (i, c) in self.0.iter().copied().enumerate() {
            if c == rgb {
                code |= 1 << i;
            }
        }

        (code + 63) as char
    }
}

/// Generate sixel image and append it to the string `out`.
///
/// Sixels are quite complicated and inefficient. This is why many modern
/// terminals choose to not support sixels and use different protocols for
/// showing images.
///
/// If you don't need the resolution, you can try using texels (e.g.
/// [`crate::image::push_texel_quater`]) which are supported on all terminals
/// that support RGB colors.
///
/// # Example
/// ```no_run
/// use termal_core::{codes, image::{RawImg, push_sixel}};
///
/// let mut buf = codes::CLEAR.to_string();
///
/// let img_data = include_bytes!("../../../../examples/img2_256.data");
/// let img = RawImg::from_rgb(img_data.into(), 256, 256);
///
/// push_sixel(&mut buf, &img);
///
/// println!("{buf}");
/// ```
///
/// ## Result in terminal
/// ![](https://raw.githubusercontent.com/BonnyAD9/termal/refs/heads/master/assets/image/push_sixel.png)
pub fn push_sixel(out: &mut String, img: &impl Image) {
    let mut state = SixelState::new(img, out);
    state.encode();
}