Struct Format

pub struct Format<'core> { /* private fields */ }

Contains information about a video format.

Implementations

impl<'core> Format<'core>

pub fn id(self) -> FormatID

Gets the unique identifier of this format.

pub fn name(self) -> &'core str

Gets the printable name of this format.

pub fn plane_count(self) -> usize

Gets the number of planes of this format.

pub fn color_family(self) -> ColorFamily

Gets the color family of this format.

pub fn sample_type(self) -> SampleType

Gets the sample type of this format.

pub fn bits_per_sample(self) -> u8

Gets the number of significant bits per sample.

pub fn bytes_per_sample(self) -> u8

Gets the number of bytes needed for a sample. This is always a power of 2 and the smallest possible that can fit the number of bits used per sample.

pub fn sub_sampling_w(self) -> u8

log2 subsampling factor, applied to second and third plane.

pub fn sub_sampling_h(self) -> u8

log2 subsampling factor, applied to second and third plane.

Trait Implementations

impl<'core> Clone for Format<'core>

fn clone(&self) -> Format<'core>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'core> Debug for Format<'core>

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

Formats the value using the given formatter.

impl<'core> PartialEq for Format<'core>

fn eq(&self, other: &Format<'core>) -> 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<'core> Copy for Format<'core>

impl<'core> Eq for Format<'core>