Skip to main content

@novorender/api / RenderStateClipping

Interface: RenderStateClipping

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

Clipping related render state.

Properties​

draw​

readonly draw: boolean;

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

Whether or not to visualize the clipping planes themselves.

enabled​

readonly enabled: boolean;

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

Whether to enable or disable geometry clipping.

Remarks​

Clipping only applies to static/streamble geometry. Enabling clipping comes at a minor cost of rendering performance.

mode​

readonly mode: ClippingMode;

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

How to combine multiple clipping planes.

planes​

readonly planes: readonly RenderStateClippingPlane[];

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

An array of up to 6 clipping planes.