GPURenderPassEncoder: Methode setVertexBuffer()

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Hinweis: Diese Funktion ist in Web Workers verfügbar.

Die setVertexBuffer()-Methode der GPURenderPassEncoder-Schnittstelle setzt oder entfernt den aktuellen GPUBuffer für den angegebenen Slot, der Vertexdaten für nachfolgende Zeichenbefehle bereitstellt.

Syntax

setVertexBuffer(slot, buffer, offset, size)

Parameter

slot: Eine Zahl, die den Vertex-Puffer-Slot referenziert, für den der Vertex-Puffer gesetzt wird.
buffer: Ein GPUBuffer, der den Puffer darstellt, der die Vertexdaten enthält, die für nachfolgende Zeichenbefehle verwendet werden sollen, oder null, in welchem Fall ein zuvor gesetzter Puffer in dem angegebenen Slot entfernt wird.
offset Optional: Eine Zahl, die den Versatz in Bytes in buffer darstellt, ab dem die Vertexdaten beginnen. Falls weggelassen, beträgt der Standardwert von offset 0.
size Optional: Eine Zahl, die die Größe in Bytes der in buffer enthaltenen Vertexdaten darstellt. Falls weggelassen, entspricht size der Differenz aus der GPUBuffer.size des Puffers und offset.

Rückgabewert

Keiner (Undefined).

Validierung

Die folgenden Kriterien müssen erfüllt sein, wenn setVertexBuffer() aufgerufen wird, andernfalls wird ein GPUValidationError generiert und der GPURenderPassEncoder wird ungültig:

Der GPUBuffer.usage von buffer enthält das GPUBufferUsage.VERTEX-Flag.
slot ist kleiner als das maxVertexBuffers Limit des GPUDevice.
offset + size ist kleiner oder gleich der GPUBuffer.size des buffer.
offset ist ein Vielfaches von 4.

Beispiele

Vertex-Puffer setzen

In unserem grundlegenden Render-Demo werden mehrere Befehle über einen GPUCommandEncoder aufgezeichnet. Die meisten dieser Befehle stammen vom GPURenderPassEncoder, das über GPUCommandEncoder.beginRenderPass() erstellt wurde. setVertexBuffer() wird entsprechend verwendet, um die Quelle der Vertexdaten festzulegen.

// …

const renderPipeline = device.createRenderPipeline(pipelineDescriptor);

// Create GPUCommandEncoder to issue commands to the GPU
// Note: render pass descriptor, command encoder, etc. are destroyed after use, fresh one needed for each frame.
const commandEncoder = device.createCommandEncoder();

// Create GPURenderPassDescriptor to tell WebGPU which texture to draw into, then initiate render pass
const renderPassDescriptor = {
  colorAttachments: [
    {
      clearValue: clearColor,
      loadOp: "clear",
      storeOp: "store",
      view: context.getCurrentTexture().createView(),
    },
  ],
};

const passEncoder = commandEncoder.beginRenderPass(renderPassDescriptor);

// Draw the triangle
passEncoder.setPipeline(renderPipeline);
passEncoder.setVertexBuffer(0, vertexBuffer);
passEncoder.draw(3);

// End the render pass
passEncoder.end();

// End frame by passing array of command buffers to command queue for execution
device.queue.submit([commandEncoder.finish()]);

// …

Vertex-Puffer entfernen

// Set vertex buffer in slot 0
passEncoder.setVertexBuffer(0, vertexBuffer);

// Later, unset vertex buffer in slot 0
passEncoder.setVertexBuffer(0, null);

Spezifikationen

Specification
WebGPU # dom-gpurendercommandsmixin-setvertexbuffer

Browser-Kompatibilität

Siehe auch

Die WebGPU API