kotlin-web/web.gpu/GPURenderPassEncoder

GPURenderPassEncoder

open class GPURenderPassEncoder : GPUBindingCommandsMixin, GPUDebugCommandsMixin, GPUObjectBase, GPURenderCommandsMixin(source)

The GPURenderPassEncoder interface of the WebGPU API encodes commands related to controlling the vertex and fragment shader stages, as issued by a GPURenderPipeline. It forms part of the overall encoding activity of a GPUCommandEncoder. Available only in secure contexts.

MDN Reference

Properties

label

open var label: String

MDN Reference

Functions

beginOcclusionQuery

fun beginOcclusionQuery(queryIndex: GPUSize32)

The beginOcclusionQuery() method of the GPURenderPassEncoder interface begins an occlusion query at the specified index of the relevant GPUQuerySet (provided as the value of the occlusionQuerySet descriptor property when invoking GPUCommandEncoder.beginRenderPass() to run the render pass).

draw

open fun draw(vertexCount: GPUSize32, instanceCount: GPUSize32 = definedExternally, firstVertex: GPUSize32 = definedExternally, firstInstance: GPUSize32 = definedExternally)

MDN Reference

drawIndexed

open fun drawIndexed(indexCount: GPUSize32, instanceCount: GPUSize32 = definedExternally, firstIndex: GPUSize32 = definedExternally, baseVertex: GPUSignedOffset32 = definedExternally, firstInstance: GPUSize32 = definedExternally)

MDN Reference

drawIndexedIndirect

open fun drawIndexedIndirect(indirectBuffer: GPUBuffer, indirectOffset: GPUSize64)

MDN Reference

drawIndirect

open fun drawIndirect(indirectBuffer: GPUBuffer, indirectOffset: GPUSize64)

MDN Reference

end

fun end()

The end() method of the GPURenderPassEncoder interface completes recording of the current render pass command sequence.

endOcclusionQuery

fun endOcclusionQuery()

The endOcclusionQuery() method of the GPURenderPassEncoder interface ends an active occlusion query previously started with beginOcclusionQuery().

executeBundles

fun executeBundles(bundles: ReadonlyArray<GPURenderBundle>)

The executeBundles() method of the GPURenderPassEncoder interface executes commands previously recorded into the referenced GPURenderBundles, as part of this render pass.

insertDebugMarker

open fun insertDebugMarker(markerLabel: String)

MDN Reference

popDebugGroup

open fun popDebugGroup()

MDN Reference

pushDebugGroup

open fun pushDebugGroup(groupLabel: String)

MDN Reference

setBindGroup

open fun setBindGroup(index: GPUIndex32, bindGroup: GPUBindGroup?, dynamicOffsets: ReadonlyArray<GPUBufferDynamicOffset> = definedExternally)

MDN Reference

open fun setBindGroup(index: GPUIndex32, bindGroup: GPUBindGroup?, dynamicOffsetsData: Uint32Array<ArrayBufferLike>, dynamicOffsetsDataStart: GPUSize64, dynamicOffsetsDataLength: GPUSize32)

setBlendConstant

fun setBlendConstant(color: GPUColor)

The setBlendConstant() method of the GPURenderPassEncoder interface sets the constant blend color and alpha values used with "constant" and "one-minus-constant" blend factors (as set in the descriptor of the GPUDevice.createRenderPipeline() method, in the blend property).

setIndexBuffer

open fun setIndexBuffer(buffer: GPUBuffer, indexFormat: GPUIndexFormat, offset: GPUSize64 = definedExternally, size: GPUSize64 = definedExternally)

MDN Reference

setPipeline

open fun setPipeline(pipeline: GPURenderPipeline)

MDN Reference

setScissorRect

fun setScissorRect(x: GPUIntegerCoordinate, y: GPUIntegerCoordinate, width: GPUIntegerCoordinate, height: GPUIntegerCoordinate)

The setScissorRect() method of the GPURenderPassEncoder interface sets the scissor rectangle used during the rasterization stage. After transformation into viewport coordinates any fragments that fall outside the scissor rectangle will be discarded.

setStencilReference

fun setStencilReference(reference: GPUStencilValue)

The setStencilReference() method of the GPURenderPassEncoder interface sets the stencil reference value using during stencil tests with the "replace" stencil operation (as set in the descriptor of the GPUDevice.createRenderPipeline() method, in the properties defining the various stencil operations).

setVertexBuffer

open fun setVertexBuffer(slot: GPUIndex32, buffer: GPUBuffer?, offset: GPUSize64 = definedExternally, size: GPUSize64 = definedExternally)

MDN Reference

setViewport

fun setViewport(x: GPUIntegerCoordinate, y: GPUIntegerCoordinate, width: GPUIntegerCoordinate, height: GPUIntegerCoordinate, minDepth: Float, maxDepth: Float)

The setViewport() method of the GPURenderPassEncoder interface sets the viewport used during the rasterization stage to linearly map from normalized device coordinates to viewport coordinates.