Image/bitmap class.

Constants

MOAIImage.FILTER_LINEAR

MOAIImage.FILTER_NEAREST

Flags

MOAIImage.POW_TWO

MOAIImage.QUANTIZE

MOAIImage.TRUECOLOR

MOAIImage.PREMULTIPLY_ALPHA

MOAIImage.PIXEL_FMT_TRUECOLOR

MOAIImage.PIXEL_FMT_INDEX_4

MOAIImage.PIXEL_FMT_INDEX_8

MOAIImage.COLOR_FMT_A_8

MOAIImage.COLOR_FMT_RGB_888

MOAIImage.COLOR_FMT_RGB_565

MOAIImage.COLOR_FMT_RGBA_5551

MOAIImage.COLOR_FMT_RGBA_4444

MOAIImage.COLOR_FMT_RGBA_8888

.

Inheritance diagram for MOAIImage:

List of all members.

Public Member Functions
void	DrawLine (int p1x, int p1y, int p2x, int p2y, u32 color)
Function List
	bleedRect
	compare
	convertColors
	copy
	copyBits
	copyRect
	fillCircle
	fillRect
	getColor32
	getFormat
	getRGBA
	getSize
	init
	load
	loadFromBuffer
	padToPow2
	resize
	resizeCanvas
	setColor32
	setRGBA
	writePNG

Function Documentation

bleedRect

'Bleeds' the interior of the rectangle out by one pixel.

function bleedRect ( MOAIImage self, number xMin, number yMin, number xMax, number yMax )

Parameters:

self	( MOAIImage )
xMin	( number )
yMin	( number )
xMax	( number )
yMax	( number )

Returns:: nil

compare

function ()

Returns:

convertColors

Return a copy of the image with a new color format. Not all provided formats are supported by OpenGL.

function convertColors ( MOAIImage self, number colorFmt )

Parameters:

self	( MOAIImage )
colorFmt	( number ) One of MOAIImage.COLOR_FMT_A_8, MOAIImage.COLOR_FMT_RGB_888, MOAIImage.COLOR_FMT_RGB_565, MOAIImage.COLOR_FMT_RGBA_5551, MOAIImage.COLOR_FMT_RGBA_4444, COLOR_FMT_RGBA_8888

Returns:: image ( MOAIImage )

copy

Copies an image.

function copy ( MOAIImage self )

Parameters:

self	( MOAIImage )

Returns:: image ( MOAIImage )

copyBits

Copy a section of one image to another.

function copyBits ( MOAIImage self, MOAIImage source, number srcX, number srcY, number destX, number destY, number width, number height )

Parameters:

self	( MOAIImage )
source	( MOAIImage ) Source image.
srcX	( number ) X location in source image.
srcY	( number ) Y location in source image.
destX	( number ) X location in destination image.
destY	( number ) Y location in destination image.
width	( number ) Width of section to copy.
height	( number ) Height of section to copy.

Returns:: nil

copyRect

Copy a section of one image to another. Accepts two rectangles. Rectangles may be of different size and proportion. Section of image may also be flipped horizontally or vertically by reversing min/max of either rectangle.

function copyRect ( MOAIImage self, MOAIImage source, number srcXMin, number srcYMin, number srcXMax, number srcYMax, number destXMin, number destYMin [, number destXMax, number destYMax, number filter ] )

Parameters:

self	( MOAIImage )
source	( MOAIImage ) Source image.
srcXMin	( number )
srcYMin	( number )
srcXMax	( number )
srcYMax	( number )
destXMin	( number )
destYMin	( number )
destXMax	( number ) Optional. Default value is destXMin + srcXMax - srcXMin;
destYMax	( number ) Optional. Default value is destYMin + srcYMax - srcYMin;
filter	( number ) Optional. One of MOAIImage.FILTER_LINEAR, MOAIImage.FILTER_NEAREST. Default value is MOAIImage.FILTER_LINEAR.

Returns:: nil

fillCircle

Draw a filled circle.

function fillCircle ( number x, number y, number r [, number r, number g, number b, number a ] )

Parameters:

x	( number )
y	( number )
r	( number )
r	( number ) Optional. Default value is 0.
g	( number ) Optional. Default value is 0.
b	( number ) Optional. Default value is 0.
a	( number ) Optional. Default value is 0.

Returns:: nil

fillRect

Fill a rectangle in the image with a solid color.

function fillRect ( MOAIImage self, number xMin, number yMin, number xMax, number yMax [, number r, number g, number b, number a ] )

Parameters:

self	( MOAIImage )
xMin	( number )
yMin	( number )
xMax	( number )
yMax	( number )
r	( number ) Optional. Default value is 0.
g	( number ) Optional. Default value is 0.
b	( number ) Optional. Default value is 0.
a	( number ) Optional. Default value is 0.

Returns:: nil

