GPUPipelineError: GPUPipelineError() constructor

Limited availability

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

Secure context: This feature is available only insecure contexts (HTTPS), in some or allsupporting browsers.

Note: This feature is available inWeb Workers.

TheGPUPipelineError() constructor creates a newGPUPipelineError object instance.

Syntax

new GPUPipelineError(message, options)

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

An object, which can contain the following properties:

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 (seeGPUInternalError for more information about these kinds of error).
"validation": Pipeline creation failed because of a validation error (seeGPUValidationError for more information about these kinds of error).

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

See the mainGPUPipelineError page for an example involving aGPUPipelineError object instance.