Struct av_data::pixel::Formaton

pub struct Formaton {
    pub model: ColorModel,
    pub primaries: ColorPrimaries,
    pub xfer: TransferCharacteristic,
    pub matrix: MatrixCoefficients,
    pub chroma_location: ChromaLocation,
    pub components: u8,
    pub comp_info: [Option<Chromaton>; 5],
    pub elem_size: u8,
    pub be: bool,
    pub alpha: bool,
    pub palette: bool,
}

Image colorspace representation.

Includes both definitions for each component and some common definitions.

For example, the format can be paletted, so the components describe the palette storage format, while the actual data is 8-bit palette indices.

Fields

model: ColorModel

Image color model.

primaries: ColorPrimaries

Image color primaries.

xfer: TransferCharacteristic

Image transfer characteristic.

matrix: MatrixCoefficients

Image matrix coefficients.

chroma_location: ChromaLocation

Image chroma location.

components: u8

Actual number of components present.

comp_info: [Option<Chromaton>; 5]

Format definition for each component.

elem_size: u8

Single pixel size for packed formats.

be: bool

Tells if data is stored as big-endian.

alpha: bool

Tells if image has alpha component.

palette: bool

Tells if data is paletted.

Implementations

impl Formaton

pub fn new(
    model: ColorModel,
    components: &[Chromaton],
    elem_size: u8,
    be: bool,
    alpha: bool,
    palette: bool
) -> Self

Constructs a new instance of Formaton.

pub fn get_model(&self) -> ColorModel

Returns current color model.

pub fn get_primaries(&self) -> ColorPrimaries

Returns current image primaries.

pub fn get_total_depth(&self) -> u8

Returns the total amount of bits needed for components.

pub fn set_primaries(mut self: Self, pc: ColorPrimaries)

Sets current image primaries.

pub fn set_primaries_from_u32(mut self: Self, pc: u32) -> Option<ColorPrimaries>

Sets current image primaries from u32.

pub fn get_xfer(&self) -> TransferCharacteristic

Returns current image transfer characteristic.

pub fn set_xfer(mut self: Self, pc: TransferCharacteristic)

Sets current image transfer characteristic.

pub fn set_xfer_from_u32(
    mut self: Self,
    tc: u32
) -> Option<TransferCharacteristic>

Sets current image transfer characteristic from u32.

pub fn get_matrix(&self) -> MatrixCoefficients

Returns current image matrix coefficients.

pub fn set_matrix(mut self: Self, mc: MatrixCoefficients)

Sets current image matrix coefficients.

pub fn set_matrix_from_u32(
    mut self: Self,
    mc: u32
) -> Option<MatrixCoefficients>

Sets current image matrix coefficients from u32.

pub fn get_num_comp(&self) -> usize

Returns the number of components.

pub fn get_chromaton(&self, idx: usize) -> Option<Chromaton>

Returns selected component information.

pub fn is_be(&self) -> bool

Reports whether the packing format is big-endian.

pub fn has_alpha(&self) -> bool

Reports whether a colorspace has an alpha component.

pub fn is_paletted(&self) -> bool

Reports whether this is a paletted format.

pub fn get_elem_size(&self) -> u8

Returns single packed pixel size.

pub fn iter(&self) -> Iter<'_, Option<Chromaton>>

Returns an iterator over the format definition of each component.

Trait Implementations

impl Clone for Formaton

pub fn clone(&self) -> Formaton

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Formaton

impl Debug for Formaton

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

Formats the value using the given formatter.

impl Display for Formaton

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

Formats the value using the given formatter.

impl<'a> Index<usize> for &'a Formaton

type Output = Option<Chromaton>

The returned type after indexing.

pub fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a Formaton

type Item = &'a Option<Chromaton>

The type of the elements being iterated over.

type IntoIter = Iter<'a, Option<Chromaton>>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<Formaton> for Formaton

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

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

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

This method tests for !=.

impl StructuralPartialEq for Formaton