RenderPassDescriptor

data class RenderPassDescriptor(
    val colorAttachments: List<GPURenderPassColorAttachment?>, 
    val depthStencilAttachment: GPURenderPassDepthStencilAttachment? = null, 
    val occlusionQuerySet: GPUQuerySet? = null, 
    val timestampWrites: GPURenderPassTimestampWrites? = null, 
    val maxDrawCount: GPUSize64, 
    val label: String = ""
) : GPURenderPassDescriptor

Describes the color, depth/stencil, and optional timestamp attachments for a render pass.

Constructors

RenderPassDescriptor

constructor(
    colorAttachments: List<GPURenderPassColorAttachment?>, 
    depthStencilAttachment: GPURenderPassDepthStencilAttachment? = null, 
    occlusionQuerySet: GPUQuerySet? = null, 
    timestampWrites: GPURenderPassTimestampWrites? = null, 
    maxDrawCount: GPUSize64, 
    label: String = ""
)

Properties

colorAttachments

open override val colorAttachments: List<GPURenderPassColorAttachment?>

The set of GPURenderPassColorAttachment values in this sequence defines which color attachments will be output to when executing this render pass. Due to usage compatibility, no color attachment may alias another attachment or any resource used inside the render pass.

depthStencilAttachment

open override val depthStencilAttachment: GPURenderPassDepthStencilAttachment?

The GPURenderPassDepthStencilAttachment value that defines the depth/stencil attachment that will be output to and tested against when executing this render pass. Due to usage compatibility, no writable depth/stencil attachment may alias another attachment or any resource used inside the render pass.

label

open override val label: String

maxDrawCount

open override val maxDrawCount: GPUSize64

The maximum number of draw calls that will be done in the render pass. Used by some implementations to size work injected before the render pass. Keeping the default value is a good default, unless it is known that more draw calls will be done.

occlusionQuerySet

open override val occlusionQuerySet: GPUQuerySet?

The GPUQuerySet value defines where the occlusion query results will be stored for this pass.

timestampWrites

open override val timestampWrites: GPURenderPassTimestampWrites?

Defines which timestamp values will be written for this pass, and where to write them to.