This animation was done with multiple CompositorVFX

CompositorEffects are often not just a single effect, but multiple effects working together. There is often the need to define animation parameters for fading them in and out.

That's why all RokojoriCompositorEffects have the property animationTargets, which allows to define mappings for properties from 0 to 1.

These animationTargets are used by the CompositorVFX.

RokojoriCompositorEffectAnimationTargets are the abstract/archetype target that the RokojoriCompositorEffects can work with. In the future, there are more planned, but for now, only one implementing type exists: CompFXMemberCurveTarget.

It needs the name of the member and a curve to map the values. The values can be scaled and it works for properties of the type float, int and bool.

CompFXMemberCurveTarget member: string = amount curve:Curve = Curve "Ease" curveScale:float = 1.0 targetType: Enum[Float,Int,Bool] = float

CompositorVFX are Nodes that hold a CompositorVFXPreset and animate them via a driverValue. A driverValue of 0 means the effect is off, while a value of 1 means it is on.

Layers & Sortation
When the a CompositorEffectLayer is specified and the target Compositor has a CompositorEffectLayerTargetSlot containing the layer, the effects are inserted after the slot while respecting the priority value. This can be used to correctly insert and layer multiple effects in a specific order.

CompositorVFX preset: CompositorVFXPreset = CompositorVFXPreset "Glow Bloom" driverValue: float (0,1) = 0.0 layer: CompositorEffectLayer = CompositorEffectLayer priority: int = 1

Presets for Multi-Effects
A CompositorVFXPreset is an array of multiple RokojoriCompositorEffects. It can be stored as presets and can be reused in many projects.

The Rokojori Action Library comes with a couple of built-in presets in the directory CompositorVFXPresets

CompositorVFXPreset Effects: RokojoriCompositorEffect = RokojoriCompositorEffect "RokojoriCompositorEffect[]" Size: int = 4 0: RokojoriCompositorEffect = VignetteEffect 1: RokojoriCompositorEffect = NoiseDistortionEffect 2: RokojoriCompositorEffect = ColorQuantizerEffect 3: RokojoriCompositorEffect = TemporalBlurEffect

Tweening
Use a TweenCompositorVFX to tween the driverValue of a CompositorVFX.

The tweens can easily be tested in the editor by pressing the button Trigger Action in Editor.

It has also some options to force a testing tween start value, so that a button press would force a tween from start value to end value.

TweenCompositorVFX compositorVFX: CompositorVFX = CompositorVFX "Star Glow" endValue: float = 1.0 duration: Duration = SecondsDuration curve: Curve ▾ Editor Testing forceStartValue: bool = false forcedStartValue: float = 0.0 Action triggerMode: Enum[Only_When_Processing_In_Hierarchy,Always] = Only_When_Processing_In_Hierarchy @ToolButton "(?) Help" @ToolButton "Trigger Action in Editor"

This animation was done with multiple CompositorVFX

Wipes are SequenceActions and have their own animation system.

They use WipeSettings to define the target Compositor and the WipeCompositorEffect and have a separate variable for the duration.

Wipe direction:Enum[In,Out] = In duration: Duration = SecondsDuration wipeSettings: wipeSettings = WipeSettings "Noise Wipe" Action triggerMode: Enum[Only_When_Processing_In_Hierarchy,Always] = Only_When_Processing_In_Hierarchy @ToolButton "(?) Help" @ToolButton "Trigger Action in Editor"
The direction determines whether is wiping in or out:
In: The screen will be hidden at the end
Out: The screen will be visible at the end

For now, there are only three wipes to choose from, but I may add more in the future. Let me know, if you have a good idea!

CircleWipe DirectionalWipe InOutWipe NoiseWipe