interface.RenderStateClipping

API > RenderStateClipping

Interface: RenderStateClipping

Clipping related render state.

Properties

draw

readonly draw: boolean

Whether or not to visualize the clipping planes themselves.

Source

@novorender/core3d/state/index.ts:523

---

enabled

readonly enabled: boolean

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.

Source

@novorender/core3d/state/index.ts:518

---

mode

readonly mode: ClippingMode

How to combine multiple clipping planes.

Source

@novorender/core3d/state/index.ts:526

---

planes

readonly planes: readonly RenderStateClippingPlane[]

An array of up to 6 clipping planes.

Source

@novorender/core3d/state/index.ts:529