GPUInternalError

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 in secure contexts (HTTPS), in some or all supporting browsers.

Note: This feature is available in Web Workers.

The GPUInternalError interface of the WebGPU API describes an application error indicating that an operation failed for a system or implementation-specific reason, even when all validation requirements were satisfied.

It represents one of the types of errors surfaced by GPUDevice.popErrorScope and the uncapturederror event.

Internal errors occur when something happens in the WebGPU implementation that wasn't caught by validation and wasn't clearly identifiable as an out-of-memory error. It generally means that an operation your code performed hit a system limit in a way that was difficult to express with WebGPU's supported limits. The same operation might succeed on a different device. These can only be raised by pipeline creation, usually if the shader is too complex for the device.

Constructor

GPUInternalError(): Creates a new GPUInternalError object instance.

Instance properties

The message property is inherited from its parent, GPUError:

message Experimental Read only: A string providing a human-readable message that explains why the error occurred.

Examples

The following example uses an error scope to capture a suspected validation error, logging it to the console.

device.pushErrorScope("internal");
let module = device.createShaderModule({
 code: shader, // REALLY complex shader
});
device.popErrorScope().then((error) => {
 if (error) {
 // error is a GPUInternalError object instance
 module = null;
 console.error(`An error occurred while creating shader: ${error.message}`);
 }
});