Skip to content

SarabOrtex

SarabOrtex is a 100% SkSL shader player with high compatibility for existing Shadertoy / GLSL shaders (continuously improving), plus a smart frame cache and color grading.

Overview

To document

Describe what SarabOrtex does, when to reach for it, and the visual result. Add a hero image/GIF here (see Media below).

Shaders inside your footage

With SarabResolver upstream, a SarabOrtex shader can live inside the shot: it follows the real camera, sits at a real depth, hides behind real objects, and shadows, lights and reflects the real room. Chain: Read → SarabResolver (Output = Source with depth in alpha) → SarabOrtex. See Shaders in real footage for the setup, the scene functions, and a porting guide for shader authors.

Adding it to your shot

Apply SarabOrtex from the SarabFX category in the Effects/OFX library of DaVinci Resolve, Nuke, Natron, or any other OFX-compatible host, then drag it onto your clip/node. (Restart the host after installing new plugins.)

Key parameters

Parameter What it controls Default
example to document —

To document

Fill this table with the plugin's real UI parameters (group by the panels shown in the host).

Viewport gizmos

To document

SarabOrtex provides a camera gizmo in the viewport for shaders that expose camera-style uniforms. Document how to drag/rotate/scale and any modifier keys. Note: overlays render in canonical coordinates scaled by renderScale — see the coordinate-system notes in the internal engineering docs if you're debugging gizmo drift across preview resolutions.

Lua scripting

SarabOrtex can override parameters at render time via Lua — define a function named after the parameter you want to override, taking the current time as its argument:

-- General SarabFX Lua override pattern: a function named after the
-- parameter, returning the value to use at this render time.
function parameterName(time)
    return baseValue + wiggle(time, amplitude, frequency)
end

To document

List every scriptable parameter/hook exposed by SarabOrtex, the exact function names expected by the default script, and the helpers available (wiggle, time, etc.). See scripts/ for the bundled default script once one exists for this plugin.

Examples & media

Adding screenshots & videos

Drop assets in docs/assets/plugins/sarabortex/ and embed them:

  • Image: ![What it shows](../assets/plugins/sarabortex/example.png)
  • Video: a raw HTML5 block —
    <video controls width="100%"><source src="../assets/plugins/sarabortex/demo.mp4" type="video/mp4"></video>
    

Tips & troubleshooting

To document

Common pitfalls, performance notes (GPU/frame cache), host-specific quirks. - SarabOrtex targets high compatibility with existing Shadertoy / GLSL shaders and improves continuously. Document which shaders are known to run cleanly, note any that need a minor tweak, and point users to the in-app shader submission flow so anything that doesn't render yet can be added. - Enable the Smart Frame Cache (Memory / Disk / Hybrid) for smooth looped playback of expensive shaders — the cache auto-invalidates on parameter change or shader hot-reload.


See also: Installation · Activation · All plugins