Struct image_canvas::layout::CanvasLayout

pub struct CanvasLayout { /* private fields */ }

The layout of a full frame, with all planes and color.

Implementations

impl CanvasLayout

pub fn with_plane(bytes: PlaneBytes) -> Self

Construct a full frame from a single plane.

pub fn with_planes(
    layers: &[PlaneBytes],
    texel: Texel
) -> Result<Self, LayoutError>

Create from a list of planes, and the texel they describe when merged.

pub fn with_row_layout(rows: &RowLayoutDescription) -> Result<Self, LayoutError>

Create a buffer layout given the layout of a simple, strided matrix.

pub fn with_texel(
    texel: &Texel,
    width: u32,
    height: u32
) -> Result<Self, LayoutError>

Create a buffer layout from a texel and dimensions.

This is a simplification of with_row_layout which itself is a simplified new.

pub fn texel(&self) -> &Texel

Get the texel represented by the canvas as a whole.

For non-planar images this is exactly the same as the texel of the first place. Otherwise, it is a merged representation.

pub fn color(&self) -> Option<&Color>

Get the color space used by the image.

pub fn texel_index(&self, x: u32, y: u32) -> u64

Returns the index of a texel in a slice of planar image data.

pub fn as_row_layout(&self) -> RowLayoutDescription

Returns a matrix descriptor that can store all bytes.

Note: for the moment, all layouts are row-wise matrices. This will be relaxed in the future to also permit the construction from planar image layouts. In this case, the method will return a descriptor that does not equal this layout. Instead, an image buffer shaped like the returned descriptor can be used to re-arrange all bytes into a simple matrix form.

pub fn width(&self) -> u32

Returns the width of the underlying image in pixels.

pub fn height(&self) -> u32

Returns the height of the underlying image in pixels.

pub fn u64_len(&self) -> u64

Returns the memory usage as a u64.

pub fn byte_len(&self) -> usize

Returns the memory usage as a usize.

pub fn set_color(&mut self, color: Color) -> Result<(), LayoutError>

Set the color of the layout, if compatible with the texel.

pub fn as_plane(&self) -> Option<PlaneBytes>

Trait Implementations

impl Clone for CanvasLayout

fn clone(&self) -> CanvasLayout

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CanvasLayout

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

Formats the value using the given formatter.

impl Decay<PlaneBytes> for CanvasLayout

fn decay(from: PlaneBytes) -> Self

impl From<&PlaneBytes> for CanvasLayout

fn from(plane: &PlaneBytes) -> Self

Converts to this type from the input type.

impl Layout for CanvasLayout

fn byte_len(&self) -> usize

impl PartialEq<CanvasLayout> for CanvasLayout

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

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

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

This method tests for !=.

impl StructuralPartialEq for CanvasLayout