$drawImage

Draws an image on the canvas.

Usage

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

Parameters

Field	Type	Description	Required
canvas	String	Name of the canvas.	True
path	Path | URL | Canvas | Image	Path or url to the image.	True
x	Number	The X coordinate of the image.	True
y	Number	The Y coordinate of the image.	True
width	Number	The image width.	False
height	Number	The image height.	False
radius	Number	The image corners radius.	False

Example(s)

No examples for this function.

Raw Info

{
 "name": "$drawImage",
 "description": "Draws an image on the canvas.",
 "params": [
  {
   "name": "canvas",
   "description": "Name of the canvas.",
   "type": "String",
   "required": true
  },
  {
   "name": "path",
   "description": "Path or url to the image.",
   "type": "Path | URL | Canvas | Image",
   "required": true
  },
  {
   "name": "x",
   "description": "The X coordinate of the image.",
   "type": "Number",
   "required": true
  },
  {
   "name": "y",
   "description": "The Y coordinate of the image.",
   "type": "Number",
   "required": true
  },
  {
   "name": "width",
   "description": "The image width.",
   "type": "Number",
   "required": false
  },
  {
   "name": "height",
   "description": "The image height.",
   "type": "Number",
   "required": false
  },
  {
   "name": "radius",
   "description": "The image corners radius.",
   "type": "Number",
   "required": false
  }
 ],
 "usage": "$drawImage[canvas;path;x;y;width?;height?;...radius?]",
 "category": "canvas",
 "src": "https://github.com/devlordduck/aoi.canvas/tree/v2/src/functions/canvas/drawImage.ts",
 "docs": "https://aoicanvas.vercel.app/functions/drawimage"
}