$compositeOperation

Sets the type of compositing operation to apply when drawing new shapes.

Usage

$compositeOperation[canvas;operation?]

Parameters

Field	Type	Description	Required
canvas	String	Name of the canvas.	True
operation	CompositingOperation	The new compositing operation.	False

Example(s)

No examples for this function.

Raw Info

{
 "name": "$compositeOperation",
 "description": "Sets the type of compositing operation to apply when drawing new shapes.",
 "params": [
  {
   "name": "canvas",
   "description": "Name of the canvas.",
   "type": "String",
   "required": true
  },
  {
   "name": "operation",
   "description": "The new compositing operation.",
   "type": "CompositingOperation",
   "required": false,
   "enum": {
    "0": "source-over",
    "1": "source-in",
    "2": "source-out",
    "3": "source-atop",
    "4": "destination-over",
    "5": "destination-in",
    "6": "destination-out",
    "7": "destination-atop",
    "8": "lighter",
    "9": "copy",
    "10": "xor",
    "11": "multiply",
    "12": "screen",
    "13": "overlay",
    "14": "darken",
    "15": "lighten",
    "16": "color-dodge",
    "17": "color-burn",
    "18": "hard-light",
    "19": "soft-light",
    "20": "difference",
    "21": "exclusion",
    "22": "hue",
    "23": "saturation",
    "24": "color",
    "25": "luminosity",
    "source-over": 0,
    "source-in": 1,
    "source-out": 2,
    "source-atop": 3,
    "destination-over": 4,
    "destination-in": 5,
    "destination-out": 6,
    "destination-atop": 7,
    "lighter": 8,
    "copy": 9,
    "xor": 10,
    "multiply": 11,
    "screen": 12,
    "overlay": 13,
    "darken": 14,
    "lighten": 15,
    "color-dodge": 16,
    "color-burn": 17,
    "hard-light": 18,
    "soft-light": 19,
    "difference": 20,
    "exclusion": 21,
    "hue": 22,
    "saturation": 23,
    "color": 24,
    "luminosity": 25
   }
  }
 ],
 "usage": "$compositeOperation[canvas;operation?]",
 "category": "canvas",
 "src": "https://github.com/devlordduck/aoi.canvas/tree/v2/src/functions/canvas/compositeOperation.ts",
 "docs": "https://aoicanvas.vercel.app/functions/compositeoperation"
}