Struct PixelFormat 

pub struct PixelFormat(/* private fields */);

Represents libcamera::PixelFormat, which itself is a pair of fourcc code and u64 modifier as defined in libdrm.

Implementations

impl PixelFormat

pub const fn new(fourcc: u32, modifier: u64) -> Self

Constructs new PixelFormat from given fourcc code and modifier.

Examples

use libcamera::pixel_format::PixelFormat;
// Constructs MJPEG pixel format
const PIXEL_FORMAT_MJPEG: PixelFormat =
    PixelFormat::new(u32::from_le_bytes([b'M', b'J', b'P', b'G']), 0);

pub fn fourcc(&self) -> u32

pub fn set_fourcc(&mut self, fourcc: u32)

pub fn modifier(&self) -> u64

pub fn set_modifier(&mut self, modifier: u64)

pub fn has_modifier(&self) -> bool

Returns true if this format has a non-zero modifier set.

pub fn stride(&self, width: u32, plane: u32, align: u32) -> u32

Compute the stride for a plane given width and optional alignment.

pub fn plane_size(&self, size: Size, plane: u32, align: u32) -> u32

Compute plane size for the given frame size and plane index.

pub fn frame_size(&self, size: Size, align: u32) -> u32

Compute total frame size for the given dimensions.

pub fn clear_modifier(&mut self)

Clears the modifier to zero.

pub const fn to_raw(self) -> (u32, u64)

Returns the raw (fourcc, modifier) tuple.

pub const fn from_raw_parts(fourcc: u32, modifier: u64) -> Self

Constructs a PixelFormat from raw (fourcc, modifier) parts.

pub fn parse(name: &str) -> Option<Self>

Parse a PixelFormat from its string representation (e.g. “YUYV”).

pub fn is_valid(&self) -> bool

Returns true if the PixelFormat represents a valid libcamera format.

pub fn info(&self) -> Option<PixelFormatInfo>

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

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

Formats the value using the given formatter.

impl Display for PixelFormat

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

Formats the value using the given formatter.

impl From<DrmFormat> for PixelFormat

fn from(f: DrmFormat) -> Self

Converts to this type from the input type.

impl FromStr for PixelFormat

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for PixelFormat

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

type Error = UnrecognizedFourcc

The type returned in the event of a conversion error.

fn try_from(value: PixelFormat) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for PixelFormat

impl Eq for PixelFormat