Class StencilOperation

Stencil operation modes.

System.Object
StencilOperation
Namespace: FlaxEngine
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public sealed class StencilOperation : Enum

Fields

Decrement

Decrement the stencil value by 1, and wrap the result if necessary.

Declaration
public const StencilOperation Decrement
Field Value
StencilOperation

DecrementSaturated

Decrement the stencil value by 1, and clamp the result.

Declaration
public const StencilOperation DecrementSaturated
Field Value
StencilOperation

Increment

Increment the stencil value by 1, and wrap the result if necessary.

Declaration
public const StencilOperation Increment
Field Value
StencilOperation

IncrementSaturated

Increment the stencil value by 1, and clamp the result.

Declaration
public const StencilOperation IncrementSaturated
Field Value
StencilOperation

Invert

Invert the stencil data.

Declaration
public const StencilOperation Invert
Field Value
StencilOperation

Keep

Keep the existing stencil data.

Declaration
public const StencilOperation Keep
Field Value
StencilOperation

Replace

Set the stencil data to the reference value (set via GPUContext.SetStencilRef).

Declaration
public const StencilOperation Replace
Field Value
StencilOperation

value__

Declaration
public byte value__
Field Value
System.Byte

Zero

Set the stencil data to 0.

Declaration
public const StencilOperation Zero
Field Value
StencilOperation

Extension Methods