Struct nannou::wgpu::TextureSnapshot

pub struct TextureSnapshot { /* private fields */ }

A snapshot captured by a Capturer.

A snapshot is a thin wrapper around a wgpu::BufferImage that knows that the image format is specifically non-linear sRGBA8.

Implementations

impl Snapshot

pub async fn read_async<'buffer>( &'buffer self ) -> Result<Rgba8AsyncMappedImageBuffer<'buffer>, BufferAsyncError>

Reads the non-linear sRGBA image from mapped memory and convert it to an owned buffer.

pub fn read<F>( self, callback: F ) -> Result<(), AwaitWorkerTimeout<impl Future<Output = ()>>>

where F: 'static + Send + FnOnce(Result<Rgba8AsyncMappedImageBuffer<'_>, BufferAsyncError>),

The same as read_async, but runs the resulting future on an inner threadpool and calls the given callback with the mapped image buffer once complete.

Note: The given callback will not be called until the memory is mapped and the device is polled. You should not rely on the callback being called immediately.

Note: The given callback will be called on the inner thread pool and will not be called on the current thread.

Note: This method may block if the associated wgpu::TextureCapturer has an active_futures count that is greater than the number of worker threads with which it was created. This is necessary in order to avoid “out of memory” errors resulting from an accumulating queue of pending texture buffers waiting to be mapped. To avoid blocking, you can try using a higher thread count, capturing a smaller texture, or using read_async instead and running the resulting future on a custom runtime or threadpool.