GPUOutOfMemoryError

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.

TheGPUOutOfMemoryError interface of theWebGPU API describes an out-of-memory (oom) error indicating that there was not enough free memory to complete the requested operation.

It represents one of the types of errors surfaced byGPUDevice.popErrorScope and theuncapturederror event.

Out-of-memory errors should be relatively rare in a well-behaved app but are less predictable thanGPUValidationErrors. This is because they are dependent on the device your app is running on as well as other apps that are using GPU resources at the time.

Constructor

GPUOutOfMemoryError(): Creates a newGPUOutOfMemoryError object instance.

Instance properties

Themessage property is inherited from its parent,GPUError:

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

Examples

The following example uses an error scope to capture an out-of-memory error, logging it to the console.

device.pushErrorScope("out-of-memory");let buffer = device.createBuffer({  size: 100_000_000_000, // 100GB; far too big  usage: GPUBufferUsage.COPY_SRC | GPUBufferUsage.MAP_WRITE,});device.popErrorScope().then((error) => {  if (error) {    // error is a GPUOutOfMemoryError object instance    buffer = null;    console.error(`Out of memory, buffer too large. Error: ${error.message}`);  }});