Enum Renderer

pub enum Renderer<A, B> {
    Primary(A),
    Secondary(B),
}

A renderer A with a fallback strategy B.

This type can be used to easily compose existing renderers and create custom, type-safe fallback strategies.

Variants

Primary(A)

The primary rendering option.

Secondary(B)

The secondary (or fallback) rendering option.

Trait Implementations

impl<A: Debug, B: Debug> Debug for Renderer<A, B>

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

Formats the value using the given formatter.

impl<A, B> Default for Renderer<A, B>

where A: Default, B: Default,

type Compositor = Compositor<<A as Default>::Compositor, <B as Default>::Compositor>

The compositor of the renderer.

impl<A, B> Headless for Renderer<A, B>

where A: Headless, B: Headless,

async fn new( default_font: Font, default_text_size: Pixels, 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<A, B> Renderer for Renderer<A, B>

where A: Renderer, B: Renderer,

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

Fills a [Quad] with the provided [Background].

fn clear(&mut self)

Clears all of the recorded primitives in the [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 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<A, B> Renderer for Renderer<A, B>

where A: Renderer, B: Renderer<Font = A::Font, Paragraph = A::Paragraph, Editor = A::Editor>,

const MONOSPACE_FONT: Self::Font = A::MONOSPACE_FONT

A monospace font.

const ICON_FONT: Self::Font = A::ICON_FONT

The icon font of the backend.

const CHECKMARK_ICON: char = A::CHECKMARK_ICON

The char representing a ✔ icon in the ICON_FONT.

const ARROW_DOWN_ICON: char = A::ARROW_DOWN_ICON

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

type Font = <A as Renderer>::Font

The font type used.

type Paragraph = <A as Renderer>::Paragraph

The [Paragraph] of this [Renderer].

type Editor = <A as Renderer>::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<String, Self::Font>, position: Point, color: Color, clip_bounds: Rectangle, )

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

impl<A, B> Renderer for Renderer<A, B>

where A: Renderer, B: Renderer<Handle = A::Handle>,

type Handle = <A as Renderer>::Handle

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

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

Returns the dimensions of an image for the given [Handle].

fn draw_image(&mut self, image: Image<A::Handle>, bounds: Rectangle)

Draws an Image inside the provided bounds.

impl<A, B> Renderer for Renderer<A, B>

where A: Renderer, B: Renderer,

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)

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

impl<A, B> Renderer for Renderer<A, B>

where A: Renderer, B: Renderer,

fn draw_mesh(&mut self, mesh: Mesh)

Draws the given [Mesh].

impl<A, B> Renderer for Renderer<A, B>

where A: Renderer, B: Renderer,

Available on crate feature wgpu only.

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

Draws a custom primitive.

impl<A, B> Renderer for Renderer<A, B>

where A: Renderer, B: Renderer,

Available on crate feature geometry only.

type Geometry = Geometry<<A as Renderer>::Geometry, <B as Renderer>::Geometry>

The kind of geometry this renderer can draw.

type Frame = Frame<<A as Renderer>::Frame, <B as Renderer>::Frame>

The kind of Frame this renderer supports.

fn new_frame(&self, size: Size) -> Self::Frame

Creates a new Self::Frame.

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

Draws the given Self::Geometry.