Graphics

Module that handles 2D rendering. More...

Enumerations
enum	ImageFilter { FILTER_POINT , FILTER_LINEAR }
	Image filters to use with Graphics.setImageFilters. More...
enum	MemType { MEM_VRAM , MEM_PHYCONT_RAM , MEM_RAM }
	Memory types usable for allocated images. More...

Functions
int	Graphics::createImage (int width, int height, int color, MemType type)
	Create an empty image.
void	Graphics::debugPrint (number x, number y, string text, int color)
	Print a text on screen using system font.
void	Graphics::drawImage (number x, number y, int img, int color)
	Draw an image.
void	Graphics::drawImageExtended (number x, number y, int img, int x_start, int y_start, number width, number height, number rad, number x_scale, number y_scale, int color)
	Draw an image with several effects.
void	Graphics::drawLine (number x1, number x2, number y1, number y2, int color)
	Draw a line.
void	Graphics::drawPartialImage (number x, number y, int img, int x_start, int y_start, number width, number height, int color)
	Draw a part of an image.
void	Graphics::drawPixel (number x, number y, int color, int image)
	Draw a pixel.
void	Graphics::drawRotateImage (number x, number y, int img, number rad, int color)
	Draw a rotated image.
void	Graphics::drawScaleImage (number x, number y, int img, number x_scale, number y_scale, int color)
	Draw a scaled image.
void	Graphics::fillCircle (number x, number y, number rad, int color)
	Draw a circle.
void	Graphics::fillEmptyRect (number x1, number x2, number y1, number y2, int color)
	Draw an empty rectangle.
void	Graphics::fillRect (number x1, number x2, number y1, number y2, int color)
	Draw a rectangle.
void	Graphics::freeImage (int img)
	Free a loaded image.
int	Graphics::getImageFramesNum (int img)
	Gets the number of frames of a loaded animated image.
int	Graphics::getImageHeight (int img)
	Get an image height.
int	Graphics::getImageWidth (int img)
	Get an image width.
int	Graphics::getPixel (int x, int y, int img)
	Get a pixel color from a loaded image.
void	Graphics::initBlend (void)
	Initialize drawing phase.
void	Graphics::initRescaler (int x, int y, number x_scale, number y_scale)
	Initialize a rescaler.
int	Graphics::loadAnimatedImage (string filename)
	Load a .gif animated image.
int	Graphics::loadImage (string filename, MemType type)
	Load a .png/.jpg/.bmp image.
void	Graphics::loadImageAsync (string filename)
	Load a .png/.jpg/.bmp image (asynchronous).
void	Graphics::overloadImage (int image, int offset, int size, string data)
	Copies pixels to a loaded image.
void	Graphics::saveImage (int img, string filename, ImgFmt format)
	Save a loaded image to a .png/.bmp image.
void	Graphics::setImageFilters (int img, ImageFilter min_filter, ImageFilter mag_filter)
	Set filters to use for a given image.
void	Graphics::setImageFrame (int img, int frame)
	Set current active frame for a loaded animated image.
void	Graphics::termBlend (void)
	Terminate drawing phase.
void	Graphics::termRescaler (void)
	Terminate a rescaler.

Detailed Description

Module that handles 2D rendering.

Enumeration Type Documentation

ImageFilter

enum ImageFilter

Image filters to use with Graphics.setImageFilters.

Enumerator
FILTER_POINT	Point filter.
FILTER_LINEAR	Linear filter.

MemType

enum MemType

Memory types usable for allocated images.

Enumerator
MEM_VRAM	VRAM memory type.
MEM_PHYCONT_RAM	Physically contiguous RAM memory type.
MEM_RAM	RAM memory type.

Function Documentation

createImage()

int Graphics::createImage	(	int	width,
		int	height,
		int	color,
		MemType	type
	)

Create an empty image.

Usage example:

img = Graphics.createImage(Color.new(25, 200, 120))

Parameters

width	- Image width.
height	- Image height.
color	- A valid color (See Color) (optional).
type	- Memory type to use for the image (optional).

Returns

A valid image ID.

debugPrint()

void Graphics::debugPrint	(	number	x,
		number	y,
		string	text,
		int	color
	)

Print a text on screen using system font.

Usage example:

Graphics.debugPrint(10, 10, "Hello World", Color.new(255, 255, 255))

Parameters

x	- X coordinate of the text position in pixels.
y	- Y coordinate of the text position in pixels.
text	- Text to print.
color	- A valid color (See Color).

drawImage()

void Graphics::drawImage	(	number	x,
		number	y,
		int	img,
		int	color
	)

Draw an image.

Usage example:

Graphics.drawImage(50, 100, img)

Parameters

x	- X coordinate of the image in pixels.
y	- Y coordinate of the image in pixels.
img	- A valid image ID.
color	- Image tint color (See Color) (optional).

drawImageExtended()

