GPUDevice: Methode createShaderModule()

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 Datensätzen mit der Struktur ("string", compilationHint). Diese verhalten sich wie geordnete Karten. In jedem Fall ist der "string" ein Schlüssel, der zur Identifizierung oder Auswahl des Datensatzes verwendet wird, und der compilationHint ist entweder eine Instanz eines GPUPipelineLayout-Objekts 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 der Kompilierung zu maximieren, die einmal durch createShaderModule() durchgeführt werden kann, anstatt sie mehrfach in mehreren Aufrufen von GPUDevice.createComputePipeline() und GPUDevice.createRenderPipeline() durchzuführen.

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

label Optional

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

sourceMap Optional

Eine Source-Map-Definition zur Bereitstellung der Integration von Entwickler-Tools wie Debugging in der Quellsprache. WGSL-Namen (Bezeichner) in Source-Maps sollten den Regeln entsprechen, die in WGSL-Bezeichnervergleich definiert sind. Falls definiert, kann die Source-Map als Source-Map-v3-Format interpretiert werden.

Hinweis: Verschiedene Implementierungen können sourceMaps auf unterschiedliche Weise verarbeiten, einschließlich der Möglichkeit, sie vollständig zu ignorieren.

Eine Instanz des GPUShaderModule-Objekts.

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

• Wenn der WGSL-Code Ihres Shaders den halben Gleitkommatyp f16 verwendet, muss er enable f16; am Anfang enthalten, und das zugehörige GPUDevice muss mit aktiviertem shader-f16 Feature erstellt worden sein.

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,
  });

  // …
}

• Die WebGPU API
• Die WebGPU Shading Language-Spezifikation