filmstrip-effects/dev.jordond.filmstrip.effects.overlay/OverlayEffect

OverlayEffect

interface OverlayEffect : EffectSpec(source)

An effect drawn over the frame once geometry has settled.

Runs in EffectStage.Composite, so a position it names is a fraction of the frame the geometry stage produced and lands in the same place at any preview or export resolution.

Inheritors

ImageOverlay

TextOverlay

Properties

animation

open val animation: OverlayAnimation?

How the overlay is drawn at each frame of its run, or null to draw it the same way throughout.

beneathOverlays

open val beneathOverlays: Boolean

abstract val id: String

isInert

open val isInert: Boolean

requiresSdr

open val requiresSdr: Boolean

scope

open val scope: EffectScope

stage

open override val stage: EffectStage

visibleDuring

abstract val visibleDuring: TimeRange?

When the overlay is drawn, or null for the whole composition.