Struct iced_graphics::renderer::Renderer

pub struct Renderer<B: Backend> { /* private fields */ }

A backend-agnostic renderer that supports all the built-in widgets.

Implementations

impl<B: Backend> Renderer<B>

pub fn new(backend: B) -> Self

Creates a new Renderer from the given Backend.

pub fn backend(&self) -> &B

Returns the Backend of the Renderer.

pub fn draw_primitive(&mut self, primitive: Primitive)

Enqueues the given Primitive in the Renderer for drawing.

pub fn with_primitives(&mut self, f: impl FnOnce(&mut B, &[Primitive]))

Runs the given closure with the Backend and the recorded primitives of the Renderer.

Trait Implementations

impl<B: Debug + Backend> Debug for Renderer<B>

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

Formats the value using the given formatter.

impl<B> Renderer for Renderer<B> where
    B: Backend, 

fn layout<'a, Message>(
    &mut self,
    element: &Element<'a, Message, Self>,
    limits: &Limits
) -> Node

Lays out the elements of a user interface.

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_translation(&mut self, translation: Vector, f: impl FnOnce(&mut Self))

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

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.

impl<B> Renderer for Renderer<B> where
    B: Backend + Text, 

type Font = Font

The font type used.

const ICON_FONT: Font = B::ICON_FONT

The icon font of the backend.

const CHECKMARK_ICON: char = B::CHECKMARK_ICON

The char representing a ✔ icon in the ICON_FONT.

const ARROW_DOWN_ICON: char = B::ARROW_DOWN_ICON

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

fn default_size(&self) -> u16

Returns the default size of Text.

fn measure(
    &self,
    content: &str,
    size: u16,
    font: Font,
    bounds: Size
) -> (f32, f32)

Measures the text in the given bounds and returns the minimum boundaries that can fit the contents.

fn hit_test(
    &self,
    content: &str,
    size: f32,
    font: Font,
    bounds: Size,
    point: Point,
    nearest_only: bool
) -> Option<Hit>

Tests whether the provided point is within the boundaries of text laid out with the given parameters, returning information about the nearest character.

