Struct sensehat_screen::frame::PixelFrame

pub struct PixelFrame(_);

A frame of pixels. This is the basic representation for the LED Matrix display.

Methods

impl PixelFrame

Methods enabled by the clip feature.

pub fn clip(&self, other: &PixelFrame, clip_at: Offset) -> Self

Shortcut to get a PixelFrame from a temporary Clip, at a given Offset. For memory reallocation, such as when rendering a clip at multiple offsets, it is better to use PixelFrame::build_clip.

pub fn build_clip(&self, other: &PixelFrame) -> Clip

Create a Clip with this and another PixelFrame.

impl PixelFrame

Methods enabled by the offset feature.

pub fn offset(&self, offset: Offset) -> Self

Offset the PixelFrame by a number of pixels in any of the possible directions:

Example

    let frame: PixelFrame = Default::default();
    let moved_1px_to_the_left = frame.offset(Offset::left(1));

Panics

If offset is out of bounds (> 8).

impl PixelFrame

Methods enabled by the rotate feature.

pub fn rotate(&self, rotate: Rotate) -> Self

Create a new PixelFrame that is rotated by a multiple of 90°, counter-clockwise.

impl PixelFrame

pub const BLACK: PixelFrame

pub const RED: PixelFrame

pub const BLUE: PixelFrame

pub const GREEN: PixelFrame

pub const WHITE: PixelFrame

pub const YELLOW: PixelFrame

pub const CYAN: PixelFrame

pub const MAGENTA: PixelFrame

impl PixelFrame

pub fn new(pixels: &[PixelColor; 64]) -> Self

Create a FrameLine representing the current PixelFrame.

pub fn frame_line(&self) -> FrameLine

Create a FrameLine representing the current PixelFrame.

pub fn transpose(&mut self)

Transpose the LED Matrix. Rows become columns.

pub fn flip_h(&mut self)

Flip the LED Matrix horizontally.

pub fn flip_v(&mut self)

Flip the LED Matrix vertically.

pub fn reverse(&mut self)

Reverse the LED Matrix.

pub fn as_rows(&self) -> [[PixelColor; 8]; 8]

Returns a [[PixelColor; 8]; 8], organized by rows, from top to bottom.

pub fn as_columns(&self) -> [[PixelColor; 8]; 8]

Returns a [[PixelColor; 8]; 8], organized by columns, from left to right.

pub fn from_rows(rows: &[[PixelColor; 8]; 8]) -> Self

Create a new PixelFrame from a [[PixelColor; 8]; 8], of 8 rows with 8 PixelColors.

pub fn from_columns(columns: &[[PixelColor; 8]; 8]) -> Self

Create a new PixelFrame from a [[PixelColor; 8]; 8], of 8 columns with 8 PixelColors.

Trait Implementations

impl Into<[PixelColor; 64]> for PixelFrame

fn into(self) -> [PixelColor; 64]

Performs the conversion.

impl PartialEq<PixelFrame> for PixelFrame

fn eq(&self, other: &PixelFrame) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Copy for PixelFrame

impl Clone for PixelFrame

fn clone(&self) -> PixelFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> From<&'a [PixelColor; 64]> for PixelFrame

fn from(array: &'a [PixelColor; 64]) -> Self

Performs the conversion.

impl From<[PixelColor; 64]> for PixelFrame

fn from(array: [PixelColor; 64]) -> Self

Performs the conversion.

impl From<FontFrame> for PixelFrame

fn from(font: FontFrame) -> Self

Performs the conversion.

impl Default for PixelFrame

fn default() -> Self

Returns the "default value" for a type.

impl Debug for PixelFrame

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

Formats the value using the given formatter.

impl Index<usize> for PixelFrame

type Output = PixelColor

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for PixelFrame

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.