# GPUStencilFaceState

Artifact: [androidx.webgpu:webgpu](https://developer.android.com/jetpack/androidx/releases/webgpu) [View Source](https://cs.android.com/search?q=file:androidx/webgpu/GPUStencilFaceState.kt+class:androidx.webgpu.GPUStencilFaceState) Added in [1.0.0-alpha06](https://developer.android.com/jetpack/androidx/releases/webgpu#1.0.0-alpha06)

*** ** * ** ***


```
class GPUStencilFaceState
```

<br />

*** ** * ** ***

Describes the stencil state for a single face of a primitive.

## Summary

| ### Nested types |
|---|
| `class https://developer.android.com/reference/kotlin/androidx/webgpu/GPUStencilFaceState.Builder` Builder for `https://developer.android.com/reference/kotlin/androidx/webgpu/GPUStencilFaceState`. |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/webgpu/GPUStencilFaceState#GPUStencilFaceState(kotlin.Int,kotlin.Int,kotlin.Int,kotlin.Int)(compare: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, failOp: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, depthFailOp: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, passOp: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/webgpu/GPUStencilFaceState#compare()` The comparison function for the stencil test. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/webgpu/GPUStencilFaceState#depthFailOp()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/webgpu/GPUStencilFaceState#failOp()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/webgpu/GPUStencilFaceState#passOp()` |

## Public constructors

### GPUStencilFaceState

Added in [1.0.0-alpha06](https://developer.android.com/jetpack/androidx/releases/webgpu#1.0.0-alpha06)

```
GPUStencilFaceState(
    compare: Int = CompareFunction.Always,
    failOp: Int = StencilOperation.Keep,
    depthFailOp: Int = StencilOperation.Keep,
    passOp: Int = StencilOperation.Keep
)
```

## Public properties

### compare

Added in [1.0.0-alpha06](https://developer.android.com/jetpack/androidx/releases/webgpu#1.0.0-alpha06)

```
var compare: Int
```

The comparison function for the stencil test. Defaults to @see `https://developer.android.com/reference/kotlin/androidx/webgpu/CompareFunction#Always()`.

Value is one of the following:

- `0`
- `1`
- `2`
- `3`
- `4`
- `5`
- `6`
- `7`
- `8`

<br />

### depthFailOp

Added in [1.0.0-alpha06](https://developer.android.com/jetpack/androidx/releases/webgpu#1.0.0-alpha06)

```
var depthFailOp: Int
```

Value is one of the following:

- `0`
- `1`
- `2`
- `3`
- `4`
- `5`
- `6`
- `7`
- `8`

<br />

### failOp

Added in [1.0.0-alpha06](https://developer.android.com/jetpack/androidx/releases/webgpu#1.0.0-alpha06)

```
var failOp: Int
```

Value is one of the following:

- `0`
- `1`
- `2`
- `3`
- `4`
- `5`
- `6`
- `7`
- `8`

<br />

### passOp

Added in [1.0.0-alpha06](https://developer.android.com/jetpack/androidx/releases/webgpu#1.0.0-alpha06)

```
var passOp: Int
```

Value is one of the following:

- `0`
- `1`
- `2`
- `3`
- `4`
- `5`
- `6`
- `7`
- `8`

<br />