Skip to main content

PixelFormat

Enum PixelFormat 

Source
#[non_exhaustive]
#[repr(u32)]
pub enum PixelFormat {
Show 21 variants Mono8 = 17_301_505, Mono10 = 17_825_795, Mono12 = 17_825_797, Mono14 = 17_825_829, Mono16 = 17_825_799, Confidence8 = 17_301_702, Coord3DC32f = 18_874_559, Coord3DAC16 = 35_651_771, Coord3DAC32f = 37_748_930, Coord3DABC32f = 39_846_080, BayerRG8 = 17_301_513, BayerGB8 = 17_301_514, BayerBG8 = 17_301_515, BayerGR8 = 17_301_512, BayerGR16 = 17_825_806, BayerRG16 = 17_825_807, BayerGB16 = 17_825_808, BayerBG16 = 17_825_809, RGB8Packed = 35_127_316, BGR8Packed = 35_127_317, Unknown(u32),
}
Expand description

Enumeration of the pixel formats supported by the helper routines.

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

Mono8 = 17_301_505

§

Mono10 = 17_825_795

§

Mono12 = 17_825_797

§

Mono14 = 17_825_829

§

Mono16 = 17_825_799

§

Confidence8 = 17_301_702

§

Coord3DC32f = 18_874_559

§

Coord3DAC16 = 35_651_771

§

Coord3DAC32f = 37_748_930

§

Coord3DABC32f = 39_846_080

§

BayerRG8 = 17_301_513

§

BayerGB8 = 17_301_514

§

BayerBG8 = 17_301_515

§

BayerGR8 = 17_301_512

§

BayerGR16 = 17_825_806

§

BayerRG16 = 17_825_807

§

BayerGB16 = 17_825_808

§

BayerBG16 = 17_825_809

§

RGB8Packed = 35_127_316

§

BGR8Packed = 35_127_317

§

Unknown(u32)

Unknown PFNC code reported by the device.

Implementations§

Source§

impl PixelFormat

Source

pub const fn from_code(code: u32) -> PixelFormat

Convert a raw PFNC code into a PixelFormat enumeration.

Source

pub const fn code(self) -> u32

Return the PFNC code associated with the pixel format.

Source

pub const fn bytes_per_pixel(self) -> Option<usize>

Number of bytes used to encode a single pixel.

For a format this enumeration does not name, the answer is derived from bits 23-16 of the PFNC code, which carry the pixel’s bit depth. None means the pixel genuinely has no whole-byte size — a packed format — not that we failed to look it up.

Source

pub fn from_name(name: &str) -> PixelFormat

Convert a PFNC name string to a PixelFormat.

Returns PixelFormat::Unknown(0) for unrecognised names.

Source

pub const fn is_bayer(self) -> bool

Whether the pixel format represents a Bayer mosaic.

Source

pub const fn cfa_pattern(self) -> Option<(&'static str, u8, u8)>

Return the Color Filter Array pattern and canonical offsets.

The tuple encodes (pattern, x_offset, y_offset) where the offsets describe how the sensor mosaic aligns to the canonical "RGGB" ordering.

Trait Implementations§

Source§

impl Clone for PixelFormat

Source§

fn clone(&self) -> PixelFormat

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 Debug for PixelFormat

Source§

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

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

impl<'de> Deserialize<'de> for PixelFormat

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for PixelFormat

Source§

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

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

impl Hash for PixelFormat

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for PixelFormat

Source§

fn eq(&self, other: &PixelFormat) -> 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 Serialize for PixelFormat

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for PixelFormat

Source§

impl Eq for PixelFormat

Source§

impl StructuralPartialEq for PixelFormat

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,