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.

Owns its staging buffer, so it can move into an async browser task.

Implementations§

Source§

impl Rgba8Readback

Source

pub const fn size(&self) -> RenderSize

The pixel dimensions of the result.

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, without draining the whole queue.

§Errors

RenderError::TextureReadback when mapping or device polling fails.

Source

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

Waits for this readback and returns tightly packed RGBA8 pixels.

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

A refused or repeated request reports a failure, which callers must treat as a failed frame.

Source

pub fn poll(&self)

Polls backends that need it to resolve a mapping; browser WebGPU ignores this.

Source

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

Packs the mapped rows into tightly packed premultiplied RGBA8.

§Errors

RenderError::TextureReadback when the buffer is not mapped, and RenderError::GpuWorkDropped when the GPU did not run the copy; the buffer is then 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> 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,