Struct CallbackFn

pub struct CallbackFn { /* private fields */ }

A callback function that can be used to compose an egui::PaintCallback for custom WGPU rendering.

The callback is composed of two functions: prepare and paint.

prepare is called every frame before paint, and can use the passed-in wgpu::Device and wgpu::Buffer to allocate or modify GPU resources such as buffers.

paint is called after prepare and is given access to the the wgpu::RenderPass so that it can issue draw commands.

The final argument of both the prepare and paint callbacks is a the [paint_callback_resources][crate::renderer::RenderPass::paint_callback_resources]. paint_callback_resources has the same lifetime as the Egui render pass, so it can be used to store buffers, pipelines, and other information that needs to be accessed during the render pass.

Example

See the custom3d_glow demo source for a detailed usage example.

Implementations

impl CallbackFn

pub fn new() -> Self

pub fn prepare<F>(self, prepare: F) -> Self

where F: Fn(&Device, &Queue, &mut TypeMap) + Sync + Send + 'static,

Set the prepare callback

pub fn paint<F>(self, paint: F) -> Self

where F: for<'a, 'b> Fn(PaintCallbackInfo, &'a mut RenderPass<'b>, &'b TypeMap) + Sync + Send + 'static,

Set the paint callback

Trait Implementations

impl Default for CallbackFn

fn default() -> Self

Returns the “default value” for a type.