getColor32

Returns a 32-bit packed RGBA value from the image for a given pixel coordinate.

function getColor32 ( MOAIImage self, number x, number y )

Parameters:

self	( MOAIImage )
x	( number )
y	( number )

Returns:: color ( number )

getFormat

Returns the color format of the image.

function getFormat ( MOAIImage self )

Parameters:

self	( MOAIImage )

Returns:: colorFormat ( number )

getRGBA

Returns an RGBA color as four floating point values.

function getRGBA ( MOAIImage self, number x, number y )

Parameters:

self	( MOAIImage )
x	( number )
y	( number )

Returns:: r ( number ), g ( number ), b ( number ), a ( number )

getSize

Returns the width and height of the image.

function getSize ( MOAIImage self )

Parameters:

self	( MOAIImage )

Returns:: width ( number ), height ( number )

init

Initializes the image with a width, height and color format.

function init ( MOAIImage self, number width, number height [, colorFmt One ] )

Parameters:

self	( MOAIImage )
width	( number )
height	( number )
One	( colorFmt ) Optional. of MOAIImage.COLOR_FMT_A_8, MOAIImage.COLOR_FMT_RGB_888, MOAIImage.COLOR_FMT_RGB_565, MOAIImage.COLOR_FMT_RGBA_5551, MOAIImage.COLOR_FMT_RGBA_4444, MOAIImage.COLOR_FMT_RGBA_8888. Default valus is MOAIImage.COLOR_FMT_RGBA_8888.

Returns:: nil

load

Loads an image from a PNG.

function load ( MOAIImage self, string filename [, number transform ] )

Parameters:

self	( MOAIImage )
filename	( string )
transform	( number ) Optional. One of MOAIImage.POW_TWO, One of MOAIImage.QUANTIZE, One of MOAIImage.TRUECOLOR, One of MOAIImage.PREMULTIPLY_ALPHA

Returns:: nil

loadFromBuffer

Loads an image from a buffer.

function loadFromBuffer ( MOAIImage self, MOAIDataBuffer Buffer [, number transform ] )

Parameters:

self	( MOAIImage )
Buffer	( MOAIDataBuffer ) containing the image
transform	( number ) Optional. One of MOAIImage.POW_TWO, One of MOAIImage.QUANTIZE, One of MOAIImage.TRUECOLOR, One of MOAIImage.PREMULTIPLY_ALPHA

Returns:: nil

padToPow2

Copies an image and returns a new image padded to the next power of 2 along each dimension. Original image will be in the upper left hand corner of the new image.

function padToPow2 ( MOAIImage self )

Parameters:

self	( MOAIImage )

Returns:: image ( MOAIImage )

resize

Copies the image to an image with a new size.

function resize ( MOAIImage self, number width, number height [, number filter ] )

Parameters:

self	( MOAIImage )
width	( number ) New width of the image.
height	( number ) New height of the image.
filter	( number ) Optional. One of MOAIImage.FILTER_LINEAR, MOAIImage.FILTER_NEAREST. Default value is MOAIImage.FILTER_LINEAR.

Returns:: image ( MOAIImage )

resizeCanvas

Copies the image to a canvas with a new size. If the canvas is larger than the original image, the exta pixels will be initialized with 0. Pass in a new frame or just a new width and height. Negative values are permitted for the frame.

function resizeCanvas ( MOAIImage self, number width, number height )

Parameters:

self	( MOAIImage )
width	( number ) New width of the image.
height	( number ) New height of the image.

Returns:: image ( MOAIImage )

Note:

function resizeCanvas ( MOAIImage self, number xMin, number yMin, number xMax, number yMax )

Parameters:

self	( MOAIImage )
xMin	( number )
yMin	( number )
xMax	( number )
yMax	( number )

Returns:: image ( MOAIImage )

Note:

setColor32

Sets 32-bit the packed RGBA value for a given pixel coordinate. Parameter will be converted to the native format of the image.

function setColor32 ( MOAIImage self, number x, number y, number color )

Parameters:

self	( MOAIImage )
x	( number )
y	( number )
color	( number )

Returns:: nil

setRGBA

Sets a color using RGBA floating point values.

function setRGBA ( MOAIImage self, number x, number y, number r, number g, number b [, number a ] )

Parameters:

self	( MOAIImage )
x	( number )
y	( number )
r	( number )
g	( number )
b	( number )
a	( number ) Optional. Default value is 1.

Returns:: nil

writePNG

Write image to a PNG file.

function writePNG ( MOAIImage self, string filename )

Parameters:

self	( MOAIImage )
filename	( string )

Returns:: nil

void MOAIImage::DrawLine	int	p1x,
		int	p1y,
		int	p2x,
		int	p2y,
		u32	color

function ()

Returns:

MOAIImage Class Reference

Public Member Functions

Function List

Function Documentation