API

Interface IStencilState

Interface defining the stencil state.

interface IStencilState {
    backFunc: number;
    backOpDepthFail: number;
    backOpStencilDepthPass: number;
    backOpStencilFail: number;
    enabled: boolean;
    func: number;
    funcMask: number;
    funcRef: number;
    mask: number;
    opDepthFail: number;
    opStencilDepthPass: number;
    opStencilFail: number;
    reset(): void;
}

Hierarchy (View Summary)

Implemented by

Index
backFunc: number

The stencil comparison function to use for back faces.

backOpDepthFail: number

The operation to perform when the stencil test passes but the depth test fails for back faces.

backOpStencilDepthPass: number

The operation to perform when both the stencil and depth tests pass for back faces.

backOpStencilFail: number

The operation to perform when the stencil test fails for back faces.

enabled: boolean

Whether the stencil test is enabled or not.

func: number

The stencil comparison function to use for front faces.

funcMask: number

The stencil mask to use for reading.

funcRef: number

The reference value to use for the stencil test.

mask: number

The stencil mask to use for writing.

opDepthFail: number

The operation to perform when the stencil test passes but the depth test fails for front faces.

opStencilDepthPass: number

The operation to perform when both the stencil and depth tests pass for front faces.

opStencilFail: number

The operation to perform when the stencil test fails for front faces.