Struct gemini_engine::elements::containers::PixelContainer

pub struct PixelContainer {
    pub pixels: Vec<Pixel>,
}

A PixelContainer only has a pixels property, which gets returned directly to the View during blit

Fields

pixels: Vec<Pixel>

This is the value that gets returned by active_pixels()

Implementations

impl PixelContainer

pub const fn new() -> Self

Create a new, empty PixelContainer

pub fn push(&mut self, pixel: Pixel)

Add a single pixel to the PixelContainer

pub fn append(&mut self, pixels: &mut Vec<Pixel>)

Moves all the pixels into the PixelContainer, leaving the input empty.

pub fn append_points(&mut self, points: &[Vec2D], fill_char: ColChar)

Append vector of coordinates and a single ColChar for all of them.

pub fn plot(&mut self, pos: Vec2D, c: ColChar)

Plot a pixel to the PixelContainer

pub fn blit<E: ViewElement>(&mut self, element: &E)

Blit a ViewElement to the PixelContainer.

pub fn shade_with(&self, shader: &mut Box<dyn CanShade>) -> Self

Applies the shader to the PixelContainer’s active pixels. A “shader” in this case is any object which implements CanShade

Trait Implementations

impl Clone for PixelContainer

fn clone(&self) -> PixelContainer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PixelContainer

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

Formats the value using the given formatter.

impl From<&[(Vec2D, ColChar)]> for PixelContainer

fn from(pixels: &[(Vec2D, ColChar)]) -> Self

Converts to this type from the input type.

impl From<&[Pixel]> for PixelContainer

fn from(pixels: &[Pixel]) -> Self

Converts to this type from the input type.

impl From<(&[Vec2D], ColChar)> for PixelContainer

fn from(value: (&[Vec2D], ColChar)) -> Self

Converts to this type from the input type.

impl ViewElement for PixelContainer

fn active_pixels(&self) -> Vec<Pixel>

Return a vector of the element’s Pixels - A ColChar. If your whole object is a solid colour, consider using utils::points_to_pixels() which will add the same ColChar to every point and can then be used as this function’s output

fn active_points(&self) -> Vec<Vec2D>

Return the positions the ViewElement occupies, essentially active_pixels() without the ColChars. This has a default setting that extracts the Vec2Ds from active_pixels but you can set it to something else to make it faster