Skip to main content

@novorender/api / RenderStateToonOutline

Interface: RenderStateToonOutline

Defined in: @novorender/src/core3d/state/index.ts:851

Toon shader related outline.

Remarks​

Toon shader is a deliberate misnomer of what is commonly referred to as outline shader. It is a post-effect that is applied on the output pixels to help visualize geometric edges and contours. Enabling it comes at a potentially significant performance penalty, depending on your device. It should thus be used sparingly, preferably only on idle frames, i.e. while the camera is not moving.

Properties​

color​

readonly color: RGB;

Defined in: @novorender/src/core3d/state/index.ts:861

Color to use for edges and contours.

enabled​

readonly enabled: boolean;

Defined in: @novorender/src/core3d/state/index.ts:859

Whether to do render "toon" outlines or not.

outlineObjects​

readonly outlineObjects: boolean;

Defined in: @novorender/src/core3d/state/index.ts:864

Creates an outline around each object in addition to edges, this can manually be disabled as it will create a lot of noise on scenes with a lot of z-fighting .