quickgui 0.1.6

A damage-driven, GPU-accelerated desktop GUI foundation
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
use super::*;

/// The box an element paints at `x`, if it paints one at all: an unrevealed member has a
/// transparent fill and no border, so the scene holds no quad for it.
fn quad_at(scene: &Scene, x: f32) -> Option<&EdgeQuad> {
    scene
        .edge_quads()
        .iter()
        .find(|quad| quad.rect.x <= x && x < quad.rect.x + quad.rect.width)
}

fn fill_at(scene: &Scene, x: f32) -> Option<Color> {
    quad_at(scene, x).map(|quad| quad.fill)
}

/// The fill of the box painted exactly at `rect`, for nested boxes that share an `x`.
fn fill_of(scene: &Scene, rect: Rect) -> Option<Color> {
    scene
        .edge_quads()
        .iter()
        .find(|quad| quad.rect == rect)
        .map(|quad| quad.fill)
}

#[test]
fn group_hover_paints_members_while_their_group_is_hovered() {
    let row = ElementId::new(120);
    let action = ElementId::new(121);
    let revealed = Color::rgb8(37, 99, 235);
    let own_hover = Color::rgb8(220, 38, 38);
    let declaration = div()
        .id(row)
        .size(200.0, 40.0)
        .flex_row()
        .group()
        .children([
            div().size(160.0, 40.0).flex_none(),
            button()
                .id(action)
                .size(40.0, 40.0)
                .flex_none()
                .clickable()
                .group_hover(|style| style.bg(revealed).rounded(8.0))
                .hover(|style| style.bg(own_hover)),
        ]);
    let viewport = Size::new(200.0, 40.0);
    let now = Instant::now();
    let mut tree = UiTree::new();
    let mut renderer = TestTextLayout;
    let mut scene = Scene::new();

    tree.set_root(declaration, viewport, 1.0, &mut renderer)
        .unwrap();
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    // Nothing is hovered: the action paints no fill at all.
    assert!(quad_at(&scene, 180.0).is_none());
    // The group registers a stateful hit region even though it paints nothing stateful itself.
    assert!(
        tree.hit_regions
            .iter()
            .any(|region| region.id == row && region.stateful)
    );

    // Over the plain label, well away from the action: the group is hovered, so the action
    // reveals itself with the group-hover fill and radius.
    assert!(tree.pointer_moved(Point::new(40.0, 20.0), &mut renderer));
    assert!(tree.hovered.contains(&row));
    assert!(!tree.hovered.contains(&action));
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    let quad = quad_at(&scene, 180.0).expect("a revealed action paints its group-hover fill");
    assert_eq!(quad.fill, revealed);
    assert_eq!(quad.radius, Corners::all(8.0));

    // Over the action itself: its own hover wins the fill it declares, and the group-hover radius
    // it does not declare stays, exactly as `.group:hover .action` and `.action:hover` cascade.
    assert!(tree.pointer_moved(Point::new(180.0, 20.0), &mut renderer));
    assert!(tree.hovered.contains(&row));
    assert!(tree.hovered.contains(&action));
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    let quad = quad_at(&scene, 180.0).expect("a hovered action paints its own fill");
    assert_eq!(quad.fill, own_hover);
    assert_eq!(quad.radius, Corners::all(8.0));

    // The pointer leaves the window: the reveal is withdrawn again.
    assert!(tree.pointer_left());
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    assert!(quad_at(&scene, 180.0).is_none());
}

