# StencilFunction

Scene/StencilFunction.js 8
Determines the function used to compare stencil values for the stencil test.

##### Properties:

Name | Type | Description
--- | --- | ---
`NEVER` | Number | The stencil test never passes.
`LESS` | Number | The stencil test passes when the masked reference value is less than the masked stencil value.
`EQUAL` | Number | The stencil test passes when the masked reference value is equal to the masked stencil value.
`LESS_OR_EQUAL` | Number | The stencil test passes when the masked reference value is less than or equal to the masked stencil value.
`GREATER` | Number | The stencil test passes when the masked reference value is greater than the masked stencil value.
`NOT_EQUAL` | Number | The stencil test passes when the masked reference value is not equal to the masked stencil value.
`GREATER_OR_EQUAL` | Number | The stencil test passes when the masked reference value is greater than or equal to the masked stencil value.
`ALWAYS` | Number | The stencil test always passes.

### Members

#### static constant Cesium.StencilFunction.ALWAYS : Number
Scene/StencilFunction.js 71

The stencil test always passes.

Default Value: `WebGLConstants.ALWAYS`

#### static constant Cesium.StencilFunction.EQUAL : Number
Scene/StencilFunction.js 31

The stencil test passes when the masked reference value is equal to the masked stencil value.

Default Value: `WebGLConstants.EQUAL`

#### static constant Cesium.StencilFunction.GREATER : Number
Scene/StencilFunction.js 47

The stencil test passes when the masked reference value is greater than the masked stencil value.

Default Value: `WebGLConstants.GREATER`

#### static constant Cesium.StencilFunction.GREATER_OR_EQUAL : Number
Scene/StencilFunction.js 63

The stencil test passes when the masked reference value is greater than or equal to the masked stencil value.

Default Value: `WebGLConstants.GEQUAL`

#### static constant Cesium.StencilFunction.LESS : Number
Scene/StencilFunction.js 23

The stencil test passes when the masked reference value is less than the masked stencil value.

Default Value: `WebGLConstants.LESS`

#### static constant Cesium.StencilFunction.LESS_OR_EQUAL : Number
Scene/StencilFunction.js 39

The stencil test passes when the masked reference value is less than or equal to the masked stencil value.

Default Value: `WebGLConstants.LEQUAL`

#### static constant Cesium.StencilFunction.NEVER : Number
Scene/StencilFunction.js 15

The stencil test never passes.

Default Value: `WebGLConstants.NEVER`

#### static constant Cesium.StencilFunction.NOT_EQUAL : Number
Scene/StencilFunction.js 55

The stencil test passes when the masked reference value is not equal to the masked stencil value.

Default Value: `WebGLConstants.NOTEQUAL`