// todo("windows"): remove #![cfg_attr(windows, allow(dead_code))] use schemars::JsonSchema; use serde::{Deserialize, Serialize}; use crate::{ AtlasTextureId, AtlasTile, Background, Bounds, ContentMask, Corners, Edges, Hsla, Pixels, Point, Radians, ScaledPixels, Size, bounds_tree::BoundsTree, point, }; use std::{ fmt::Debug, iter::Peekable, ops::{Add, Range, Sub}, slice, }; #[allow(non_camel_case_types, unused)] #[expect(missing_docs)] pub type PathVertex_ScaledPixels = PathVertex; #[expect(missing_docs)] pub type DrawOrder = u32; /// A boolean stored as a `u32` so that GPU-facing structs contain no /// compiler-inserted padding bytes, which would be undefined behavior to /// reinterpret as `&[u8]` when writing instance buffers. Guaranteed to be /// `0` or `1` by construction; shaders read it as a `u32`/`uint`. #[derive(Copy, Clone, Debug, Default, PartialEq, Eq)] #[repr(transparent)] pub struct PaddedBool32(u32); impl From for PaddedBool32 { fn from(value: bool) -> Self { PaddedBool32(value as u32) } } #[derive(Default)] #[expect(missing_docs)] pub struct Scene { pub(crate) paint_operations: Vec, primitive_bounds: BoundsTree, layer_stack: Vec, pub shadows: Vec, pub quads: Vec, pub paths: Vec>, pub underlines: Vec, pub monochrome_sprites: Vec, pub subpixel_sprites: Vec, pub polychrome_sprites: Vec, pub surfaces: Vec, } #[expect(missing_docs)] impl Scene { pub fn clear(&mut self) { self.paint_operations.clear(); self.primitive_bounds.clear(); self.layer_stack.clear(); self.paths.clear(); self.shadows.clear(); self.quads.clear(); self.underlines.clear(); self.monochrome_sprites.clear(); self.subpixel_sprites.clear(); self.polychrome_sprites.clear(); self.surfaces.clear(); } pub fn len(&self) -> usize { self.paint_operations.len() } pub fn push_layer(&mut self, bounds: Bounds) { let order = self.primitive_bounds.insert(bounds); self.layer_stack.push(order); self.paint_operations .push(PaintOperation::StartLayer(bounds)); } pub fn pop_layer(&mut self) { self.layer_stack.pop(); self.paint_operations.push(PaintOperation::EndLayer); } pub fn insert_primitive(&mut self, primitive: impl Into) { let mut primitive = primitive.into(); let clipped_bounds = primitive .bounds() .intersect(&primitive.content_mask().bounds); if clipped_bounds.is_empty() { return; } let order = self .layer_stack .last() .copied() .unwrap_or_else(|| self.primitive_bounds.insert(clipped_bounds)); match &mut primitive { Primitive::Shadow(shadow) => { shadow.order = order; self.shadows.push(*shadow); } Primitive::Quad(quad) => { quad.order = order; self.quads.push(*quad); } Primitive::Path(path) => { path.order = order; path.id = PathId(self.paths.len()); self.paths.push(path.clone()); } Primitive::Underline(underline) => { underline.order = order; self.underlines.push(*underline); } Primitive::MonochromeSprite(sprite) => { sprite.order = order; self.monochrome_sprites.push(*sprite); } Primitive::SubpixelSprite(sprite) => { sprite.order = order; self.subpixel_sprites.push(*sprite); } Primitive::PolychromeSprite(sprite) => { sprite.order = order; self.polychrome_sprites.push(*sprite); } Primitive::Surface(surface) => { surface.order = order; self.surfaces.push(surface.clone()); } } self.paint_operations .push(PaintOperation::Primitive(primitive)); } pub fn replay(&mut self, range: Range, prev_scene: &Scene) { for operation in &prev_scene.paint_operations[range] { match operation { PaintOperation::Primitive(primitive) => self.insert_primitive(primitive.clone()), PaintOperation::StartLayer(bounds) => self.push_layer(*bounds), PaintOperation::EndLayer => self.pop_layer(), } } } pub fn finish(&mut self) { self.shadows.sort_by_key(|shadow| shadow.order); self.quads.sort_by_key(|quad| quad.order); self.paths.sort_by_key(|path| path.order); self.underlines.sort_by_key(|underline| underline.order); self.monochrome_sprites .sort_by_key(|sprite| (sprite.order, sprite.tile.tile_id)); self.subpixel_sprites .sort_by_key(|sprite| (sprite.order, sprite.tile.tile_id)); self.polychrome_sprites .sort_by_key(|sprite| (sprite.order, sprite.tile.tile_id)); self.surfaces.sort_by_key(|surface| surface.order); } #[cfg_attr( all( any(target_os = "linux", target_os = "freebsd"), not(any(feature = "x11", feature = "wayland")) ), allow(dead_code) )] pub fn batches(&self) -> impl Iterator + '_ { BatchIterator { shadows_start: 0, shadows_iter: self.shadows.iter().peekable(), quads_start: 0, quads_iter: self.quads.iter().peekable(), paths_start: 0, paths_iter: self.paths.iter().peekable(), underlines_start: 0, underlines_iter: self.underlines.iter().peekable(), monochrome_sprites_start: 0, monochrome_sprites_iter: self.monochrome_sprites.iter().peekable(), subpixel_sprites_start: 0, subpixel_sprites_iter: self.subpixel_sprites.iter().peekable(), polychrome_sprites_start: 0, polychrome_sprites_iter: self.polychrome_sprites.iter().peekable(), surfaces_start: 0, surfaces_iter: self.surfaces.iter().peekable(), } } } #[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Default)] #[cfg_attr( all( any(target_os = "linux", target_os = "freebsd"), not(any(feature = "x11", feature = "wayland")) ), allow(dead_code) )] pub(crate) enum PrimitiveKind { Shadow, #[default] Quad, Path, Underline, MonochromeSprite, SubpixelSprite, PolychromeSprite, Surface, } pub(crate) enum PaintOperation { Primitive(Primitive), StartLayer(Bounds), EndLayer, } #[derive(Clone)] #[expect(missing_docs)] pub enum Primitive { Shadow(Shadow), Quad(Quad), Path(Path), Underline(Underline), MonochromeSprite(MonochromeSprite), SubpixelSprite(SubpixelSprite), PolychromeSprite(PolychromeSprite), Surface(PaintSurface), } #[expect(missing_docs)] impl Primitive { pub fn bounds(&self) -> &Bounds { match self { Primitive::Shadow(shadow) => &shadow.bounds, Primitive::Quad(quad) => &quad.bounds, Primitive::Path(path) => &path.bounds, Primitive::Underline(underline) => &underline.bounds, Primitive::MonochromeSprite(sprite) => &sprite.bounds, Primitive::SubpixelSprite(sprite) => &sprite.bounds, Primitive::PolychromeSprite(sprite) => &sprite.bounds, Primitive::Surface(surface) => &surface.bounds, } } pub fn content_mask(&self) -> &ContentMask { match self { Primitive::Shadow(shadow) => &shadow.content_mask, Primitive::Quad(quad) => &quad.content_mask, Primitive::Path(path) => &path.content_mask, Primitive::Underline(underline) => &underline.content_mask, Primitive::MonochromeSprite(sprite) => &sprite.content_mask, Primitive::SubpixelSprite(sprite) => &sprite.content_mask, Primitive::PolychromeSprite(sprite) => &sprite.content_mask, Primitive::Surface(surface) => &surface.content_mask, } } } #[cfg_attr( all( any(target_os = "linux", target_os = "freebsd"), not(any(feature = "x11", feature = "wayland")) ), allow(dead_code) )] struct BatchIterator<'a> { shadows_start: usize, shadows_iter: Peekable>, quads_start: usize, quads_iter: Peekable>, paths_start: usize, paths_iter: Peekable>>, underlines_start: usize, underlines_iter: Peekable>, monochrome_sprites_start: usize, monochrome_sprites_iter: Peekable>, subpixel_sprites_start: usize, subpixel_sprites_iter: Peekable>, polychrome_sprites_start: usize, polychrome_sprites_iter: Peekable>, surfaces_start: usize, surfaces_iter: Peekable>, } impl<'a> Iterator for BatchIterator<'a> { type Item = PrimitiveBatch; fn next(&mut self) -> Option { let mut orders_and_kinds = [ ( self.shadows_iter.peek().map(|s| s.order), PrimitiveKind::Shadow, ), (self.quads_iter.peek().map(|q| q.order), PrimitiveKind::Quad), (self.paths_iter.peek().map(|q| q.order), PrimitiveKind::Path), ( self.underlines_iter.peek().map(|u| u.order), PrimitiveKind::Underline, ), ( self.monochrome_sprites_iter.peek().map(|s| s.order), PrimitiveKind::MonochromeSprite, ), ( self.subpixel_sprites_iter.peek().map(|s| s.order), PrimitiveKind::SubpixelSprite, ), ( self.polychrome_sprites_iter.peek().map(|s| s.order), PrimitiveKind::PolychromeSprite, ), ( self.surfaces_iter.peek().map(|s| s.order), PrimitiveKind::Surface, ), ]; orders_and_kinds.sort_by_key(|(order, kind)| (order.unwrap_or(u32::MAX), *kind)); let first = orders_and_kinds[0]; let second = orders_and_kinds[1]; let (batch_kind, max_order_and_kind) = if first.0.is_some() { (first.1, (second.0.unwrap_or(u32::MAX), second.1)) } else { return None; }; match batch_kind { PrimitiveKind::Shadow => { let shadows_start = self.shadows_start; let mut shadows_end = shadows_start + 1; self.shadows_iter.next(); while self .shadows_iter .next_if(|shadow| (shadow.order, batch_kind) < max_order_and_kind) .is_some() { shadows_end += 1; } self.shadows_start = shadows_end; Some(PrimitiveBatch::Shadows(shadows_start..shadows_end)) } PrimitiveKind::Quad => { let quads_start = self.quads_start; let mut quads_end = quads_start + 1; self.quads_iter.next(); while self .quads_iter .next_if(|quad| (quad.order, batch_kind) < max_order_and_kind) .is_some() { quads_end += 1; } self.quads_start = quads_end; Some(PrimitiveBatch::Quads(quads_start..quads_end)) } PrimitiveKind::Path => { let paths_start = self.paths_start; let mut paths_end = paths_start + 1; self.paths_iter.next(); while self .paths_iter .next_if(|path| (path.order, batch_kind) < max_order_and_kind) .is_some() { paths_end += 1; } self.paths_start = paths_end; Some(PrimitiveBatch::Paths(paths_start..paths_end)) } PrimitiveKind::Underline => { let underlines_start = self.underlines_start; let mut underlines_end = underlines_start + 1; self.underlines_iter.next(); while self .underlines_iter .next_if(|underline| (underline.order, batch_kind) < max_order_and_kind) .is_some() { underlines_end += 1; } self.underlines_start = underlines_end; Some(PrimitiveBatch::Underlines(underlines_start..underlines_end)) } PrimitiveKind::MonochromeSprite => { let texture_id = self.monochrome_sprites_iter.peek().unwrap().tile.texture_id; let sprites_start = self.monochrome_sprites_start; let mut sprites_end = sprites_start + 1; self.monochrome_sprites_iter.next(); while self .monochrome_sprites_iter .next_if(|sprite| { (sprite.order, batch_kind) < max_order_and_kind && sprite.tile.texture_id == texture_id }) .is_some() { sprites_end += 1; } self.monochrome_sprites_start = sprites_end; Some(PrimitiveBatch::MonochromeSprites { texture_id, range: sprites_start..sprites_end, }) } PrimitiveKind::SubpixelSprite => { let texture_id = self.subpixel_sprites_iter.peek().unwrap().tile.texture_id; let sprites_start = self.subpixel_sprites_start; let mut sprites_end = sprites_start + 1; self.subpixel_sprites_iter.next(); while self .subpixel_sprites_iter .next_if(|sprite| { (sprite.order, batch_kind) < max_order_and_kind && sprite.tile.texture_id == texture_id }) .is_some() { sprites_end += 1; } self.subpixel_sprites_start = sprites_end; Some(PrimitiveBatch::SubpixelSprites { texture_id, range: sprites_start..sprites_end, }) } PrimitiveKind::PolychromeSprite => { let texture_id = self.polychrome_sprites_iter.peek().unwrap().tile.texture_id; let sprites_start = self.polychrome_sprites_start; let mut sprites_end = sprites_start + 1; self.polychrome_sprites_iter.next(); while self .polychrome_sprites_iter .next_if(|sprite| { (sprite.order, batch_kind) < max_order_and_kind && sprite.tile.texture_id == texture_id }) .is_some() { sprites_end += 1; } self.polychrome_sprites_start = sprites_end; Some(PrimitiveBatch::PolychromeSprites { texture_id, range: sprites_start..sprites_end, }) } PrimitiveKind::Surface => { let surfaces_start = self.surfaces_start; let mut surfaces_end = surfaces_start + 1; self.surfaces_iter.next(); while self .surfaces_iter .next_if(|surface| (surface.order, batch_kind) < max_order_and_kind) .is_some() { surfaces_end += 1; } self.surfaces_start = surfaces_end; Some(PrimitiveBatch::Surfaces(surfaces_start..surfaces_end)) } } } } #[derive(Debug)] #[cfg_attr( all( any(target_os = "linux", target_os = "freebsd"), not(any(feature = "x11", feature = "wayland")) ), allow(dead_code) )] #[allow(missing_docs)] pub enum PrimitiveBatch { Shadows(Range), Quads(Range), Paths(Range), Underlines(Range), MonochromeSprites { texture_id: AtlasTextureId, range: Range, }, #[cfg_attr(target_os = "macos", allow(dead_code))] SubpixelSprites { texture_id: AtlasTextureId, range: Range, }, PolychromeSprites { texture_id: AtlasTextureId, range: Range, }, Surfaces(Range), } impl PrimitiveBatch { #[expect(missing_docs)] pub fn label(&self) -> String { match self { Self::Shadows(range) => format!("shadows ({})", range.len()), Self::Quads(range) => format!("quads ({})", range.len()), Self::Paths(range) => format!("paths ({})", range.len()), Self::Underlines(range) => format!("underlines ({})", range.len()), Self::MonochromeSprites { texture_id, range } => { format!( "monochrome sprites ({}) on atlas {}", range.len(), texture_id.index ) } Self::SubpixelSprites { texture_id, range } => { format!( "subpixel sprites ({}) on atlas {}", range.len(), texture_id.index ) } Self::PolychromeSprites { texture_id, range } => { format!( "polychrome sprites ({}) on atlas {}", range.len(), texture_id.index ) } Self::Surfaces(range) => format!("surfaces ({})", range.len()), } } } #[derive(Default, Debug, Copy, Clone)] #[repr(C)] #[expect(missing_docs)] pub struct Quad { pub order: DrawOrder, pub border_style: BorderStyle, pub bounds: Bounds, pub content_mask: ContentMask, pub background: Background, pub border_color: Hsla, pub corner_radii: Corners, pub border_widths: Edges, } impl From for Primitive { fn from(quad: Quad) -> Self { Primitive::Quad(quad) } } #[derive(Debug, Copy, Clone)] #[repr(C)] #[expect(missing_docs)] pub struct Underline { pub order: DrawOrder, pub pad: u32, // align to 8 bytes pub bounds: Bounds, pub content_mask: ContentMask, pub color: Hsla, pub thickness: ScaledPixels, pub wavy: PaddedBool32, } impl From for Primitive { fn from(underline: Underline) -> Self { Primitive::Underline(underline) } } #[derive(Debug, Copy, Clone)] #[repr(C)] #[expect(missing_docs)] pub struct Shadow { pub order: DrawOrder, pub blur_radius: ScaledPixels, pub bounds: Bounds, pub corner_radii: Corners, pub content_mask: ContentMask, pub color: Hsla, pub element_bounds: Bounds, pub element_corner_radii: Corners, /// 0 = drop shadow (rendered outside the element), 1 = inset shadow (rendered inside). pub inset: u32, pub pad: u32, // align to 8 bytes } impl From for Primitive { fn from(shadow: Shadow) -> Self { Primitive::Shadow(shadow) } } /// The style of a border. #[derive(Default, Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize, JsonSchema)] #[repr(C)] pub enum BorderStyle { /// A solid border. #[default] Solid = 0, /// A dashed border. Dashed = 1, } /// A data type representing a 2 dimensional transformation that can be applied to an element. #[derive(Debug, Clone, Copy, PartialEq)] #[repr(C)] pub struct TransformationMatrix { /// 2x2 matrix containing rotation and scale, /// stored row-major pub rotation_scale: [[f32; 2]; 2], /// translation vector pub translation: [f32; 2], } impl Eq for TransformationMatrix {} impl TransformationMatrix { /// The unit matrix, has no effect. pub fn unit() -> Self { Self { rotation_scale: [[1.0, 0.0], [0.0, 1.0]], translation: [0.0, 0.0], } } /// Move the origin by a given point pub fn translate(mut self, point: Point) -> Self { self.compose(Self { rotation_scale: [[1.0, 0.0], [0.0, 1.0]], translation: [point.x.0, point.y.0], }) } /// Clockwise rotation in radians around the origin pub fn rotate(self, angle: Radians) -> Self { self.compose(Self { rotation_scale: [ [angle.0.cos(), -angle.0.sin()], [angle.0.sin(), angle.0.cos()], ], translation: [0.0, 0.0], }) } /// Scale around the origin pub fn scale(self, size: Size) -> Self { self.compose(Self { rotation_scale: [[size.width, 0.0], [0.0, size.height]], translation: [0.0, 0.0], }) } /// Perform matrix multiplication with another transformation /// to produce a new transformation that is the result of /// applying both transformations: first, `other`, then `self`. #[inline] pub fn compose(self, other: TransformationMatrix) -> TransformationMatrix { if other == Self::unit() { return self; } // Perform matrix multiplication TransformationMatrix { rotation_scale: [ [ self.rotation_scale[0][0] * other.rotation_scale[0][0] + self.rotation_scale[0][1] * other.rotation_scale[1][0], self.rotation_scale[0][0] * other.rotation_scale[0][1] + self.rotation_scale[0][1] * other.rotation_scale[1][1], ], [ self.rotation_scale[1][0] * other.rotation_scale[0][0] + self.rotation_scale[1][1] * other.rotation_scale[1][0], self.rotation_scale[1][0] * other.rotation_scale[0][1] + self.rotation_scale[1][1] * other.rotation_scale[1][1], ], ], translation: [ self.translation[0] + self.rotation_scale[0][0] * other.translation[0] + self.rotation_scale[0][1] * other.translation[1], self.translation[1] + self.rotation_scale[1][0] * other.translation[0] + self.rotation_scale[1][1] * other.translation[1], ], } } /// Apply transformation to a point, mainly useful for debugging pub fn apply(&self, point: Point) -> Point { let input = [point.x.0, point.y.0]; let mut output = self.translation; for (i, output_cell) in output.iter_mut().enumerate() { for (k, input_cell) in input.iter().enumerate() { *output_cell += self.rotation_scale[i][k] * *input_cell; } } Point::new(output[0].into(), output[1].into()) } } impl Default for TransformationMatrix { fn default() -> Self { Self::unit() } } #[derive(Copy, Clone, Debug)] #[repr(C)] #[expect(missing_docs)] pub struct MonochromeSprite { pub order: DrawOrder, pub pad: u32, pub bounds: Bounds, pub content_mask: ContentMask, pub color: Hsla, pub tile: AtlasTile, pub transformation: TransformationMatrix, } impl From for Primitive { fn from(sprite: MonochromeSprite) -> Self { Primitive::MonochromeSprite(sprite) } } #[derive(Copy, Clone, Debug)] #[repr(C)] #[expect(missing_docs)] pub struct SubpixelSprite { pub order: DrawOrder, pub pad: u32, // align to 8 bytes pub bounds: Bounds, pub content_mask: ContentMask, pub color: Hsla, pub tile: AtlasTile, pub transformation: TransformationMatrix, } impl From for Primitive { fn from(sprite: SubpixelSprite) -> Self { Primitive::SubpixelSprite(sprite) } } #[derive(Copy, Clone, Debug)] #[repr(C)] #[expect(missing_docs)] pub struct PolychromeSprite { pub order: DrawOrder, pub pad: u32, pub grayscale: PaddedBool32, pub opacity: f32, pub bounds: Bounds, pub content_mask: ContentMask, pub corner_radii: Corners, pub tile: AtlasTile, } impl From for Primitive { fn from(sprite: PolychromeSprite) -> Self { Primitive::PolychromeSprite(sprite) } } #[derive(Clone, Debug)] #[allow(missing_docs)] pub struct PaintSurface { pub order: DrawOrder, pub bounds: Bounds, pub content_mask: ContentMask, #[cfg(target_os = "macos")] pub image_buffer: core_video::pixel_buffer::CVPixelBuffer, } impl From for Primitive { fn from(surface: PaintSurface) -> Self { Primitive::Surface(surface) } } #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] #[expect(missing_docs)] pub struct PathId(pub usize); /// A line made up of a series of vertices and control points. #[derive(Clone, Debug)] #[expect(missing_docs)] pub struct Path { pub id: PathId, pub order: DrawOrder, pub bounds: Bounds

