Skip to main content

Rgba8Readback

Struct Rgba8Readback 

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

A submitted texture readback whose buffer has not been mapped yet.

The handle owns its staging buffer, so it outlives the renderer borrow and can be moved into an asynchronous browser task. Any pack target returns to the texture pool after its copy submission, before buffer mapping finishes.

Implementations§

Source§

impl Rgba8Readback

Source

pub const fn size(&self) -> RenderSize

Returns the pixel dimensions the mapped result will contain.

Source

pub const fn staging_bytes(&self) -> u64

Returns bytes retained by the GPU-visible staging buffer.

Source

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

Blocks a native caller until this specific readback submission is mapped.

Other work may be submitted between creating and waiting on the handle; the stored submission index prevents this wait from draining the entire device queue.

§Errors

Returns RenderError::TextureReadback when mapping or device polling fails.

Source

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

Waits for this readback and packs its mapped rows into RGBA8 pixels.

§Errors

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

The callback receives the failure when mapping was refused or was already requested, which a caller must treat as a failed frame rather than as empty pixels.

Source

pub fn poll(&self)

Advances backends that need explicit polling to resolve a mapping.

Browser WebGPU resolves mapping on its own event loop and ignores this; wgpu-core backends need it to make progress without a blocking wait.

Source

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

Packs the mapped rows into tightly packed premultiplied RGBA8.

§Errors

Returns RenderError::TextureReadback when the buffer is not mapped, and RenderError::GpuWorkDropped when the GPU did not run the copy: the buffer holds no pixels of this readback, so it is not recycled, and the renderer refuses further work.

Trait Implementations§

Source§

impl Debug for Rgba8Readback

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> 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,