Skip to content

RenderBundleEncoderDescriptor

data class RenderBundleEncoderDescriptor(
    val colorFormats: List<GPUTextureFormat?>, 
    val depthReadOnly: Boolean = false, 
    val stencilReadOnly: Boolean = false, 
    val depthStencilFormat: GPUTextureFormat? = null, 
    val sampleCount: GPUSize32, 
    val label: String = ""
) : GPURenderBundleEncoderDescriptor
Options used to create a GPURenderBundleEncoder. See [GPURenderBundleEncoderDescriptor in the WebGPU specification](https://www.w3.org/TR/webgpu/#dictdef-gpurenderbundleencoderdescriptor).

Constructors

RenderBundleEncoderDescriptor

constructor(
    colorFormats: List<GPUTextureFormat?>, 
    depthReadOnly: Boolean = false, 
    stencilReadOnly: Boolean = false, 
    depthStencilFormat: GPUTextureFormat? = null, 
    sampleCount: GPUSize32, 
    label: String = ""
)

Properties

colorFormats

open override val colorFormats: List<GPUTextureFormat?>

depthReadOnly

open override val depthReadOnly: Boolean
If true, indicates that the render bundle does not modify the depth component of the GPURenderPassDepthStencilAttachment of any render pass the render bundle is executed in. See read-only depth-stencil.

depthStencilFormat

open override val depthStencilFormat: GPUTextureFormat?

label

open override val label: String

sampleCount

open override val sampleCount: GPUSize32

stencilReadOnly

open override val stencilReadOnly: Boolean
If true, indicates that the render bundle does not modify the stencil component of the GPURenderPassDepthStencilAttachment of any render pass the render bundle is executed in. See read-only depth-stencil.