Skip to main content

Yuv420pReadback

Struct Yuv420pReadback 

Source
pub struct Yuv420pReadback { /* private fields */ }
Expand description

A submitted GPU RGB-to-YUV420 conversion whose buffer is not mapped yet.

Implementations§

Source§

impl Yuv420pReadback

Source

pub const fn size(&self) -> RenderSize

The luma-plane dimensions.

Source

pub const fn staging_bytes(&self) -> u64

Bytes held by the staging buffer.

Source

pub fn wait_ready(&self) -> Result<(), RenderError>

Blocks a native caller until this readback is mapped.

§Errors

Returns RenderError::TextureReadback when mapping or polling fails.

Source

pub fn wait_for_submission(&self) -> Result<(), RenderError>

Blocks until this readback’s submission completes; may follow an earlier Self::map_async.

§Errors

RenderError::GpuTimeout past the renderer’s wait timeout, or RenderError::TextureReadback when device polling fails.

Source

pub fn wait(self) -> Result<Yuv420pPlanes, RenderError>

Waits for this readback and returns tightly packed planes.

§Errors

RenderError::TextureReadback when mapping, polling or row packing fails.

Source

pub fn map_async( &self, on_ready: impl FnOnce(Result<(), RenderError>) + Send + 'static, )

Requests buffer mapping and reports readiness exactly once.

Source

pub fn poll(&self)

Polls backends that need it to resolve a mapping.

Source

pub fn finish_into( self, targets: &mut Yuv420pTargets<'_>, ) -> Result<(), RenderError>

Packs mapped planes into caller-owned, possibly strided, plane buffers, avoiding the allocation and copy of Yuv420pReadback::finish.

§Errors RenderError::TextureReadback when the buffer is not mapped, the layout is

unrepresentable or a target is too small, and RenderError::GpuWorkDropped when the GPU did not run the copy (the buffer is not recycled and the renderer refuses further work).

Source

pub fn finish(self) -> Result<Yuv420pPlanes, RenderError>

Packs mapped planes into three tightly packed planes.

§Errors

As Self::finish_into.

Source

pub fn pixel_layout(&self) -> Option<PixelLayout>

The layout a texel readback packs into, None for a GPU-packed 8-bit 4:2:0 readback.

Source

pub fn finish_into_planes( self, targets: &mut [PlaneTarget<'_>], ) -> Result<(), RenderError>

Packs the mapped frame into one target per plane of its layout, in storage order (PixelLayout::planes).

§Errors

As Self::finish_into, and RenderError::TextureReadback for a wrong target count.

Trait Implementations§

Source§

impl Debug for Yuv420pReadback

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,