Skip to main content

PixelLayout

Enum PixelLayout 

Source
#[non_exhaustive]
pub enum PixelLayout {
Show 13 variants Rgb8Srgb, Bgr8Srgb, Rgbx8Srgb, Bgrx8Srgb, Gray8Srgb, Rgb16Linear, Rgbx16Linear, Gray16Linear, RgbF32Linear, RgbxF32Linear, GrayF32Linear, YCbCr8, YCbCrF32,
}
Expand description

Pixel data layout for raw byte input.

Describes channel order, bit depth, and color space interpretation. Use with encode_from_bytes() when working with raw buffers.

For rgb crate types, use encode_from_rgb() which infers layout.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Rgb8Srgb

RGB, 3 bytes/pixel, sRGB gamma

§

Bgr8Srgb

BGR, 3 bytes/pixel, sRGB gamma (Windows/GDI order)

§

Rgbx8Srgb

RGBX, 4 bytes/pixel, sRGB gamma (4th byte ignored)

§

Bgrx8Srgb

BGRX, 4 bytes/pixel, sRGB gamma (4th byte ignored)

§

Gray8Srgb

Grayscale, 1 byte/pixel, sRGB gamma

§

Rgb16Linear

RGB, 6 bytes/pixel, linear light (0-65535)

§

Rgbx16Linear

RGBX, 8 bytes/pixel, linear light (4th channel ignored)

§

Gray16Linear

Grayscale, 2 bytes/pixel, linear light

§

RgbF32Linear

RGB, 12 bytes/pixel, linear light (0.0-1.0)

§

RgbxF32Linear

RGBX, 16 bytes/pixel, linear light (4th channel ignored)

§

GrayF32Linear

Grayscale, 4 bytes/pixel, linear light

§

YCbCr8

YCbCr interleaved, 3 bytes/pixel, u8

§

YCbCrF32

YCbCr interleaved, 12 bytes/pixel, f32

Implementations§

Source§

impl PixelLayout

Source

pub const fn bytes_per_pixel(&self) -> usize

Bytes per pixel for this layout.

Source

pub const fn channels(&self) -> usize

Number of channels (including ignored channels).

Source

pub const fn is_grayscale(&self) -> bool

Whether this is a grayscale format.

Source

pub const fn is_ycbcr(&self) -> bool

Whether this is pre-converted YCbCr.

Source

pub const fn is_bgr(&self) -> bool

Whether this uses BGR channel order.

Source

pub const fn is_float(&self) -> bool

Whether this is a float format (linear color space).

Source

pub const fn is_16bit(&self) -> bool

Whether this is a 16-bit format (linear color space).

Trait Implementations§

Source§

impl Clone for PixelLayout

Source§

fn clone(&self) -> PixelLayout

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 Copy for PixelLayout

Source§

impl Debug for PixelLayout

Source§

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

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

impl Eq for PixelLayout

Source§

impl PartialEq for PixelLayout

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for PixelLayout

Auto Trait Implementations§

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> 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<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> 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.