Files
video-shader-toys/runtime/README.md
2026-05-08 16:42:23 +10:00

1.3 KiB

Runtime Files

This directory is used by the native host for local runtime output.

Tracked files:

  • templates/: source templates used to generate shader runtime code.

Packaged documentation:

  • ../docs/openapi.yaml: OpenAPI/Swagger spec for the local control API.
  • ../docs/OSC_CONTROL.md: OSC address and value reference.
  • http://127.0.0.1:<serverPort>/docs: Swagger UI page served by the native control server.

Generated files:

  • shader_cache/active_shader_wrapper.slang: generated Slang wrapper for the active shader/layer.
  • shader_cache/active_shader.raw.frag: raw GLSL emitted by slangc.
  • shader_cache/active_shader.frag: patched GLSL consumed by the OpenGL path.
  • runtime_state.json: autosaved latest layer stack, layer order, bypass state, shader assignments, and parameter values. The host reloads this file on startup.
  • stack_presets/*.json: user-saved layer stack presets.
  • screenshots/*.png: screenshots captured from the final output render target through the control UI/API.

Git policy:

  • Runtime cache/state/preset output is ignored by default.
  • Template files are source files and should stay tracked.
  • If a project wants shared stack presets, move selected preset JSON files into a tracked fixtures or presets directory intentionally rather than committing the whole runtime output tree.