Struct Renderer 

pub struct Renderer<'a> { /* private fields */ }

Implementations

impl<'a> Renderer<'a>

pub const DEPTH_FORMAT: TextureFormat = TextureFormat::Depth32Float

Format of the depth buffer attached to the main render pass. Pipelines created through Renderer::create_render_pipeline must use this format if they specify a depth state.

pub async fn new(window: Arc<Window>) -> Self

pub fn camera(&self) -> &Camera

pub fn camera_mut(&mut self) -> &mut Camera

pub fn window(&self) -> Arc<Window>

The window this renderer’s surface was created from, as a cheap Arc clone. Useful for consumers that need to integrate other window-aware systems (e.g. egui-winit) and cache the handle for later (e.g. in a Scene::on_window_event, which isn’t handed the renderer).

pub fn device(&self) -> &Device

pub fn queue(&self) -> &Queue

pub fn wgpu_surface_format(&self) -> TextureFormat

The raw wgpu format of the render surface, e.g. for configuring a third-party renderer (like egui-wgpu) that needs to target the same surface. See also Renderer::surface_format for the crate’s own wrapper type.

pub fn size(&self) -> PhysicalSize<u32>

pub fn resize(&mut self, new_size: PhysicalSize<u32>)

pub fn surface_format(&self) -> TextureFormat

pub fn render<T>( &mut self, clear_color: Color, context: &mut T, draw_fn: impl FnOnce(&mut T, &mut DrawPass<'_>), overlay_fn: impl FnOnce(&mut T, &Device, &Queue, &mut CommandEncoder, &TextureView), post_overlay_fn: impl FnOnce(&mut T, &mut DrawPass<'_>), )

Renders one frame: a main pass (color + depth, cleared), an overlay pass (color only, loaded not cleared, no depth test, e.g. egui), then a post-overlay pass (same as the overlay pass but drawn after it, e.g. a custom titlebar that must stay on top of an egui-based editor UI) — all on the same target before it’s submitted and presented.

context is threaded through to all three closures as an explicit parameter, rather than captured from the caller’s environment, so the FnOnces can both reference the same mutable state (e.g. a SceneManager) without the borrow checker seeing two simultaneous unique borrows of it — they run one after another, but as closure values they’d otherwise need to exist at the same time as arguments to this call.

pub fn create_shader_module( &self, desc: &ShaderModuleDescriptor<'_>, ) -> ShaderModule

pub fn create_render_pipeline( &self, desc: &RenderPipelineDescriptor<'_>, ) -> RenderPipeline

pub fn create_buffer_init(&self, desc: &BufferInitDescriptor<'_>) -> Buffer

pub fn create_buffer(&self, desc: &BufferDescriptor<'_>) -> Buffer