Interface StencilStateOptions

What a StencilState is asked for. Every field is optional and every default is GL's own initial state, so new StencilState() describes a material that enables the stencil test and changes nothing — see StencilState.

interface StencilStateOptions {
    depthFailOp?: StencilOp;
    failOp?: StencilOp;
    func?: StencilFunc;
    passOp?: StencilOp;
    readMask?: number;
    ref?: number;
    writeMask?: number;
}

Index

Properties

depthFailOp? failOp? func? passOp? readMask? ref? writeMask?

Properties

`Optional`depthFailOp

depthFailOp?: StencilOp

Initial StencilState.depthFailOp; defaults to "keep".

`Optional`failOp

failOp?: StencilOp

Initial StencilState.failOp; defaults to "keep".

`Optional`func

func?: StencilFunc

Initial StencilState.func; defaults to "always".

`Optional`passOp

passOp?: StencilOp

Initial StencilState.passOp; defaults to "keep".

`Optional`readMask

readMask?: number

Initial StencilState.readMask; defaults to 0xff.

`Optional`ref

ref?: number

Initial StencilState.ref; defaults to 0.

`Optional`writeMask

writeMask?: number

Initial StencilState.writeMask; defaults to 0xff.