GPURenderPassEncoder: Methode setScissorRect()

Limited availability

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

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 setScissorRect() Methode der Schnittstelle GPURenderPassEncoder legt das Scherrechteck fest, das während der Rasterisierungsphase verwendet wird. Nach der Transformation in Viewport-Koordinaten werden alle Fragmente, die außerhalb des Scherrechtecks liegen, verworfen.

Syntax

js
setScissorRect(x, y, width, height)

Parameter

x

Eine Zahl, die den minimalen X-Wert des Scherrechtecks in Pixel angibt.

y

Eine Zahl, die den minimalen Y-Wert des Scherrechtecks in Pixel angibt.

width

Eine Zahl, die die Breite des Scherrechtecks in Pixel angibt.

height

Eine Zahl, die die Höhe des Scherrechtecks in Pixel angibt.

Hinweis: Wenn kein setScissorRect() Aufruf erfolgt, sind die Standardwerte (0, 0, Anhangbreite, Anhanghöhe) für jeden Renderpass.

Rückgabewert

Keiner (Undefined).

Validierung

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

  • x + width ist kleiner oder gleich der Breite der Render-Pass-Render-Anhänge (siehe Hinweis unten).
  • y + height ist kleiner oder gleich der Höhe der Render-Pass-Render-Anhänge (siehe Hinweis unten).

Hinweis: Beachten Sie die Farb- und Tiefen/Stencil-Anhänge, die im Deskriptor von GPUCommandEncoder.beginRenderPass() angegeben sind; die Breite und Höhe basieren auf der des GPUTexture, von der deren views stammen.

Beispiele

Einfaches Beispiel

Bei einem typischen Canvas-Render könnte das Folgende verwendet werden, um jede Darstellung außerhalb des oberen linken Viertels der Leinwand zu verwerfen:

js
passEncoder.setScissorRect(0, 0, canvas.width / 2, canvas.height / 2);

Spezifikationen

Specification
WebGPU
# dom-gpurenderpassencoder-setscissorrect

Browser-Kompatibilität

Siehe auch