jerome/wsg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

réorg doc

Browse Source
This commit is contained in:
Jérôme Bousquié
2026-09-25 19:08:20 +02:00
parent 7e88390006
commit 24fbafc810
34 changed files with 684 additions and 383 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+26 -15
View File
@@ -76,7 +76,7 @@ pollster = { version = "1", features = ["macro"] }
```
```sh
cargo run --example demo # full showcase (6 primitives, 3 lights, shadows, HDR)
cargo run -p wsg-lib --example demo # full showcase (6 primitives, 3 lights, shadows, HDR)
```
## Features
@@ -100,26 +100,37 @@ cargo run --example demo # full showcase (6 primitives, 3 lights, shadows, HDR
|-------|------|
| [docs/user/](docs/user/README.md) | **User guide** — how to use the API, step by step |
| [docs/tech/](docs/tech/ARCHI_APP.md) | **Internal architecture** — decisions, specs, targets |
| [lib/examples/](lib/examples/README.md) | **Examples** — 4 category folders (meshes/lights/cameras/effects), each with a README |
| [docs/ROADMAP.md](docs/ROADMAP.md) | Roadmap (phases 1-5 ✅, phase 6 in progress) |
| [docs/PLAN.md](docs/PLAN.md) | Recipe book (step history) |
| `cargo doc -p wsg-lib --no-deps` | **API reference** (rustdoc, 100% covered) |
## Examples
| Example | What it shows |
|---------|---------------|
| `demo` | Full showcase: 6 primitives, 3 lights, shadows, HDR, LOD, orbital camera |
| `bloom` | HDR bloom post-process |
| `hdr` | HDR + tone mapping (ACES/Reinhard) |
| `emissive` | Emissive materials + runtime exposure control |
| `shadow` | Shadow mapping in isolation |
| `culling` | GPU-driven frustum culling (15×15 grid) |
| `msaa` | 4× multisample anti-aliasing |
| `fog` | 3 fog modes (linear, exponential, exponential²) |
| `dof` | Depth of field with focus presets |
| `pbr` | PBR metallic/roughness + normal mapping |
| `import` | OBJ file import (feature `import-obj`) |
| `manual` | Low-level workflow (Context/Renderer/PipelineCache, no App) |
Sixteen examples in `lib/examples/`, organized into **four category folders** —
each folder has its own README (run commands, keys, what to observe):
[`lib/examples/README.md`](lib/examples/README.md). All run from the repo root
with `cargo run -p wsg-lib --example <name>` (feature-gated ones need
`--features`, e.g. `import` → `--features import-obj`).
| Folder | Example | What it shows |
|--------|---------|---------------|
| [`meshes/`](lib/examples/meshes/README.md) | `simple` | Minimal declarative workflow (flat unlit quad, ~15 lines) |
| | `cube` | Textured, lit, spinning cube (the 3D MVP) |
| | `pbr` | PBR metallic/roughness + normal mapping |
| | `import` | OBJ file import (feature `import-obj`) |
| | `manual` | Low-level workflow (Context/Renderer/PipelineCache, no App) |
| [`lights/`](lib/examples/lights/README.md) | `shadow` | Shadow mapping in isolation |
| | `shadow_test` | Dedicated shadow test (directional caster + PCF) |
| | `spot_test` | Isolated spot light (beam, penumbra) |
| | `emissive` | Emissive materials + runtime exposure control |
| [`cameras/`](lib/examples/cameras/README.md) | `culling` | GPU-driven frustum culling (15×15 grid) |
| [`effects/`](lib/examples/effects/README.md) | `demo` | Full showcase: 6 primitives, 3 lights, shadows, HDR, LOD, orbital camera |
| | `bloom` | HDR bloom post-process |
| | `hdr` | HDR + tone mapping (ACES/Reinhard) |
| | `msaa` | 4× multisample anti-aliasing |
| | `fog` | 3 fog modes (linear, exponential, exponential²) |
| | `dof` | Depth of field with focus presets |
## Cargo Features