Skip to main content

ImageDescriptor

Struct ImageDescriptor 

Source
pub struct ImageDescriptor<'a> {
    pub format: PixelFormat,
    pub width: u16,
    pub height: u16,
    pub data: ImageData<'a>,
    pub stride: Option<u32>,
}
Expand description

Description of an image’s dimensions, format, storage, and row stride.

Fields§

§format: PixelFormat

Pixel layout used by the image data.

§width: u16

Width in pixels.

§height: u16

Height in pixels.

§data: ImageData<'a>

Pixel bytes or safe borrowed color pixels.

§stride: Option<u32>

Bytes per row; None means tightly packed rows.

Implementations§

Source§

impl<'a> ImageDescriptor<'a>

Source

pub const fn new( format: PixelFormat, width: u16, height: u16, data: ImageData<'a>, stride: Option<u32>, ) -> Self

Create an image descriptor from explicit parts.

Source

pub const fn borrowed( format: PixelFormat, width: u16, height: u16, data: &'a [u8], ) -> Self

Create a tightly packed descriptor over borrowed encoded pixel bytes.

Source

pub fn owned( format: PixelFormat, width: u16, height: u16, data: Vec<u8>, ) -> Self

Create a tightly packed descriptor over owned encoded pixel bytes.

Source

pub const fn from_color_slice( pixels: &'a [Color], width: u16, height: u16, ) -> Self

Create a zero-copy ARGB8888 descriptor over borrowed Color pixels.

The descriptor uses ImageData::BorrowedColors instead of exposing raw bytes because Color does not define a stable memory layout. The effective representation is still ARGB8888: consumers serialize each color through Color::to_argb8888 when byte output is needed.

Source

pub const fn dimensions(&self) -> (u16, u16)

Return (width, height) in pixels.

Source

pub const fn tightly_packed_stride(&self) -> u32

Return the bytes per row for tightly packed rows.

Source

pub fn stride_bytes(&self) -> u32

Return the effective bytes per row.

Source

pub fn is_tightly_packed(&self) -> bool

Return true when rows are tightly packed with no padding bytes.

Trait Implementations§

Source§

impl<'a> Clone for ImageDescriptor<'a>

Source§

fn clone(&self) -> ImageDescriptor<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for ImageDescriptor<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Eq for ImageDescriptor<'a>

Source§

impl<'a> PartialEq for ImageDescriptor<'a>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<'a> StructuralPartialEq for ImageDescriptor<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for ImageDescriptor<'a>

§

impl<'a> RefUnwindSafe for ImageDescriptor<'a>

§

impl<'a> Send for ImageDescriptor<'a>

§

impl<'a> Sync for ImageDescriptor<'a>

§

impl<'a> Unpin for ImageDescriptor<'a>

§

impl<'a> UnsafeUnpin for ImageDescriptor<'a>

§

impl<'a> UnwindSafe for ImageDescriptor<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Az for T

Source§

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

Source§

fn cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> CheckedAs for T

Source§

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

Source§

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> OverflowingAs for T

Source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

Source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
Source§

impl<T> SaturatingAs for T

Source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

Source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UnwrappedAs for T

Source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

Source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
Source§

impl<T> WrappingAs for T

Source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
Source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

Source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.