Class HalftoneEffect

Effect interface.

Lifecycle hooks:

init: called once on effect register
update: called every frame, before render
render: called every frame. Bypassed if omitted
dispose: called once on removal

outputRect declares the rect this stage writes into, in
element-local physical px. Defaults to the source rect (no growth).

Implements

Effect

Index

Constructors

Properties

Methods

render setInkPreset setParams

Constructors

constructor

new HalftoneEffect(initial?: Partial<HalftoneParams>): HalftoneEffect
Parameters
- initial: Partial<HalftoneParams> = {}
Returns HalftoneEffect
- Defined in effects/src/halftone.ts:282

Properties

params

params: HalftoneParams

Methods

render

render(ctx: EffectContext): void
Render phase. Omit to make this effect transparent in the chain.
Parameters
- ctx: EffectContext
Returns void
Implementation of Effect.render
- Defined in effects/src/halftone.ts:310

setInkPreset

setInkPreset(name: HalftoneInkPresetName): void
Apply a named ink preset. Presets are partial overlays — applying
a CMYK-only preset (e.g. "fogra51") leaves the RGB inks alone
and vice versa, so a story can switch presets per mode without
resetting the other side.
Parameters
- name: HalftoneInkPresetName
Returns void
- Defined in effects/src/halftone.ts:306

setParams

setParams(updates: Partial<HalftoneParams>): void
Parameters
- updates: Partial<HalftoneParams>
Returns void
- Defined in effects/src/halftone.ts:296