verdant 0.5.2

A windowing and rendering library, inspired by Processing. Clean API, SDF-based rendering, multi-window support, built on wgpu and winit.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
use crate::{canvas::RenderSurface, image::Image, text::{RichText, Text}, transform::Transform2d, types::Color, vec::Vec2};

/// Trait for types that can draw themselves onto a [`RenderSurface`].
pub trait Drawable {
    /// Draws this shape onto the given window.
    fn draw(&self, window: &mut impl RenderSurface);

    /// Draws this shape onto the given window at the given position.
    /// Transforms are still applied.
    fn draw_at(&self, window: &mut impl RenderSurface, x: f32, y: f32);
}

/// The scaling mode for outlines and corner radii.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub enum ScalingMode {
    /// Scales with both local transforms and camera zoom, behaving like physical geometry.
    /// The default.
    #[default]
    Geometric,

    /// Stays at a constant screen pixel size, completely unaffected by zoom or transforms.
    Constant,

    /// Scales only with local transforms, remaining unaffected by view scaling.
    WithTransform,

    /// Scales only with view scaling, remaining unaffected by local transforms.
    WithView,
}

#[derive(Debug, Clone, Copy)]
pub struct Style {
    /// The fill color of this shape.
    pub fill_color: Color,

    /// The outline color of this shape.
    pub outline_color: Color,
    /// The outline width of this shape.
    pub outline_width: f32,
    /// How the outline of this shape scales with local transform and zoom (default: None).
    pub outline_scaling: ScalingMode,

    /// The corner radius of this shape.
    pub corner_radius: f32,
    /// How the corner radius of this shape scales with local transform and zoom (default: None).
    pub corner_scaling: ScalingMode,
}

impl Default for Style {
    fn default() -> Self {
        Self {
            fill_color: Color::WHITE,

            outline_color: Color::default(),
            outline_width: f32::default(),
            outline_scaling: ScalingMode::default(),

            corner_radius: f32::default(),
            corner_scaling: ScalingMode::default(),
        }
    }
}

impl Style {
    /// Sets the fill color.
    pub fn fill(&mut self, color: Color) -> Self {
        self.fill_color = color;
        *self
    }

    /// Sets the outline color.
    pub fn outline_color(&mut self, color: Color) -> Self {
        self.outline_color = color;
        *self
    }

    /// Sets the outline width.
    pub fn outline_width(&mut self, width: f32) -> Self {
        self.outline_width = width;
        *self
    }

    /// Sets the outline scaling mode.
    pub fn outline_scaling(&mut self, scaling: ScalingMode) -> Self {
        self.outline_scaling = scaling;
        *self
    }

    /// Sets the outline color and width.
    pub fn outline(&mut self, color: Color, width: f32) -> Self {
        self.outline_color = color;
        self.outline_width = width;
        *self
    }

    /// Sets the outline color, width, and scaling mode.
    pub fn outline_style(&mut self, color: Color, width: f32, scaling: ScalingMode) -> Self {
        self.outline_color = color;
        self.outline_width = width;
        self.outline_scaling = scaling;
        *self
    }

    /// Sets the corner radius.
    pub fn corner_radius(&mut self, radius: f32) -> Self {
        self.corner_radius = radius;
        *self
    }

    /// Sets the corner scaling mode.
    pub fn corner_scaling(&mut self, scaling: ScalingMode) -> Self {
        self.corner_scaling = scaling;
        *self
    }

    /// Sets the corner radius and scaling mode.
    pub fn corner_style(&mut self, radius: f32, scaling: ScalingMode) -> Self {
        self.corner_radius = radius;
        self.corner_scaling = scaling;
        *self
    }
}

macro_rules! impl_new {
    ($name:ident) => {
        impl $name {
            #[doc = concat!("Creates a fully specified [`", stringify!($name), "`] with position, size, style, and transform.")]
            pub fn new(
                position: Vec2,
                size: Vec2,
                style: Style,
                transform: Transform2d,
            ) -> Self {
                Self {
                    position,
                    size,
                    style,
                    transform,
                }
            }
        }
    };
}

