Interface EffectParams

Parameters for a ViewStyleBin material.

interface EffectParams {
    backfaces?: boolean;
    clearDepthBefore?: boolean;
    edgeAlpha?: number;
    edgeColor?: Vec3;
    edges?: boolean;
    edgeWidth?: number;
    fill?: boolean;
    fillAlpha?: number;
    fillColor?: Vec3;
}

Hierarchy (View Summary)

Properties

backfaces? clearDepthBefore? edgeAlpha? edgeColor? edges? edgeWidth? fill? fillAlpha? fillColor?

Properties

Optionalbackfaces

backfaces?: boolean

Whether Effect backfaces are visible.

Default is false.

OptionalclearDepthBefore

clearDepthBefore?: boolean

Sets whether to clear the depth buffer before rendering this style bin.

When true, objects in this style bin are also rendered in a depth-cleared style-bin pass, making the bin treatment visible through occluding geometry while leaving the object's normal rendering treatment intact.

Default is false.

Note: updating this property marks the View dirty but does not change membership.

OptionaledgeAlpha

edgeAlpha?: number

Opacity of Effect edges.

Value is in range [0..1].

Default is 1.

OptionaledgeColor

edgeColor?: Vec3

The RGB color of Effect edges.

Default is [0.2, 0.2, 0.2].

Optionaledges

edges?: boolean

Whether Effect edges are visible.

Default is true.

OptionaledgeWidth

edgeWidth?: number

Pixel width of Effect edges.

Default is 1.

Optionalfill

fill?: boolean

Whether Effect surfaces are filled.

Default is true.

OptionalfillAlpha

fillAlpha?: number

Opacity of Effect surfaces.

Value is in range [0..1].

Default is 1.

OptionalfillColor

fillColor?: Vec3

The RGB color of Effect surfaces.

Default is [1.0, 1.0, 1.0].

Settings

Member Visibility

On This Page

Properties