GPUDevice: Methode createShaderModule()

Syntax

createShaderModule(descriptor)

Parameter

descriptor

Ein Objekt, das die folgenden Eigenschaften enthält:

code

Ein String, der den WGSL-Quellcode für das Shader-Modul darstellt.

hints Optional

Eine Sequenz von Aufzeichnungstypen mit der Struktur ("string", compilationHint). Diese verhalten sich wie geordnete Karten. In jedem Fall ist die "string" ein Schlüssel, der verwendet wird, um die Aufzeichnung zu identifizieren oder auszuwählen, und der compilationHint ist entweder eine GPUPipelineLayout-Objektinstanz oder ein enumerierter Wert von "auto".

Der Zweck von hints besteht darin, so früh wie möglich Informationen über das Pipeline-Layout bereitzustellen, um die Leistung zu verbessern. Die Idee ist, die Menge an Kompilierung zu maximieren, die durch createShaderModule() einmal durchgeführt werden kann, anstatt mehrmals in mehreren Aufrufen von GPUDevice.createComputePipeline() und GPUDevice.createRenderPipeline().

Hinweis: Verschiedene Implementierungen können hints unterschiedlich behandeln, einschließlich der Möglichkeit, sie vollständig zu ignorieren. Das Bereitstellen von Hinweisen garantiert nicht, dass die Leistung der Shader-Kompilierung in allen Browsern/Systemen verbessert wird.

label Optional

Ein String, der ein Label bereitstellt, das zur Identifizierung des Objekts verwendet werden kann, zum Beispiel in GPUError-Nachrichten oder Konsolenwarnungen.

sourceMap Optional

Eine Definition einer Source-Map zur Integration von Entwicklerwerkzeugen wie Debugging in der Quellsprache. WGSL-Namen (Identifier) in Source-Maps sollten den Regeln folgen, die in WGSL-Identifier-Vergleich definiert sind. Wenn definiert, kann die Source-Map als ein source-map-v3-Format interpretiert werden.

Hinweis: Verschiedene Implementierungen können sourceMaps unterschiedlich behandeln, einschließlich der Möglichkeit, sie vollständig zu ignorieren.

Rückgabewert

Eine GPUShaderModule-Objektinstanz.

Validierung

Die folgenden Kriterien müssen erfüllt sein, wenn createShaderModule() aufgerufen wird, andernfalls wird ein GPUValidationError generiert und ein ungültiges GPUShaderModule-Objekt zurückgegeben:

• Wenn Ihr WGSL-Code des Shaders den Halbpräzisions-Gleitkommatyp f16 verwendet, muss enable f16; am Anfang stehen, und das zugehörige GPUDevice muss mit dem shader-f16 Feature erstellt worden sein.

Beispiele

In unserem Basis-Render-Demo wird unser Shader-Modul mit folgendem Code erstellt:

const shaders = `
struct VertexOut {
  @builtin(position) position : vec4f,
  @location(0) color : vec4f
}

@vertex
fn vertex_main(@location(0) position: vec4f,
               @location(1) color: vec4f) -> VertexOut
{
  var output : VertexOut;
  output.position = position;
  output.color = color;
  return output;
}

@fragment
fn fragment_main(fragData: VertexOut) -> @location(0) vec4f
{
  return fragData.color;
}
`;

async function init() {
  if (!navigator.gpu) {
    throw Error("WebGPU not supported.");
  }

  const adapter = await navigator.gpu.requestAdapter();
  if (!adapter) {
    throw Error("Couldn't request WebGPU adapter.");
  }

  const device = await adapter.requestDevice();

  // …
  // later on

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

  // …
}

Spezifikationen

Browser-Kompatibilität

Siehe auch

• Die WebGPU API
• Die WebGPU Shading Language Spezifikation