---
title: "StencilMode | JavaScript maps SDK"
description: "Documentation for MapTiler SDK"
---

> For AI agents: a documentation index is available at [/llms.txt](https://docs.maptiler.com/llms.txt). Markdown versions of all pages are available by appending .md to any URL.

# Class StencilMode

##### Index

### Constructors[](#constructors)

[constructor](#constructor)

### Properties[](#properties)

[depthFail](#depthfail) [fail](#fail) [mask](#mask) [pass](#pass) [ref](#ref) [test](#test) [disabled](#disabled)

## Constructors[](#constructors-1)

### constructor[](#constructor)

-   new StencilMode(  
        test: [StencilTestGL](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.StencilTestGL/),  
        ref: number,  
        mask: number,  
        fail: [StencilOpConstant](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.StencilOpConstant/),  
        depthFail: [StencilOpConstant](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.StencilOpConstant/),  
        pass: [StencilOpConstant](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.StencilOpConstant/),  
    ): StencilMode[](#constructorstencilmode)
    
    #### Parameters
    
    -   test: [StencilTestGL](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.StencilTestGL/)
    -   ref: number
    -   mask: number
    -   fail: [StencilOpConstant](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.StencilOpConstant/)
    -   depthFail: [StencilOpConstant](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.StencilOpConstant/)
    -   pass: [StencilOpConstant](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.StencilOpConstant/)
    
    #### Returns StencilMode
    

## Properties[](#properties-1)

### depthFail[](#depthfail)

depthFail: [StencilOpConstant](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.StencilOpConstant/)

### fail[](#fail)

fail: [StencilOpConstant](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.StencilOpConstant/)

### mask[](#mask)

mask: number

### pass[](#pass)

pass: [StencilOpConstant](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.StencilOpConstant/)

### ref[](#ref)

ref: number

### test[](#test)

test: [StencilTestGL](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.StencilTestGL/)

### `Static`disabled[](#disabled)

disabled: [Readonly](https://docs.maptiler.com/sdk-js/api-reference/types/Externals.Readonly/)<StencilMode\>
