CanvasRenderingContext2D: createPattern() Methode
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
Die CanvasRenderingContext2D.createPattern()
Methode der Canvas 2D API erstellt ein Muster mit dem angegebenen Bild und der Wiederholung.
Diese Methode gibt ein CanvasPattern
zurück.
Diese Methode zeichnet nichts direkt auf das Canvas.
Das erstellte Muster muss den Eigenschaften CanvasRenderingContext2D.fillStyle
oder CanvasRenderingContext2D.strokeStyle
zugewiesen werden, danach wird es auf jede nachfolgende Zeichnung angewendet.
Syntax
createPattern(image, repetition)
Parameter
image
-
Ein Bild, das als Musterbild verwendet werden soll. Es kann eines der folgenden sein:
HTMLImageElement
(<img>
)SVGImageElement
(<image>
)HTMLVideoElement
(<video>
, durch die Erfassung des Videos)HTMLCanvasElement
(<canvas>
)ImageBitmap
OffscreenCanvas
VideoFrame
repetition
-
Ein String, der angibt, wie das Musterbild wiederholt werden soll. Mögliche Werte sind:
"repeat"
(beide Richtungen)"repeat-x"
(nur horizontal)"repeat-y"
(nur vertikal)"no-repeat"
(keine Richtung)
Ein
null
Wert wird genauso behandelt wie der leere String (""
): beide sind Synonyme für"repeat"
.
Rückgabewert
CanvasPattern
-
Ein undurchsichtiges Objekt, das ein Muster beschreibt.
Wenn das image
nicht vollständig geladen ist (HTMLImageElement.complete
ist false
), wird null
zurückgegeben.
Beispiele
Ein Muster aus einem Bild erstellen
Dieses Beispiel verwendet die createPattern()
Methode, um ein CanvasPattern
mit einem sich wiederholenden Quellbild zu erstellen.
Sobald es erstellt ist, wird das Muster dem Füllstil des Canvas-Kontextes zugewiesen und auf ein Rechteck angewendet.
Das Originalbild sieht so aus:
HTML
<canvas id="canvas" width="300" height="300"></canvas>
JavaScript
const canvas = document.getElementById("canvas");
const ctx = canvas.getContext("2d");
const img = new Image();
img.src = "canvas_create_pattern.png";
// Only use the image after it's loaded
img.onload = () => {
const pattern = ctx.createPattern(img, "repeat");
ctx.fillStyle = pattern;
ctx.fillRect(0, 0, 300, 300);
};
Ein Muster aus einem Canvas erstellen
In diesem Beispiel erstellen wir ein Muster aus dem Inhalt eines Offscreen-Canvas. Dann wenden wir es auf den Füllstil unseres primären Canvas an und füllen dieses Canvas mit dem Muster.
JavaScript
// Create a pattern, offscreen
const patternCanvas = document.createElement("canvas");
const patternContext = patternCanvas.getContext("2d");
// Give the pattern a width and height of 50
patternCanvas.width = 50;
patternCanvas.height = 50;
// Give the pattern a background color and draw an arc
patternContext.fillStyle = "#fec";
patternContext.fillRect(0, 0, patternCanvas.width, patternCanvas.height);
patternContext.arc(0, 0, 50, 0, 0.5 * Math.PI);
patternContext.stroke();
// Create our primary canvas and fill it with the pattern
const canvas = document.createElement("canvas");
const ctx = canvas.getContext("2d");
const pattern = ctx.createPattern(patternCanvas, "repeat");
ctx.fillStyle = pattern;
ctx.fillRect(0, 0, canvas.width, canvas.height);
// Add our primary canvas to the webpage
document.body.appendChild(canvas);
Ergebnis
Spezifikationen
Specification |
---|
HTML Standard # dom-context-2d-createpattern-dev |
Browser-Kompatibilität
BCD tables only load in the browser
Siehe auch
- Die Schnittstelle, die diese Methode definiert:
CanvasRenderingContext2D
CanvasPattern