_imImage Struct Reference
[imImage]

imImage Structure Definition. More...

Data Fields

int width
int height
int color_space
int data_type
int has_alpha
int depth
int line_size
int plane_size
int size
int count
void ** data
long * palette
int palette_count
void * attrib_table

Detailed Description

An image representation than supports all the color spaces, but planes are always unpacked and the orientation is always bottom up.

Field Documentation

Number of columns. image:Width() -> width: number [in Lua 5].

Number of lines. image:Height() -> height: number [in Lua 5].

Color space descriptor. See also imColorSpace. image:ColorSpace() -> color_space: number [in Lua 5].

Data type descriptor. See also imDataType. image:DataType() -> data_type: number [in Lua 5].

Indicates that there is an extra channel with alpha. image:HasAlpha() -> has_alpha: number [in Lua 5].
It will not affect the secondary parameters, i.e. the number of planes will be in fact depth+1.
It is always 0 unless imImageAddAlpha is called, this is done in image load functions.

Number of planes (ColorSpaceDepth)

Number of bytes per line in one plane (width * DataTypeSize)

Number of bytes per plane. (line_size * height)

Number of bytes occupied by the image (plane_size * depth)

Number of pixels (width * height)

Image data organized as a 2D matrix with several planes.
But plane 0 is also a pointer to the full data.
The remaining planes are: data[i] = data[0] + i*plane_size
In Lua, data indexing is possible using: image[plane][row][column]

Color palette. image:GetPalette() -> palette: imPalette [in Lua 5].
Used when depth=1. Otherwise is NULL.

The palette is always 256 colors allocated, but can have less colors used.

in fact is an imAttribTable, but we hide this here


The documentation for this struct was generated from the following file:

Generated on Thu Oct 1 11:40:08 2009 for IM by  doxygen 1.6.1