GPUDevice: createShaderModule() Methode

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 der "string" ein Schlüssel, der verwendet wird, um den Datensatz zu identifizieren oder auszuwählen, und compilationHint ist entweder ein GPUPipelineLayout-Objekt oder ein enumerierter Wert von "auto".

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

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

label Optional

Ein String, der ein Etikett bereitstellt, das verwendet werden kann, um das Objekt zu identifizieren, beispielsweise in GPUError-Meldungen oder Konsolenwarnungen.

sourceMap Optional

Eine Source-Map-Definition zur Bereitstellung von Entwickler-Tool-Integrationen wie Debugging in der Quellsprache. WGSL-Namen (Identifier) in Source Maps sollten den in WGSL Identifier Comparison definierten Regeln folgen. Wenn sie definiert sind, können die Quellkarten im source-map-v3-Format interpretiert werden.

Hinweis: Verschiedene Implementierungen können sourceMaps auf unterschiedliche Weise 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 der WGSL-Code Ihres Shaders den Halbpräzisionstyp f16 verwendet, muss er enable f16; am Anfang enthalten, und das zugehörige GPUDevice muss mit dem shader-f16 Feature aktiviert erstellt werden.

Beispiele

In unserem Basis-Render-Demo wird unser Shader-Modul mit dem folgenden 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