filmstrip-core/dev.jordond.filmstrip.effect/EffectScope

EffectScope

enum EffectScope : Enum<EffectScope> (source)

Where an effect may be declared.

A track effect is lowered by fanning it onto every clip under the track, and a composition-level geometry effect is fanned the same way on a backend that has no composition-wide geometry pass. An effect that reads the time a frame sits at within its span therefore sees a span of its own on each clip rather than one across the track, which is a different picture on backends that fan and on backends that do not.

Entries

Everywhere

Valid at clip, track and composition scope.

ClipOnly

Valid on a clip alone.

Properties

entries

val entries: EnumEntries<EffectScope>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): EffectScope

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<EffectScope>

Returns an array containing the constants of this enum type, in the order they're declared.