macro_rules! impl_position {
    ($name:ident, $map:expr) => {
        impl $name {
            #[doc = concat!("Creates a [`", stringify!($name), "`] at `(x, y)` with nothing else set.")]
            pub fn at(x: f32, y: f32) -> Self {
                Self {
                    position: Vec2 { x, y },
                    ..Default::default()
                }
            }

            #[doc = concat!("Sets the position of this [`", stringify!($name), "`].")]
            pub fn position(&mut self, x: f32, y: f32) -> Self {
                self.position = Vec2 { x, y };
                $map(self)
            }
        }
    };
    (no_at, $name:ident, $map:expr) => {
        impl $name {
            #[doc = concat!("Sets the position of this [`", stringify!($name), "`].")]
            pub fn position(&mut self, x: f32, y: f32) -> Self {
                self.position = Vec2 { x, y };
                $map(self)
            }
        }
    };
}

macro_rules! impl_size {
    ($name:ident, $map:expr) => {
        impl $name {
            #[doc = concat!("Sets the size of this [`", stringify!($name), "`].")]
            pub fn size(&mut self, width: f32, height: f32) -> Self {
                self.size = Vec2::new(width, height);
                $map(self)
            }
        }
    };
}

macro_rules! impl_styled {
    ($name:ident, $map:expr) => {
        impl $name {
            #[doc = concat!("Sets the fill color of this [`", stringify!($name), "`].")]
            pub fn fill(&mut self, color: Color) -> Self {
                self.style.fill_color = color;
                $map(self)
            }

            #[doc = concat!("Sets the outline color of this [`", stringify!($name), "`].")]
            pub fn outline_color(&mut self, color: Color) -> Self {
                self.style.outline_color = color;
                $map(self)
            }

            #[doc = concat!("Sets the outline width of this [`", stringify!($name), "`].")]
            pub fn outline_width(&mut self, width: f32) -> Self {
                self.style.outline_width = width;
                $map(self)
            }

            #[doc = concat!("Sets the outline color and width of this [`", stringify!($name), "`].")]
            pub fn outline(&mut self, color: Color, width: f32) -> Self {
                self.style.outline(color, width);
                $map(self)
            }

            #[doc = concat!("Sets the outline scaling mode of this [`", stringify!($name), "`].")]
            pub fn outline_scaling(&mut self, scaling: ScalingMode) -> Self {
                self.style.outline_scaling = scaling;
                $map(self)
            }

            #[doc = concat!("Sets the outline color, width, and scaling mode of this [`", stringify!($name), "`].")]
            pub fn outline_style(&mut self, color: Color, width: f32, scaling: ScalingMode) -> Self {
                self.style.outline_style(color, width, scaling);
                $map(self)
            }
        }
    };
    ($name:ident, no_outline, $map:expr) => {
        impl $name {
            #[doc = concat!("Sets the fill color of this [`", stringify!($name), "`].")]
            pub fn fill(&mut self, color: Color) -> Self {
                self.style.fill_color = color;
                $map(self)
            }
        }
    };
}

macro_rules! impl_rounded {
    ($name:ident, $map:expr) => {
        impl $name {
            #[doc = concat!("Sets the corner radius of this [`", stringify!($name), "`].")]
            pub fn corner_radius(&mut self, radius: f32) -> Self {
                self.style.corner_radius = radius;
                *self
            }

            #[doc = concat!("Sets the corner scaling mode of this [`", stringify!($name), "`].")]
            pub fn corner_scaling(&mut self, scaling: ScalingMode) -> Self {
                self.style.corner_scaling = scaling;
                *self
            }

            #[doc = concat!("Sets the corner radius and scaling mode of this [`", stringify!($name), "`].")]
            pub fn corner_style(&mut self, radius: f32, scaling: ScalingMode) -> Self {
                self.style.corner_style(radius, scaling);
                *self
            }
        }
    };
}

