Struct egui_wgpu_backend::RenderPass

pub struct RenderPass { /* fields omitted */ }

RenderPass to render a egui based GUI.

Implementations

impl RenderPass

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

Creates a new render pass to render a egui UI. output_format needs to be either wgpu::TextureFormat::Rgba8UnormSrgb or wgpu::TextureFormat::Bgra8UnormSrgb. Panics if it's not a Srgb format.

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

Executes the egui render pass. When clear_on_draw is set, the output target will get cleared before writing to it.

pub fn update_texture(
    &mut self,
    device: &Device,
    queue: &Queue,
    egui_texture: &Texture
)

Updates the texture used by egui for the fonts etc. Should be called before execute().

pub fn update_user_textures(&mut self, device: &Device, queue: &Queue)

Updates the user textures that the app allocated. Should be called before execute().

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

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

Trait Implementations

impl TextureAllocator for RenderPass

fn new_texture_srgba_premultiplied(
    &mut self,
    size: (usize, usize),
    pixels: &[Srgba]
) -> TextureId

Allocate a user texture (EXPERIMENTAL!)