Struct v_frame::plane::PlaneConfig

pub struct PlaneConfig {
    pub stride: usize,
    pub alloc_height: usize,
    pub width: usize,
    pub height: usize,
    pub xdec: usize,
    pub ydec: usize,
    pub xpad: usize,
    pub ypad: usize,
    pub xorigin: usize,
    pub yorigin: usize,
}

Plane-specific configuration.

Fields

stride: usize

Data stride.

alloc_height: usize

Allocated height in pixels.

width: usize

Width in pixels.

height: usize

Height in pixels.

xdec: usize

Decimator along the X axis.

For example, for chroma planes in a 4:2:0 configuration this would be 1.

ydec: usize

Decimator along the Y axis.

For example, for chroma planes in a 4:2:0 configuration this would be 1.

xpad: usize

Number of padding pixels on the right.

ypad: usize

Number of padding pixels on the bottom.

xorigin: usize

X where the data starts.

yorigin: usize

Y where the data starts.

Implementations

impl PlaneConfig

pub fn new(
    width: usize,
    height: usize,
    xdec: usize,
    ydec: usize,
    xpad: usize,
    ypad: usize,
    type_size: usize
) -> Self

Trait Implementations

impl Clone for PlaneConfig

fn clone(&self) -> PlaneConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlaneConfig

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

Formats the value using the given formatter.

impl PartialEq<PlaneConfig> for PlaneConfig

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

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

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

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

impl Eq for PlaneConfig

impl StructuralEq for PlaneConfig

impl StructuralPartialEq for PlaneConfig