macro_rules! impl_transformed {
    ($name:ident, $map:expr) => {
        impl $name {
            #[doc = concat!("Sets the transform of this [`", stringify!($name), "`].")]
            pub fn transform(&mut self, transform: Transform2d) -> Self {
                self.transform = transform;
                $map(self)
            }
        }
    };
}

#[derive(Debug, Clone, Copy, Default)]
pub struct Rect {
    pub position: Vec2,
    pub size: Vec2,
    pub style: Style,
    pub transform: Transform2d,
}

impl_new!(Rect);
impl_position!(Rect, |s: &mut Rect| *s);
impl_size!(Rect, |s: &mut Rect| *s);
impl_styled!(Rect, |s: &mut Rect| *s);
impl_rounded!(Rect, |s: &mut Rect| *s);
impl_transformed!(Rect, |s: &mut Rect| *s);

impl Drawable for Rect {
    fn draw(&self, window: &mut impl RenderSurface) {
        self.draw_at(window, self.position.x, self.position.y);
    }

    fn draw_at(&self, window: &mut impl RenderSurface, x: f32, y: f32) {
        window.with_style(|window| {
            window.with_transform(
                self.transform
                    .then(Transform2d::translation(x, y)),
                |window| {
                    window.fill(self.style.fill_color);
                    window.outline_color(self.style.outline_color);
                    window.outline_width(self.style.outline_width);
                    window.corner_radius(self.style.corner_radius);
                    window.rect(0., 0., self.size.x, self.size.y);
                }
            );
        });
    }
}

#[derive(Debug, Clone, Copy, Default)]
pub struct Ellipse {
    pub position: Vec2,
    pub size: Vec2,
    pub style: Style,
    pub transform: Transform2d,
}

impl_new!(Ellipse);
impl_position!(Ellipse, |s: &mut Ellipse| *s);
impl_size!(Ellipse, |s: &mut Ellipse| *s);
impl_styled!(Ellipse, |s: &mut Ellipse| *s);
impl_transformed!(Ellipse, |s: &mut Ellipse| *s);

impl Drawable for Ellipse {
    fn draw(&self, window: &mut impl RenderSurface) {
        self.draw_at(window, self.position.x, self.position.y);
    }

    fn draw_at(&self, window: &mut impl RenderSurface, x: f32, y: f32) {
        window.with_style(|window| {
            window.with_transform(
                self.transform
                    .then(Transform2d::translation(x, y)),
                |window| {
                    window.fill(self.style.fill_color);
                    window.outline_color(self.style.outline_color);
                    window.outline_width(self.style.outline_width);
                    window.ellipse(0., 0., self.size.x, self.size.y);
                }
            );
        });
    }
}

#[derive(Debug, Clone, Copy, Default)]
pub struct Line {
    pub start: Vec2,
    pub end: Vec2,
    pub style: Style,
    pub transform: Transform2d,
}

impl Line {
    /// Creates a fully specified [`Line`] with start point, end point, style, and transform.
    pub fn new(
        start: Vec2,
        end: Vec2,
        outline_width: f32,
        outline_color: Color,
        transform: Transform2d,
    ) -> Self {
        Self {
            start,
            end,
            style: Style { outline_width, outline_color, ..Default::default() },
            transform,
        }
    }

    /// Creates a [`Line`] between two points.
    pub fn between(x1: f32, y1: f32, x2: f32, y2: f32) -> Self {
        Self {
            start: Vec2::new(x1, y1),
            end: Vec2::new(x2, y2),
            ..Default::default()
        }
    }

    /// Sets the start point of this [`Line`].
    pub fn start(&mut self, x: f32, y: f32) -> Self {
        self.start = Vec2 { x, y };
        *self
    }

