Enum PixelFormat 

#[non_exhaustive]
#[repr(u32)]
pub enum PixelFormat {
    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),
}

Enumeration of the pixel formats supported by the helper routines.

Variants (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

impl PixelFormat

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

Convert a raw PFNC code into a PixelFormat enumeration.

pub const fn code(self) -> u32

Return the PFNC code associated with the pixel format.

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.

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

Convert a PFNC name string to a PixelFormat.

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

pub const fn is_bayer(self) -> bool

Whether the pixel format represents a Bayer mosaic.

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

impl Clone for PixelFormat

fn clone(&self) -> PixelFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PixelFormat

impl Debug for PixelFormat

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PixelFormat

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

Formats the value using the given formatter.

impl Eq for PixelFormat

impl Hash for PixelFormat

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

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 PixelFormat

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for PixelFormat

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PixelFormat