Skip to content

1681-engine / index / DitherWipeOptions

Interface: DitherWipeOptions ​

Defined in: src/transitions/DitherWipeTransition.ts:6

Properties ​

cell? ​

ts
optional cell?: number;

Defined in: src/transitions/DitherWipeTransition.ts:14

Screen pixels per dither cell (default the main camera's zoom, so a cell is one world pixel).


color? ​

ts
optional color?: number;

Defined in: src/transitions/DitherWipeTransition.ts:8

0xrrggbb (default black).


direction? ​

ts
optional direction?: "none" | "left" | "right" | "up" | "down";

Defined in: src/transitions/DitherWipeTransition.ts:12

The way the wipe travels, or 'none' for the whole screen dissolving at once (default 'right').


duration? ​

ts
optional duration?: number;

Defined in: src/transitions/DitherWipeTransition.ts:10

Ms for each half (default 450).


softness? ​

ts
optional softness?: number;

Defined in: src/transitions/DitherWipeTransition.ts:16

Share of the screen the dithered edge spans (default 0.35).

Released under the MIT License.