Struct iced_graphics::Renderer

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

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 a reference to the Backend of the Renderer.

pub fn backend_mut(&mut self) -> &mut B

Returns a mutable reference to the Backend 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> Debugger for Renderer<B> where
    B: Backend, 

fn explain<Message>(
    &mut self,
    defaults: &Defaults,
    widget: &dyn Widget<Message, Self>,
    layout: Layout<'_>,
    cursor_position: Point,
    color: Color
) -> Self::Output

Explains the [Layout] of an [Element] for debugging purposes.

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

type Output = (Primitive, Interaction)

The type of output of the [Renderer].

type Defaults = Defaults

The default styling attributes of the [Renderer].

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

Lays out the elements of a user interface.

fn overlay(
    &mut self,
    (base_primitive, base_cursor): (Primitive, Interaction),
    (overlay_primitives, overlay_cursor): (Primitive, Interaction),
    overlay_bounds: Rectangle
) -> (Primitive, Interaction)

Overlays the overlay output with the given bounds on top of the base output.

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

type Style = Style

The [Menu] style supported by this renderer.

fn decorate(
    &mut self,
    bounds: Rectangle,
    _cursor_position: Point,
    style: &Style,
    (primitives, mouse_cursor): Self::Output
) -> Self::Output

Decorates a the list of options of a [Menu].

fn draw<T: ToString>(
    &mut self,
    bounds: Rectangle,
    cursor_position: Point,
    options: &[T],
    hovered_option: Option<usize>,
    padding: u16,
    text_size: u16,
    font: Font,
    style: &Style
) -> Self::Output

Draws the list of options of a [Menu].

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

type Style = Box<dyn StyleSheet>

The style supported by this renderer.

const DEFAULT_HEIGHT: u16

The default height of a [ProgressBar].

fn draw(
    &self,
    bounds: Rectangle,
    range: RangeInclusive<f32>,
    value: f32,
    style_sheet: &Self::Style
) -> Self::Output

Draws a [ProgressBar].

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

type Style = Box<dyn StyleSheet>

The style supported by this renderer.

const DEFAULT_SIZE: u16

The default size of a [Radio] button.

const DEFAULT_SPACING: u16

The default spacing of a [Radio] button.

fn draw(
    &mut self,
    bounds: Rectangle,
    is_selected: bool,
    is_mouse_over: bool,
    (label, _): Self::Output,
    style_sheet: &Self::Style
) -> Self::Output

Draws a [Radio] button.

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

type Style = Box<dyn StyleSheet>

The style supported by this renderer.

const DEFAULT_HEIGHT: u16

The default height of a [Slider].

fn draw(
    &mut self,
    bounds: Rectangle,
    cursor_position: Point,
    range: RangeInclusive<f32>,
    value: f32,
    is_dragging: bool,
    style_sheet: &Self::Style
) -> Self::Output

Draws a [Slider].

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

type Style = Box<dyn StyleSheet>

The style supported by this renderer.

fn measure_value(&self, value: &str, size: u16, font: Font) -> f32

Returns the width of the value of the [TextInput].

fn offset(
    &self,
    text_bounds: Rectangle,
    font: Font,
    size: u16,
    value: &Value,
    state: &State
) -> f32

Returns the current horizontal offset of the value of the [TextInput].

fn draw(
    &mut self,
    bounds: Rectangle,
    text_bounds: Rectangle,
    cursor_position: Point,
    font: Font,
    size: u16,
    placeholder: &str,
    value: &Value,
    state: &State,
    style_sheet: &Self::Style
) -> Self::Output

Draws a [TextInput].

fn find_cursor_position(
    &self,
    text_bounds: Rectangle<f32>,
    font: Self::Font,
    size: Option<u16>,
    value: &Value,
    state: &State,
    x: f32
) -> usize

Computes the position of the text cursor at the given X coordinate of a [TextInput].

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

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

Returns the dimensions of an [Image] located on the given path.

