Getting started with ZenFG
Choose a path for your application. ZenFG coordinates graph-visible GPU work; your application owns the device, rendering policy, and presentation.
| Goal | Start here | What you will get |
|---|---|---|
| Integrate TypeScript and WebGPU | WebGPU quick start | A clear-only presentation frame |
| Integrate Rust and wgpu | Rust quick start | A CPU-only compiled graph, followed by device-backed recipes |
| Read or produce Snapshot data | TypeScript Snapshot or Rust Snapshot | Validated, canonical portable diagnostics |
| Embed a visual debugger | Inspector quick start | A browser workbench for your captures |
Before you start
Read Compatibility for package and toolchain requirements. Browser FrameGraph execution needs native WebGPU on HTTPS or localhost. Snapshot processing and the Inspector do not require a GPU. Pin exact beta package versions and check that your producer and consumer agree on the Snapshot wire version.
Continue by task
- Understand Core concepts: recording, content validity, dependencies, retention, and resource lifetimes.
- Follow the complete TypeScript recipes for transient resources, imported storage, persistent state, external submissions, snapshots, and GPU timing.
- Use the Inspector workbench guide and theme guide.
- Read the Snapshot specification for the portable wire contract.
- Explore the Examples or open the standalone Inspector.
API reference
TypeScript API is generated from public source comments. For an installed version, follow its package manifest's exports to the included declarations and source. Rust API reference is on docs.rs; each crate README links its exact version.
Versions and contributing
The website follows the development branch. Installed READMEs, packaged examples, and per-package release tags preserve documentation for published versions. See beta.4 migration guidance and the changelog.
For repository work, read Contributing, the documentation workflow, and the release process.