Struct kludgine::Frame

pub struct Frame<'gfx> { /* private fields */ }

A frame that can be rendered.

Panics

After Frame::render() has been invoked, this type will panic if dropped before either Frame::submit() or Frame::abort() are invoked. This panic is designed to prevent accidentally forgetting to submit a frame to the GPU.q

Implementations

impl Frame<'_>

pub fn prepare<'gfx>( &'gfx mut self, device: &'gfx Device, queue: &'gfx Queue ) -> Graphics<'gfx>

Creates a Graphics context for this frame that can be used to prepare graphics for rendering:

• Shape::prepare
• Texture::prepare
• Texture::prepare_partial
• CollectedTexture::prepare
• Drawing::new_frame

The returned graphics provides access to the various types to update their representation on the GPU so that they can be rendered later.

pub fn render<'gfx, 'pass>( &'pass mut self, pass: &RenderPassDescriptor<'pass, '_>, device: &'gfx Device, queue: &'gfx Queue ) -> RenderingGraphics<'gfx, 'pass>

Creates a RenderingGraphics context for this frame which is used to render previously prepared graphics:

• PreparedGraphic
• PreparedText
• Drawing

pub fn render_into<'gfx, 'pass>( &'pass mut self, texture: &'pass Texture, load_op: LoadOp<Color>, graphics: &Graphics<'gfx> ) -> RenderingGraphics<'gfx, 'pass>

Creates a RenderingGraphics that renders into texture for this frame. The returned context can be used to render previously prepared graphics:

• PreparedGraphic
• PreparedText
• Drawing

pub fn submit(self, queue: &Queue) -> Option<SubmissionIndex>

Submits all of the commands for this frame to the GPU.

This function does not block for the operations to finish. The returned wgpu::SubmissionIndex can be used to block until completion if desired.

pub fn abort(self)

Aborts rendering this frame.

If Frame::render() has been invoked, this function must be used instead of dropping the frame. This type implements a panic-on-drop to prevent forgetting to submit the frame to the GPU, and this function prevents the panic from happening.

Trait Implementations

impl Drop for Frame<'_>

fn drop(&mut self)

Executes the destructor for this type.