GPUPipelineError: GPUPipelineError() constructor

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Note: This feature is available in Web Workers.

The GPUPipelineError() constructor creates a new GPUPipelineError object instance.

Syntax

js
new GPUPipelineError(message, options)

Parameters

message Optional

A string providing a human-readable message that explains why the error occurred. If not specified, message defaults to an empty string ("").

options

An object, which can contain the following properties:

reason

An enumerated value that defines the reason the pipeline creation failed in a machine-readable way. The value can be one of:

  • "internal": Pipeline creation failed because of an internal error (see GPUInternalError for more information about these kinds of error).
  • "validation": Pipeline creation failed because of a validation error (see GPUValidationError for more information about these kinds of error).

Examples

A developer would not manually use the constructor to create a GPUPipelineError object. The user agent uses this constructor to create an appropriate object when a Promise returned by a GPUDevice.createComputePipelineAsync() or GPUDevice.createRenderPipelineAsync() call rejects, signalling a pipeline failure.

See the main GPUPipelineError page for an example involving a GPUPipelineError object instance.

Specifications

Specification
WebGPU
# dom-gpupipelineerror-constructor

Browser compatibility

Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
GPUPipelineError() constructor
Experimental
message parameter is optional
Experimental

See also