View source

class RenderPass

package wgpu

@:nullSafety(Strict)@:headerClassCode("\n\tWGPURenderPassId native;\n")@:headerInclude("./wgpu.h")

An in-progress recording of a render pass.

Methods

@:has_untypeddraw(verticesStart:Int, verticesEnd:Int, instancesStart:Int, instancesEnd:Int):Void

Draws primitives from the active vertex buffer(s).

The active vertex buffers can be set with RenderPass.setVertexBuffers.

@:has_untypeddrawIndexed(indicesStart:Int, indicesEnd:Int, baseVertex:Int, instancesStart:Int, instancesEnd:Int):Void

Draws indexed primitives using the active index buffer and the active vertex buffers.

The active index buffer can be set with RenderPass.setIndexBuffer, while the active vertex buffers can be set with RenderPass.setVertexBuffers.

@:has_untypeddrawIndexedIndirect(indirectBuffer:Buffer, indirectOffset:Int):Void

Draws indexed primitives using the active index buffer and the active vertex buffers, based on the contents of the indirectBuffer.

The active index buffer can be set with RenderPass.setIndexBuffer, while the active vertex buffers can be set with RenderPass.setVertexBuffers.

Throws:

UseAfterDestroyException

If indirectBuffer was already destroyed.

@:has_untypeddrawIndirect(indirectBuffer:Buffer, indirectOffset:Int):Void

Draws primitives from the active vertex buffer(s) based on the contents of the indirectBuffer.

The active vertex buffers can be set with RenderPass.setVertexBuffers.

Throws:

UseAfterDestroyException

If indirectBuffer was already destroyed.

@:has_untypedendPass():Void

@:has_untypedsetBindGroup(index:Int, bindGroup:BindGroup, offsets:Array<Int>):Void

Sets the active bind group for a given bind group index.

Throws:

UseAfterDestroyException

If bindGroup was already destroyed.

@:has_untypedsetBlendColor(color:Color):Void

@:has_untypedsetIndexBuffer(buffer:Buffer, offset:Int, size:Int):Void

Sets the active index buffer.

Subsequent calls to drawIndexed on this RenderPass will use buffer as the source index buffer.

If size == 0, the remaining part of the buffer is considered.

Throws:

UseAfterDestroyException

If buffer was destroyed.

@:has_untypedsetPipeline(renderPipeline:RenderPipeline):Void

Sets the active render pipeline.

Subsequent draw calls will exhibit the behavior defined by pipeline.

@:has_untypedsetScissorRect(x:Int, y:Int, width:Int, height:Int):Void

Sets the scissor region.

Subsequent draw calls will discard any fragments that fall outside this region.

@:has_untypedsetStencilReference(reference:Int):Void

Sets the stencil reference.

Subsequent stencil tests will test against this value.

@:has_untypedsetVertexBuffer(slot:Int, buffer:Buffer, offset:Int, size:Int):Void

Assign a vertex buffer to a slot.

Subsequent calls to draw and drawIndexed on this RenderPass will use buffer as one of the source vertex buffers.

The slot refers to the index of the matching descriptor in RenderPipelineDescriptor.vertex_buffers.

If size == 0, the remaining part of the buffer is considered.

Throws:

UseAfterDestroyException

If buffer was destroyed.

@:has_untypedsetViewport(x:Float, y:Float, width:Float, height:Float, minDepth:Float, maxDepth:Float):Void

Sets the viewport region.

Subsequent draw calls will draw any fragments in this region.