StencilFaceState¶

data class StencilFaceState(
    val compare: GPUCompareFunction = GPUCompareFunction.Always, 
    val failOp: GPUStencilOperation = GPUStencilOperation.Keep, 
    val depthFailOp: GPUStencilOperation = GPUStencilOperation.Keep, 
    val passOp: GPUStencilOperation = GPUStencilOperation.Keep
) : GPUStencilFaceState

Describes stencil comparison and the operations applied to a stencil face.

Constructors¶

StencilFaceState¶

constructor(
    compare: GPUCompareFunction = GPUCompareFunction.Always, 
    failOp: GPUStencilOperation = GPUStencilOperation.Keep, 
    depthFailOp: GPUStencilOperation = GPUStencilOperation.Keep, 
    passOp: GPUStencilOperation = GPUStencilOperation.Keep
)

Properties¶

compare¶

open override val compare: GPUCompareFunction

The GPUCompareFunction used when testing the [stencilReference] value against the fragment’s depthStencilAttachment stencil values.

depthFailOp¶

open override val depthFailOp: GPUStencilOperation

The GPUStencilOperation performed if the fragment depth comparison described by depthCompare fails.

failOp¶

open override val failOp: GPUStencilOperation

The GPUStencilOperation performed if the fragment stencil comparison test described by compare fails.

passOp¶

open override val passOp: GPUStencilOperation

The GPUStencilOperation performed if the fragment stencil comparison test described by compare passes.