#[test]
fn group_hover_follows_the_nearest_group_and_moves_transforms() {
    let outer = ElementId::new(130);
    let inner = ElementId::new(131);
    let member = ElementId::new(132);
    let revealed = Color::rgb8(16, 185, 129);
    let declaration = div()
        .id(outer)
        .size(200.0, 40.0)
        .flex_row()
        .group()
        .children([
            div().size(100.0, 40.0).flex_none(),
            div().id(inner).size(100.0, 40.0).flex_row().group().child(
                div()
                    .id(member)
                    .size(40.0, 40.0)
                    .flex_none()
                    .group_hover(|style| style.bg(revealed).translate(0.0, -4.0)),
            ),
        ]);
    let viewport = Size::new(200.0, 40.0);
    let now = Instant::now();
    let mut tree = UiTree::new();
    let mut renderer = TestTextLayout;
    let mut scene = Scene::new();

    tree.set_root(declaration, viewport, 1.0, &mut renderer)
        .unwrap();
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();

    // Inside the outer group but outside the inner one: the member's nearest group is not
    // hovered, so nothing reveals.
    assert!(tree.pointer_moved(Point::new(50.0, 20.0), &mut renderer));
    assert!(tree.hovered.contains(&outer));
    assert!(!tree.hovered.contains(&inner));
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    assert!(quad_at(&scene, 120.0).is_none());

    // Inside the inner group, away from the member: it reveals, lifted by its paint-only
    // translation, and its reported bounds follow the painted pixels.
    assert!(tree.pointer_moved(Point::new(170.0, 20.0), &mut renderer));
    assert!(tree.hovered.contains(&inner));
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    let quad = quad_at(&scene, 120.0).expect("the member reveals inside its nearest group");
    assert_eq!(quad.fill, revealed);
    assert_eq!(quad.rect.y, -4.0);
    assert_eq!(
        tree.element_bounds(member),
        Some(Rect::new(100.0, -4.0, 40.0, 40.0))
    );
}

#[test]
fn named_group_hover_follows_the_named_ancestor_past_nearer_groups() {
    let sidebar = ElementId::new(140);
    let row = ElementId::new(141);
    let direct = ElementId::new(142);
    let named_member = ElementId::new(143);
    let nearest_member = ElementId::new(144);
    let stray = ElementId::new(145);
    let direct_color = Color::rgb8(14, 165, 233);
    let sidebar_color = Color::rgb8(99, 102, 241);
    let row_color = Color::rgb8(245, 158, 11);
    let declaration = div()
        .id(sidebar)
        .size(200.0, 40.0)
        .flex_row()
        .group_named("sidebar")
        .children([
            // A member naming no group follows the nearest one, even when that group is named.
            div()
                .id(direct)
                .size(80.0, 40.0)
                .flex_none()
                .group_hover(|style| style.bg(direct_color)),
            div()
                .id(row)
                .size(120.0, 40.0)
                .flex_row()
                .group()
                .children([
                    div()
                        .id(named_member)
                        .size(40.0, 40.0)
                        .flex_none()
                        .group_hover_named("sidebar", |style| style.bg(sidebar_color)),
                    div()
                        .id(nearest_member)
                        .size(40.0, 40.0)
                        .flex_none()
                        .group_hover(|style| style.bg(row_color)),
                    div()
                        .id(stray)
                        .size(40.0, 40.0)
                        .flex_none()
                        .group_hover_named("toolbar", |style| style.bg(Color::WHITE)),
                ]),
        ]);
    let viewport = Size::new(200.0, 40.0);
    let now = Instant::now();
    let mut tree = UiTree::new();
    let mut renderer = TestTextLayout;
    let mut scene = Scene::new();

    tree.set_root(declaration, viewport, 1.0, &mut renderer)
        .unwrap();
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();

    // Over the sidebar's own member, outside the row: the sidebar is hovered and the row is not,
    // so the direct member and the row member naming the sidebar reveal while the row member
    // following its nearest group does not.
    assert!(tree.pointer_moved(Point::new(40.0, 20.0), &mut renderer));
    assert!(tree.hovered.contains(&sidebar));
    assert!(!tree.hovered.contains(&row));
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    assert_eq!(fill_at(&scene, 40.0), Some(direct_color));
    assert_eq!(fill_at(&scene, 100.0), Some(sidebar_color));
    assert!(quad_at(&scene, 140.0).is_none());
    assert!(quad_at(&scene, 180.0).is_none());

    // Inside the row: both groups are hovered, every member follows its own group, and the member
    // naming a group no ancestor carries still paints nothing.
    assert!(tree.pointer_moved(Point::new(180.0, 20.0), &mut renderer));
    assert!(tree.hovered.contains(&row));
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    assert_eq!(fill_at(&scene, 40.0), Some(direct_color));
    assert_eq!(fill_at(&scene, 100.0), Some(sidebar_color));
    assert_eq!(fill_at(&scene, 140.0), Some(row_color));
    assert!(quad_at(&scene, 180.0).is_none());
}

