Difference between revisions of "Paintutils (API)"

From ComputerCraft Wiki
Jump to: navigation, search
m (Methods fix, shit was all over the place.)
 
(18 intermediate revisions by 10 users not shown)
Line 1: Line 1:
Paintutils is an API to draw and load images
+
{{lowercase}}
 +
Paintutils is a default API for advanced systems which can draw [[paintutils.drawPixel|pixels]] and [[paintutils.drawLine|lines]], [[paintutils.loadImage|load]] and [[paintutils.drawImage|draw]] image files. You can use [[Colors (API)|colors API]] for easier color manipulation.
  
==Methods==
+
{{API table|paintutils|image=Grid disk.png|2=
{| border="1" cellpadding="2" cellspacing="0"
+
 
!style="background:#EEE" width="300px"|Method name
+
{{API table/row
!style="background:#EEE" width="*"|Description
+
|[[paintutils.loadImage]]({{type|string}} path)
|-
+
|{{type|table}} image
|[[paintutils.loadImage]](path)
+
|Loads and returns an image object from <var>path</var>.
|Returns an image object.
+
|odd}}
|-
+
 
|[[paintutils.drawImage]](image, x, y)
+
{{API table/row
|Draws an image at (x, y) where image is an image object.
+
|[[paintutils.drawImage]]({{type|table}} image, {{type|number}} x, {{type|number}} y)
|-
+
|{{type|nil}}
|[[paintutils.drawPixel]](x, y, colour)
+
|Draws an image at (<var>x</var>, <var>y</var>) where <var>image</var> is an image object.
|Draws a pixel at (x, y) in the colour specified.
+
|}}
|-
+
 
|[[paintutils.drawLine]](startX, startY, endX, endY, colour)
+
{{API table/row
|Draws a line from (startX, startY) to (endX, endY) in the colour specified.
+
|[[paintutils.drawPixel]]({{type|number}} x, {{type|number}} y [, {{type|number}} color*])
 +
|{{type|nil}}
 +
|Draws a pixel at (<var>x</var>, <var>y</var>) in the specified color.
 +
|odd}}
 +
 
 +
{{API table/row
 +
|[[paintutils.drawLine]]({{type|number}} startX, {{type|number}} startY, {{type|number}} endX, {{type|number}} endY [, {{type|number}} color*])
 +
|{{type|nil}}
 +
|Draws a line from (<var>startX</var>, <var>startY</var>) to (<var>endX</var>, <var>endY</var>) in the specified color.
 +
|}}
 +
 
 +
{{API table/row
 +
|[[paintutils.drawBox]]({{type|number}} startX, {{type|number}} startY, {{type|number}} endX, {{type|number}} endY [, {{type|number}} color])
 +
|{{type|nil}}
 +
|Draws a box from (<var>startX</var>, <var>startY</var>) to (<var>endX</var>, <var>endY</var>) in the specified color. ''Requires version 1.64 or newer.''
 +
|odd}}
 +
 
 +
{{API table/row
 +
|[[paintutils.drawFilledBox]]({{type|number}} startX, {{type|number}} startY, {{type|number}} endX, {{type|number}} endY [, {{type|number}} color])
 +
|{{type|nil}}
 +
|Draws a filled box from (<var>startX</var>, <var>startY</var>) to (<var>endX</var>, <var>endY</var>) in the specified color. ''Requires version 1.64 or newer.''
 +
|}}
 +
}}
 +
''<nowiki>*</nowiki> Note: In builds prior to ComputerCraft 1.6, the "color" parameter required by [[paintutils.drawPixel|paintutils.drawPixel()]] and [[paintutils.drawLine|paintutils.drawLine()]] is optional. From ComputerCraft 1.6 the parameter is required, but it was changed back to optional in ComputerCraft 1.64.''
  
 
[[Category:APIs]]
 
[[Category:APIs]]

Latest revision as of 13:47, 14 June 2015

Paintutils is a default API for advanced systems which can draw pixels and lines, load and draw image files. You can use colors API for easier color manipulation.

Grid disk.png  paintutils (API)
Function Return values Description
paintutils.loadImage(string path) table image Loads and returns an image object from path.
paintutils.drawImage(table image, number x, number y) nil Draws an image at (x, y) where image is an image object.
paintutils.drawPixel(number x, number y [, number color*]) nil Draws a pixel at (x, y) in the specified color.
paintutils.drawLine(number startX, number startY, number endX, number endY [, number color*]) nil Draws a line from (startX, startY) to (endX, endY) in the specified color.
paintutils.drawBox(number startX, number startY, number endX, number endY [, number color]) nil Draws a box from (startX, startY) to (endX, endY) in the specified color. Requires version 1.64 or newer.
paintutils.drawFilledBox(number startX, number startY, number endX, number endY [, number color]) nil Draws a filled box from (startX, startY) to (endX, endY) in the specified color. Requires version 1.64 or newer.

* Note: In builds prior to ComputerCraft 1.6, the "color" parameter required by paintutils.drawPixel() and paintutils.drawLine() is optional. From ComputerCraft 1.6 the parameter is required, but it was changed back to optional in ComputerCraft 1.64.