filmstrip-core/dev.jordond.filmstrip.effect

Package-level declarations

Types

Attributes

class Attributes

Cross-cutting facts the pipeline resolved before any effect ran.

AuxInput

class AuxInput(val image: ImageSource, val chain: List<FilterNode> = emptyList(), val timeline: AuxTimeline? = null)

An extra input a FilterFragment needs, such as the image an overlay composites.

AuxTimeline

class AuxTimeline(val frameRate: Float, val duration: Duration)

How long an AuxInput's branch runs for, and at what rate it advances.

CoreImageEffect

fun interface CoreImageEffect

One step of a Core Image chain.

Degradation

class Degradation(val reason: DegradationReason, val message: String)

One way an EffectResolution.Degraded differs from what was declared.

DegradationReason

enum DegradationReason : Enum<DegradationReason>

Why a resolution is EffectResolution.Degraded rather than exact.

EffectIds

object EffectIds

The identifiers of filmstrip's built-in effects.

EffectResolution

sealed interface EffectResolution

The outcome of asking one resolver to realize one spec.

EffectResolver

fun interface EffectResolver

Realizes an EffectSpec as something the current platform can render.

EffectScope

enum EffectScope : Enum<EffectScope>

Where an effect may be declared.

EffectSpec

interface EffectSpec

A declaration of an effect: pure data describing intent rather than realization.

EffectStage

enum EffectStage : Enum<EffectStage>

The fixed pipeline stages, in execution order.

FilterArgument

class FilterArgument(val key: String, val value: String)

One key=value argument to a FilterNode.

FilterBranch

class FilterBranch(val reads: List<String>, val nodes: List<FilterNode>, val writes: List<String>)

One chain of a FilterFragment.branches graph, or a fan out when it writes more than one pad.

FilterCrop

class FilterCrop(val width: String, val height: String, val x: String? = null, val y: String? = null, val exact: Boolean = true)

The region a FilterFragment works on, as the tool's crop filter would cut it.

FilterFragment

class FilterFragment

One effect's contribution to a filter graph.

FilterNode

class FilterNode(val name: String, val arguments: List<FilterArgument> = emptyList())

One filter, and the arguments it is configured with.

FrameInfo

class FrameInfo

What a CoreImageEffect is told about the frame it has been handed.

PlatformEffect

actual class PlatformEffect

The Android form: a media3 Effect that runs as its own pass, or a TextureOverlay that the pipeline blends with the overlays next to it.

actual class PlatformEffect

The Apple form: one step of a Core Image chain.

expect class PlatformEffect

A platform's own realization of one EffectSpec, opaque to common code.

actual class PlatformEffect

The JVM form: a fragment of a filter graph.

actual class PlatformEffect

The browser form: a declaration of one render pass, not a compiled program.

RenderApi

enum RenderApi : Enum<RenderApi>

Which rendering API is behind the effect pipeline.

RenderCapabilities

class RenderCapabilities

What the platform can actually render, on this device, right now.

RenderFeature

enum RenderFeature : Enum<RenderFeature>

Additive capability flags.

Sidecar

class Sidecar(val bytes: ByteArray, val extension: String)

A file an effect needs the tool to read, such as the lookup table a color grade lowers to.

WebGlPass

class WebGlPass

One pass of a browser render chain, described rather than compiled.

Functions

inCanonicalOrder

fun List<EffectSpec>.inCanonicalOrder(): List<EffectSpec>

Sorts this into the canonical pipeline order.