Skip to main content

cvkg_render_gpu/
lib.rs

1//! # CVKG Agentic Development Guidelines (v1.2)
2//!
3//! All AI agents contributing to this crate MUST follow ALL seven rules:
4//!
5//! ── Karpathy Guidelines (1–4) ────────────────────────────────────────────
6//! 1. THINK FIRST     -- State assumptions. Surface ambiguity. Push back on complexity.
7//! 2. STAY SIMPLE     -- Minimum code. No speculative features. No unasked-for abstractions.
8//! 3. BE SURGICAL     -- Touch only what's required. Own your orphans. Don't improve neighbors.
9//! 4. VERIFY GOALS    -- Turn tasks into checkable criteria. Loop until they pass. Never commit broken.
10//!
11//! ── CVKG Extended Protocols (5–7) ────────────────────────────────────────
12//! 5. TRIPLE-PASS     -- Read the target, its surrounding context, and its full call graph
13//!                      at least THREE TIMES before making any edit or revision.
14//! 6. COMMENT ALL     -- Every major pub fn, unsafe block, and non-trivial algorithm in
15//!                      every .rs/.ts/.h/.wgsl file MUST have a descriptive doc comment.
16//!                      Comments describe WHY and WHAT CONTRACT, not HOW mechanically.
17//! 7. MONITOR LOOPS   -- Check every tool call / command for progress every 30 seconds.
18//!                      After 3 consecutive identical failures, stop, write BLOCKED.md,
19//!                      and move to unblocked work. Never silently accept a broken state.
20//!
21//! Sources:
22//!   Karpathy: https://github.com/multica-ai/andrej-karpathy-skills
23//!   CVKG Extended: Section 2 of the CVKG Design Specification
24#![allow(
25    clippy::type_complexity,
26    clippy::unwrap_or_default,
27    dead_code,
28    unused_variables,
29    unused_imports,
30    unused_mut,
31    unused_parens
32)]
33
34mod kvasir;
35mod material;
36
37// Re-export material types for downstream users
38pub use material::builtins;
39pub use material::{CompiledMaterial, MaterialCompiler, MaterialError, MaterialGraph, MaterialOp};
40
41pub mod accessibility;
42pub mod ai;
43mod api;
44mod draw;
45pub(crate) mod passes;
46pub mod pyramid;
47pub mod renderer;
48mod surtr_util;
49pub mod types;
50pub mod vertex;
51
52pub mod heim;
53pub use heim::SundrPacker;
54
55// P1-1 (phase 6): subsystems module. Each subsystem (config,
56// geometry, text, svg, particles) is a self-contained module
57// that can be tested, reviewed, and modified in isolation.
58pub mod subsystems;
59pub use subsystems::SurtrConfig;
60
61#[cfg(test)]
62mod tests {
63    use super::*;
64
65    use super::heim::SundrPacker;
66
67    #[test]
68    fn test_shelf_packer_basic() {
69        let mut packer = SundrPacker::new(100, 100);
70        assert_eq!(packer.pack(10, 10), Some((0, 0)));
71        assert_eq!(packer.pack(20, 15), Some((10, 0)));
72    }
73
74    #[test]
75    fn test_shelf_packer_wrap() {
76        let mut packer = SundrPacker::new(100, 100);
77        packer.pack(60, 10);
78        assert_eq!(packer.pack(50, 20), Some((0, 10)));
79    }
80
81    #[test]
82    fn test_parse_svg_animations() {
83        let svg = r##"
84            <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
85                <g id="spinner">
86                    <animateTransform attributeName="transform" type="rotate" from="0" to="360" dur="2s" />
87                </g>
88                <circle id="pulse">
89                    <animate attributeName="opacity" from="0.5" to="1.0" dur="0.5s" />
90                </circle>
91                <!-- Edge cases: xlink:href, ms suffix, values list -->
92                <rect>
93                    <animate xlink:href="#myRect" attributeName="x" values="10; 20; 30" dur="500ms" />
94                </rect>
95            </svg>
96        "##;
97        let anims = draw::parse_svg_animations(svg.as_bytes());
98        assert_eq!(anims.len(), 3);
99
100        assert_eq!(anims[0].target_id, "spinner");
101        assert_eq!(anims[0].keyframe_values, vec![0.0, 360.0]);
102
103        assert_eq!(anims[1].target_id, "pulse");
104        assert_eq!(anims[1].attribute_name, "opacity");
105        assert_eq!(anims[1].duration, 0.5);
106        assert_eq!(anims[1].keyframe_values, vec![0.5, 1.0]);
107
108        assert_eq!(anims[2].target_id, "myRect");
109        assert_eq!(anims[2].attribute_name, "x");
110        assert_eq!(anims[2].duration, 0.5); // 500ms parsed as 0.5
111        assert_eq!(anims[2].keyframe_values, vec![10.0, 20.0, 30.0]);
112    }
113
114    #[test]
115    fn test_shelf_packer_full() {
116        let mut packer = SundrPacker::new(10, 10);
117        assert_eq!(packer.pack(11, 5), None);
118        assert_eq!(packer.pack(5, 11), None);
119    }
120}
121
122// P1-12 fix: on wasm32/WebGL2, texture binding arrays are not supported.
123// The bind group layout uses count: None (single texture) on WASM, so the
124// WGSL must declare t_diffuse as a single texture, not a binding_array.
125// We swap the three affected WGSL files (common, material_opaque, bloom)
126// to WASM-specific variants on wasm32 targets. All other shader files
127// (shapes, material_glass, bifrost, color_blind, tonemap, particles) are
128// the same on both targets.
129#[cfg(target_arch = "wasm32")]
130pub(crate) const WGSL_COMMON: &str = include_str!("shaders/common_wasm.wgsl");
131#[cfg(not(target_arch = "wasm32"))]
132pub(crate) const WGSL_COMMON: &str = include_str!("shaders/common.wgsl");
133
134pub(crate) const WGSL_SHAPES: &str = include_str!("shaders/shapes.wgsl");
135
136#[cfg(target_arch = "wasm32")]
137pub(crate) const WGSL_MATERIAL_OPAQUE: &str = include_str!("shaders/material_opaque_wasm.wgsl");
138#[cfg(not(target_arch = "wasm32"))]
139pub(crate) const WGSL_MATERIAL_OPAQUE: &str = include_str!("shaders/material_opaque.wgsl");
140
141pub(crate) const WGSL_MATERIAL_GLASS: &str = include_str!("shaders/material_glass.wgsl");
142pub(crate) const WGSL_BIFROST: &str = include_str!("shaders/bifrost.wgsl");
143
144#[cfg(target_arch = "wasm32")]
145pub(crate) const WGSL_BLOOM: &str = include_str!("shaders/bloom_wasm.wgsl");
146#[cfg(not(target_arch = "wasm32"))]
147pub(crate) const WGSL_BLOOM: &str = include_str!("shaders/bloom.wgsl");
148
149pub(crate) const WGSL_COLOR_BLIND: &str = include_str!("shaders/color_blind.wgsl");
150pub(crate) const WGSL_TONEMAP: &str = include_str!("shaders/tonemap.wgsl");
151pub(crate) const WGSL_PARTICLES: &str = include_str!("shaders/particles.wgsl");
152
153pub mod color_blindness;
154
155// Re-export ColorBlindMode for downstream users
156pub use color_blindness::ColorBlindMode;
157
158// ShieldWall -- re-export AccessKit types so callers can build tree updates
159// without depending on accesskit directly.
160pub use accesskit::{
161    ActionHandler, ActionRequest, ActivationHandler, DeactivationHandler, Node, NodeId, Role, Tree,
162    TreeId, TreeUpdate,
163};
164pub use accesskit_winit::Adapter as ShieldWallAdapter;
165
166// Re-export ColorTheme and SceneUniforms for cvkg-render-gpu users
167pub use cvkg_core::{ColorTheme, SceneUniforms};
168
169pub use renderer::SurtrRenderer;
170
171// P1-35: SVG filter graph integration
172pub mod svg_filter_graph;
173pub use types::{SvgAnimation, SvgModel};
174pub use vertex::{InstanceData, Vertex};