Struct vapoursynth::frame::FrameRefMut

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

A reference to a mutable frame.

Implementations

impl<'core> FrameRefMut<'core>

pub fn copy_of(core: CoreRef<'_>, frame: &Frame<'core>) -> Self

Creates a copy of the given frame.

The plane data is copy-on-write, so this isn’t very expensive by itself.

Judging by the underlying implementation, it seems that any valid core can be used.

pub unsafe fn new_uninitialized(
    core: CoreRef<'core>,
    prop_src: Option<&Frame<'core>>,
    format: Format<'core>,
    resolution: Resolution
) -> Self

Creates a new frame with uninitialized plane data.

Optionally copies the frame properties from the provided prop_src frame.

Safety

The returned frame contains uninitialized plane data. This should be handled carefully. See the docs for std::mem::uninitialized() for more information.

Panics

Panics if the given resolution has components that don’t fit into an i32.

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_row_mut<T: Component>(
    &mut self,
    plane: usize,
    row: usize
) -> &mut [T]

Returns a mutable 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 plane_mut<T: Component>(
    &mut self,
    plane: usize
) -> Result<&mut [T], NonZeroPadding>

Returns a mutable 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_ptr_mut(&mut self, plane: usize) -> *mut u8

Returns a mutable 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_row_mut(&mut self, plane: usize, row: usize) -> &mut [u8]

Returns a mutable 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 data_mut(&mut self, plane: usize) -> Result<&mut [u8], NonZeroPadding>

Returns a mutable 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.

pub fn props_mut(&mut self) -> MapRefMut<'_, '_>

Returns a mutable map of frame’s properties.

Trait Implementations

impl<'core> Debug for FrameRefMut<'core>

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

Formats the value using the given formatter.

impl<'core> Deref for FrameRefMut<'core>

type Target = Frame<'core>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'core> DerefMut for FrameRefMut<'core>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

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

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

Converts to this type from the input type.