#[test]
fn several_group_styles_layer_in_declaration_order() {
    let sidebar = ElementId::new(150);
    let row = ElementId::new(151);
    let member = ElementId::new(152);
    let sidebar_color = Color::rgb8(99, 102, 241);
    let row_color = Color::rgb8(245, 158, 11);
    let declaration = div()
        .id(sidebar)
        .size(200.0, 40.0)
        .flex_row()
        .group_named("sidebar")
        .children([
            div().size(80.0, 40.0).flex_none(),
            div().id(row).size(120.0, 40.0).flex_row().group().child(
                // One member follows two groups: the sidebar sets a fill and a radius, the
                // nearer row only a fill.
                div()
                    .id(member)
                    .size(40.0, 40.0)
                    .flex_none()
                    .group_hover_named("sidebar", |style| style.bg(sidebar_color).rounded(6.0))
                    .group_hover(|style| style.bg(row_color)),
            ),
        ]);
    let viewport = Size::new(200.0, 40.0);
    let now = Instant::now();
    let mut tree = UiTree::new();
    let mut renderer = TestTextLayout;
    let mut scene = Scene::new();

    tree.set_root(declaration, viewport, 1.0, &mut renderer)
        .unwrap();
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();

    // Only the sidebar is hovered: its entry alone paints.
    assert!(tree.pointer_moved(Point::new(40.0, 20.0), &mut renderer));
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    let quad = quad_at(&scene, 100.0).expect("the sidebar entry paints");
    assert_eq!(quad.fill, sidebar_color);
    assert_eq!(quad.radius, Corners::all(6.0));

    // Both are hovered: the later row entry wins the fill and the sidebar's radius stays, as two
    // matching CSS rules of equal specificity cascade.
    assert!(tree.pointer_moved(Point::new(170.0, 20.0), &mut renderer));
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    let quad = quad_at(&scene, 100.0).expect("both entries paint");
    assert_eq!(quad.fill, row_color);
    assert_eq!(quad.radius, Corners::all(6.0));
}

#[test]
fn group_active_follows_a_held_press_inside_the_group() {
    let row = ElementId::new(160);
    let trigger = ElementId::new(161);
    let member = ElementId::new(162);
    let hover_color = Color::rgb8(59, 130, 246);
    let active_color = Color::rgb8(29, 78, 216);
    let declaration = div()
        .id(row)
        .size(200.0, 40.0)
        .flex_row()
        .group()
        .children([
            button()
                .id(trigger)
                .size(80.0, 40.0)
                .flex_none()
                .clickable(),
            // `group_active` declared after `group_hover` wins over it while the press is held.
            div()
                .id(member)
                .size(40.0, 40.0)
                .flex_none()
                .group_hover(|style| style.bg(hover_color))
                .group_active(|style| style.bg(active_color)),
        ]);
    let viewport = Size::new(200.0, 40.0);
    let now = Instant::now();
    let mut tree = UiTree::new();
    let mut renderer = TestTextLayout;
    let mut scene = Scene::new();

    tree.set_root(declaration, viewport, 1.0, &mut renderer)
        .unwrap();
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();

    // Hovering the trigger hovers the group.
    let on_trigger = Point::new(40.0, 20.0);
    assert!(tree.pointer_moved(on_trigger, &mut renderer));
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    assert_eq!(fill_at(&scene, 100.0), Some(hover_color));

    // Pressing the trigger makes the group active: the press is inside it, not on it.
    let result = tree.pointer_button(Some(on_trigger), true, false, now, &mut renderer);
    assert!(result.repaint);
    assert_eq!(tree.pressed, Some(trigger));
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    assert_eq!(fill_at(&scene, 100.0), Some(active_color));

    // Releasing ends the press and the hover entry paints again.
    tree.pointer_button(Some(on_trigger), false, false, now, &mut renderer);
    assert_eq!(tree.pressed, None);
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    assert_eq!(fill_at(&scene, 100.0), Some(hover_color));
}

