felis-render-core 0.1.0

felis renderer-neutral core: palette, cell appearance, box drawing, glyph index, shelf atlas, cell painter and its display list
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

#![doc = include_str!("../README.md")]

use felis_protocol::{ImageId, messages::ImageFormat};

pub mod appearance;
pub mod atlas;
#[cfg(feature = "glyphs")]
pub mod box_drawing;
pub mod display_list;
#[cfg(feature = "glyphs")]
pub mod glyphs;
pub mod overlay;
#[cfg(feature = "glyphs")]
pub mod painter;
pub mod palette;

/// `start` / `end` are normalized by the client: row-major min/max for
/// a linear selection, axis-aligned bounding box for a rectangle.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct SelectionRange {
    pub start: (u16, u16),
    pub end: (u16, u16),
    pub rectangle: bool,
}

/// `pixels.len()` equals `width * height * bytes_per_pixel(format)`;
/// the daemon dispatcher enforces it.
#[derive(Debug, Clone, Copy)]
pub struct ImageData<'a> {
    pub width: u32,
    pub height: u32,
    pub format: ImageFormat,
    pub pixels: &'a [u8],
}

/// Supplies image pixels for GPU atlas re-uploads when the atlas recycles itself.
///
/// Images are held in `felis_client_core::ImageShadow`. Returns `None` if pixels have not
/// fully arrived or were deleted, in which case placements paint nothing.
pub trait ImageSource {
    fn image_data(&self, id: ImageId) -> Option<ImageData<'_>>;
}