Struct Renderer 

pub struct Renderer { /* private fields */ }

GPU renderer that draws a RenderFrame using seven shader pipelines.

Implementations

impl Renderer

pub fn new(device: Device, queue: Queue, surface_format: TextureFormat) -> Self

Create a new renderer from an existing wgpu device and queue. It installs the device’s lost-device latch: a device shared by several renderers opens one latch where it is opened and builds each renderer with with_device_health.

pub fn with_device_health( device: Device, queue: Queue, surface_format: TextureFormat, health: DeviceHealth, ) -> Self

new, on a device whose lost-device latch health is, installed once where the device was opened. Renderers built with one latch and drawn on one thread share their live pictures’ uploads: one whose texture lacks a commit another already holds copies that texture on the device rather than upload the frame again.

pub fn upload_atlas(&mut self, width: u32, height: u32, pixels: &[u8])

Upload atlas texture data from the text backend.

pub fn render( &mut self, frame: &RenderFrame, view: &TextureView, scale_factor: f32, viewport_width: u32, viewport_height: u32, clear_color: [f32; 4], )

Render a frame to the given surface texture view.

Live pictures first: the live pass uploads what this window’s textures lack, under each source’s lock, without waiting longer than about one refresh for a producer.

pub fn render_capture( &mut self, frame: &RenderFrame, view: &TextureView, scale_factor: f32, viewport_width: u32, viewport_height: u32, clear_color: [f32; 4], )

render for a screenshot: the frame as the window’s next one will show it. Each live picture shows its latest commit, whatever a producer’s lock or a pause says, and every band of a large frame is written before the draw. It counts as a capture, not as a frame drawn, and tells no producer its frame was displayed.

pub fn live_texture_stats(&self) -> LiveTextureStats

What this renderer holds and did for live pictures.

pub fn live_texture_timings(&self) -> LiveImageTimings

How long the live pass has taken: one render’s pass for a frame that draws a live picture, each hold of a source’s lock, and each upload’s delay from its commit, each over its latest 1,024 samples. In debug builds and with the live-image-timings feature.

pub fn device(&self) -> &Device

pub fn queue(&self) -> &Queue

pub fn register_image( &mut self, name: &str, width: u32, height: u32, pixels: &[u8], )

Register an image for rendering by name.

pub fn remove_image(&mut self, name: &str)

Remove a registered image.

Trait Implementations

impl Drop for Renderer

fn drop(&mut self)

Every texture this renderer holds goes with it: a window closing frees its live textures without waiting for another window’s frame.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.