GPUCompilationMessage: lineNum property

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 lineNum read-only property of the GPUCompilationMessage interface is a number representing the line number in the shader code that the message corresponds to.

Value

A number.

Note that:

  • If the message corresponds to a substring, lineNum refers to the line number that the substring begins on.
  • If the message does not correspond to a specific line of code (perhaps it refers to the whole of the shader code), lineNum will be 0.
  • Values are one-based — a value of 1 refers to the first line of code.
  • Lines are delimited by line breaks. In WGSL, a specific list of characters is defined as line breaks.

Examples

js
  // ...
  const shaderModule = device.createShaderModule({
    code: shaders,
  });

  const shaderInfo = await shaderModule.getCompilationInfo();
  const firstMessage = shaderInfo.messages[0];
  console.log(firstMessage.lineNum);
  // ...
}

See the main GPUCompilationInfo page for a more detailed example.

Specifications

Specification
WebGPU
# dom-gpucompilationmessage-linenum

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
lineNum
Experimental

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
Partial support
Partial support
In development. Supported in a pre-release version.
In development. Supported in a pre-release version.
No support
No support
Experimental. Expect behavior to change in the future.
See implementation notes.

See also