Struct iced::pure::widget::canvas::Frame

pub struct Frame { /* private fields */ }

Available on crate feature pure only.

The frame of a Canvas.

Implementations

impl Frame

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

Available on crate feature 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

Available on crate feature canvas only.

Returns the width of the Frame.

pub fn height(&self) -> f32

Available on crate feature canvas only.

Returns the height of the Frame.

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

Available on crate feature canvas only.

Returns the dimensions of the Frame.

pub fn center(&self) -> Point

Available on crate feature canvas only.

Returns the coordinate of the center of the Frame.

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

Available on crate feature 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>
)

Available on crate feature 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<'a>(&mut self, path: &Path, stroke: impl Into<Stroke<'a>>)

Available on crate feature 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>)

Available on crate feature 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))

Available on crate feature 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 with_clip(&mut self, region: Rectangle<f32>, f: impl FnOnce(&mut Frame))

Available on crate feature canvas only.

Executes the given drawing operations within a Rectangle region, clipping any geometry that overflows its bounds. Any transformations performed are local to the provided closure.

This method is useful to perform drawing operations that need to be clipped.

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

Available on crate feature canvas only.

Applies a translation to the current transform of the Frame.

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

Available on crate feature canvas only.

Applies a rotation to the current transform of the Frame.

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

Available on crate feature canvas only.

Applies a scaling to the current transform of the Frame.

pub fn into_geometry(self) -> Geometry

Available on crate feature canvas only.

Produces the Geometry representing everything drawn on the Frame.