Paintutils (API) - Revision history

Superaxander at 13:47, 14 June 2015

2015-06-14T13:47:49Z

MKlegoman357: Added missing functions drawBox and drawFilledBox, expanded the note about optional color params

2015-01-29T19:18:19Z

Added missing functions drawBox and drawFilledBox, expanded the note about optional color params

Bomb Bloke: CC 1.6 changes

2014-04-28T05:54:49Z

CC 1.6 changes

MKlegoman357 at 16:19, 10 April 2014

2014-04-10T16:19:22Z

MKlegoman357: Expanded

2014-04-10T16:17:36Z

Expanded

Immibis: use API table template

2013-09-14T21:48:49Z

use API table template

TheCoryKid: Removed the NeedsWork (it no longer explained what needed work), adjusted column widths, changed int to number, added tags.

2013-05-14T09:56:37Z

Removed the NeedsWork (it no longer explained what needed work), adjusted column widths, changed int to number, added <em> tags.

← Older revision Revision as of 09:56, 14 May 2013
Line 1: Line 1:

−
~~{{NeedsWork|Function pages are added. When the time is appropriate, whoever deems that time, may take this NeedsWork template down'' [[User:SuicidalSTDz|SuicidalSTDz]] 20:40, 29 March 2013 (MSK)}}~~
+
Paintutils is a default API for advanced computers which can draw pixels and lines, and load and draw image files.

−

+

−
Paintutils is an API to draw and load ~~images~~.
+

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">

Line 9: Line 7:

</td></tr>

</td></tr>

−
<tr><td style="width: ~~350px~~; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
+
<tr><td style="width: 550px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.loadImage]]({{type|string}} path)</td>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.loadImage]]({{type|string}} path)</td>

−
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns an image object.</td></tr>
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns an image object from <em>path</em>.</td></tr>

−
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawImage]](image, {{type|~~int~~}} x, {{type|~~int~~}} y)</td>
+
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawImage]]({{type|table}} image, {{type|number}} x, {{type|number}} y)</td>

−
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws an image at (x, y) where image is an image object.</td></tr>
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws an image at (<em>x</em>, <em>y</em>) where <em>image</em> is an image object.</td></tr>

−
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawPixel]]({{type|~~int~~}} x, {{type|~~int~~}} y, {{type|~~int~~}} colour)</td>
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawPixel]]({{type|number}} x, {{type|number}} y, {{type|number}} colour)</td>

−
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a pixel at (x, y) in the ~~colour~~ specified.</td></tr>
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a pixel at (<em>x</em>, <em>y</em>) in the specified <em>colour</em>.</td></tr>

−
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawLine]]({{type|~~int~~}} startX, {{type|~~int~~}} startY, {{type|~~int~~}} endX, {{type|~~int~~}} endY, {{type|~~int~~}} color)</td>
+
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawLine]]({{type|number}} startX, {{type|number}} startY, {{type|number}} endX, {{type|number}} endY, {{type|number}} color)</td>

−
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a line from (startX, startY) to (endX, endY) in the ~~colour~~ specified.</td></tr>
+
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a line from (<em>startX</em>, <em>startY</em>) to (<em>endX</em>, <em>endY</em>) in the specified <em>colour</em>.</td></tr>

</table>

</table>

Smiley43210: Added types

2013-05-02T15:13:31Z

Added types

← Older revision Revision as of 15:13, 2 May 2013
Line 11: Line 11:

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

−
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.loadImage]](path)</td>
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.loadImage]]({{type|string}} path)</td>

<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns an image object.</td></tr>

<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns an image object.</td></tr>

−
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawImage]](image, x, y)</td>
+
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawImage]](image, {{type|int}} x, {{type|int}} y)</td>

<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws an image at (x, y) where image is an image object.</td></tr>

<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws an image at (x, y) where image is an image object.</td></tr>

−
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawPixel]](x, y, colour)</td>
+
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawPixel]]({{type|int}} x, {{type|int}} y, {{type|int}} colour)</td>

<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a pixel at (x, y) in the colour specified.</td></tr>

<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a pixel at (x, y) in the colour specified.</td></tr>

−
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawLine]](startX, startY, endX, endY, ~~colour~~)</td>
+
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawLine]]({{type|int}} startX, {{type|int}} startY, {{type|int}} endX, {{type|int}} endY, {{type|int}} color)</td>

<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a line from (startX, startY) to (endX, endY) in the colour specified.</td></tr>

<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a line from (startX, startY) to (endX, endY) in the colour specified.</td></tr>

Tiin57: Added a period. Blegh grammar.

2013-03-29T18:41:05Z

Added a period. Blegh grammar.

← Older revision Revision as of 18:41, 29 March 2013
Line 1: Line 1:

{{NeedsWork|Function pages are added. When the time is appropriate, whoever deems that time, may take this NeedsWork template down'' [[User:SuicidalSTDz|SuicidalSTDz]] 20:40, 29 March 2013 (MSK)}}

