GPUDevice: createRenderPipelineAsync() method
MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونهکد
{{APIRef("WebGPU API")}}{{SecureContext_Header}}{{AvailableInWorkers}}
The **createRenderPipelineAsync()** method of the {{domxref("GPUDevice")}} interface returns a {{jsxref("Promise")}} that fulfills with a {{domxref("GPURenderPipeline")}}, which can control the vertex and fragment shader stages and be used in a {{domxref("GPURenderPassEncoder")}} or {{domxref("GPURenderBundleEncoder")}}, once the pipeline can be used without any stalling.
توجه: It is generally preferable to use this method over {{domxref("GPUDevice.createRenderPipeline()")}} whenever possible, as it prevents blocking of GPU operation execution on pipeline compilation.
Syntax
createRenderPipelineAsync(descriptor)Parameters
descriptor- : See the descriptor definition for the [
GPUDevice.createRenderPipeline()](/en-US/docs/Web/API/GPUDevice/createRenderPipeline#syntax) method.
Return value
A {{jsxref("Promise")}} that fulfills with a {{domxref("GPURenderPipeline")}} object instance when the created pipeline is ready to be used without additional delay.
Validation
If pipeline creation fails and the resulting pipeline becomes invalid as a result, the returned promise rejects with a {{domxref("GPUPipelineError")}}:
- If this is due to an internal error, the {{domxref("GPUPipelineError")}} will have a
reasonof"internal". - If this is due to a validation error, the {{domxref("GPUPipelineError")}} will have a
reasonof"validation".
A validation error can occur if any of the following are false:
- For
depthStencilobjects: formatis a [depth-or-stencil](https://gpuweb.github.io/gpuweb/#depth-or-stencil-format) format.- The [
depthBias](/en-US/docs/Web/API/GPUDevice/createRenderPipeline#depthbias), [depthBiasClamp](/en-US/docs/Web/API/GPUDevice/createRenderPipeline#depthbiasclamp), and [depthBiasSlopeScale](/en-US/docs/Web/API/GPUDevice/createRenderPipeline#depthbiasslopescale) properties are set to <code>0</code> for line and point topologies, i.e., if [topology](/en-US/docs/Web/API/GPUDevice/createRenderPipeline#topology) is set to"line-list","line-strip", or"point-list". - If
depthWriteEnabledistrueordepthCompareis not"always",formathas a depth component. - If
stencilFrontorstencilBack's properties are not at their default values,formathas a stencil component. - For
fragmentobjects: targets.lengthis less than or equal to the {{domxref("GPUDevice")}}'smaxColorAttachments{{domxref("GPUSupportedLimits", "limit", "", "nocode")}}.- For each
target,writeMask's numeric equivalent is less than 16. - If any of the used blend factor operations use the source alpha channel (for example
"src-alpha-saturated"), the output has an alpha channel (that is, it must be avec4). - If the
entryPointproperty is omitted, the shader code contains a single fragment shader entry point function for the browser to use as the default entry point. - For
primitiveobjects: - If the
unclippedDepthproperty is used, thedepth-clip-controlfeature is enabled. - For
vertexobjects: - If the
entryPointproperty is omitted, the shader code contains a single vertex shader entry point function for the browser to use as the default entry point.
Examples
توجه: The WebGPU samples feature many more examples.
Basic example
The following example shows a basic example of the construction of a valid render pipeline descriptor object, which is then used to create a {{domxref("GPURenderPipeline")}} via a createRenderPipelineAsync() call.
async function init() {
// …
const vertexBuffers = [
{
attributes: [
{
shaderLocation: 0, // position
offset: 0,
format: "float32x4",
},
{
shaderLocation: 1, // color
offset: 16,
format: "float32x4",
},
],
arrayStride: 32,
stepMode: "vertex",
},
];
const pipelineDescriptor = {
vertex: {
module: shaderModule,
entryPoint: "vertex_main",
buffers: vertexBuffers,
},
fragment: {
module: shaderModule,
entryPoint: "fragment_main",
targets: [
{
format: navigator.gpu.getPreferredCanvasFormat(),
},
],
},
primitive: {
topology: "triangle-list",
},
layout: "auto",
};
const renderPipeline =
await device.createRenderPipelineAsync(pipelineDescriptor);
// …
}Specifications
{{Specifications}}
Browser compatibility
{{Compat}}
See also
- The WebGPU API