GPUStencilFaceState

class GPUStencilFaceState

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

Summary

Nested types

Builder for GPUStencilFaceState.

Public constructors
GPUStencilFaceState(compare: Int, failOp: Int, depthFailOp: Int, passOp: Int)

Public properties
Int

The comparison function for the stencil test.
Int
Int
Int

Public constructors

GPUStencilFaceState

Added in 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
var compare: Int

The comparison function for the stencil test. Defaults to @see CompareFunction.Always.

Value is one of the following:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

depthFailOp

Added in 1.0.0-alpha06
var depthFailOp: Int

Value is one of the following:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

failOp

Added in 1.0.0-alpha06
var failOp: Int

Value is one of the following:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8

passOp

Added in 1.0.0-alpha06
var passOp: Int

Value is one of the following:

  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8