$clip

Turns the current path into the current clipping region.

Usage

$clip[canvas;rule?]

Parameters

Field	Type	Description	Required
canvas	String	Name of the canvas.	True
rule	”nonzero” | “evenodd” | 0 | 1	The fill rule.	False

Example(s)

No examples for this function.

Raw Info

{
 "name": "$clip",
 "description": "Turns the current path into the current clipping region.",
 "params": [
  {
   "name": "canvas",
   "description": "Name of the canvas.",
   "type": "String",
   "required": true
  },
  {
   "name": "rule",
   "description": "The fill rule.",
   "type": "\"nonzero\" | \"evenodd\" | 0 | 1",
   "required": false,
   "enum": {
    "0": "nonzero",
    "1": "evenodd",
    "nonzero": 0,
    "evenodd": 1
   }
  }
 ],
 "usage": "$clip[canvas;rule?]",
 "category": "canvas",
 "src": "https://github.com/devlordduck/aoi.canvas/tree/v2/src/functions/canvas/clip.ts",
 "docs": "https://aoicanvas.vercel.app/functions/clip"
}