Our volunteers haven't translated this article into Català yet. Join us and help get the job done!
You can also read the article in English (US).

The CanvasRenderingContext2D.clip() method of the Canvas 2D API turns the path currently being built into the current clipping path.

Syntax

void ctx.clip();
void ctx.clip(fillRule);
void ctx.clip(path, fillRule);

Parameters

fillRule
The algorithm by which to determine if a point is inside a path or outside a path.
Possible values:
path
A Path2D path to clip.

Examples

Using the clip method

This is just a simple code snippet which uses the clip method to create a clipping region.

HTML

<canvas id="canvas"></canvas>

JavaScript

var canvas = document.getElementById('canvas');
var ctx = canvas.getContext('2d');

// Create clipping region
ctx.beginPath();
ctx.arc(100, 100, 75, 0, Math.PI * 2, false);
ctx.clip();

ctx.fillRect(0, 0, 100,100);

Edit the code below and see your changes update live in the canvas:

Playable code
<canvas id="canvas" width="400" height="200" class="playable-canvas"></canvas>
<div class="playable-buttons">
  <input id="edit" type="button" value="Edit" />
  <input id="reset" type="button" value="Reset" />
</div>
<textarea id="code" class="playable-code">
ctx.arc(100, 100, 75, 0, Math.PI*2, false);
ctx.clip();
ctx.fillRect(0, 0, 100,100);</textarea>
var canvas = document.getElementById("canvas");
var ctx = canvas.getContext("2d");
var textarea = document.getElementById("code");
var reset = document.getElementById("reset");
var edit = document.getElementById("edit");
var code = textarea.value;

function drawCanvas() {
  ctx.clearRect(0, 0, canvas.width, canvas.height);
  eval(textarea.value);
}

reset.addEventListener("click", function() {
  textarea.value = code;
  drawCanvas();
});

edit.addEventListener("click", function() {
  textarea.focus();
})

textarea.addEventListener("input", drawCanvas);
window.addEventListener("load", drawCanvas);

Note: Be aware that the clip() region is only constructed from shapes added to the path; it doesn't work with shape primitives drawn directly to the canvas such as fillRect(). In that case you'd have to use rect() to add a rectangular shape to the path before calling clip().

Specifications

Specification Status Comment
HTML Living Standard
The definition of 'CanvasRenderingContext2D.clip' in that specification.
Living Standard  

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidEdge MobileFirefox for AndroidOpera for AndroidiOS SafariSamsung Internet
Basic supportChrome Full support YesEdge Full support 12Firefox Full support YesIE Full support YesOpera Full support YesSafari Full support YesWebView Android Full support YesChrome Android Full support YesEdge Mobile Full support YesFirefox Android Full support YesOpera Android Full support YesSafari iOS Full support YesSamsung Internet Android Full support Yes
Path parameterChrome ? Edge Full support YesFirefox Full support 31IE No support NoOpera ? Safari No support NoWebView Android ? Chrome Android ? Edge Mobile Full support YesFirefox Android Full support 31Opera Android ? Safari iOS ? Samsung Internet Android ?

Legend

Full support  
Full support
No support  
No support
Compatibility unknown  
Compatibility unknown

See also

Document Tags and Contributors

Last updated by: MatthewMastracci,