GPURenderBundleEncoder: setPipeline() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("WebGPU API")}}{{SecureContext_Header}}{{AvailableInWorkers}}
The **setPipeline()** method of the {{domxref("GPURenderBundleEncoder")}} interface sets the {{domxref("GPURenderPipeline")}} to use for subsequent render bundle commands.
توجه: This method is functionally identical to its equivalent on {{domxref("GPURenderPassEncoder")}} — {{domxref("GPURenderPassEncoder.setPipeline", "setPipeline()")}}.
Syntax
setPipeline(pipeline)Parameters
pipeline- : The {{domxref("GPURenderPipeline")}} to use for subsequent render bundle commands.
Return value
None ({{jsxref("undefined")}}).
Validation
The following criteria must be met when calling **setPipeline()**, otherwise a {{domxref("GPUValidationError")}} is generated and the {{domxref("GPURenderBundleEncoder")}} becomes invalid:
- If the {{domxref("GPURenderPipeline")}} writes to the depth component of the depth/stencil attachment,
depthReadOnly(as specified in the descriptor of the originating {{domxref("GPUCommandEncoder.beginRenderPass()")}} call) istrue. - If the {{domxref("GPURenderPipeline")}} writes to the stencil component of the depth/stencil attachment,
stencilReadOnly(as specified in the descriptor of the originating {{domxref("GPUCommandEncoder.beginRenderPass()")}} call) istrue.
Examples
function recordRenderPass(passEncoder) {
if (settings.dynamicOffsets) {
passEncoder.setPipeline(dynamicPipeline);
} else {
passEncoder.setPipeline(pipeline);
}
passEncoder.setVertexBuffer(0, vertexBuffer);
passEncoder.setBindGroup(0, timeBindGroup);
const dynamicOffsets = [0];
for (let i = 0; i < numTriangles; ++i) {
if (settings.dynamicOffsets) {
dynamicOffsets[0] = i * alignedUniformBytes;
passEncoder.setBindGroup(1, dynamicBindGroup, dynamicOffsets);
} else {
passEncoder.setBindGroup(1, bindGroups[i]);
}
passEncoder.draw(3, 1, 0, 0);
}
}The above snippet is taken from the WebGPU Samples Animometer example.
Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- The WebGPU API