fn draw(&mut self, handle: Handle, layout: Layout<'_>) -> Self::Output

Draws an [Image].

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

type Style = Box<dyn StyleSheet>

The [PickList] style supported by this renderer.

const DEFAULT_PADDING: u16

The default padding of a [PickList].

fn menu_style(style: &Box<dyn StyleSheet>) -> Style

Returns the style of the [Menu] of the [PickList].

fn draw(
    &mut self,
    bounds: Rectangle,
    cursor_position: Point,
    selected: Option<String>,
    padding: u16,
    text_size: u16,
    font: Font,
    style: &Box<dyn StyleSheet>
) -> Self::Output

Draws a [PickList].

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

type Style = Box<dyn StyleSheet>

The style supported by this renderer.

fn draw(
    &mut self,
    bounds: Rectangle,
    style_sheet: &Self::Style,
    is_horizontal: bool
) -> Self::Output

Draws a [Rule].

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

fn draw(&mut self, _bounds: Rectangle) -> Self::Output

Draws an amount of empty [Space].

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, layout: Layout<'_>) -> Self::Output

Draws an [Svg].

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

type Style = Box<dyn StyleSheet>

The style supported by this renderer.

fn draw<Message>(
    &mut self,
    defaults: &Defaults,
    bounds: Rectangle,
    cursor_position: Point,
    style_sheet: &Self::Style,
    content: &Element<'_, Message, Self>,
    content_layout: Layout<'_>
) -> Self::Output

Draws a [Container].

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

type Style = Box<dyn StyleSheet>

The style supported by this renderer.

fn scrollbar(
    &self,
    bounds: Rectangle,
    content_bounds: Rectangle,
    offset: u32
) -> Option<Scrollbar>

Returns the [Scrollbar] given the bounds and content bounds of a [Scrollable].

fn draw(
    &mut self,
    state: &State,
    bounds: Rectangle,
    _content_bounds: Rectangle,
    is_mouse_over: bool,
    is_mouse_over_scrollbar: bool,
    scrollbar: Option<Scrollbar>,
    offset: u32,
    style_sheet: &Self::Style,
    (content, mouse_interaction): Self::Output
) -> Self::Output

Draws the [Scrollable].

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

fn draw<Message>(
    &mut self,
    defaults: &Self::Defaults,
    content: &[Element<'_, Message, Self>],
    layout: Layout<'_>,
    cursor_position: Point
) -> Self::Output

Draws a [Column].

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

type Font = Font

The font type used for [Text].

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 draw(
    &mut self,
    defaults: &Self::Defaults,
    bounds: Rectangle,
    content: &str,
    size: u16,
    font: Font,
    color: Option<Color>,
    horizontal_alignment: HorizontalAlignment,
    vertical_alignment: VerticalAlignment
) -> Self::Output

Draws a [Text] fragment.

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

const DEFAULT_PADDING: u16

The default padding of a [Button].

type Style = Box<dyn StyleSheet>

The style supported by this renderer.

fn draw<Message>(
    &mut self,
    _defaults: &Defaults,
    bounds: Rectangle,
    cursor_position: Point,
    is_disabled: bool,
    is_pressed: bool,
    style: &Box<dyn StyleSheet>,
    content: &Element<'_, Message, Self>,
    content_layout: Layout<'_>
) -> Self::Output

Draws a [Button].

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

type Style = Box<dyn StyleSheet>

The style supported by this renderer.

const DEFAULT_SIZE: u16

The default size of a [Checkbox].

const DEFAULT_SPACING: u16

The default spacing of a [Checkbox].

fn draw(
    &mut self,
    bounds: Rectangle,
    is_checked: bool,
    is_mouse_over: bool,
    (label, _): Self::Output,
    style_sheet: &Self::Style
) -> Self::Output

Draws a [Checkbox].

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

fn draw<Message>(
    &mut self,
    defaults: &Self::Defaults,
    content: &[Element<'_, Message, Self>],
    layout: Layout<'_>,
    cursor_position: Point
) -> Self::Output

Draws a [Row].

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

fn draw<Message>(
    &mut self,
    defaults: &Self::Defaults,
    content: &[(Pane, Content<'_, Message, Self>)],
    dragging: Option<(Pane, Point)>,
    resizing: Option<Axis>,
    layout: Layout<'_>,
    cursor_position: Point
) -> Self::Output

Draws a [PaneGrid].

fn draw_pane<Message>(
    &mut self,
    defaults: &Self::Defaults,
    bounds: Rectangle,
    style_sheet: &Self::Style,
    title_bar: Option<(&TitleBar<'_, Message, Self>, Layout<'_>)>,
    body: (&Element<'_, Message, Self>, Layout<'_>),
    cursor_position: Point
) -> Self::Output

Draws a [Pane].

fn draw_title_bar<Message>(
    &mut self,
    defaults: &Self::Defaults,
    bounds: Rectangle,
    style_sheet: &Self::Style,
    title: &str,
    title_size: u16,
    title_font: Self::Font,
    title_bounds: Rectangle,
    controls: Option<(&Element<'_, Message, Self>, Layout<'_>)>,
    cursor_position: Point
) -> Self::Output

Draws a [TitleBar].

impl<Message, P, B> Widget<Message, Renderer<B>> for Canvas<Message, P> where
    P: Program<Message>,
    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 [Node] of the [Widget].

fn on_event(
    &mut self,
    event: Event,
    layout: Layout<'_>,
    cursor_position: Point,
    messages: &mut Vec<Message>,
    _renderer: &Renderer<B>,
    _clipboard: Option<&dyn Clipboard>
)

Processes a runtime [Event].

fn draw(
    &self,
    _renderer: &mut Renderer<B>,
    _defaults: &Defaults,
    layout: Layout<'_>,
    cursor_position: Point
) -> (Primitive, Interaction)

Draws the [Widget] using the associated Renderer.

fn hash_layout(&self, state: &mut Hasher)

Computes the layout hash of the [Widget].

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

Returns the overlay of the [Element], if there is any.