Skip to main content

Canvas

Struct Canvas 

Source
pub struct Canvas { /* private fields */ }
Expand description

A box a config draws on with paths, arcs, curves and dashed strokes, for progress rings, graphs and audio visualizers.

The paint closure gets a Pen and runs when the canvas is first laid out, when its laid-out size changes, and when a signal it read changes; each run replaces the drawing, and repaints only the canvas’s box. Coordinates are logical pixels from the canvas’s top-left, and the drawing is cut to its box and rounded corners. Size it with its style’s width and height, or let its parent stretch it, as any box. A panic in the closure is logged with the canvas’s path, such as PanelWindow[DP-1]/Row/Canvas[2].paint, and the last drawing stays.

use crabshell_ui::{Canvas, Cap, Color, Path, Point, Stroke, Style};

let charge = cx.signal(0.6_f32);
let ring = Canvas::new(move |pen| {
    let size = pen.size();
    let middle = Point::new(size.width / 2.0, size.height / 2.0);
    let radius = size.width.min(size.height) / 2.0 - 3.0;
    let arc = Path::new().arc(middle, radius, -90.0, 360.0 * charge.get());
    pen.stroke(&arc, &Stroke::new(4.0, Color::hex("#a6e3a1")).cap(Cap::Round));
})
.style(Style::new().width(24.0).height(24.0));

Implementations§

Source§

impl Canvas

Source

pub fn new(paint: impl FnMut(&mut Pen) + 'static) -> Canvas

A canvas paint draws on.

Source

pub fn style(self, style: impl IntoProp<Style>) -> Canvas

Sets the style: its width and height size the canvas, and its background and border are drawn under the drawing.

Source

pub fn visible(self, visible: impl IntoProp<bool>) -> Self

Shows or hides the widget. Hidden, it is taken out of the layout, so its space goes to the others, and it isn’t drawn, hit or reached by Tab; it drops the keyboard focus and the pointer. Its bindings and state stay, so it shows again as it was. Shown by default.

Source

pub fn geometry(self, geometry: Signal<Rect>) -> Self

Shares where the widget is: after each layout that moves or resizes it, its laid-out rectangle in the window’s logical pixels, scrolled with any scroll view around it but not moved by a style’s translate, scale or rotate, is written to geometry. A hidden widget writes nothing. An effect that reads it may change the layout: the window is laid out again at once, until nothing moves.

Trait Implementations§

Source§

impl Widget for Canvas

Source§

fn into_element(self: Box<Self>) -> Element

Turns the description, and everything inside it, into the element the window builds nodes from. It runs when the window is created or a list item first appears, before the window’s tree is touched and without recording what it reads, so it only describes.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Canvas

§

impl !Send for Canvas

§

impl !Sync for Canvas

§

impl !UnwindSafe for Canvas

§

impl Forget for Canvas

§

impl Freeze for Canvas

§

impl Move for Canvas

§

impl Unpin for Canvas

§

impl UnsafeUnpin for Canvas

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more