Struct rav1e::prelude::Plane

pub struct Plane<T: Pixel> {
    pub cfg: PlaneConfig,
    // some fields omitted
}

One data plane of a frame.

For example, a plane can be a Y luma plane or a U or V chroma plane.

Fields

cfg: PlaneConfig

Plane configuration.

Implementations

impl<T: Pixel> Plane<T>

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

Allocates and returns a new plane.

pub fn slice(&self, po: PlaneOffset) -> PlaneSlice<T>

pub fn p(&self, x: usize, y: usize) -> T

Returns the pixel at the given coordinates.

pub fn data_origin(&self) -> &[T]

Returns plane data starting from the origin.

pub fn data_origin_mut(&mut self) -> &mut [T]

Returns mutable plane data starting from the origin.

pub fn copy_from_raw_u8(
    &mut self,
    source: &[u8],
    source_stride: usize,
    source_bytewidth: usize
)

Copies data into the plane from a pixel array.

pub fn downsampled(&self, frame_width: usize, frame_height: usize) -> Plane<T>

pub fn iter(&self) -> PlaneIter<T>

Iterates over the pixels in the plane, skipping the padding.

Trait Implementations

impl<T: Clone + Pixel> Clone for Plane<T>

fn clone(&self) -> Plane<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Pixel> Debug for Plane<T> where
    T: Display, 

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

Formats the value using the given formatter.

impl<T: Eq + Pixel> Eq for Plane<T>

impl<T: PartialEq + Pixel> PartialEq<Plane<T>> for Plane<T>

fn eq(&self, other: &Plane<T>) -> bool

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

fn ne(&self, other: &Plane<T>) -> bool

This method tests for !=.

impl<T: Pixel> StructuralEq for Plane<T>

impl<T: Pixel> StructuralPartialEq for Plane<T>