Interface Step

One step of a filter chain. Params missing from params take their defaults.

interface Step {
    enabled?: boolean;
    filter: Filter<any>;
    mask?: Mask;
    params?: Readonly<Record<string, unknown>>;
}

Index

Properties

enabled? filter mask? params?

Properties

`Optional` `Readonly`enabled

enabled?: boolean

Defaults to true. Disabled steps are skipped entirely.

`Readonly`filter

filter: Filter<any>

`Optional` `Readonly`mask

mask?: Mask

Restricts the step to part of the image: out = mix(in, step(in), mask).

`Optional` `Readonly`params

params?: Readonly<Record<string, unknown>>