Struct vapoursynth::frame::FrameRef
source · [−]pub struct FrameRef<'core> { /* private fields */ }Expand description
A reference to a ref-counted frame.
Methods from Deref<Target = Frame<'core>>
sourcepub fn width(&self, plane: usize) -> usize
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().
sourcepub fn height(&self, plane: usize) -> usize
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().
sourcepub fn resolution(&self, plane: usize) -> Resolution
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.
sourcepub fn stride(&self, plane: usize) -> usize
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().
sourcepub fn plane_row<T: Component>(&self, plane: usize, row: usize) -> &[T]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
pub fn plane_row<T: Component>(&self, plane: usize, row: usize) -> &[T]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
Returns a slice of a plane’s pixel row.
Panics
Panics if the requested plane, row or component type is invalid.
sourcepub fn plane<T: Component>(&self, plane: usize) -> Result<&[T], NonZeroPadding>
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.
sourcepub fn data_ptr(&self, plane: usize) -> *const u8
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().
sourcepub fn data_row(&self, plane: usize, row: usize) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
pub fn data_row(&self, plane: usize, row: usize) -> &[u8]ⓘNotable traits for &'_ [u8]impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [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().
sourcepub fn data(&self, plane: usize) -> Result<&[u8], NonZeroPadding>
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().
Trait Implementations
sourceimpl<'map, 'elem: 'map> FilterArgument<'map, 'elem> for FrameRef<'elem>
impl<'map, 'elem: 'map> FilterArgument<'map, 'elem> for FrameRef<'elem>
sourceimpl<'core> From<FrameRefMut<'core>> for FrameRef<'core>
impl<'core> From<FrameRefMut<'core>> for FrameRef<'core>
sourcefn from(x: FrameRefMut<'core>) -> Self
fn from(x: FrameRefMut<'core>) -> Self
Converts to this type from the input type.
sourceimpl<'map, 'elem: 'map> Value<'map, 'elem> for FrameRef<'elem>
impl<'map, 'elem: 'map> Value<'map, 'elem> for FrameRef<'elem>
sourcefn get_from_map(map: &Map<'elem>, key: &str) -> Result<Self>
fn get_from_map(map: &Map<'elem>, key: &str) -> Result<Self>
Retrieves the value from the map.
sourcefn get_iter_from_map(
map: &'map Map<'elem>,
key: &str
) -> Result<ValueIter<'map, 'elem, Self>>
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.
Auto Trait Implementations
impl<'core> RefUnwindSafe for FrameRef<'core>
impl<'core> Send for FrameRef<'core>
impl<'core> Sync for FrameRef<'core>
impl<'core> Unpin for FrameRef<'core>
impl<'core> UnwindSafe for FrameRef<'core>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<'map, 'elem, T> FilterParameter<'map, 'elem> for T where
'elem: 'map,
T: FilterArgument<'map, 'elem>,
impl<'map, 'elem, T> FilterParameter<'map, 'elem> for T where
'elem: 'map,
T: FilterArgument<'map, 'elem>,
type Argument = T
type Argument = T
The underlying argument type for this parameter type.
sourcefn is_optional() -> bool
fn is_optional() -> bool
Returns whether this parameter is optional.
sourcefn get_from_map(map: &'map Map<'elem>, key: &str) -> T
fn get_from_map(map: &'map Map<'elem>, key: &str) -> T
Retrieves this parameter from the given map.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more