Struct kernel::services::emb_display::MonoChunk

pub struct MonoChunk {
    meta: FrameChunkMetadata,
    data: Buf8,
    mask: Buf8,
}

Fields

meta: FrameChunkMetadata

data: Buf8

mask: Buf8

Implementations

impl MonoChunk

pub fn clear(&mut self)

Mark all transparency data as fully transparent

pub async fn allocate_mono(size: FrameLocSize) -> Self

Allocate a monochrome framebuffer with the given metadata

pub fn invert_masked(&mut self)

Invert all pixels that are NOT currently transparent

This can be used to “unblit” an image

pub fn meta(&self) -> &FrameChunkMetadata

Get the metadata of this FrameChunk

pub fn meta_mut(&mut self) -> &mut FrameChunkMetadata

Get the metadatae of this FrameChunk as a mutable reference

pub fn data(&self) -> &[u8]

Get the raw pixel data

This is currently one byte per pixel, with 0x00 representing “OFF” and 0xFF representing “ON”. All other values are invalid.

pub fn mask(&self) -> &[u8]

Get the raw mask data

This is currently one byte per pixel, with 0x00 representing “Transparent” and 0xFF representing “Solid”. All other values are invalid.

pub fn draw_pixel(&mut self, x: u32, y: u32, state: bool)

Draw the given pixel, and mark the pixel as not transparent

If you want to instead mark the pixel as transparent, see MonoChunk::clear_pixel().

pub fn pix_idx(&self, x: u32, y: u32) -> Option<usize>

Get the data/mask array index of the given X/Y coordinates

This does NOT account for offset, this is only in the coordinate system of the MonoChunk, not the total display.

Returns None if the given x/y coordinates are outside of the MonoChunk

pub fn clear_pixel(&mut self, x: u32, y: u32)

Clear the given pixel by marking it as transparent

NOTE: This is not used for setting the pixel as “off”, instead use MonoChunk::draw_pixel().

Trait Implementations

impl DrawTarget for MonoChunk

FrameChunk implements embedded-graphics’s DrawTarget trait so that clients can directly use embedded-graphics primitives for drawing into the framebuffer.

type Color = BinaryColor

The pixel color type the targetted display supports.

type Error = Infallible

Error type to return when a drawing operation fails.

fn draw_iter<I>(&mut self, pixels: I) -> Result<(), Self::Error>

where I: IntoIterator<Item = Pixel<Self::Color>>,

Draw individual pixels to the display without a defined order.

fn fill_contiguous<I>( &mut self, area: &Rectangle, colors: I, ) -> Result<(), Self::Error>

where I: IntoIterator<Item = Self::Color>,

Fill a given area with an iterator providing a contiguous stream of pixel colors.

fn fill_solid( &mut self, area: &Rectangle, color: Self::Color, ) -> Result<(), Self::Error>

Fill a given area with a solid color.

fn clear(&mut self, color: Self::Color) -> Result<(), Self::Error>

Fill the entire display with a solid color.

impl From<MonoChunk> for FrameChunk

fn from(value: MonoChunk) -> Self

Converts to this type from the input type.

impl OriginDimensions for MonoChunk

fn size(&self) -> Size

Returns the size of the bounding box.