Struct Plane

pub struct Plane<T>
where
    T: Pixel,
{
    pub data: PlaneData<T>,
    pub cfg: PlaneConfig,
}

One data plane of a frame.

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

Fields

data: PlaneData<T>

cfg: PlaneConfig

Plane configuration.

Implementations

impl<T> Plane<T>

where T: Pixel,

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

Allocates and returns a new plane.

pub fn from_slice(data: &[T], stride: usize) -> Plane<T>

Panics

• If len is not a multiple of stride

pub fn pad(&mut self, w: usize, h: usize)

pub fn probe_padding(&self, w: usize, h: usize) -> bool

Minimally test that the plane has been padded.

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

pub fn mut_slice(&mut self, po: PlaneOffset) -> PlaneMutSlice<'_, T>

pub fn row_range_cropped(&self, x: isize, y: isize) -> Range<usize>

This version of the function crops off the padding on the right side of the image

pub fn row_range(&self, x: isize, y: isize) -> Range<usize>

This version of the function includes the padding on the right side of the image

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.

Panics

• If source_bytewidth does not match the generic T of Plane

pub fn copy_to_raw_u8( &self, dest: &mut [u8], dest_stride: usize, dest_bytewidth: usize, )

Copies data from a plane into a pixel array.

Panics

• If dest_bytewidth does not match the generic T of Plane

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

Returns plane with half the resolution for width and height. Downscaled with 2x2 box filter. Padded to dimensions with frame_width and frame_height.

Panics

• If the requested width and height are > half the input width or height

pub fn downscale<const SCALE: usize>(&self) -> Plane<T>

Returns a plane downscaled from the source plane by a factor of scale (not padded)

pub fn downscale_in_place<const SCALE: usize>(&self, in_plane: &mut Plane<T>)

Downscales the source plane by a factor of scale, writing the result to in_plane (not padded)

Panics

• If the current plane’s width and height are not at least SCALE times the in_plane’s

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

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

pub fn rows_iter(&self) -> RowsIter<'_, T>

Iterates over the lines of the plane

pub fn rows_iter_mut(&mut self) -> RowsIterMut<'_, T>

pub fn row(&self, y: isize) -> &[T]

Return a line

Trait Implementations

impl<T> Clone for Plane<T>

where T: Clone + Pixel,

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> Debug for Plane<T>

where T: Pixel + Display,

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

Formats the value using the given formatter.

impl<T> PartialEq for Plane<T>

where T: PartialEq + Pixel,

fn eq(&self, other: &Plane<T>) -> 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<T> Eq for Plane<T>

where T: Eq + Pixel,

impl<T> StructuralPartialEq for Plane<T>

where T: Pixel,