void Graphics::drawImageExtended	(	number	x,
		number	y,
		int	img,
		int	x_start,
		int	y_start,
		number	width,
		number	height,
		number	rad,
		number	x_scale,
		number	y_scale,
		int	color
	)

Draw an image with several effects.

Usage example:

Graphics.drawImageExtended(50, 100, img, 20, 20, 100, 100, 1.0, 0.5, 0.5)

Parameters

x	- X coordinate of the image in pixels.
y	- Y coordinate of the image in pixels.
img	- A valid image ID.
x_start	- Image X coordinate for the partial drawing.
y_start	- Image Y coordinate for the partial drawing.
width	- Partial drawing width.
height	- Partial drawing height.
rad	- Rotation radius.
x_scale	- Scale value for X parameter.
y_scale	- Scale value for Y parameter.
color	- Image tint color (See Color) (optional).

drawLine()

void Graphics::drawLine	(	number	x1,
		number	x2,
		number	y1,
		number	y2,
		int	color
	)

Draw a line.

Usage example:

Graphics.drawLine(10, 25, 100, 250, Color.new(25, 200, 120))

Parameters

x1	- Starting X coordinate of the line in pixels.
x2	- Ending X coordinate of the line in pixels.
y1	- Starting Y coordinate of the line in pixels.
y2	- Ending Y coordinate of the line in pixels.
color	- A valid color (See Color).

drawPartialImage()

void Graphics::drawPartialImage	(	number	x,
		number	y,
		int	img,
		int	x_start,
		int	y_start,
		number	width,
		number	height,
		int	color
	)

Draw a part of an image.

Usage example:

Graphics.drawPartialImage(50, 100, img, 20, 20, 100, 100)

Parameters

x	- X coordinate of the image in pixels.
y	- Y coordinate of the image in pixels.
img	- A valid image ID.
x_start	- Image X coordinate for the partial drawing.
y_start	- Image Y coordinate for the partial drawing.
width	- Partial drawing width.
height	- Partial drawing height.
color	- Image tint color (See Color) (optional).

drawPixel()

void Graphics::drawPixel	(	number	x,
		number	y,
		int	color,
		int	image
	)

Draw a pixel.

Usage example:

Graphics.drawPixel(5, 5, Color.new(15, 255, 200))

Parameters

x	- X coordinate of the pixel position in pixels.
y	- Y coordinate of the pixel position in pixels.
color	- A valid color (See Color).
image	- Image to draw on (optional).

Note

If image is not provided, pixel will be drawn on screen.

drawRotateImage()

void Graphics::drawRotateImage	(	number	x,
		number	y,
		int	img,
		number	rad,
		int	color
	)

Draw a rotated image.

Usage example:

Graphics.drawRotateImage(50, 100, img, 1.0)

Parameters

x	- X coordinate of the image in pixels.
y	- Y coordinate of the image in pixels.
img	- A valid image ID.
rad	- Rotation radius.
color	- Image tint color (See Color) (optional).

drawScaleImage()

void Graphics::drawScaleImage	(	number	x,
		number	y,
		int	img,
		number	x_scale,
		number	y_scale,
		int	color
	)

Draw a scaled image.

Usage example:

Graphics.drawScaleImage(50, 100, img, 0.5, 0.5)

Parameters

x	- X coordinate of the image in pixels.
y	- Y coordinate of the image in pixels.
img	- A valid image ID.
x_scale	- Scale value for X parameter.
y_scale	- Scale value for Y parameter.
color	- Image tint color (See Color) (optional).

fillCircle()

void Graphics::fillCircle	(	number	x,
		number	y,
		number	rad,
		int	color
	)

Draw a circle.

Usage example:

Graphics.fillCircle(10, 25, 1.0, Color.new(25, 200, 120))

Parameters

x	- X coordinate of the circle in pixels.
y	- Y coordinate of the circle in pixels.
rad	- Radius size of the circle.
color	- A valid color (See Color).

fillEmptyRect()

void Graphics::fillEmptyRect	(	number	x1,
		number	x2,
		number	y1,
		number	y2,
		int	color
	)

Draw an empty rectangle.

Usage example:

Graphics.fillEmptyRect(10, 25, 100, 250, Color.new(25, 200, 120))

Parameters

x1	- Starting X coordinate of the rectangle in pixels.
x2	- Ending X coordinate of the rectangle in pixels.
y1	- Starting Y coordinate of the rectangle in pixels.
y2	- Ending Y coordinate of the rectangle in pixels.
color	- A valid color (See Color).

fillRect()

void Graphics::fillRect	(	number	x1,
		number	x2,
		number	y1,
		number	y2,
		int	color
	)

Draw a rectangle.

Usage example:

Graphics.fillRect(10, 25, 100, 250, Color.new(25, 200, 120))

Parameters

