Struct Frame 

pub struct Frame {
    pub width: u32,
    pub height: u32,
    /* private fields */
}

An RGB8 image.

Fields

width: u32

height: u32

Implementations

impl Frame

pub fn black(width: u32, height: u32) -> Self

pub fn from_rgb( width: u32, height: u32, data: Vec<u8>, ) -> Result<Self, FrameError>

Wrap existing RGB8 bytes.

Errors

Fails if data is not exactly width * height * 3 bytes.

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

The raw RGB8 bytes, row major.

pub fn as_bytes_mut(&mut self) -> &mut [u8]

The raw RGB8 bytes, row major, for in-place fills.

pub fn into_bytes(self) -> Vec<u8>

pub fn row(&self, y: u32) -> &[[u8; 3]]

One row of pixels. Panics if y is off the frame.

pub fn row_mut(&mut self, y: u32) -> &mut [[u8; 3]]

One row of pixels, writable. Panics if y is off the frame.

pub fn rows(&self) -> impl Iterator<Item = &[[u8; 3]]> + '_

Every row, top to bottom.

pub fn pixel(&self, x: u32, y: u32) -> [u8; 3]

The pixel at (x, y); black when off the frame.

pub fn set_pixel(&mut self, x: u32, y: u32, px: [u8; 3])

Set the pixel at (x, y); a no-op when off the frame.

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Eq for Frame

impl PartialEq for Frame

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Frame