GPURenderBundleEncoder: setIndexBuffer() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("WebGPU API")}}{{SecureContext_Header}}{{AvailableInWorkers}}
The **setIndexBuffer()** method of the {{domxref("GPURenderBundleEncoder")}} interface sets the current {{domxref("GPUBuffer")}} that will provide index data for subsequent drawing commands.
توجه: This method is functionally identical to its equivalent on {{domxref("GPURenderPassEncoder")}} — {{domxref("GPURenderPassEncoder.setIndexBuffer", "setIndexBuffer()")}}.
Syntax
setIndexBuffer(buffer, indexFormat, offset, size)Parameters
buffer- : A {{domxref("GPUBuffer")}} representing the buffer containing the index data to use for subsequent drawing commands.
indexFormat- : An enumerated value that defines the format of the index data contained in
buffer. Possible values are: "uint16""uint32"offset{{optional_inline}}- : A number representing the offset, in bytes, into
bufferwhere the index data begins. If omitted,offsetdefaults to 0. size{{optional_inline}}- : A number representing the size, in bytes, of the index data contained in
buffer. If omitted,sizedefaults to thebuffer's {{domxref("GPUBuffer.size")}} -offset.
Note on indexFormat
indexFormat determines both the data type of index values in a buffer and, when used with a pipeline that specifies a strip primitive topology ("line-strip" or "triangle-strip"), also determines the primitive restart value. The primitive restart value is an index value indicating that a new primitive should be started rather than continuing to construct the strip with the prior indexed vertices. The value is 0xFFFF for "uint16", or 0xFFFFFFFF for "uint32".
Return value
None ({{jsxref("undefined")}}).
Validation
The following criteria must be met when calling **setIndexBuffer()**, otherwise a {{domxref("GPUValidationError")}} is generated and the {{domxref("GPURenderBundleEncoder")}} becomes invalid:
buffer's {{domxref("GPUBuffer.usage")}} contains theGPUBufferUsage.INDEXflag.offset+sizeis less than or equal to thebuffer's {{domxref("GPUBuffer.size")}}.offsetis a multiple ofindexFormat's byte size (2 for"uint16", 4 for"uint32").
Examples
// …
const bundleEncoder = device.createRenderBundleEncoder(descriptor);
bundleEncoder.setPipeline(pipeline);
bundleEncoder.setBindGroup(0, sceneBindGroupForRender);
bundleEncoder.setBindGroup(1, modelBindGroup);
bundleEncoder.setVertexBuffer(0, vertexBuffer);
bundleEncoder.setIndexBuffer(indexBuffer, "uint16");
bundleEncoder.drawIndexed(indexCount);
const renderBundle = bundleEncoder.finish();
// …Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- The WebGPU API