StencilModeOptions

Initial stencil test settings; omitted fields use StencilMode defaults.

interface StencilModeOptions {
    stencilComparison?: StencilComparison;
    stencilMask?: number | Readonly<StencilValue>;
    stencilOnly?: boolean;
    stencilReference?: number | Readonly<StencilValue>;
    stencilUpdateOperation?: StencilUpdateOperation;
}

Source & inheritance

Member directory5

Properties

stencilComparison?: StencilComparison

Comparison method; defaults to Always.

Source & inheritance

stencilMask?: number | Readonly<StencilValue>

Bitmask used for comparison; defaults to 0xffffffff.

Source & inheritance

stencilOnly?: boolean

Whether to write only stencil, not color; defaults to false.

Source & inheritance

stencilReference?: number | Readonly<StencilValue>

Reference value for comparison and replacement; defaults to 0.

Source & inheritance

stencilUpdateOperation?: StencilUpdateOperation

Update operation; defaults to Keep.

Source & inheritance