Description

The stencil test state for Pass.

interface StencilState {
    depthFailureOperation: StencilOperation;
    depthStencilPassOperation: StencilOperation;
    enabled: boolean;
    face: StencilFace;
    readMask: number;
    referenceValue: number;
    stencilCompareFunction: StencilFunction;
    stencilFailureOperation: StencilOperation;
    writeMask: number;
    getTypeName(): string;
    isOfType(type): boolean;
    isSame(other): boolean;
}

Hierarchy (view full)

Properties

depthFailureOperation: StencilOperation

Description

Specifies the stencil action when the stencil test passes, but the depth test fails. The initial value is "Keep".

depthStencilPassOperation: StencilOperation

Description

Specifies the stencil action when both the stencil test and the depth test pass, or when the stencil test passes and either there is no depth buffer or depth testing is not enabled. The initial value is "Keep".

enabled: boolean

Description

Enable or disable the stencil test for pass. The initial value is false.

Description

Specifies whether the front and/or back face stencil test will be applied. The initial value is "FrontAndBack"

readMask: number

Description

Specifies a mask that is ANDed with both the reference value and the stored stencil value when the test is done. The initial value is 0xFF.

referenceValue: number

Description

Specifies the reference value for the stencil test. It is clamped to the range [0..pow(2, n)1], where n is the number of bitplanes in the stencil buffer. The initial value is 0.

stencilCompareFunction: StencilFunction

Description

Specifies the stencil test function. The initial value is "Always".

stencilFailureOperation: StencilOperation

Description

Specifies the action to take when the stencil test fails. The initial value is "Keep".

writeMask: number

Description

Specifies a bit mask to enable and disable writing of individual bits in the stencil planes. Initially, the mask is 0xFF.

Methods

  • Returns string

    Description

    Returns the name of this object's type.

  • Parameters

    • type: string

    Returns boolean

    Description

    Returns true if the object matches or derives from the passed in type.

  • Parameters

    Returns boolean

    Description

    Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Generated using TypeDoc