Struct egui_wgpu::renderer::RenderPass

pub struct RenderPass { /* private fields */ }

Render pass to render a egui based GUI.

Implementations

impl RenderPass

pub fn new(
    device: &Device,
    output_format: TextureFormat,
    msaa_samples: u32
) -> Self

Creates a new render pass to render a egui UI.

If the format passed is not a *Srgb format, the shader will automatically convert to sRGB colors in the shader.

pub fn execute(
    &self,
    encoder: &mut CommandEncoder,
    color_attachment: &TextureView,
    paint_jobs: &[ClippedPrimitive],
    screen_descriptor: &ScreenDescriptor,
    clear_color: Option<Color>
)

Executes the egui render pass.

pub fn execute_with_renderpass<'rpass>(
    &'rpass self,
    rpass: &mut RenderPass<'rpass>,
    paint_jobs: &[ClippedPrimitive],
    screen_descriptor: &ScreenDescriptor
)

Executes the egui render pass onto an existing wgpu renderpass.

pub fn update_texture(
    &mut self,
    device: &Device,
    queue: &Queue,
    id: TextureId,
    image_delta: &ImageDelta
)

Should be called before execute().

pub fn free_texture(&mut self, id: &TextureId)

Should be called before execute().

pub fn update_buffers(
    &mut self,
    device: &Device,
    queue: &Queue,
    paint_jobs: &[ClippedPrimitive],
    screen_descriptor: &ScreenDescriptor
)

Uploads the uniform, vertex and index data used by the render pass. Should be called before execute().