Struct iced::widget::canvas::Frame

pub struct Frame { /* fields omitted */ }

This is supported on feature="canvas" or feature="glow_canvas" only.

The frame of a Canvas.

Implementations

impl Frame

pub fn new(size: Size<f32>) -> Frame

This is supported on feature="canvas" or feature="glow_canvas" only.

Creates a new empty Frame with the given dimensions.

The default coordinate system of a Frame has its origin at the top-left corner of its bounds.

pub fn width(&self) -> f32

This is supported on feature="canvas" or feature="glow_canvas" only.

Returns the width of the Frame.

pub fn height(&self) -> f32

This is supported on feature="canvas" or feature="glow_canvas" only.

Returns the width of the Frame.

pub fn size(&self) -> Size<f32>

This is supported on feature="canvas" or feature="glow_canvas" only.

Returns the dimensions of the Frame.

pub fn center(&self) -> Point

This is supported on feature="canvas" or feature="glow_canvas" only.

Returns the coordinate of the center of the Frame.

pub fn fill(&mut self, path: &Path, fill: impl Into<Fill>)

This is supported on feature="canvas" or feature="glow_canvas" only.

Draws the given Path on the Frame by filling it with the provided style.

pub fn fill_rectangle(
    &mut self,
    top_left: Point,
    size: Size<f32>,
    fill: impl Into<Fill>
)

This is supported on feature="canvas" or feature="glow_canvas" only.

Draws an axis-aligned rectangle given its top-left corner coordinate and its Size on the Frame by filling it with the provided style.

pub fn stroke(&mut self, path: &Path, stroke: impl Into<Stroke>)

This is supported on feature="canvas" or feature="glow_canvas" only.

Draws the stroke of the given Path on the Frame with the provided style.

pub fn fill_text(&mut self, text: impl Into<Text>)

This is supported on feature="canvas" or feature="glow_canvas" only.

Draws the characters of the given Text on the Frame, filling them with the given color.

Warning: Text currently does not work well with rotations and scale transforms! The position will be correctly transformed, but the resulting glyphs will not be rotated or scaled properly.

Additionally, all text will be rendered on top of all the layers of a Canvas. Therefore, it is currently only meant to be used for overlays, which is the most common use case.

Support for vectorial text is planned, and should address all these limitations.

pub fn with_save(&mut self, f: impl FnOnce(&mut Frame))

This is supported on feature="canvas" or feature="glow_canvas" only.

Stores the current transform of the Frame and executes the given drawing operations, restoring the transform afterwards.

This method is useful to compose transforms and perform drawing operations in different coordinate systems.

pub fn translate(&mut self, translation: Vector<f32>)

This is supported on feature="canvas" or feature="glow_canvas" only.

Applies a translation to the current transform of the Frame.

pub fn rotate(&mut self, angle: f32)

This is supported on feature="canvas" or feature="glow_canvas" only.

Applies a rotation to the current transform of the Frame.

pub fn scale(&mut self, scale: f32)

This is supported on feature="canvas" or feature="glow_canvas" only.

Applies a scaling to the current transform of the Frame.

pub fn into_geometry(self) -> Geometry

This is supported on feature="canvas" or feature="glow_canvas" only.

Produces the Geometry representing everything drawn on the Frame.

Trait Implementations

impl Debug for Frame

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

Formats the value using the given formatter.