Doc cleanup
This commit is contained in:
22
README.md
22
README.md
@@ -18,7 +18,7 @@ The app loads shader packages from `shaders/`, compiles Slang to GLSL at runtime
|
||||
|
||||
Native app internals are grouped by boundary:
|
||||
|
||||
- `app/`: startup/shutdown orchestration and runtime layer controller.
|
||||
- `app/`: startup/shutdown orchestration, runtime-content controller boundary, config, preview, telemetry, and HTTP hookup.
|
||||
- `control/`: HTTP/WebSocket server, command parsing, and runtime-state JSON presentation.
|
||||
- `frames/`: system-memory frame exchange and input mailbox handoff.
|
||||
- `render/`: render thread, readback, runtime render scene, and shared-context shader program preparation.
|
||||
@@ -129,6 +129,8 @@ The control UI provides:
|
||||
- A searchable shader library for adding layers.
|
||||
- Compact parameter rows with inline descriptions and intended OSC route copy controls.
|
||||
- Manual shader reload.
|
||||
- Host config editing, save, restart request, and NDI input source discovery.
|
||||
- Compact video I/O and render cadence status.
|
||||
|
||||
## Package
|
||||
|
||||
@@ -205,6 +207,7 @@ Current native test coverage includes:
|
||||
"oscBindAddress": "127.0.0.1",
|
||||
"oscPort": 9000,
|
||||
"oscSmoothing": 0.18,
|
||||
"runtimeShaderId": "",
|
||||
"input": {
|
||||
"backend": "decklink",
|
||||
"device": "default",
|
||||
@@ -218,12 +221,14 @@ Current native test coverage includes:
|
||||
"frameRate": "59.94",
|
||||
"pixelFormat": "auto",
|
||||
"keying": {
|
||||
"external": true,
|
||||
"alphaRequired": true
|
||||
"external": false,
|
||||
"alphaRequired": false
|
||||
}
|
||||
},
|
||||
"autoReload": true,
|
||||
"maxTemporalHistoryFrames": 12
|
||||
"maxTemporalHistoryFrames": 12,
|
||||
"previewEnabled": false,
|
||||
"previewFps": 59.94
|
||||
}
|
||||
```
|
||||
|
||||
@@ -245,7 +250,7 @@ http://127.0.0.1:<serverPort>
|
||||
|
||||
The current layer stack is autosaved to `runtime/runtime_state.json` whenever durable UI/API layer changes are accepted: add/remove, shader assignment, bypass state, ordering, parameter updates, parameter reset, and reload compatibility refreshes. Saves are debounced and written on a background worker, with a final flush during shutdown.
|
||||
|
||||
On startup, the host tries to reload `runtime/runtime_state.json` before compiling the stack. Valid saved layers are rebuilt in saved order, with shader id, bypass state, and parameter values restored. Missing shader packages are skipped, invalid saved parameter values fall back to shader defaults, and if the file is missing or unusable the app falls back to the configured default shader.
|
||||
On startup, the host tries to reload `runtime/runtime_state.json` before compiling the stack. Valid saved layers are rebuilt in saved order, with shader id, bypass state, and parameter values restored. Missing shader packages are skipped, invalid saved parameter values fall back to shader defaults, and if the file is missing or unusable the app falls back to the optional configured startup shader. The checked-in config leaves `runtimeShaderId` empty, so a fresh host uses the simple fallback renderer until layers are added or a saved stack exists.
|
||||
|
||||
Manual stack preset and screenshot routes are still present in the UI/OpenAPI surface, but they are not implemented by the current native command path yet. `runtime_state.json` is the supported latest-working-state mechanism for now.
|
||||
|
||||
@@ -278,7 +283,7 @@ Each parameter row still exposes the intended OSC route in the UI. The native ho
|
||||
|
||||
The control UI currently still shows preset and screenshot controls from the intended route surface. Those endpoints return an unimplemented action result in the native host until their backend paths are wired.
|
||||
|
||||
The planned screenshot output directory is:
|
||||
The reserved screenshot output directory is:
|
||||
|
||||
```text
|
||||
runtime/screenshots/
|
||||
@@ -318,8 +323,8 @@ Runtime-generated files are intentionally ignored:
|
||||
- `runtime/shader_cache/active_shader.raw.frag`
|
||||
- `runtime/shader_cache/active_shader.frag`
|
||||
- `runtime/runtime_state.json` autosaved latest stack and parameter state.
|
||||
- `runtime/stack_presets/*.json` planned manual preset output; preset routes are not implemented in the native host yet.
|
||||
- `runtime/screenshots/*.png` planned screenshot output; screenshot capture is not implemented in the native host yet.
|
||||
- `runtime/stack_presets/*.json` reserved manual preset output; preset routes are not implemented in the native host yet.
|
||||
- `runtime/screenshots/*.png` reserved screenshot output; screenshot capture is not implemented in the native host yet.
|
||||
|
||||
Only `runtime/templates/` and `runtime/README.md` are tracked.
|
||||
|
||||
@@ -366,7 +371,6 @@ If these variables are not set, CMake first looks under the private `video-io-3r
|
||||
- Anotate included shaders
|
||||
- allow 3 vector exposed controls
|
||||
- add nearest sampling to the extra shader pass
|
||||
- add spout input/output (https://github.com/leadedge/Spout2)
|
||||
- Add Aja input and output (Assuming i can get a hold of an aja card)
|
||||
- Add bluefish input and output (Assuming again card acess)
|
||||
- Endpoint to show OSC paths seperatly instead of a part of the control UI
|
||||
|
||||
Reference in New Issue
Block a user