SIMPOL Documentation

Chapter 42. imagelib

Thi9s library was started by Simpol Limited and extended significantly and contributed by John Roberts. It provides functionality for saving blobs as BMPs and XPM files, as well as reading them from such files.

BMP

Description

Type Tags

None

Object Value

Objects of type BMP have no value, and it is an error to try to get or set this value.

BMP.new()

Description

Prototype

BMP.new ( BMP me, string filename, string name )

Parameters

ParameterDefault valueType nameDescription
meNoneBMP
filenameNonestring
nameNonestring

Properties

PropertyTypeDescription
backcolorinteger
charsperpixelinteger
datablob
filenamestring
getdefbackcolorfunction
getheaderfunction
headerBMP_header
heightinteger
infoheaderBMP_infoheader
namestring
palettecolorpalette
readfromfilefunction
rereadpalettefunction
typetype
widthinteger
writetofilefunction

Methods

getdefbackcolor()

Description

Prototype

BMPvar.getdefbackcolor ( BMP me )

Parameters
ParameterDefault valueType nameDescription
meNoneBMP

getheader()

Description

Prototype

BMPvar.getheader ( BMP bmp, integer error )

Parameters
ParameterDefault valueType nameDescription
bmpNoneBMP
errorNoneinteger

readfromfile()

Description

Prototype

BMPvar.readfromfile ( BMP me, string filename, integer error )

Parameters
ParameterDefault valueType nameDescription
meNoneBMP
filenameNonestring
errorNoneinteger

rereadpalette()

Description

Prototype

BMPvar.rereadpalette ( BMP me, boolean buildstrindx, integer error )

Parameters
ParameterDefault valueType nameDescription
meNoneBMP
buildstrindx.falseboolean
errorNoneinteger

writetofile()

Description

Prototype

BMPvar.writetofile ( BMP bmp, string filename, integer bmpbits, integer error )

Parameters
ParameterDefault valueType nameDescription
bmpNoneBMP
filenameNonestring
bmpbitsNoneinteger
errorNoneinteger