    /// Sets the end point of this [`Line`].
    pub fn end(&mut self, x: f32, y: f32) -> Self {
        self.end = Vec2 { x, y };
        *self
    }

    /// Sets the start and end points of this [`Line`].
    pub fn points(&mut self, x1: f32, y1: f32, x2: f32, y2: f32) -> Self {
        self.start = Vec2::new(x1, y1);
        self.end = Vec2::new(x2, y2);
        *self
    }

    /// Sets the color of this [`Line`].
    pub fn color(&mut self, color: Color) -> Self {
        self.style.outline_color = color;
        *self
    }

    /// Sets the width of this [`Line`].
    pub fn width(&mut self, width: f32) -> Self {
        self.style.outline_width = width;
        *self
    }

    /// Sets the color and width of this [`Line`].
    pub fn style(&mut self, color: Color, width: f32) -> Self {
        self.style.outline_color = color;
        self.style.outline_width = width;
        *self
    }
}

impl Drawable for Line {
    fn draw(&self, window: &mut impl RenderSurface) {
        self.draw_at(window, self.start.x, self.start.y);
    }

    /// Draws this line onto the given window at the given position, relative to the starting point.
    fn draw_at(&self, window: &mut impl RenderSurface, x: f32, y: f32) {
        let offset = self.end - self.start;
        window.with_style(|window| {
            window.with_transform(
                self.transform
                    .then(Transform2d::translation(x, y)),
                |window| {
                    window.outline(self.style.outline_color, self.style.outline_width);
                    window.line(0., 0., offset.x, offset.y);
                }
            );
        });
    }
}

#[derive(Debug, Clone)]
pub struct ImageRect {
    pub position: Vec2,
    pub size: Vec2,
    pub color: Color,
    pub image: Image,
    pub transform: Transform2d,
}

// `.clone()` here is fine, because it's just cloning an `Arc` and everything else is `Copy`
impl_position!(no_at, ImageRect, |s: &mut ImageRect| s.clone());
impl_size!(ImageRect, |s: &mut ImageRect| s.clone());
impl_transformed!(ImageRect, |s: &mut ImageRect| s.clone());

impl ImageRect {
    /// Creates a fully specified [`ImageRect`] with start point, end point, color, image, and transform.
    pub fn new(
        position: Vec2,
        size: Vec2,
        color: Color,
        image: Image,
        transform: Transform2d,
    ) -> Self {
        Self {
            position,
            size,
            color,
            image,
            transform,
        }
    }

    /// Creates a [`ImageRect`] with a given image.
    pub fn from_image(image: Image) -> Self {
        Self {
            position: Vec2::default(),
            size: Vec2::default(),
            color: Color::WHITE,
            image,
            transform: Transform2d::default(),
        }
    }

    /// Sets the image displayed by this [`ImageRect`].
    pub fn image(&mut self, image: Image) -> Self {
        self.image = image;
        self.clone()
    }

    /// Sets the color of this [`ImageRect`].
    pub fn color(&mut self, color: Color) -> Self {
        self.color = color;
        self.clone()
    }
}

impl Drawable for ImageRect {
    fn draw(&self, window: &mut impl RenderSurface) {
        self.draw_at(window, self.position.x, self.position.y);
    }

    fn draw_at(&self, window: &mut impl RenderSurface, x: f32, y: f32) {
        window.with_style(|window| {
            window.with_transform(
                self.transform
                    .then(Transform2d::translation(x, y)),
                |window| {
                    window.fill(self.color);
                    window.image(&self.image, 0., 0., self.size.x, self.size.y);
                }
            );
        });
    }
}

// `.clone()` here is fine, because it's just cloning an `Arc` and everything else is `Copy`
impl_position!(no_at, Text, |s: &mut Text| s.clone());
impl_transformed!(Text, |s: &mut Text| s.clone());

impl_position!(no_at, RichText, |s: &mut RichText| s.clone());
impl_transformed!(RichText, |s: &mut RichText| s.clone());