Struct vapoursynth::frame::FrameRef

pub struct FrameRef<'core> { /* private fields */ }

A reference to a ref-counted frame.

Methods from Deref<Target = Frame<'core>>

pub fn format(&self) -> Format<'core>

Returns the frame format.

pub fn width(&self, plane: usize) -> usize

Returns the width of a plane, in pixels.

The width depends on the plane number because of the possible chroma subsampling.

Panics

Panics if plane >= format().plane_count().

pub fn height(&self, plane: usize) -> usize

Returns the height of a plane, in pixels.

The height depends on the plane number because of the possible chroma subsampling.

Panics

Panics if plane >= format().plane_count().

pub fn resolution(&self, plane: usize) -> Resolution

Returns the resolution of a plane.

The resolution depends on the plane number because of the possible chroma subsampling.

Panics

Panics if plane is invalid for this frame.

pub fn stride(&self, plane: usize) -> usize

Returns the distance in bytes between two consecutive lines of a plane.

Panics

Panics if plane >= format().plane_count().

pub fn plane_row<T: Component>(&self, plane: usize, row: usize) -> &[T]

Returns a slice of a plane’s pixel row.

Panics

Panics if the requested plane, row or component type is invalid.

pub fn plane<T: Component>(&self, plane: usize) -> Result<&[T], NonZeroPadding>

Returns a slice of the plane’s pixels.

The length of the returned slice is height() * width(). If the pixel data has non-zero padding (that is, stride() is larger than width()), an error is returned, since returning the data slice would open access to uninitialized bytes.

Panics

Panics if the requested plane or component type is invalid.

pub fn data_ptr(&self, plane: usize) -> *const u8

Returns a pointer to the plane’s pixels.

The pointer points to an array with a length of height() * stride() and is valid for as long as the frame is alive.

Panics

Panics if plane >= format().plane_count().

pub fn data_row(&self, plane: usize, row: usize) -> &[u8]

Returns a slice of a plane’s pixel row.

The length of the returned slice is equal to width() * format().bytes_per_sample().

Panics

Panics if plane >= format().plane_count() or if row >= height().

pub fn data(&self, plane: usize) -> Result<&[u8], NonZeroPadding>

Returns a slice of the plane’s pixels.

The length of the returned slice is height() * width() * format().bytes_per_sample(). If the pixel data has non-zero padding (that is, stride() is larger than width()), an error is returned, since returning the data slice would open access to uninitialized bytes.

Panics

Panics if plane >= format().plane_count() or if row >= height().

pub fn props(&self) -> MapRef<'_, '_>

Returns a map of frame’s properties.

Trait Implementations

impl<'core> Clone for FrameRef<'core>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'core> Debug for FrameRef<'core>

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

Formats the value using the given formatter.

impl<'core> Deref for FrameRef<'core>

type Target = Frame<'core>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'map, 'elem: 'map> FilterArgument<'map, 'elem> for FrameRef<'elem>

fn type_name() -> &'static str

Returns the VapourSynth type name for this argument type.

impl<'core> From<FrameRefMut<'core>> for FrameRef<'core>

fn from(x: FrameRefMut<'core>) -> Self

Converts to this type from the input type.

impl<'map, 'elem: 'map> Value<'map, 'elem> for FrameRef<'elem>

fn get_from_map(map: &Map<'elem>, key: &str) -> Result<Self>

Retrieves the value from the map.

fn get_iter_from_map(
    map: &'map Map<'elem>,
    key: &str
) -> Result<ValueIter<'map, 'elem, Self>>

Retrieves an iterator over the values from the map.

fn store_in_map(map: &mut Map<'elem>, key: &str, x: &Self) -> Result<()>

Sets the property value in the map.

fn append_to_map(map: &mut Map<'elem>, key: &str, x: &Self) -> Result<()>

Appends the value to the map.