Struct Renderer 

pub struct Renderer { /* private fields */ }

A wgpu graphics renderer for iced.

Implementations

impl Renderer

pub fn new(engine: Engine, settings: Settings) -> Self

pub fn draw( &mut self, clear_color: Option<Color>, target: &TextureView, viewport: &Viewport, ) -> CommandEncoder

Record commands that draw the current primitives to the target texture view.

You must call finish and recall when submitting the resulting wgpu::CommandEncoder.

pub fn present( &mut self, clear_color: Option<Color>, _format: TextureFormat, frame: &TextureView, viewport: &Viewport, ) -> SubmissionIndex

pub fn screenshot( &mut self, viewport: &Viewport, background_color: Color, ) -> Vec<u8>

Renders the current surface to an offscreen buffer.

Returns RGBA bytes of the texture data.

pub fn finish(&mut self)

Prepares currently mapped buffers for use in a submission.

Usually, this method is only needed if you are calling Renderer::draw directly, instead of relying on Renderer::present.

You must call this method before submitting the resulting wgpu::CommandEncoder of Renderer::draw to a wgpu::Queue.

pub fn recall(&mut self)

Recalls all of the closed buffers back to be reused.

Usually, this method is only needed if you are calling Renderer::draw directly, instead of relying on Renderer::present to a wgpu::Queue.

You must call this method after submitting the resulting wgpu::CommandEncoder of Renderer::draw to a wgpu::Queue.

Trait Implementations

impl Default for Renderer

type Compositor = Compositor

The compositor of the renderer.

impl Headless for Renderer

async fn new(settings: Settings, backend: Option<&str>) -> Option<Self>

Creates a new Headless renderer;

fn name(&self) -> String

Returns the unique name of the renderer.

fn screenshot( &mut self, size: Size<u32>, scale_factor: f32, background_color: Color, ) -> Vec<u8>

Draws offscreen into a screenshot, returning a collection of bytes representing the rendered pixels in RGBA order.

impl Renderer for Renderer

fn start_layer(&mut self, bounds: Rectangle)

Starts recording a new layer.

fn end_layer(&mut self)

Ends recording a new layer.

fn start_transformation(&mut self, transformation: Transformation)

Starts recording with a new Transformation.

fn end_transformation(&mut self)

Ends recording a new layer.

fn fill_quad(&mut self, quad: Quad, background: impl Into<Background>)

Fills a Quad with the provided Background.

fn allocate_image( &mut self, _handle: &Handle, _callback: impl FnOnce(Result<Allocation, Error>) + Send + 'static, )

Creates an image::Allocation for the given image::Handle and calls the given callback with it.

fn hint(&mut self, scale_factor: f32)

Provides hints to the Renderer about the rendering target.

fn scale_factor(&self) -> Option<f32>

Returns the last scale factor provided as a hint.

fn tick(&mut self)

Polls any concurrent computations that may be pending in the Renderer.

fn reset(&mut self, new_bounds: Rectangle)

Resets the Renderer to start drawing in the new_bounds from scratch.

fn with_layer(&mut self, bounds: Rectangle, f: impl FnOnce(&mut Self))

Draws the primitives recorded in the given closure in a new layer.

fn with_transformation( &mut self, transformation: Transformation, f: impl FnOnce(&mut Self), )

Applies a Transformation to the primitives recorded in the given closure.

fn with_translation(&mut self, translation: Vector, f: impl FnOnce(&mut Self))

Applies a translation to the primitives recorded in the given closure.

impl Renderer for Renderer

const ICON_FONT: Font

The icon font of the backend.

const CHECKMARK_ICON: char = '\u{f00c}'

The char representing a ✔ icon in the ICON_FONT.

const ARROW_DOWN_ICON: char = '\u{e800}'

The char representing a ▼ icon in the built-in ICON_FONT.

const ICED_LOGO: char = '\u{e801}'

The ‘char’ representing the iced logo in the built-in ‘ICON_FONT’.

const SCROLL_UP_ICON: char = '\u{e802}'

The char representing a ^ icon in the built-in ICON_FONT.

const SCROLL_DOWN_ICON: char = '\u{e803}'

The char representing a v icon in the built-in ICON_FONT.

const SCROLL_LEFT_ICON: char = '\u{e804}'

The char representing a < icon in the built-in ICON_FONT.

const SCROLL_RIGHT_ICON: char = '\u{e805}'

The char representing a > icon in the built-in ICON_FONT.

type Font = Font

The font type used.

type Paragraph = Paragraph

The Paragraph of this Renderer.

type Editor = Editor

The Editor of this Renderer.

fn default_font(&self) -> Self::Font

Returns the default Self::Font.

fn default_size(&self) -> Pixels

Returns the default size of Text.

fn fill_paragraph( &mut self, text: &Self::Paragraph, position: Point, color: Color, clip_bounds: Rectangle, )

Draws the given Paragraph at the given position and with the given Color.

fn fill_editor( &mut self, editor: &Self::Editor, position: Point, color: Color, clip_bounds: Rectangle, )

Draws the given Editor at the given position and with the given Color.

fn fill_text( &mut self, text: Text, position: Point, color: Color, clip_bounds: Rectangle, )

Draws the given Text at the given position and with the given Color.

impl Renderer for Renderer

fn fill_raw(&mut self, raw: Raw)

Draws the given Raw text.

impl Renderer for Renderer

Available on crate feature image only.

type Handle = Handle

The image Handle to be displayed. Iced exposes its own default implementation of a Handle

fn load_image(&self, handle: &Self::Handle) -> Result<Allocation, Error>

Loads an image and returns an explicit Allocation to it.

fn measure_image(&self, handle: &Self::Handle) -> Option<Size<u32>>

Returns the dimensions of an image for the given Handle.

fn draw_image( &mut self, image: Image, bounds: Rectangle, clip_bounds: Rectangle, )

Draws an Image inside the provided bounds.

impl Renderer for Renderer

Available on crate feature svg only.

fn measure_svg(&self, handle: &Handle) -> Size<u32>

Returns the default dimensions of an SVG for the given Handle.

fn draw_svg(&mut self, svg: Svg, bounds: Rectangle, clip_bounds: Rectangle)

Draws an SVG with the given Handle, an optional Color filter, and inside the provided bounds.

impl Renderer for Renderer

fn draw_mesh(&mut self, mesh: Mesh)

Draws the given Mesh.

fn draw_mesh_cache(&mut self, cache: Cache)

Draws the given Cache.

impl Renderer for Renderer

Available on crate feature geometry only.

type Geometry = Geometry

The kind of geometry this renderer can draw.

type Frame = Frame

The kind of Frame this renderer supports.

fn new_frame(&self, bounds: Rectangle) -> Self::Frame

Creates a new Self::Frame.

fn draw_geometry(&mut self, geometry: Self::Geometry)

Draws the given Self::Geometry.

impl Renderer for Renderer

fn draw_primitive(&mut self, bounds: Rectangle, primitive: impl Primitive)

Draws a custom primitive.