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

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

Implementations§

source§

impl<B: Backend> Renderer<B>

source

pub fn new(backend: B, default_font: Font, default_text_size: Pixels) -> Self

Creates a new Renderer from the given Backend.

source

pub fn backend(&self) -> &B

Returns a reference to the Backend of the Renderer.

source

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

Enqueues the given Primitive in the Renderer for drawing.

source

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

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

source

pub fn start_layer(&mut self) -> Vec<Primitive<B::Primitive>>

Starts recording a new layer.

source

pub fn end_layer( &mut self, primitives: Vec<Primitive<B::Primitive>>, bounds: Rectangle )

Ends the recording of a layer.

source

pub fn start_transformation(&mut self) -> Vec<Primitive<B::Primitive>>

Starts recording a translation.

source

pub fn end_transformation( &mut self, primitives: Vec<Primitive<B::Primitive>>, transformation: Transformation )

Ends the recording of a translation.

Trait Implementations§

source§

impl<B: Debug + Backend> Debug for Renderer<B>
where B::Primitive: Debug,

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Draws the primitives recorded in the given closure in a new layer. Read more
source§

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

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

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

Fills a Quad with the provided Background.
source§

fn clear(&mut self)

Clears all of the recorded primitives in the Renderer.
source§

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

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

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

source§

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

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

fn draw(&mut self, handle: Handle, color: Option<Color>, bounds: Rectangle)

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

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
source§

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

Returns the dimensions of an image for the given Handle.
source§

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

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

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

§

type Font = Font

The font type used.
§

type Paragraph = Paragraph

The Paragraph of this Renderer.
§

type Editor = Editor

The Editor of this Renderer.
source§

const ICON_FONT: Font = _

The icon font of the backend.
source§

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

The char representing a ✔ icon in the ICON_FONT.
source§

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

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

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

Returns the default Self::Font.
source§

fn default_size(&self) -> Pixels

Returns the default size of Text.
source§

fn load_font(&mut self, bytes: Cow<'static, [u8]>)

Loads a Self::Font from its bytes.
source§

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

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

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.
source§

fn fill_text( &mut self, text: Text<'_, Self::Font>, position: Point, color: Color, clip_bounds: Rectangle )

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

Auto Trait Implementations§

§

impl<B> !RefUnwindSafe for Renderer<B>

§

impl<B> Send for Renderer<B>
where B: Send, <B as Backend>::Primitive: Sync + Send,

§

impl<B> Sync for Renderer<B>
where B: Sync, <B as Backend>::Primitive: Sync + Send,

§

impl<B> Unpin for Renderer<B>
where B: Unpin, <B as Backend>::Primitive: Unpin,

§

impl<B> !UnwindSafe for Renderer<B>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> MaybeSend for T
where T: Send,

source§

impl<T> MaybeSync for T
where T: Sync,