Struct av_data::pixel::Chromaton

pub struct Chromaton {
    pub h_ss: u8,
    pub v_ss: u8,
    pub packed: bool,
    pub depth: u8,
    pub shift: u8,
    pub comp_offs: u8,
    pub next_elem: u8,
}

Single colorspace component definition.

Defines how the components of a colorspace are subsampled and where and how they are stored.

Fields

h_ss: u8

Horizontal subsampling in power of two (e.g. 0 = no subsampling, 1 = only every second value is stored).

v_ss: u8

Vertial subsampling in power of two (e.g. 0 = no subsampling, 1 = only every second value is stored).

packed: bool

Tells if a component is packed.

depth: u8

Bit depth of a component.

shift: u8

Shift for packed components.

comp_offs: u8

Component offset for byte-packed components.

next_elem: u8

The distance to the next packed element in bytes.

Implementations

impl Chromaton

pub const fn new(
    h_ss: u8,
    v_ss: u8,
    packed: bool,
    depth: u8,
    shift: u8,
    comp_offs: u8,
    next_elem: u8
) -> Self

Constructs a new Chromaton instance.

pub const fn yuv8(h_ss: u8, v_ss: u8, comp_offs: u8) -> Chromaton

Constructs a specific Chromaton instance for yuv8.

pub const fn yuvhb(h_ss: u8, v_ss: u8, depth: u8, comp_offs: u8) -> Chromaton

Constructs a specific Chromaton instance for yuvhb.

pub const fn packrgb(
    depth: u8,
    shift: u8,
    comp_offs: u8,
    next_elem: u8
) -> Chromaton

Constructs a specific Chromaton instance for packrgb.

pub const fn pal8(comp_offs: u8) -> Chromaton

Constructs a specific Chromaton instance for pal8.

pub fn get_subsampling(self) -> (u8, u8)

Returns the subsampling of a component.

pub fn is_packed(self) -> bool

Tells whether a component is packed.

pub fn get_depth(self) -> u8

Returns the bit depth of a component.

pub fn get_shift(self) -> u8

Returns the bit shift of a packed component.

pub fn get_offset(self) -> u8

Returns the byte offset of a packed component.

pub fn get_step(self) -> u8

Returns the byte offset to the next element of a packed component.

pub fn get_width(self, width: usize) -> usize

Calculates the width for a component from general image width.

pub fn get_height(self, height: usize) -> usize

Calculates the height for a component from general image height.

pub fn get_linesize(self, width: usize, alignment: usize) -> usize

Calculates the minimal stride for a component from general image width.

pub fn get_data_size(self, width: usize, height: usize, align: usize) -> usize

Calculates the required image size in pixels for a component from general image width.

Trait Implementations

impl Clone for Chromaton

pub fn clone(&self) -> Chromaton

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Chromaton

impl Debug for Chromaton

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

Formats the value using the given formatter.

impl Display for Chromaton

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

Formats the value using the given formatter.

impl PartialEq<Chromaton> for Chromaton

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Chromaton