Skip to content

1681-engine / postfx / PostFxOptions

Interface: PostFxOptions ​

Defined in: src/postfx/PostFx.ts:9

Properties ​

backdrop? ​

ts
optional backdrop?: number | false;

Defined in: src/postfx/PostFx.ts:20

Fills the screen behind the picture with this colour (default the renderer's background when layer is 'all'). Effects only see what is drawn: without a backdrop the empty background stays untouched by a vignette or a flash. false for none.


honourReducedFx? ​

ts
optional honourReducedFx?: boolean;

Defined in: src/postfx/PostFx.ts:22

Skip flashes and shockwaves while the player asked for reduced effects (default true).


layer? ​

ts
optional layer?: Container<ContainerChild> | "all" | "world";

Defined in: src/postfx/PostFx.ts:14

What the effects lie over: 'all' (default) the whole picture, HUD included; 'world' the camera's layer only, so the HUD stays sharp; or any container.

Released under the MIT License.