$filter

Use filters in your canvas.

Usage

$filter[canvas;method;filter?;value?]

Parameters

Field	Type	Description	Required
canvas	String	The name of the canvas to use filters in.	True
method	”add” | “set” | “remove” | “clear” | “get” | “parse” | 0 | 1 | 2 | 3 | 4 | 5	Method.	True
filter	”none” | “blur” | “sepia” | “grayscale” | “brightness” | “contrast” | “invert” | “saturate” | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7	Name of the filter.	False
value	Number	Value of the filter.	False

Example(s)

No examples for this function.

Raw Info

{
 "name": "$filter",
 "description": "Use filters in your canvas.",
 "params": [
  {
   "name": "canvas",
   "description": "The name of the canvas to use filters in.",
   "type": "String",
   "required": true
  },
  {
   "name": "method",
   "description": "Method.",
   "type": "\"add\" | \"set\" | \"remove\" | \"clear\" | \"get\" | \"parse\" | 0 | 1 | 2 | 3 | 4 | 5",
   "required": true,
   "enum": {
    "0": "add",
    "1": "set",
    "2": "remove",
    "3": "clear",
    "4": "get",
    "5": "parse",
    "add": 0,
    "set": 1,
    "remove": 2,
    "clear": 3,
    "get": 4,
    "parse": 5
   }
  },
  {
   "name": "filter",
   "description": "Name of the filter.",
   "type": "\"none\" | \"blur\" | \"sepia\" | \"grayscale\" | \"brightness\" | \"contrast\" | \"invert\" | \"saturate\" | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7",
   "required": false,
   "enum": {
    "0": "none",
    "1": "blur",
    "2": "sepia",
    "3": "grayscale",
    "4": "brightness",
    "5": "contrast",
    "6": "invert",
    "7": "saturate",
    "none": 0,
    "blur": 1,
    "sepia": 2,
    "grayscale": 3,
    "brightness": 4,
    "contrast": 5,
    "invert": 6,
    "saturate": 7
   }
  },
  {
   "name": "value",
   "description": "Value of the filter.",
   "type": "Number",
   "required": false
  }
 ],
 "usage": "$filter[canvas;method;filter?;value?]",
 "category": "canvas",
 "src": "https://github.com/devlordduck/aoi.canvas/tree/v2/src/functions/canvas/filter.ts",
 "docs": "https://aoicanvas.vercel.app/functions/filter"
}