|
1 | | -# scheng SDK (v0.1.0) (WIP) |
| 1 | +<p align="center"> |
| 2 | + <img width="35%" height="35%" src="https://raw.githubusercontent.com/schwwaaa/scheng/refs/heads/main/img/logo.png"/> |
| 3 | +</p> |
2 | 4 |
|
3 | | -This workspace is the developer-facing SDK extracted from scheng. |
4 | | - |
5 | | -- `scheng-core`: pure data model (configs/events), no OS/GL/IO deps. |
6 | | -- `scheng-runtime-glow`: OpenGL/glow runtime ("shader machine"). |
7 | | -- `scheng-host-winit`: optional host glue (windowing/policy), kept separate. |
8 | | -- `examples/minimal`: shows intended SDK usage. |
9 | | - |
10 | | -Design rule: **engine takes bytes/handles, returns pixels/errors; host handles files/windows/devices/policy.** |
11 | | - |
12 | | -## Engine Contract |
13 | | - |
14 | | -See `docs/ENGINE_CONTRACT.md`. |
15 | | - |
16 | | -## Runtime invariants (read this if you are building on scheng) |
17 | | - |
18 | | -- `docs/RUNTIME_INVARIANTS.md` — the non-negotiable layering rules |
19 | | -- `docs/PORTS_AND_MIXERS.md` — PortId ordering + mixer semantics |
20 | | -- `docs/SCENES_AND_BANKS.md` — banks/scenes data model + JSON schema |
21 | | - |
22 | | -## Examples |
23 | | - |
24 | | -```bash |
25 | | -cargo run -p scheng-example-minimal |
26 | | -cargo run -p scheng-example-pure-single-pass |
27 | | -cargo run -p scheng-example-render-target-only |
28 | | -``` |
29 | | - |
30 | | -Graph → Plan → Runtime (C3): |
31 | | - |
32 | | -```bash |
33 | | -cargo run -p scheng-example-graph-minimal |
34 | | -cargo run -p scheng-example-graph-chain2 |
35 | | -cargo run -p scheng-example-graph-mixer2 |
36 | | -cargo run -p scheng-example-graph-mixer-builtin |
37 | | -``` |
38 | | - |
39 | | -Matrix mixer + banks/scenes (C4): |
40 | | - |
41 | | -```bash |
42 | | -cargo run -p scheng-example-graph-matrix-mix4 -- --banks banks.json |
43 | | -``` |
44 | | - |
45 | | -```bash |
46 | | -cargo run -p scheng-example-feedback-pingpong |
47 | | -``` |
48 | | - |
49 | | -## OSC (example) |
50 | | - |
51 | | -`feedback_pingpong` listens on `127.0.0.1:9000` for `/param/<name> <float>` messages. |
52 | | - |
53 | | -Params: `u_speed`, `u_amount`, `u_shift`, `u_mix`. |
54 | | - |
55 | | -```bash |
56 | | -cargo run -p scheng-example-feedback-orb |
57 | | -``` |
58 | | - |
59 | | -`feedback_orb` params: `u_decay`, `u_gain`, `u_blur`, `u_add`, `u_smear`, `u_smear_angle`, `u_smear_strength`, `u_mix`, `u_bg`. |
60 | | - |
61 | | -Max patches are in `max/`. |
62 | | - |
63 | | - |
64 | | -## Contract Gate (forbidden deps) |
65 | | - |
66 | | -Run locally: |
67 | | - |
68 | | -```bash |
69 | | -bash ci/check_forbidden_deps.sh |
70 | | -``` |
| 5 | +<p align="center"><em>Rust-based engine for GPU-accelerated video synthesis and real-time video instrument development.</em></p> |
0 commit comments