Struct Renderer 

pub struct Renderer { /* private fields */ }

The wgpu renderer. Consumes scene deltas; owns only derived GPU/CPU caches.

Implementations

impl Renderer

pub fn new( device: Device, queue: Queue, format: TextureFormat, options: RendererOptions, ) -> Result<Self, RenderError>

Create a renderer drawing into targets of format.

The device should be created with limits no larger than [wgpu::Limits::downlevel_webgl2_defaults] needs; the renderer uses only WebGL2-compatible features on every backend.

Errors

RenderError::Font if the bundled font fails to load (never expected).

pub fn device(&self) -> &Device

The device.

pub fn queue(&self) -> &Queue

The queue.

pub fn format(&self) -> TextureFormat

Target format.

pub fn sample_count(&self) -> u32

MSAA sample count in use.

pub fn apply_delta_bytes(&mut self, bytes: &[u8]) -> Result<(), RenderError>

Apply a binary scene delta (dotloom-scene format).

Errors

RenderError::Scene for malformed input; the scene is left unchanged.

pub fn apply_delta(&mut self, delta: SceneDelta)

Apply a decoded scene delta.

pub fn scene(&self) -> &SceneCache

The scene cache.

pub fn set_view(&mut self, view: View) -> Result<(), RenderError>

Set the camera.

Errors

RenderError::InvalidView for non-finite or out-of-range values.

pub fn view(&self) -> View

Current camera.

pub fn set_theme(&mut self, theme: Theme)

Set colors (rebuilds cached geometry).

pub fn theme(&self) -> &Theme

Current theme.

pub fn set_grid(&mut self, grid: Grid)

Set grid settings.

pub fn set_overlay(&mut self, overlay: Overlay)

Set the interaction overlay.

pub fn set_hover(&mut self, id: Option<u64>)

Highlight one item as hovered (drawn on top as feedback).

pub fn last_stats(&self) -> FrameStats

Statistics of the last frame.

pub fn render(&mut self, target: &Texture) -> Result<FrameStats, RenderError>

Draw one frame into target (its size defines the viewport in device pixels).

Errors

RenderError::Disposed after Renderer::dispose.

pub fn dispose(&mut self)

Release all GPU resources now (buffers, textures). The renderer cannot draw afterwards. Dropping the renderer also releases them.

pub fn is_disposed(&self) -> bool

Whether Renderer::dispose was called.

Trait Implementations

impl Debug for Renderer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.