Struct canvas::Layout

pub struct Layout<P> { /* fields omitted */ }

Describes the memory region used for the image.

The underlying buffer may have more data allocated than this region and cause the overhead to be reused when resizing the image. All ways to construct this already check that all pixels within the resulting image can be addressed via an index.

Methods

impl<P> Layout<P>

pub fn width_and_height_for_pixel(
    pixel: Pixel<P>,
    width: usize,
    height: usize
) -> Option<Self>

pub fn width_and_height(width: usize, height: usize) -> Option<Self> where
    P: AsPixel, 

pub fn byte_len(self) -> usize

Get the required bytes for this layout.

pub fn len(self) -> usize

The number of pixels in this layout

pub fn width(self) -> usize

pub fn height(self) -> usize

pub fn pixel(self) -> Pixel<P>

pub fn transmute<Q: AsPixel>(self) -> Layout<Q>

Reinterpret to another, same size pixel type.

See transmute_to for details.

pub fn transmute_to<Q>(self, pixel: Pixel<Q>) -> Layout<Q>

Reinterpret to another, same size pixel type.

Panics

Like std::mem::transmute, the size of the two types need to be equal. This ensures that all indices are valid in both directions.

pub fn map<Q: AsPixel>(self) -> Option<Layout<Q>>

Utility method to change the pixel type without changing the dimensions.

pub fn map_to<Q>(self, pixel: Pixel<Q>) -> Option<Layout<Q>>

Utility method to change the pixel type without changing the dimensions.

Trait Implementations

impl<P> Clone for Layout<P>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P> Copy for Layout<P>

impl<P> Debug for Layout<P>

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

Formats the value using the given formatter.

impl<P: AsPixel> Default for Layout<P>

fn default() -> Self

Returns the "default value" for a type.

impl<P> Eq for Layout<P>

impl<P> PartialEq<Layout<P>> for Layout<P>

fn eq(&self, other: &Self) -> 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<P> PartialOrd<Layout<P>> for Layout<P>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.