Back to Filament

StencilOperation

docs/android/dokka/filament-android/com.google.android.filament/-material-instance/-stencil-operation/index.md

1.75.02.3 KB
Original Source

//filament-android/com.google.android.filament/MaterialInstance/StencilOperation

StencilOperation

[main]
enum StencilOperation

Operations that control how the stencil buffer is updated.

Entries

KEEP[main]
KEEP
Keeps the current value.
ZERO[main]
ZERO
Sets the value to 0.
REPLACE[main]
REPLACE
Sets the value to the stencil reference value.
INCR_CLAMP[main]
INCR_CLAMP
Increments the current value. Clamps to the maximum representable unsigned value.
INCR_WRAP[main]
INCR_WRAP
Increments the current value. Wraps value to zero when incrementing the maximum representable unsigned value.
DECR_CLAMP[main]
DECR_CLAMP
Decrements the current value. Clamps to 0.
DECR_WRAP[main]
DECR_WRAP
Decrements the current value. Wraps value to the maximum representable unsigned value when decrementing a value of zero.
INVERT[main]
INVERT
Bitwise inverts the current value.

Functions

NameSummary
valueOf[main]
open fun valueOf(name: String): MaterialInstance.StencilOperation
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
values[main]
open fun values(): Array<MaterialInstance.StencilOperation>
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.