Struct ImageDescriptor 

#[non_exhaustive]
pub struct ImageDescriptor {
    pub width: u32,
    pub height: u32,
    pub pixel: PixelFormat,
    pub color: ColorModel,
}

The shape of an image at a point in the graph.

Descriptors flow forward at graph-build time: every node computes its output descriptor from its inputs’ descriptors when it is constructed. That is what makes metadata() free — no pixels are touched to answer it (ARCHITECTURE §Layer 3).

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.

width: u32

Width in pixels; always non-zero.

height: u32

Height in pixels; always non-zero.

pixel: PixelFormat

Interleaved pixel format of the samples.

color: ColorModel

Color model the samples are interpreted in (sRGB-assumed in v1).

Implementations

impl ImageDescriptor

pub fn new( width: u32, height: u32, pixel: PixelFormat, ) -> Result<ImageDescriptor, PixelsError>

Construct a descriptor, validating it against the default Limits.

Errors

See Limits::check.

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

Construct a descriptor, validating it against explicit limits.

Errors

See Limits::check.

pub const fn region(&self) -> Region

The region covering the whole image.

pub const fn row_bytes(&self) -> usize

Bytes in one densely packed row of this image.

pub fn byte_len(&self) -> Option<usize>

Bytes in the whole image when densely packed.

Returns None on overflow, which on a 32-bit target is reachable for large-but-legal dimensions. Callers sizing an allocation must treat None as “too large for this platform” rather than unwrapping.

pub fn resized( &self, width: u32, height: u32, ) -> Result<ImageDescriptor, PixelsError>

The same descriptor with different dimensions, revalidated.

Errors

See Limits::check.

Trait Implementations

impl Clone for ImageDescriptor

fn clone(&self) -> ImageDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ImageDescriptor

impl Debug for ImageDescriptor

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

Formats the value using the given formatter.

impl Display for ImageDescriptor

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

Formats the value using the given formatter.

impl Eq for ImageDescriptor

impl Hash for ImageDescriptor

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ImageDescriptor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ImageDescriptor