Skip to main content

@novorender/api / RenderStateClippingPlane

Interface: RenderStateClippingPlane

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

Render state for a single clipping plane.

Properties​

color?​

readonly optional color: RGBA;

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

The color to use when visualizing the clipping plane, or undefined to not visualize.

normalOffset​

readonly normalOffset: ReadonlyVec4;

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

The half-space normal (xyz) and signed offset/distance (w) of the plane.

outline?​

readonly optional outline: object;

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

Geometry outline settings for this clipping plane.

enabled​

enabled: boolean;

Whether to render outlines or not.

Remarks​

Currently, due to limitations in WebGL2, outlines are a costly features that is disabled on weaker devices. Even on more powerful GPUs this feature should be used sparingly.

lineColor?​

optional lineColor: RGB;

The color to use for the outlines of this plane, or undefined to use the default outline color.