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
//! The per-frame collection of overlay items a consumer submits for a frame.
use crate::overlay::*;
/// Screen-space overlays rendered after post-processing: shapes, labels, glyph
/// runs, and polylines.
///
/// This frame section is the right place for any visual element that belongs
/// in front of the 3D scene and must not be affected by tone-mapping or bloom.
#[derive(Debug, Clone, PartialEq, Default)]
#[non_exhaustive]
pub struct OverlayFrame {
/// Current time in seconds, used to resolve animation tracks on
/// shapes. Use the same epoch as the `start_time` values in your
/// animations (e.g. seconds since app launch). Default: `0.0`.
pub time: f64,
/// SDF-based shapes rendered before labels. Supports rounded rects,
/// circles, ellipses, and capsules with anti-aliased edges and borders.
/// A solid rectangle is `OverlayShape::Rect` with an `OverlayFill::Solid`.
pub shapes: Vec<OverlayShapeItem>,
/// Text labels anchored to world-space or screen-space positions.
pub labels: Vec<LabelItem>,
/// Pre-positioned glyph runs. The low-level text path: the caller supplies
/// glyph ids and positions (typically from a shaping engine) and the
/// renderer only rasterises and draws them. `labels` is the string-in,
/// laid-out-here path; this is the glyphs-in, drawn-as-given path.
pub glyph_runs: Vec<GlyphRunItem>,
/// Stroked polylines. Rendered through the same pipeline as labels; share
/// their z-order space.
pub polylines: Vec<OverlayPolylineItem>,
/// Retained overlay groups: geometry compiled once with
/// `compile_overlay_geometry` and re-drawn from cached buffers, each carrying
/// its per-frame translate, opacity, z-order, and clip. Empty by default and
/// costs nothing when unused; this is the opt-in path for a UI that draws many
/// mostly-static overlays without re-tessellating them every frame.
pub retained: Vec<RetainedOverlay>,
}
impl OverlayFrame {
/// Whether any overlay item carries a non-zero `z_order`. When every item is
/// at the default `0`, the renderer keeps its fixed family draw order and
/// skips building the cross-family ordering list, so the common case pays
/// nothing for the feature.
#[doc(hidden)]
pub fn uses_nonzero_z_order(&self) -> bool {
self.shapes.iter().any(|i| i.z_order != 0)
|| self.labels.iter().any(|i| i.z_order != 0)
|| self.glyph_runs.iter().any(|i| i.z_order != 0)
|| self.polylines.iter().any(|i| i.z_order != 0)
}
}