x1	- Starting X coordinate of the rectangle in pixels.
x2	- Ending X coordinate of the rectangle in pixels.
y1	- Starting Y coordinate of the rectangle in pixels.
y2	- Ending Y coordinate of the rectangle in pixels.
color	- A valid color (See Color).

freeImage()

void Graphics::freeImage

(

int

img

)

Free a loaded image.

Usage example:

Graphics.freeImage(img)

Parameters

img	- A valid image ID.

getImageFramesNum()

int Graphics::getImageFramesNum

(

int

img

)

Gets the number of frames of a loaded animated image.

Usage example:

img = Graphics.loadAnimatedImage("app0:/image.gif")
frames = Graphics.getImageFramesNum(img)

Parameters

img	- A valid image ID.

Returns

The number of frames for the given image.

getImageHeight()

int Graphics::getImageHeight

(

int

img

)

Get an image height.

Usage example:

height = Graphics.getImageHeight(img)

Parameters

img	- A valid image ID.

Returns

The image height in pixels.

getImageWidth()

int Graphics::getImageWidth

(

int

img

)

Get an image width.

Usage example:

width = Graphics.getImageWidth(img)

Parameters

img	- A valid image ID.

Returns

The image width in pixels.

getPixel()

int Graphics::getPixel	(	int	x,
		int	y,
		int	img
	)

Get a pixel color from a loaded image.

Usage example:

pixel_color = Graphics.getPixel(5, 25, img)

Parameters

x	- X coordinate of the pixel.
y	- Y coordinate of the pixel.
img	- A valid image ID.

Returns

The pixel color value (See Color).

initBlend()

void Graphics::initBlend

(

void

)

Initialize drawing phase.

Usage example:

Graphics.initBlend()

initRescaler()

void Graphics::initRescaler	(	int	x,
		int	y,
		number	x_scale,
		number	y_scale
	)

Initialize a rescaler.

Usage example:

Graphics.initRescaler(0, 0, 2.0, 2.0)

Parameters

x	- X coordinate of the rescaler output.
y	- Y coordinate of the rescaler output.
x_scale	- Scale value for X parameter.
y_scale	- Scale value for Y parameter.

loadAnimatedImage()

int Graphics::loadAnimatedImage

(

string

filename

)

Load a .gif animated image.

Usage example:

img = Graphics.loadAnimatedImage("app0:/image.gif")

Parameters

filename

- Name of the file to open.

Returns

A valid image ID.

loadImage()

int Graphics::loadImage	(	string	filename,
		MemType	type
	)

Load a .png/.jpg/.bmp image.

Usage example:

img = Graphics.loadImage("app0:/image.jpg")

Parameters

filename	- Name of the file to open.
type	- Memory type to use for the image (optional).

Returns

A valid image ID.

loadImageAsync()

void Graphics::loadImageAsync

(

string

filename

)

Load a .png/.jpg/.bmp image (asynchronous).

Usage example:

Graphics.loadImageAsync("app0:/image.jpg")
while System.getAsyncState() == 0 do
 
end
img = System.getAsyncResult()

Parameters

filename

- Name of the file to open.

overloadImage()

void Graphics::overloadImage	(	int	image,
		int	offset,
		int	size,
		string	data
	)

Copies pixels to a loaded image.

Usage example:

Graphics.overloadImage(0, 32 * 32 * 4, pixels, image)

Parameters

image	- Image to copies pixels onto.
offset	- Offset in bytes to which to copies pixels.
size	- Size in bytes of the pixels to copy.
data	- Pixels to copy.

saveImage()

void Graphics::saveImage	(	int	img,
		string	filename,
		ImgFmt	format
	)

Save a loaded image to a .png/.bmp image.

Usage example:

Graphics.saveImage(img, "ux0:/data/image.png", FORMAT_PNG)

Parameters

img	- A valid image ID.
filename	- The filename of the screenshot output.
format	- The format to use for the output file (optional).

Note

FORMAT_JPG is not supported.

setImageFilters()

void Graphics::setImageFilters	(	int	img,
		ImageFilter	min_filter,
		ImageFilter	mag_filter
	)

Set filters to use for a given image.

Usage example:

Graphics.setImageFilters(img, FILTER_LINEAR, FILTER_LINEAR)

Parameters

img	- A valid image ID.
min_filter	- Min filter to use.
mag_filter	- Mag filter to use.

setImageFrame()

void Graphics::setImageFrame	(	int	img,
		int	frame
	)

Set current active frame for a loaded animated image.

Usage example:

img = Graphics.loadAnimatedImage("app0:/image.gif")
Graphics.setImageFrame(img, 8)

Parameters

img	- A valid image ID.
frame	- The frame to set as active.

termBlend()

void Graphics::termBlend

(

void

)

Terminate drawing phase.

Usage example:

Graphics.termBlend()

termRescaler()

void Graphics::termRescaler

(

void

)

Terminate a rescaler.

Usage example:

Graphics.termRescaler()