Documentation

XPM
Prev Chapter 37. imagelib Next

XPM

Description

Type Tags

None

Object Value

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

XPM.new()

Description

Prototype

XPM.new ( XPM me, string filename, string name, integer maxcolors, integer charsperpixel )

Parameters

ParameterDefault valueType nameDescription
meNoneXPM
filenameNonestring
nameNonestring
maxcolors16777215integer
charsperpixel1integer

Properties

PropertyTypeDescription
backcolorinteger
charsperpixelinteger
colorsinteger
datablob
filenamestring
getdefbackcolorfunction
heightinteger
idblob
namestring
palettecolorpalette
readfromfilefunction
rereadpalettefunction
typetype
widthinteger
writetofilefunction

Methods

getdefbackcolor()

Description

Prototype

XPMvar.getdefbackcolor ( XPM me )

Parameters
ParameterDefault valueType nameDescription
meNoneXPM

readfromfile()

Description

Prototype

XPMvar.readfromfile ( XPM me, string filename, string xpmstr, XPMcolorlist x11colors, integer backgroundcolor, integer error )

Parameters
ParameterDefault valueType nameDescription
meNoneXPM
filenameNonestring
xpmstrNonestring
x11colorsNoneXPMcolorlist
backgroundcolor12632256integer
errorNoneinteger

rereadpalette()

Description

Prototype

XPMvar.rereadpalette ( XPM me, boolean buildstrindx, integer error )

Parameters
ParameterDefault valueType nameDescription
meNoneXPM
buildstrindx.trueboolean
errorNoneinteger

writetofile()

Description

Prototype

XPMvar.writetofile ( XPM me, string filename, XPMcolorlist colorlist, integer error )

Parameters
ParameterDefault valueType nameDescription
meNoneXPM
filenameNonestring
colorlistNoneXPMcolorlist
errorNoneinteger
Prev Up Next
BMP_infoheader Home XPMcolorlist