Struct image_texel::layout::StridedBytes

pub struct StridedBytes { /* private fields */ }

A validated layout of a rectangular matrix of pixels, treated as bytes.

The invariants are that the whole layout fits into memory, additionally ensuring that all indices within have proper indices into the byte slice containing the data.

The related containers StridedBufferRef and StridedBufferMut can be utilized to setup efficient initialization of data from different stride sources. Since they require only the alignment according to their elements, not according to the maximum alignment, they may be used for external data that is copied to an image.

Implementations

impl StridedBytes

pub fn new(spec: StrideSpec) -> Result<Self, BadStrideError>

Try to create a new layout from a specification.

This fails if the specification does not describe a valid layout. The reasons for this include the element being misaligned according to the provided offsets/strides or the layout not describing a memory size expressible on the current architecture.

pub fn with_repeated_width_and_height(
    element: TexelLayout,
    width: usize,
    height: usize
) -> Self

Construct a layout with zeroed strides, repeating one element.

pub fn with_column_major(matrix: MatrixBytes) -> Self

Construct from a packed matrix of elements in column major layout.

This is guaranteed to succeed and will construct the strides such that a packed column major matrix of elements at offset zero is described.

pub fn with_row_major(matrix: MatrixBytes) -> Self

Construct from a packed matrix of elements in row major layout.

This is guaranteed to succeed and will construct the strides such that a packed row major matrix of elements at offset zero is described.

pub fn spec(&self) -> StrideSpec

Get the specification of this matrix.

pub fn shrink_element(&mut self, new: TexelLayout)

Shrink the element’s size or alignment.

This is always valid since the new layout is strictly contained within the old one.

Trait Implementations

impl Clone for StridedBytes

fn clone(&self) -> StridedBytes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: StridedLayout> Decay<T> for StridedBytes

fn decay(from: T) -> Self

impl From<&'_ StridedBytes> for StrideSpec

fn from(layout: &StridedBytes) -> Self

Converts to this type from the input type.

impl Layout for StridedBytes

fn byte_len(&self) -> usize

impl PartialEq<StridedBytes> for StridedBytes

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

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

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

This method tests for !=.

impl StridedLayout for StridedBytes

fn strided(&self) -> StridedBytes

The valid strided specification of this layout.

impl<P> TryMend<StridedBytes> for Texel<P>

Try to use the matrix with a specific pixel type.

type Into = Strides<P>

type Err = MismatchedPixelError

fn try_mend(self, matrix: &StridedBytes) -> Result<Strides<P>, Self::Err>

impl Copy for StridedBytes

impl Eq for StridedBytes

impl StructuralEq for StridedBytes

impl StructuralPartialEq for StridedBytes