Struct Frame 

pub struct Frame { /* private fields */ }

Represents the current frame of a render target.

Returned by Context::get_next_frame.

Implementations

impl Frame

pub fn texture(&self) -> &Texture

Returns the underlying texture of this target.

pub fn view(&self) -> TextureView

pub fn copy_to_buffer( &self, device: &Device, queue: &Queue, width: u32, height: u32, ) -> CopiedTextureBuffer

pub fn get_size(&self) -> UVec2

pub fn read_image(&self) -> Result<RgbaImage, TextureError>

Read the current frame buffer into an image.

This should be called after rendering, before presentation. Good for getting headless screen grabs.

The resulting image will be in the color space of the frame.

Note

This operation can take a long time, depending on how big the screen is.

pub fn read_srgb_image(&self) -> Result<RgbaImage, TextureError>

Read the frame into an image.

This should be called after rendering, before presentation. Good for getting headless screen grabs.

The resulting image will be in a sRGB color space.

Note

This operation can take a long time, depending on how big the screen is.

pub fn read_linear_image(&self) -> Result<RgbaImage, TextureError>

Read the frame into an image.

This should be called after rendering, before presentation. Good for getting headless screen grabs.

The resulting image will be in a linear color space.

Note

This operation can take a long time, depending on how big the screen is.

pub fn present(self)

If self is TargetFrame::Surface this presents the surface frame.

If self is a TargetFrame::Texture this is a noop.