GPURenderBundleEncoder

The GPURenderBundleEncoder interface of the WebGPU API is used to pre-record bundles of commands. Available only in secure contexts.

MDN Reference

Extends

• GPUBindingCommandsMixin.GPUDebugCommandsMixin.GPUObjectBase.GPURenderCommandsMixin

Methods

draw()

draw(
   vertexCount, 
   instanceCount?, 
   firstVertex?, 
   firstInstance?
): void;

MDN Reference

Parameters

Parameter	Type
vertexCount	number
instanceCount?	number
firstVertex?	number
firstInstance?	number

Returns

void

Inherited from

GPURenderCommandsMixin.draw

---

drawIndexed()

drawIndexed(
   indexCount, 
   instanceCount?, 
   firstIndex?, 
   baseVertex?, 
   firstInstance?
): void;

MDN Reference

Parameters

Parameter	Type
indexCount	number
instanceCount?	number
firstIndex?	number
baseVertex?	number
firstInstance?	number

Returns

void

Inherited from

GPURenderCommandsMixin.drawIndexed

---

drawIndexedIndirect()

drawIndexedIndirect(indirectBuffer, indirectOffset): void;

MDN Reference

Parameters

Parameter	Type
indirectBuffer	GPUBuffer
indirectOffset	number

Returns

void

Inherited from

GPURenderCommandsMixin.drawIndexedIndirect

---

drawIndirect()

drawIndirect(indirectBuffer, indirectOffset): void;

MDN Reference

Parameters

Parameter	Type
indirectBuffer	GPUBuffer
indirectOffset	number

Returns

void

Inherited from

GPURenderCommandsMixin.drawIndirect

---

finish()

finish(descriptor?): GPURenderBundle;

The finish() method of the GPURenderBundleEncoder interface completes recording of the current render bundle command sequence, returning a GPURenderBundle object that can be passed into a GPURenderPassEncoder.executeBundles() call to execute those commands in a specific render pass.

MDN Reference

Parameters

Parameter	Type
descriptor?	GPURenderBundleDescriptor

Returns

GPURenderBundle

---

insertDebugMarker()

insertDebugMarker(markerLabel): void;

MDN Reference

Parameters

Parameter	Type
markerLabel	string

Returns

void

Inherited from

GPUDebugCommandsMixin.insertDebugMarker

---

popDebugGroup()

popDebugGroup(): void;

MDN Reference

Returns

void

Inherited from

GPUDebugCommandsMixin.popDebugGroup

---

pushDebugGroup()

pushDebugGroup(groupLabel): void;

MDN Reference

Parameters

Parameter	Type
groupLabel	string

Returns

void

Inherited from

GPUDebugCommandsMixin.pushDebugGroup

---

setBindGroup()

Call Signature

setBindGroup(
   index, 
   bindGroup, 
   dynamicOffsets?
): void;

MDN Reference

Parameters

Parameter	Type
index	number
bindGroup	GPUBindGroup | null
dynamicOffsets?	number[]

Returns

void

Inherited from

GPUBindingCommandsMixin.setBindGroup

Call Signature

setBindGroup(
   index, 
   bindGroup, 
   dynamicOffsetsData, 
   dynamicOffsetsDataStart, 
   dynamicOffsetsDataLength
): void;

Parameters

Parameter	Type
index	number
bindGroup	GPUBindGroup | null
dynamicOffsetsData	Uint32Array<ArrayBufferLike>
dynamicOffsetsDataStart	number
dynamicOffsetsDataLength	number

Returns

void

Inherited from

GPUBindingCommandsMixin.setBindGroup

Call Signature

setBindGroup(
   index, 
   bindGroup, 
   dynamicOffsets?
): void;

MDN Reference

Parameters

Parameter	Type
index	number
bindGroup	GPUBindGroup | null
dynamicOffsets?	Iterable<number, any, any>

Returns

void

Inherited from

GPUBindingCommandsMixin.setBindGroup

---

setIndexBuffer()

setIndexBuffer(
   buffer, 
   indexFormat, 
   offset?, 
   size?
): void;

MDN Reference

Parameters

Parameter	Type
buffer	GPUBuffer
indexFormat	GPUIndexFormat
offset?	number
size?	number

Returns

void

Inherited from

GPURenderCommandsMixin.setIndexBuffer

---

setPipeline()

setPipeline(pipeline): void;

MDN Reference

Parameters

Parameter	Type
pipeline	GPURenderPipeline

Returns

void

Inherited from

GPURenderCommandsMixin.setPipeline

---

setVertexBuffer()

setVertexBuffer(
   slot, 
   buffer, 
   offset?, 
   size?
): void;

MDN Reference

Parameters

Parameter	Type
slot	number
buffer	GPUBuffer | null
offset?	number
size?	number

Returns

void

Inherited from

GPURenderCommandsMixin.setVertexBuffer

Properties

label

label: string;

MDN Reference

Inherited from

GPUObjectBase.label