Struct PlaneGeometry 

pub struct PlaneGeometry { /* private fields */ }

Describes the geometry of a plane, including dimensions and padding.

This struct contains all the information needed to interpret the layout of a plane’s data buffer, including the visible dimensions and the padding on all four sides.

The stride represents the number of pixels per row in the data buffer, which is equal to width + pad_left + pad_right.

Implementations

impl PlaneGeometry

pub fn new( width: usize, height: usize, pad_left: usize, pad_right: usize, pad_top: usize, pad_bottom: usize, subsampling_x: u8, subsampling_y: u8, ) -> Option<Self>

Returns a new PlaneGeometry with the given dimensions, padding and subsampling.

Will return None if:

• width, height, subsampling_x or subsampling_y are zero or
• the data stride would overflow a usize.

pub fn unpadded( width: usize, height: usize, subsampling_x: u8, subsampling_y: u8, ) -> Option<Self>

Returns a new PlaneGeometry with the given dimensions, subsampling and zero padding.

Returns None if width, height, subsampling_x or subsampling_y are zero.

pub fn width(&self) -> usize

Width of the visible area in pixels.

Guaranteed to be non-zero.

pub fn height(&self) -> usize

Height of the visible area in pixels.

Guaranteed to be non-zero.

pub fn stride(&self) -> usize

Data stride (pixels per row in the buffer, including padding).

Guaranteed to be non-zero.

pub fn pad_left(&self) -> usize

Number of padding pixels on the left side.

pub fn pad_right(&self) -> usize

Number of padding pixels on the right side.

pub fn pad_top(&self) -> usize

Number of padding pixels on the top.

pub fn pad_bottom(&self) -> usize

Number of padding pixels on the bottom.

pub fn subsampling_x(&self) -> u8

The horizontal subsampling ratio of this plane compared to the luma plane.

Guaranteed to be non-zero, and 1 if not subsampled.

pub fn subsampling_y(&self) -> u8

The horizontal subsampling ratio of this plane compared to the luma plane.

Guaranteed to be non-zero, and 1 if not subsampled.

pub fn for_subsampling( self, subsampling: ChromaSubsampling, ) -> Result<Option<Self>, SubsamplingError>

Returns a new PlaneGeometry based on self and according to subsampling.

Returns:

• Ok(None) if the subsampling specifies no other planes (i.e. monochrome),
• Ok(Some(g)) if self was successfully subsampled into a new geometry g,
• Err(..) if self could not be subsampled into a new geometry, for example due to self having an odd width or height.

Errors

See SubsamplingError.

pub fn data_origin(&self) -> usize

Returns the index for the first visible pixel.

pub fn alloc_height(&self) -> usize

Returns the total height of the plane, including padding.

pub fn alloc_size(&self) -> usize

Returns the total allocation size of the plane, including padding.

Trait Implementations

impl Clone for PlaneGeometry

fn clone(&self) -> PlaneGeometry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PlaneGeometry

impl Debug for PlaneGeometry

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

Formats the value using the given formatter.

impl Eq for PlaneGeometry

impl PartialEq for PlaneGeometry

fn eq(&self, other: &PlaneGeometry) -> 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 StructuralPartialEq for PlaneGeometry