|
| 1 | +//! Boundary between GUI scene production and the standalone graphics engine. |
| 2 | +//! |
| 3 | +//! This module exposes the engine's platform-neutral scene vocabulary without |
| 4 | +//! leaking `wgpu` or window-system types into GUI semantics. The optional |
| 5 | +//! software reference renderer is deterministic and intended for tests, |
| 6 | +//! snapshots, and GPU parity checks. |
| 7 | +
|
| 8 | +pub use a3s_graphics::{ |
| 9 | + Affine, Color, CornerRadii, Damage, DrawCommand, DrawId, EdgeWidths, FillRect, FillRoundedRect, |
| 10 | + Primitive, Rect, Scene, SceneBuilder, Size, StrokeRect, SCENE_SCHEMA_VERSION, |
| 11 | +}; |
| 12 | + |
| 13 | +#[cfg(feature = "software-reference")] |
| 14 | +use a3s_graphics::{FramePlanner, SoftwareRenderer}; |
| 15 | + |
| 16 | +#[cfg(feature = "software-reference")] |
| 17 | +use crate::GuiResult; |
| 18 | + |
| 19 | +/// Metadata and pixels produced by one deterministic reference frame. |
| 20 | +#[cfg(feature = "software-reference")] |
| 21 | +#[derive(Debug, Clone, Copy, PartialEq)] |
| 22 | +pub struct ReferenceFrame<'a> { |
| 23 | + index: u64, |
| 24 | + fingerprint: u64, |
| 25 | + damage: Damage, |
| 26 | + width: u32, |
| 27 | + height: u32, |
| 28 | + rgba8: &'a [u8], |
| 29 | +} |
| 30 | + |
| 31 | +#[cfg(feature = "software-reference")] |
| 32 | +impl<'a> ReferenceFrame<'a> { |
| 33 | + pub const fn index(self) -> u64 { |
| 34 | + self.index |
| 35 | + } |
| 36 | + |
| 37 | + pub const fn fingerprint(self) -> u64 { |
| 38 | + self.fingerprint |
| 39 | + } |
| 40 | + |
| 41 | + pub const fn damage(self) -> Damage { |
| 42 | + self.damage |
| 43 | + } |
| 44 | + |
| 45 | + pub const fn width(self) -> u32 { |
| 46 | + self.width |
| 47 | + } |
| 48 | + |
| 49 | + pub const fn height(self) -> u32 { |
| 50 | + self.height |
| 51 | + } |
| 52 | + |
| 53 | + pub const fn rgba8(self) -> &'a [u8] { |
| 54 | + self.rgba8 |
| 55 | + } |
| 56 | +} |
| 57 | + |
| 58 | +/// Stateful reference renderer used to verify GUI scene extraction. |
| 59 | +/// |
| 60 | +/// Stable draw IDs let the internal planner calculate retained damage across |
| 61 | +/// calls. Use [`Self::reset`] when the associated surface or document is |
| 62 | +/// discarded. |
| 63 | +#[cfg(feature = "software-reference")] |
| 64 | +#[derive(Debug, Default)] |
| 65 | +pub struct ReferenceRenderer { |
| 66 | + planner: FramePlanner, |
| 67 | + renderer: SoftwareRenderer, |
| 68 | +} |
| 69 | + |
| 70 | +#[cfg(feature = "software-reference")] |
| 71 | +impl ReferenceRenderer { |
| 72 | + pub fn new() -> Self { |
| 73 | + Self::default() |
| 74 | + } |
| 75 | + |
| 76 | + pub fn render(&mut self, scene: Scene) -> GuiResult<ReferenceFrame<'_>> { |
| 77 | + let frame = self.planner.plan(scene)?; |
| 78 | + let index = frame.index; |
| 79 | + let fingerprint = frame.fingerprint; |
| 80 | + let damage = frame.damage; |
| 81 | + let pixels = self.renderer.render(&frame)?; |
| 82 | + Ok(ReferenceFrame { |
| 83 | + index, |
| 84 | + fingerprint, |
| 85 | + damage, |
| 86 | + width: pixels.width(), |
| 87 | + height: pixels.height(), |
| 88 | + rgba8: pixels.as_rgba8(), |
| 89 | + }) |
| 90 | + } |
| 91 | + |
| 92 | + pub fn reset(&mut self) { |
| 93 | + self.planner.reset(); |
| 94 | + self.renderer = SoftwareRenderer::new(); |
| 95 | + } |
| 96 | +} |
| 97 | + |
| 98 | +#[cfg(all(test, feature = "software-reference"))] |
| 99 | +mod tests { |
| 100 | + use super::*; |
| 101 | + use crate::GuiError; |
| 102 | + |
| 103 | + fn scene() -> Scene { |
| 104 | + let mut builder = SceneBuilder::new(Size::new(4.0, 3.0), 1.0, Color::WHITE); |
| 105 | + builder |
| 106 | + .push(DrawCommand::new( |
| 107 | + DrawId::new(1).unwrap(), |
| 108 | + Primitive::FillRect(FillRect { |
| 109 | + rect: Rect::new(1.0, 1.0, 2.0, 1.0), |
| 110 | + color: Color::BLACK, |
| 111 | + }), |
| 112 | + )) |
| 113 | + .unwrap(); |
| 114 | + builder.finish().unwrap() |
| 115 | + } |
| 116 | + |
| 117 | + #[test] |
| 118 | + fn reference_renderer_retains_identical_scenes() { |
| 119 | + let mut renderer = ReferenceRenderer::new(); |
| 120 | + let first = renderer.render(scene()).unwrap(); |
| 121 | + assert_eq!((first.width(), first.height()), (4, 3)); |
| 122 | + assert!(first.damage().full_repaint); |
| 123 | + let fingerprint = first.fingerprint(); |
| 124 | + let pixels = first.rgba8().to_vec(); |
| 125 | + |
| 126 | + let second = renderer.render(scene()).unwrap(); |
| 127 | + assert_eq!(second.index(), 1); |
| 128 | + assert_eq!(second.fingerprint(), fingerprint); |
| 129 | + assert!(!second.damage().requires_render()); |
| 130 | + assert_eq!(second.rgba8(), pixels); |
| 131 | + } |
| 132 | + |
| 133 | + #[test] |
| 134 | + fn reset_forces_a_full_reference_frame_without_rewinding_diagnostics() { |
| 135 | + let mut renderer = ReferenceRenderer::new(); |
| 136 | + renderer.render(scene()).unwrap(); |
| 137 | + renderer.reset(); |
| 138 | + |
| 139 | + let frame = renderer.render(scene()).unwrap(); |
| 140 | + assert_eq!(frame.index(), 1); |
| 141 | + assert!(frame.damage().full_repaint); |
| 142 | + } |
| 143 | + |
| 144 | + #[test] |
| 145 | + fn graphics_validation_errors_keep_the_gui_boundary() { |
| 146 | + let mut renderer = ReferenceRenderer::new(); |
| 147 | + let invalid = Scene::new(Size::new(0.0, 3.0), 1.0, Color::WHITE); |
| 148 | + |
| 149 | + let error = renderer.render(invalid).unwrap_err(); |
| 150 | + assert!(matches!(error, GuiError::Graphics { .. })); |
| 151 | + assert!(error.to_string().contains("logical surface size")); |
| 152 | + } |
| 153 | + |
| 154 | + #[test] |
| 155 | + fn reference_renderer_is_send_and_sync() { |
| 156 | + fn assert_send_sync<T: Send + Sync>() {} |
| 157 | + assert_send_sync::<ReferenceRenderer>(); |
| 158 | + } |
| 159 | +} |
0 commit comments