Struct CopiedTextureBuffer

pub struct CopiedTextureBuffer {
    pub format: TextureFormat,
    pub dimensions: BufferDimensions,
    pub buffer: Buffer,
}

Helper for retreiving a rendered frame.

Fields

format: TextureFormat

dimensions: BufferDimensions

buffer: Buffer

Implementations

impl CopiedTextureBuffer

pub async fn pixels(&self, device: &Device) -> Result<Vec<u8>, TextureError>

Access the raw unpadded pixels of the buffer.

This calls wgpu::Device::poll.

pub async fn convert_to_rgba(self) -> Result<RgbaImage, TextureError>

Convert the post render buffer into an RgbaImage.

pub async fn into_image<Sp, P>( self, device: &Device, ) -> Result<DynamicImage, TextureError>

where Sp: AnyBitPattern, P: Pixel<Subpixel = Sp>, DynamicImage: From<ImageBuffer<P, Vec<Sp>>>,

Convert the post render buffer into an image.

Sp is the sub-pixel type. eg, u8 or f32

P is the pixel type. eg, Rgba<u8> or Luma<f32>

pub async fn into_atlas_image( self, device: &Device, ) -> Result<AtlasImage, TextureError>

Convert the post render buffer into an internal-format AtlasImage.

pub async fn into_rgba( self, device: &Device, linear: bool, ) -> Result<RgbaImage, TextureError>

Convert the post render buffer into an RgbaImage.

Ensures that the pixels are in the given color space by applying the correct transfer function if needed.

Assumes the texture is in Rgba8 format.

pub async fn into_linear_rgba( self, device: &Device, ) -> Result<RgbaImage, TextureError>

Convert the post render buffer into an RgbaImage.

Ensures that the pixels are in a linear color space by applying the linear transfer if the texture this buffer was copied from was sRGB.

pub async fn into_srgba( self, device: &Device, ) -> Result<RgbaImage, TextureError>

Convert the post render buffer into an RgbaImage.

Ensures that the pixels are in a sRGB color space by applying the opto transfer function if the texture this buffer was copied from was linear.

pub fn read_from( runtime: impl AsRef<WgpuRuntime>, texture: &Texture, width: usize, height: usize, channels: usize, subpixel_bytes: usize, mip_level: u32, origin: Option<Origin3d>, ) -> CopiedTextureBuffer

Read the texture from the GPU.

To read the texture you must provide the width, height, the number of color/alpha channels and the number of bytes in the underlying subpixel type (usually u8=1, u16=2 or f32=4).

pub fn new( runtime: impl AsRef<WgpuRuntime>, texture: &Texture, ) -> Result<Self, TextureError>

Copy the entire texture into a buffer, at mip 0.

Attempts to figure out the parameters to CopiedTextureBuffer::read_from.