GPUDepthStencilState


class GPUDepthStencilState


Describes the depth and stencil state for a render pipeline.

Summary

Nested types

Builder for GPUDepthStencilState.

Public constructors

GPUDepthStencilState(
    format: Int,
    depthWriteEnabled: Int,
    depthCompare: Int,
    stencilFront: GPUStencilFaceState,
    stencilBack: GPUStencilFaceState,
    stencilReadMask: Int,
    stencilWriteMask: Int,
    depthBias: Int,
    depthBiasSlopeScale: Float,
    depthBiasClamp: Float
)

Public constructors

GPUDepthStencilState

Added in 1.0.0-alpha05
GPUDepthStencilState(
    format: Int = TextureFormat.Undefined,
    depthWriteEnabled: Int = OptionalBool.Undefined,
    depthCompare: Int = CompareFunction.Undefined,
    stencilFront: GPUStencilFaceState = GPUStencilFaceState(),
    stencilBack: GPUStencilFaceState = GPUStencilFaceState(),
    stencilReadMask: Int = -1,
    stencilWriteMask: Int = -1,
    depthBias: Int = 0,
    depthBiasSlopeScale: Float = 0.0f,
    depthBiasClamp: Float = 0.0f
)

Public properties

depthBias

Added in 1.0.0-alpha05
var depthBias: Int

depthBiasClamp

Added in 1.0.0-alpha05
var depthBiasClamp: Float

depthBiasSlopeScale

Added in 1.0.0-alpha05
var depthBiasSlopeScale: Float

depthCompare

Added in 1.0.0-alpha05
var depthCompare: Int

depthWriteEnabled

Added in 1.0.0-alpha05
var depthWriteEnabled: Int

format

Added in 1.0.0-alpha05
var format: Int

The texture format of the depth-stencil attachment.

stencilBack

Added in 1.0.0-alpha05
var stencilBack: GPUStencilFaceState

stencilFront

Added in 1.0.0-alpha05
var stencilFront: GPUStencilFaceState

stencilReadMask

Added in 1.0.0-alpha05
var stencilReadMask: Int

stencilWriteMask

Added in 1.0.0-alpha05
var stencilWriteMask: Int