fn fill_text(&mut self, text: Text<'_, Self::Font>)

Draws the given Text.

fn measure_width(&self, content: &str, size: u16, font: Self::Font) -> f32

Measures the width of the text as if it were laid out in a single line.

impl<B> Renderer for Renderer<B> where
    B: Backend + Image, 

type Handle = Handle

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

fn dimensions(&self, handle: &Handle) -> (u32, u32)

Returns the dimensions of an image for the given Handle.

fn draw(&mut self, handle: Handle, bounds: Rectangle)

Draws an image with the given Handle and inside the provided bounds.

impl<B> Renderer for Renderer<B> where
    B: Backend + Svg, 

fn dimensions(&self, handle: &Handle) -> (u32, u32)

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

fn draw(&mut self, handle: Handle, bounds: Rectangle)

Draws an SVG with the given Handle and inside the provided bounds.

impl<Message, P, B> Widget<Message, Renderer<B>> for Canvas<Message, P> where
    P: Program<Message>,
    B: Backend, 

Available on crate feature canvas only.

fn width(&self) -> Length

Returns the width of the Widget.

fn height(&self) -> Length

Returns the height of the Widget.

fn layout(&self, _renderer: &Renderer<B>, limits: &Limits) -> Node

Returns the Node of the Widget.

fn on_event(
    &mut self,
    event: Event,
    layout: Layout<'_>,
    cursor_position: Point,
    _renderer: &Renderer<B>,
    _clipboard: &mut dyn Clipboard,
    shell: &mut Shell<'_, Message>
) -> Status

Processes a runtime Event.

fn mouse_interaction(
    &self,
    layout: Layout<'_>,
    cursor_position: Point,
    _viewport: &Rectangle,
    _renderer: &Renderer<B>
) -> Interaction

Returns the current [mouse::Interaction] of the Widget.

fn draw(
    &self,
    renderer: &mut Renderer<B>,
    _style: &Style,
    layout: Layout<'_>,
    cursor_position: Point,
    _viewport: &Rectangle
)

Draws the Widget using the associated Renderer.

fn overlay(
    &mut self,
    _layout: Layout<'_>,
    _renderer: &Renderer
) -> Option<Element<'_, Message, Renderer>>

Returns the overlay of the Widget, if there is any.

impl<'a, Message, B> Widget<Message, Renderer<B>> for QRCode<'a> where
    B: Backend, 

Available on crate feature qr_code only.

fn width(&self) -> Length

Returns the width of the Widget.

fn height(&self) -> Length

Returns the height of the Widget.

fn layout(&self, _renderer: &Renderer<B>, _limits: &Limits) -> Node

Returns the Node of the Widget.

fn draw(
    &self,
    renderer: &mut Renderer<B>,
    _style: &Style,
    layout: Layout<'_>,
    _cursor_position: Point,
    _viewport: &Rectangle
)

Draws the Widget using the associated Renderer.

fn on_event(
    &mut self,
    _event: Event,
    _layout: Layout<'_>,
    _cursor_position: Point,
    _renderer: &Renderer,
    _clipboard: &mut dyn Clipboard,
    _shell: &mut Shell<'_, Message>
) -> Status

Processes a runtime Event.

fn mouse_interaction(
    &self,
    _layout: Layout<'_>,
    _cursor_position: Point,
    _viewport: &Rectangle<f32>,
    _renderer: &Renderer
) -> Interaction

Returns the current [mouse::Interaction] of the Widget.

fn overlay(
    &mut self,
    _layout: Layout<'_>,
    _renderer: &Renderer
) -> Option<Element<'_, Message, Renderer>>

Returns the overlay of the Widget, if there is any.

impl<Message, P, B> Widget<Message, Renderer<B>> for Canvas<Message, P> where
    P: Program<Message>,
    B: Backend, 

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn width(&self) -> Length

Returns the width of the Widget.

fn height(&self) -> Length

Returns the height of the Widget.

fn layout(&self, _renderer: &Renderer<B>, limits: &Limits) -> Node

Returns the layout::Node of the Widget.

fn on_event(
    &mut self,
    tree: &mut Tree,
    event: Event,
    layout: Layout<'_>,
    cursor_position: Point,
    _renderer: &Renderer<B>,
    _clipboard: &mut dyn Clipboard,
    shell: &mut Shell<'_, Message>
) -> Status

Processes a runtime Event.

fn mouse_interaction(
    &self,
    tree: &Tree,
    layout: Layout<'_>,
    cursor_position: Point,
    _viewport: &Rectangle,
    _renderer: &Renderer<B>
) -> Interaction

Returns the current [mouse::Interaction] of the Widget.

fn draw(
    &self,
    tree: &Tree,
    renderer: &mut Renderer<B>,
    _style: &Style,
    layout: Layout<'_>,
    cursor_position: Point,
    _viewport: &Rectangle
)

Draws the Widget using the associated Renderer.

fn children(&self) -> Vec<Tree, Global>

Returns the state Tree of the children of the Widget.

fn diff(&self, _tree: &mut Tree)

Reconciliates the Widget with the provided Tree.

fn overlay(
    &'a self,
    _state: &'a mut Tree,
    _layout: Layout<'_>,
    _renderer: &Renderer
) -> Option<Element<'a, Message, Renderer>>

Returns the overlay of the Widget, if there is any.

impl<'a, Message, B> Widget<Message, Renderer<B>> for QRCode<'a> where
    B: Backend, 

fn width(&self) -> Length

Returns the width of the Widget.

fn height(&self) -> Length

Returns the height of the Widget.

fn layout(&self, renderer: &Renderer<B>, limits: &Limits) -> Node

Returns the layout::Node of the Widget.

fn draw(
    &self,
    _tree: &Tree,
    renderer: &mut Renderer<B>,
    style: &Style,
    layout: Layout<'_>,
    cursor_position: Point,
    viewport: &Rectangle
)

Draws the Widget using the associated Renderer.

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn children(&self) -> Vec<Tree, Global>

Returns the state Tree of the children of the Widget.

fn diff(&self, _tree: &mut Tree)

Reconciliates the Widget with the provided Tree.

fn on_event(
    &mut self,
    _state: &mut Tree,
    _event: Event,
    _layout: Layout<'_>,
    _cursor_position: Point,
    _renderer: &Renderer,
    _clipboard: &mut dyn Clipboard,
    _shell: &mut Shell<'_, Message>
) -> Status

Processes a runtime Event.

fn mouse_interaction(
    &self,
    _state: &Tree,
    _layout: Layout<'_>,
    _cursor_position: Point,
    _viewport: &Rectangle<f32>,
    _renderer: &Renderer
) -> Interaction

Returns the current [mouse::Interaction] of the Widget.

fn overlay(
    &'a self,
    _state: &'a mut Tree,
    _layout: Layout<'_>,
    _renderer: &Renderer
) -> Option<Element<'a, Message, Renderer>>

Returns the overlay of the Widget, if there is any.