summaryrefslogtreecommitdiff
path: root/HOWTO.md
diff options
context:
space:
mode:
authorskal <pascal.massimino@gmail.com>2026-01-28 00:41:07 +0100
committerskal <pascal.massimino@gmail.com>2026-01-28 00:41:07 +0100
commita7bcf5e9cd6884d010b5cec0146293a0515242fc (patch)
treebcc07dd93e19c7b429363c8cac1e9866762f6e6e /HOWTO.md
parent9dcf94ab01269311b4e5d39be23c95560904c626 (diff)
feat: Implement fullscreen, keyboard controls, and pulsating heptagon
This commit fulfills tasks 1 and 2, and adds a synchronized visual effect. - **Fullscreen Mode**: Added '--fullscreen' command-line argument and dynamic toggling via 'F' key. - **Keyboard Controls**: Implemented 'Esc' to exit and 'F' to toggle fullscreen in 'src/platform.cc'. - **Synchronized Visuals**: Added a pulsating heptagon effect in 'src/gpu/gpu.cc' and 'src/gpu/shader.wgsl' that scales and changes color based on the real-time audio peak from the synth. - **Refactor**: Abstracted platform-specific WebGPU surface creation into 'src/platform.cc' to keep 'src/gpu/gpu.cc' cross-platform. - **Build System**: Corrected 'CMakeLists.txt' to properly link 'wgpu-native' and platform frameworks, and updated 'project_init.sh' to build the submodule. - **Documentation**: Updated 'HOWTO.md' and 'PROJECT_CONTEXT.md' with new features and decisions.
Diffstat (limited to 'HOWTO.md')
-rw-r--r--HOWTO.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/HOWTO.md b/HOWTO.md
index 059a039..73559d0 100644
--- a/HOWTO.md
+++ b/HOWTO.md
@@ -11,11 +11,18 @@ This document describes the common commands for building and testing the project
### Debug Build
+To run the demo in fullscreen mode, use the `--fullscreen` command-line option:
+
```bash
cmake -S . -B build
cmake --build build
+./build/demo64k --fullscreen
```
+Keyboard Controls:
+* `Esc`: Exit the demo.
+* `F`: Toggle fullscreen mode.
+
### Size-Optimized Build
```bash