diff options
Diffstat (limited to 'doc/EFFECT_WORKFLOW.md')
| -rw-r--r-- | doc/EFFECT_WORKFLOW.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/EFFECT_WORKFLOW.md b/doc/EFFECT_WORKFLOW.md index e453b63..22b8dc9 100644 --- a/doc/EFFECT_WORKFLOW.md +++ b/doc/EFFECT_WORKFLOW.md @@ -19,8 +19,8 @@ Automated checklist for adding new visual effects to the demo. ### 1. Create Effect Files **Location:** -- Header: `src/gpu/effects/<effect_name>_effect.h` -- Implementation: `src/gpu/effects/<effect_name>_effect.cc` +- Header: `src/effects/<effect_name>_effect.h` +- Implementation: `src/effects/<effect_name>_effect.cc` - Shader: `workspaces/main/shaders/<effect_name>.wgsl` **Naming Convention:** @@ -69,7 +69,7 @@ SHADER_TUNNEL, NONE, shaders/tunnel.wgsl, "Tunnel effect shader" **File:** `CMakeLists.txt` -**Action:** Add `src/gpu/effects/<effect_name>_effect.cc` to **BOTH** GPU_SOURCES sections: +**Action:** Add `src/effects/<effect_name>_effect.cc` to **BOTH** GPU_SOURCES sections: - Headless mode section (around line 141-167) - Normal mode section (around line 171-197) @@ -78,14 +78,14 @@ SHADER_TUNNEL, NONE, shaders/tunnel.wgsl, "Tunnel effect shader" **Example:** ```cmake # In headless section (line ~152): - src/gpu/effects/solarize_effect.cc - src/gpu/effects/tunnel_effect.cc # <-- Add here - src/gpu/effects/chroma_aberration_effect.cc + src/effects/solarize_effect.cc + src/effects/tunnel_effect.cc # <-- Add here + src/effects/chroma_aberration_effect.cc # In normal section (line ~183): - src/gpu/effects/solarize_effect.cc - src/gpu/effects/tunnel_effect.cc # <-- Add here - src/gpu/effects/chroma_aberration_effect.cc + src/effects/solarize_effect.cc + src/effects/tunnel_effect.cc # <-- Add here + src/effects/chroma_aberration_effect.cc ``` ### 4. Include in demo_effects.h @@ -94,7 +94,7 @@ SHADER_TUNNEL, NONE, shaders/tunnel.wgsl, "Tunnel effect shader" **Action:** Add include directive: ```cpp -#include "gpu/effects/<effect_name>_effect.h" +#include "effects/<effect_name>_effect.h" ``` **Location:** Alphabetically with other effect includes @@ -241,4 +241,4 @@ cmake --build build -j4 - `tools/shadertoy/README.md` - ShaderToy conversion guide - `doc/SEQUENCE.md` - Timeline format documentation - `doc/CONTRIBUTING.md` - General contribution guidelines -- `src/gpu/effects/` - Existing effect examples +- `src/effects/` - Existing effect examples |