Struct nannou::draw::renderer::Renderer

pub struct Renderer { /* fields omitted */ }

A helper type aimed at simplifying the rendering of conrod primitives via wgpu.

Implementations

impl Renderer

pub const DEFAULT_DEPTH_FORMAT: TextureFormat

The default depth format

pub const DEFAULT_GLYPH_CACHE_SIZE: [u32; 2]

The default size for the inner glyph cache.

pub const DEFAULT_GLYPH_CACHE_SCALE_TOLERANCE: f32

The default scale tolerance for the glyph cache.

pub const DEFAULT_GLYPH_CACHE_POSITION_TOLERANCE: f32

The default position tolerance for the glyph cache.

pub const GLYPH_CACHE_TEXTURE_FORMAT: TextureFormat

The texture format of the inner glyph cache.

pub const INDEX_FORMAT: IndexFormat

The index format used to index into vertices.

pub fn new(
    device: &Device,
    output_attachment_size: [u32; 2],
    output_scale_factor: f32,
    sample_count: u32,
    output_color_format: TextureFormat,
    depth_format: TextureFormat,
    glyph_cache_size: [u32; 2],
    glyph_cache_scale_tolerance: f32,
    glyph_cache_position_tolerance: f32
) -> Self

Create a new Renderer, ready to target an output attachment with the given size, sample count and color format.

See the RendererBuilder type for a simplified approach to building a renderer that will fall back to a set of reasonable defaults.

The depth_format will be used to construct a depth texture for depth testing.

The glyph_cache_size will be used to create a texture on which glyphs will be stored for efficient look-up.

pub fn clear(&mut self)

Clear all pending render commands vertex data.

pub fn fill(
    &mut self,
    device: &Device,
    draw: &Draw,
    scale_factor: f32,
    output_attachment_size: [u32; 2]
)

Generate a list of RenderCommands from the given Draw instance and prepare any necessary vertex data.

Note that the given Draw instance will be drained of its commands.

pub fn encode_render_pass(
    &mut self,
    device: &Device,
    encoder: &mut CommandEncoder,
    draw: &Draw,
    scale_factor: f32,
    output_attachment_size: [u32; 2],
    output_attachment: &TextureView,
    resolve_target: Option<&TextureView>
)

Encode a render pass with the given Drawing to the given output_attachment.

If the Drawing has been scaled for handling DPI, specify the necessary scale_factor for scaling back to the output_attachment_size (physical dimensions).

If the output_attachment is multisampled and should be resolved to another texture, include the resolve_target.

pub fn render_to_texture(
    &mut self,
    device: &Device,
    encoder: &mut CommandEncoder,
    draw: &Draw,
    texture: &Texture
)

Encode the necessary commands to render the contents of the given Drawing to the given Texture.

pub fn render_to_frame(
    &mut self,
    device: &Device,
    draw: &Draw,
    scale_factor: f32,
    frame: &Frame<'_>
)

Encode the necessary commands to render the contents of the given Drawing to the given Frame.

Trait Implementations

impl Debug for Renderer

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

Formats the value using the given formatter.