#[test]
fn focus_within_paints_the_focused_element_and_every_ancestor() {
    let left = ElementId::new(170);
    let left_button = ElementId::new(171);
    let right = ElementId::new(172);
    let right_button = ElementId::new(173);
    let left_color = Color::rgb8(14, 165, 233);
    let right_color = Color::rgb8(244, 63, 94);
    let own_color = Color::rgb8(34, 197, 94);
    let declaration = div().size(200.0, 40.0).flex_row().children([
        div()
            .id(left)
            .size(100.0, 40.0)
            .flex_row()
            .focus_within(|style| style.bg(left_color))
            .child(
                button()
                    .id(left_button)
                    .size(60.0, 40.0)
                    .flex_none()
                    .clickable(),
            ),
        div()
            .id(right)
            .size(100.0, 40.0)
            .flex_row()
            .focus_within(|style| style.bg(right_color))
            .child(
                button()
                    .id(right_button)
                    .size(60.0, 40.0)
                    .flex_none()
                    .clickable()
                    .focus_within(|style| style.bg(own_color)),
            ),
    ]);
    let viewport = Size::new(200.0, 40.0);
    let now = Instant::now();
    let mut tree = UiTree::new();
    let mut renderer = TestTextLayout;
    let mut scene = Scene::new();

    tree.set_root(declaration, viewport, 1.0, &mut renderer)
        .unwrap();
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    assert!(quad_at(&scene, 80.0).is_none());
    assert!(quad_at(&scene, 180.0).is_none());

    // Programmatic focus keeps focus invisible, so the `focus` variant stays off while
    // `focus_within` follows the focus itself up through the ancestors.
    assert!(tree.focus(left_button));
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    assert_eq!(fill_at(&scene, 80.0), Some(left_color));
    assert!(quad_at(&scene, 180.0).is_none());

    // Moving focus moves the highlight, and the focused element counts as within itself.
    assert!(tree.focus(right_button));
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    assert!(quad_at(&scene, 80.0).is_none());
    assert_eq!(
        fill_of(&scene, Rect::new(100.0, 0.0, 100.0, 40.0)),
        Some(right_color)
    );
    assert_eq!(
        fill_of(&scene, Rect::new(100.0, 0.0, 60.0, 40.0)),
        Some(own_color)
    );
}

#[test]
fn selected_paints_while_the_element_is_selected_and_keeps_its_paint_under_hover() {
    let row = ElementId::new(150);
    let chosen = Color::rgb8(37, 99, 235);
    let hover = Color::rgb8(220, 38, 38);
    let declaration = |selected: bool| {
        div()
            .id(row)
            .size(200.0, 40.0)
            .clickable()
            .selected(selected)
            .selected_style(|style| style.bg(chosen))
            .hover(|style| style.bg(hover))
    };
    let viewport = Size::new(200.0, 40.0);
    let now = Instant::now();
    let mut tree = UiTree::new();
    let mut renderer = TestTextLayout;
    let mut scene = Scene::new();

    tree.set_root(declaration(false), viewport, 1.0, &mut renderer)
        .unwrap();
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    // Neither selected nor hovered: the row paints no box at all.
    assert!(quad_at(&scene, 100.0).is_none());

    // Hovered: the ordinary hover fill.
    assert!(tree.pointer_moved(Point::new(100.0, 20.0), &mut renderer));
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    assert_eq!(fill_at(&scene, 100.0), Some(hover));

    // Selected under the same pointer: the selected fill wins over the hover beneath it, as a
    // native list row keeps its selection colour while the pointer rests on it.
    tree.set_root(declaration(true), viewport, 1.0, &mut renderer)
        .unwrap();
    tree.pointer_moved(Point::new(100.0, 20.0), &mut renderer);
    assert!(tree.hovered.contains(&row));
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    assert_eq!(fill_at(&scene, 100.0), Some(chosen));

    // The pointer leaves: the selection paint stays, because it follows the flag, not the pointer.
    assert!(tree.pointer_left());
    scene.clear(Color::TRANSPARENT);
    tree.paint_at(&mut scene, &mut renderer, now).unwrap();
    assert_eq!(fill_at(&scene, 100.0), Some(chosen));
}