Skip to main content

interface.RenderStateClippingPlane

API > RenderStateClippingPlane

Interface: RenderStateClippingPlane

Render state for a single clipping plane.

Properties​

color​

color?: RGBA

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

Source​

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

normalOffset​

readonly normalOffset: ReadonlyVec4

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

Source​

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

outline​

outline?: object

Geometry outline settings for this clipping plane.

Type declaration​

outline.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.

outline.lineColor​

lineColor?: RGB

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

Source​

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