{{NeedsWork|Function pages are added. When the time is appropriate, whoever deems that time, may take this NeedsWork template down'' [[User:SuicidalSTDz|SuicidalSTDz]] 20:40, 29 March 2013 (MSK)}}

−
Paintutils is an API to draw and load images
+
Paintutils is an API to draw and load images.

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">

SuicidalSTDz: Function pages are all added

2013-03-29T16:40:17Z

Function pages are all added

← Older revision Revision as of 16:40, 29 March 2013
Line 1: Line 1:

−
{{NeedsWork|~~Missing function~~ pages ''[[User:~~Pokepal101~~|~~Pokepal101~~]] 02:28, 29 ~~December 2012~~ (MSK)''}}
+
{{NeedsWork|Function pages are added. When the time is appropriate, whoever deems that time, may take this NeedsWork template down'' [[User:SuicidalSTDz|SuicidalSTDz]] 20:40, 29 March 2013 (MSK)}}

Paintutils is an API to draw and load images

Paintutils is an API to draw and load images

@@ Line 40: / Line 40: @@
 |}}
 }}
-''<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. The current [[term.setBackgroundColor|background colour]] will be used if it's omitted. This was changed back to optional in version 1.64.''
+''<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]]

@@ Line 17: / Line 17: @@
 {{API table/row
-|[[paintutils.drawPixel]]({{type|number}} x, {{type|number}} y, {{type|number}} color*)
+|[[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.
@@ Line 23: / Line 23: @@
 {{API table/row
-|[[paintutils.drawLine]]({{type|number}} startX, {{type|number}} startY, {{type|number}} endX, {{type|number}} endY, {{type|number}} color*)
+|[[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.
 |}}
 }}
-''<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. The current [[term.setBackgroundColor|background colour]] will be used if it's omitted.''
+''<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. The current [[term.setBackgroundColor|background colour]] will be used if it's omitted. This was changed back to optional in version 1.64.''
 [[Category:APIs]]

@@ Line 17: / Line 17: @@
 {{API table/row
-|[[paintutils.drawPixel]]({{type|number}} x, {{type|number}} y [<nowiki/>, {{type|number}} color])
+|[[paintutils.drawPixel]]({{type|number}} x, {{type|number}} y, {{type|number}} color*)
 |{{type|nil}}
-|Draws a pixel at (<var>x</var>, <var>y</var>). If <var>color</var> is specified draws it in that color.
+|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 [<nowiki/>, {{type|number}} color])
+|[[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>). If <var>color</var> is specified draws it in that color.
+|Draws a line from (<var>startX</var>, <var>startY</var>) to (<var>endX</var>, <var>endY</var>) in the specified color.
 |}}
 }}
+''<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. The current [[term.setBackgroundColor|background colour]] will be used if it's omitted.''
 [[Category:APIs]]

@@ Line 1: / Line 1: @@
-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. Use [[Colors (API)|colors API]] for easier color manipulation.
+{{lowercase}}
-{{API table|Paintutils|image=Grid disk.png|2=
+{{API table|paintutils|image=Grid disk.png|2=
 {{API table/row
@@ Line 18: / Line 19: @@
 |[[paintutils.drawPixel]]({{type|number}} x, {{type|number}} y [<nowiki/>, {{type|number}} color])
 |{{type|nil}}
-|Draws a pixel at (<var>x</var>, <var>y</var>). If <var>color</var> specified draws it in that color.
+|Draws a pixel at (<var>x</var>, <var>y</var>). If <var>color</var> is specified draws it in that color.
 |odd}}
@@ Line 24: / Line 25: @@
 |[[paintutils.drawLine]]({{type|number}} startX, {{type|number}} startY, {{type|number}} endX, {{type|number}} endY [<nowiki/>, {{type|number}} color])
 |{{type|nil}}
-|Draws a line from (<var>startX</var>, <var>startY</var>) to (<var>endX</var>, <var>endY</var>). If <var>color</var> specified draws it in that color.
+|Draws a line from (<var>startX</var>, <var>startY</var>) to (<var>endX</var>, <var>endY</var>). If <var>color</var> is specified draws it in that color.
 |}}

@@ Line 1: / Line 1: @@
-Paintutils is a default API for advanced computers which can draw pixels and lines, and load and draw image files.
+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. Use [[Colors (API)|colors API]] for easier color manipulation.
 {{API table|Paintutils|image=Grid disk.png|2=
 {{API table/row
-|[[paintutils.loadImage]]({{type|string}} path)|{{type|table}} image
+|[[paintutils.loadImage]]({{type|string}} path)
-|Returns an image object from <var>path</var>.
+|{{type|table}} image
 |odd}}
 {{API table/row
-|[[paintutils.drawImage]]({{type|table}} image, {{type|number}} x, {{type|number}} y)|{{type|nil}}
+|[[paintutils.drawImage]]({{type|table}} image, {{type|number}} x, {{type|number}} y)
 |Draws an image at (<var>x</var>, <var>y</var>) where <var>image</var> is an image object.
 |}}
 {{API table/row
-|[[paintutils.drawPixel]]({{type|number}} x, {{type|number}} y, {{type|number}} colour)|{{type|nil}}
+|[[paintutils.drawPixel]]({{type|number}} x, {{type|number}} y [<nowiki/>, {{type|number}} color])
-|Draws a pixel at (<var>x</var>, <var>y</var>) in the specified <var>colour</var>.
+|{{type|nil}}
 |odd}}
 {{API table/row
-|[[paintutils.drawLine]]({{type|number}} startX, {{type|number}} startY, {{type|number}} endX, {{type|number}} endY, {{type|number}} color)|{{type|nil}}
+|[[paintutils.drawLine]]({{type|number}} startX, {{type|number}} startY, {{type|number}} endX, {{type|number}} endY [<nowiki/>, {{type|number}} color])
-|Draws a line from (<var>startX</var>, <var>startY</var>) to (<var>endX</var>, <var>endY</var>) in the specified <var>colour</var>.
+|{{type|nil}}
 |}}

@@ Line 1: / Line 1: @@
 Paintutils is a default API for advanced computers which can draw pixels and lines, and load and draw image files.
-<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
+{{API table|Paintutils|image=Grid disk.png|2=
-<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
-[[File:Grid_disk.png|24px]]&nbsp;&nbsp;
-Paintutils (API)
-</td></tr>
-<tr><td style="width: 550px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
+{{API table/row
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.loadImage]]({{type|string}} path)</td>
+{{API table/row
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns an image object from <em>path</em>.</td></tr>
+|[[paintutils.drawImage]]({{type|table}} image, {{type|number}} x, {{type|number}} y)|{{type|nil}}
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawImage]]({{type|table}} image, {{type|number}} x, {{type|number}} y)</td>
+{{API table/row
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws an image at (<em>x</em>, <em>y</em>) where <em>image</em> is an image object.</td></tr>
+|[[paintutils.drawPixel]]({{type|number}} x, {{type|number}} y, {{type|number}} colour)|{{type|nil}}
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawPixel]]({{type|number}} x, {{type|number}} y, {{type|number}} colour)</td>
+{{API table/row
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a pixel at (<em>x</em>, <em>y</em>) in the specified <em>colour</em>.</td></tr>
+|[[paintutils.drawLine]]({{type|number}} startX, {{type|number}} startY, {{type|number}} endX, {{type|number}} endY, {{type|number}} color)|{{type|nil}}
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawLine]]({{type|number}} startX, {{type|number}} startY, {{type|number}} endX, {{type|number}} endY, {{type|number}} color)</td>
+}}
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a line from (<em>startX</em>, <em>startY</em>) to (<em>endX</em>, <em>endY</em>) in the specified <em>colour</em>.</td></tr>
-−
-</table>
 [[Category:APIs]]

@@ Line 11: / Line 11: @@
 <tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.loadImage]](path)</td>
+<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.loadImage]]({{type|string}} path)</td>
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns an image object.</td></tr>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawImage]](image, x, y)</td>
+<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawImage]](image, {{type|int}} x, {{type|int}} y)</td>
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws an image at (x, y) where image is an image object.</td></tr>
-<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawPixel]](x, y, colour)</td>
+<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawPixel]]({{type|int}} x, {{type|int}} y, {{type|int}} colour)</td>
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a pixel at (x, y) in the colour specified.</td></tr>
-<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawLine]](startX, startY, endX, endY, colour)</td>
+<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawLine]]({{type|int}} startX, {{type|int}} startY, {{type|int}} endX, {{type|int}} endY, {{type|int}} color)</td>
 <td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a line from (startX, startY) to (endX, endY) in the colour specified.</td></tr>

@@ Line 1: / Line 1: @@
 {{NeedsWork|Function pages are added. When the time is appropriate, whoever deems that time, may take this NeedsWork template down'' [[User:SuicidalSTDz|SuicidalSTDz]] 20:40, 29 March 2013 (MSK)}}
-Paintutils is an API to draw and load images
+Paintutils is an API to draw and load images.
 <table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">

← Older revision		Revision as of 16:40, 29 March 2013
Line 1:		Line 1:
−	{{NeedsWork\|~~Missing function~~ pages ''[[User:~~Pokepal101~~\|~~Pokepal101~~]] 02:28, 29 ~~December 2012~~ (MSK)''}}	+	{{NeedsWork\|Function pages are added. When the time is appropriate, whoever deems that time, may take this NeedsWork template down'' [[User:SuicidalSTDz\|SuicidalSTDz]] 20:40, 29 March 2013 (MSK)}}

	Paintutils is an API to draw and load images		Paintutils is an API to draw and load images