Skip to main content

VolumeFxToolkit

16 tools in this family (folder Editor/Tools/VolumeFxToolkit/ in the bridge package). Effect: writes changes the project or the scene, read-only does not, destructive deletes or overwrites and the client asks before running it.

ToolEffectDescription
volumefx_add_timeline_clipwritesAdd a VolumeFx clip to a VolumeFxTimelineTrack inside an existing TimelineAsset. The clip carries th…
volumefx_apply_profilewritesApply one of the 18 built-in preset profiles to the camera's stack.
volumefx_chain_effectswritesSchedule a sequence of effects firing one after another with explicit delays. Each step is
volumefx_configure_effectwritesUpdate parameters of an active effect identified by tag. Pass the same fields as volumefx_trigger
volumefx_create_custom_effectwritesEmit a custom HLSL fragment shader from user-supplied code and register a CustomHlslFx that uses
volumefx_create_timeline_trackwritesCreate a new TimelineAsset with a VolumeFxTimelineTrack bound to the camera's controller.
volumefx_disable_effect_in_stackwritesRemove a triggered effect from the stack by tag. Equivalent to volumefx_stop for that tag.
volumefx_enable_effect_in_stackwritesAdd an effect as a persistent triggered event (composable layered effect that runs until removed).
volumefx_export_setupread-onlyExport the camera's full active queue as JSON. Useful for snapshotting a setup, sharing with
volumefx_fade_outwritesFade out an active effect over time (it keeps running but weight decays to 0, then drops).
volumefx_load_profilewritesLoad a VolumeFxProfile asset and replay its event spec onto the camera's queue.
volumefx_play_loopedwritesStart a looped effect that runs until stopped via volumefx_stop or volumefx_fade_out.
volumefx_save_profilewritesSave the camera's current active stack (every event's effect spec) to a VolumeFxProfile
volumefx_setupwritesAttach a VolumeFxStackController to a Camera. Without this you cannot use any other volumefx_* tool.…
volumefx_stopwritesStop an active effect by tag (immediately removes from queue). Pass tag='*' or omit to stop all.
volumefx_triggerwritesTrigger a one-shot effect. 'effect' is the effect id (color_overlay, flash, fade,