$rect

Draws a rectangle in the current path. (not filled or stroked)

Usage

$rect[canvas;x;y;width;height;...radius?]

Parameters

Field	Type	Description	Required
canvas	String	Name of the canvas.	True
x	Number	The rect start X coordinate.	True
y	Number	The rect start Y coordinate.	True
width	Number	The rect width.	True
height	Number	The rect height.	True
radius	Number	The rect corners radius.	False

Example(s)

No examples for this function.

Raw Info

{
 "name": "$rect",
 "description": "Draws a rectangle in the current path. (not filled or stroked)",
 "params": [
  {
   "name": "canvas",
   "description": "Name of the canvas.",
   "type": "String",
   "required": true
  },
  {
   "name": "x",
   "description": "The rect start X coordinate.",
   "type": "Number",
   "required": true
  },
  {
   "name": "y",
   "description": "The rect start Y coordinate.",
   "type": "Number",
   "required": true
  },
  {
   "name": "width",
   "description": "The rect width.",
   "type": "Number",
   "required": true
  },
  {
   "name": "height",
   "description": "The rect height.",
   "type": "Number",
   "required": true
  },
  {
   "name": "radius",
   "description": "The rect corners radius.",
   "type": "Number",
   "required": false
  }
 ],
 "usage": "$rect[canvas;x;y;width;height;...radius?]",
 "category": "canvas",
 "src": "https://github.com/devlordduck/aoi.canvas/tree/v2/src/functions/canvas/rect.ts",
 "docs": "https://aoicanvas.vercel.app/functions/rect"
}