Struct RawFormat 

#[non_exhaustive]
pub struct RawFormat {
    pub descriptor: ImageDescriptor,
    pub stride: usize,
}

The layout of a raw pixel stream.

Raw carries no self-description, so this is the contract the caller must supply on both the decode and encode side.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

descriptor: ImageDescriptor

Dimensions and pixel format of the stream.

stride: usize

Bytes between the starts of consecutive rows in the stream.

At least descriptor.row_bytes(). Any excess is row padding, which the decoder reads and discards and the encoder writes as zeroes — this is how raw dumps from graphics APIs with aligned rows are consumed.

Implementations

impl RawFormat

pub const fn packed(descriptor: ImageDescriptor) -> RawFormat

A densely packed layout: stride equals one row of pixels.

pub fn with_stride( descriptor: ImageDescriptor, stride: usize, ) -> Result<RawFormat, PixelsError>

A layout with explicit row padding.

Errors

Returns PixelsError::InvalidArgument if stride is shorter than one packed row.

pub fn from_dimensions( width: u32, height: u32, pixel: PixelFormat, limits: &Limits, ) -> Result<RawFormat, PixelsError>

Describe a raw stream from its dimensions, checked against limits.

This is the raw equivalent of a header parse: dimensions are validated before any pixel buffer is allocated (SPEC §Safety), so a caller forwarding untrusted dimensions cannot provoke a huge allocation.

Errors

Returns PixelsError::LimitExceeded if the dimensions exceed limits, or PixelsError::InvalidArgument if either is zero.

pub const fn padding(&self) -> usize

Bytes of padding after each row.

Trait Implementations

impl Clone for RawFormat

fn clone(&self) -> RawFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RawFormat

impl Debug for RawFormat

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

Formats the value using the given formatter.

impl Eq for RawFormat

impl PartialEq for RawFormat

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RawFormat