, pub content_mask: ContentMask

, pub vertices: Vec>, pub color: Background, start: Point

, current: Point

, contour_count: usize, } impl Path { /// Create a new path with the given starting point. pub fn new(start: Point) -> Self { Self { id: PathId(0), order: DrawOrder::default(), vertices: Vec::new(), start, current: start, bounds: Bounds { origin: start, size: Default::default(), }, content_mask: Default::default(), color: Default::default(), contour_count: 0, } } /// Scale this path by the given factor. pub fn scale(&self, factor: f32) -> Path { Path { id: self.id, order: self.order, bounds: self.bounds.scale(factor), content_mask: self.content_mask.scale(factor), vertices: self .vertices .iter() .map(|vertex| vertex.scale(factor)) .collect(), start: self.start.map(|start| start.scale(factor)), current: self.current.scale(factor), contour_count: self.contour_count, color: self.color, } } /// Move the start, current point to the given point. pub fn move_to(&mut self, to: Point) { self.contour_count += 1; self.start = to; self.current = to; } /// Draw a straight line from the current point to the given point. pub fn line_to(&mut self, to: Point) { self.contour_count += 1; if self.contour_count > 1 { self.push_triangle( (self.start, self.current, to), (point(0., 1.), point(0., 1.), point(0., 1.)), ); } self.current = to; } /// Draw a curve from the current point to the given point, using the given control point. pub fn curve_to(&mut self, to: Point, ctrl: Point) { self.contour_count += 1; if self.contour_count > 1 { self.push_triangle( (self.start, self.current, to), (point(0., 1.), point(0., 1.), point(0., 1.)), ); } self.push_triangle( (self.current, ctrl, to), (point(0., 0.), point(0.5, 0.), point(1., 1.)), ); self.current = to; } /// Push a triangle to the Path. pub fn push_triangle( &mut self, xy: (Point, Point, Point), st: (Point, Point, Point), ) { self.bounds = self .bounds .union(&Bounds { origin: xy.0, size: Default::default(), }) .union(&Bounds { origin: xy.1, size: Default::default(), }) .union(&Bounds { origin: xy.2, size: Default::default(), }); self.vertices.push(PathVertex { xy_position: xy.0, st_position: st.0, content_mask: Default::default(), }); self.vertices.push(PathVertex { xy_position: xy.1, st_position: st.1, content_mask: Default::default(), }); self.vertices.push(PathVertex { xy_position: xy.2, st_position: st.2, content_mask: Default::default(), }); } } impl Path where T: Clone + Debug + Default + PartialEq + PartialOrd + Add + Sub, { #[allow(unused)] #[expect(missing_docs)] pub fn clipped_bounds(&self) -> Bounds { self.bounds.intersect(&self.content_mask.bounds) } } impl From> for Primitive { fn from(path: Path) -> Self { Primitive::Path(path) } } #[derive(Clone, Debug)] #[repr(C)] #[expect(missing_docs)] pub struct PathVertex { pub xy_position: Point

, pub st_position: Point, pub content_mask: ContentMask

, } #[expect(missing_docs)] impl PathVertex { pub fn scale(&self, factor: f32) -> PathVertex { PathVertex { xy_position: self.xy_position.scale(factor), st_position: self.st_position, content_mask: self.content_mask.scale(factor), } } }