Table of Contents

xPaintIcon

All settings mentioned in this class, need a prefix. This prefix is explained in the documentation of the module that uses this class.

Examples:

xTray...
xTaskbarActive...
xPopupFolder...

Legend

[ ]
Values between [ and ] are optional
BOOL
Boolean value (true or false)
COLOR
Color in Hex (FFFFFF = White, 000000 = Black, …)
COORDINATE
X or Y coordinate relative to the requested painting rectangle.
If the value is positive, then it is relative to the top/left of the requested painting rectangle.
If the value is negative, then it is relative to the bottom/right of the requested painting rectangle.
You can make the position relative to the center of the requested painting rectangle by appending the character 'c' after the number ("32c", "-128c")
You can use "real negative values" by adding a '~' before the number ("~10").
Additionally you can use percent values of the requested painting rectangle ("50%", "75%") and you can combine those percent values with further positioning ("20%-20", "80%+5", "100%+20").
INT
A number
STRING
A word, usually beginning with a period (.) or a quoted text

Settings

IconAddToGroup STRING [STRING] [STRING] […]
The parameters are: (group-name1) (group-name2) (group-name3)
Adds the xPaintIcon to the specified group.
Please don't use this as normal AddToGroup, this is a special setting only very few themers will ever need.
Overrides the module internal AddToGroup, if available.
Only the first group has full support for adding itself to another group. The other groups do not. So (group-name2)AddToGroup SomeGroup will not work as expected.
IconVisible BOOL
If you set this value to false, you can prevent the icon from being painted.

Layout

IconX COORDINATE
Sets the horizontal position of the icon.
IconY COORDINATE
Sets the vertical position of the icon.
IconSize INT
This command specifies the size (width and height) of the displayed icon.
The range of possible values is 8 - 64.
If no value is provided, then the default is 16.
If an IconSize of 32 or more is specified, then a larger version of the icon will be used for resizing than if an IconSize of less than 32 is specified.
IconMode STRING
STRING can be .stretch.
.stretch supports a scaling filter, which is appended to the setting IconMode .stretch_FILTER.
*Label test1 test2
test1IconMode .stretch_box
test2IconMode .stretch_bell

Sets the method used to scale the texture icon.
Explanations of the filters:
Box
equivalent to Nearest Neighbor on upsampling, averages pixels on downsampling
Triangle
equivalent to Low; the function can be called Tent function for its shape
Hermite
use of the cubic spline from Hermite interpolation
Bell
attempt to compromise between reducing block artifacts and blurring image
CubicBSpline
most blurry filter (cubic Bezier spline) - known samples are just "magnets" for this curve
Lanczos3
windowed Sinc function (sin(x)/x) - promising quality, but ringing artifacts can appear
Mitchell
another compromise, but excellent for upsampling
Cosine
an attemp to replace curve of high order polynomial by cosine function (which is even)
CatmullRom
Catmull-Rom curve, used in first image warping algorithm (did you see Terminator II ?)
Quadratic
performance optimized filter - results are like with Bezier-Splines, but using quadratic function only
QuadraticBSpline
quadratic Bezier spline modification
CubicConvolution
filter used in one example, its weight distribution enhances image edges
Lanczos8
also Sinc function, but with larger window, this function includes largest neighborhood
If no value is provided, then the default is .stretch.
Minimum Requirement: xPaintClass-1.0 Update 6.
IconRotation INT
Rotates the icon.
The range of possible values is -360 to 360.
Minimum Requirement: xPaintClass-1.0 Update 4.

Icon Colorization

IconHueColor COLOR
This command specifies the color of the hue, if HueIntensity is greater than 0.
Gray scale colors, like FFFFFF, c0c0c0, 888888, 000000, etc, will not make a difference to the hue since they don't have a color.
If no value is provided, then the default is FFFFFF (i.e. no hue color).
IconHueIntensity INT
This command sets the intensity of the hue effect.
Minimum: 0 (nothing), maximum: 100
If no value is provided the default is 0.
IconMixColor COLOR
This command specifies the color, which is mixed with the existing colors.
If no value is provided, then the default is FFFFFF.
IconMixIntensity INT
This command sets the intensity of the color mixing effect.
Minimum: 0 (nothing), maximum: 100
If no value is provided the default is 0.
IconLuminanceIntensity INT
This command sets the the intensity of the luminance effect applied to the texture image.
Minimum: -100 (black), maximum: 100 (white)
If no value is provided the default is 0.
IconSaturationIntensity INT
This command sets the color saturation of the texture image.
Minimum: 0 (grayscale), maximum: 200.
If no value is provided the default is 100 (fully colored).
Values between 101-200 overrides the original saturation of the pixel. This way you can colorize gray scale texture images.

Transparency features

IconAlphaTransparency INT
Makes the icon alphatransparent
Valid values are 0-255, where 0 is totally transparent and 255 is opaque.
Default is 255.
OS requirement: Windows 2000 or newer