paintutils

Utilities for drawing more complex graphics, such as pixels, lines and images.

Changes

• New in version 1.45

parseImage(image)Source

Parses an image from a multi-line string

Parameters

1. image string The string containing the raw-image data.

Returns

1. table The parsed image data, suitable for use with paintutils.drawImage.

Changes

• New in version 1.80pr1

loadImage(path)Source

Loads an image from a file.

You can create a file suitable for being loaded using the paint program.

Parameters

1. path string The file to load.

Returns

1. table | nil The parsed image data, suitable for use with paintutils.drawImage, or nil if the file does not exist.

Usage

• Load an image and draw it.

  local image = paintutils.loadImage("data/example.nfp")
  paintutils.drawImage(image, term.getCursorPos())

drawPixel(xPos, yPos [, colour])Source

Draws a single pixel to the current term at the specified position.

Be warned, this may change the position of the cursor and the current background colour. You should not expect either to be preserved.

Parameters

1. xPos number The x position to draw at, where 1 is the far left.
2. yPos number The y position to draw at, where 1 is the very top.
3. colour? number The color of this pixel. This will be the current background colour if not specified.

drawLine(startX, startY, endX, endY [, colour])Source

Draws a straight line from the start to end position.

Be warned, this may change the position of the cursor and the current background colour. You should not expect either to be preserved.

Parameters

1. startX number The starting x position of the line.
2. startY number The starting y position of the line.
3. endX number The end x position of the line.
4. endY number The end y position of the line.
5. colour? number The color of this pixel. This will be the current background colour if not specified.

Usage

• paintutils.drawLine(2, 3, 30, 7, colors.red)

drawBox(startX, startY, endX, endY [, colour])Source

Draws the outline of a box on the current term from the specified start position to the specified end position.

Be warned, this may change the position of the cursor and the current background colour. You should not expect either to be preserved.

Parameters

1. startX number The starting x position of the line.
2. startY number The starting y position of the line.
3. endX number The end x position of the line.
4. endY number The end y position of the line.
5. colour? number The color of this pixel. This will be the current background colour if not specified.

Usage

• paintutils.drawBox(2, 3, 30, 7, colors.red)

drawFilledBox(startX, startY, endX, endY [, colour])Source

Draws a filled box on the current term from the specified start position to the specified end position.

Be warned, this may change the position of the cursor and the current background colour. You should not expect either to be preserved.

Parameters

1. startX number The starting x position of the line.
2. startY number The starting y position of the line.
3. endX number The end x position of the line.
4. endY number The end y position of the line.
5. colour? number The color of this pixel. This will be the current background colour if not specified.

Usage

• paintutils.drawFilledBox(2, 3, 30, 7, colors.red)

drawImage(image, xPos, yPos)Source

Draw an image loaded by paintutils.parseImage or paintutils.loadImage.

Parameters

1. image table The parsed image data.
2. xPos number The x position to start drawing at.
3. yPos number The y position to start drawing at.