grdMagick.dll - alter the appearance of your world!

grdMagick is module for LiteStep, which provides all users with some fantastic (if I may say so) general porpose eyecandy.
What it does is provide whichevery other module you'd like, with an overlay which totally changes the looks of that specific module.
The source for inspiration for this module was the great module lsTransparent by carluchi (Carl Milano).
And not only did I get inspired by lsTransparent, but he also let me look at the source-code for lsTransparent. Allthough almost everything is rewritten, I owe him a great lot of thanx.

developer: Gustav Munkby
grimreaperdesigns@gmx.net

with GREAT help from: Carl Milano
carluchi@stratos.net

evolution

[v 1.3.1]
- corrected the issue with desat, where the scale was inverted.
[v 1.3]
- corrected a bug wich would make grdmagick eat memory and resources
- <+> added another effect, rect.
[v 1.2.1]
- corrected a bug wich could appear with !grdmagickset
- <+> added a check so that a chain including itself would not render an infinite loop.
[v 1.2]
- <+> name is now grdMagick. (notice the k)
- <+> first actual public version.
- <+> removed some debugging code.
[v 1.2 beta 1]
- <+> added filter and blur/gaus effect. read more
[v 1.1 beta 1]
- <+> added replace effect. read more
[v 1.0 beta 1]
- <0> initial version.

installation

unpack the grdMagick.dll into your modules directory.
add the line to step.rc looking somewhat like this: LoadModule $LiteStepDir$\modules\grdMagick.dll
start playin' around with the settings in your step.rc

step.rc commands

*grdMagick <module> <magic/fx> <options>

<module> the name of the module you want to add your magic to. Path and extension is ignored.

<magic/fx> could be any magic effect, read about them in the section called effects.

<options> depending on what magic effect you've choosen. this is all different.

Examples:
*grdMagick popup2 invert *grdMagick grdtray3 hue 96 0xff00ff *grdMagick popup2 desaturnation 96

*grdMagickChain <name> [? <vars> ?][<magic/fx> <options>]

<name> the name used to reference this effect in a *grdMagick statement.

<vars> [optional], containing variables referenced in the later specified magic/fx. This enables specifying options to a userdefined chain of effects.

<magic/fx> see *grdMagick

<options> see *grdMagick

Examples:
*grdMagickChain ghue [?am cl?][invert][hue ?am? ?cl?] *grdMagickChain invbluehue [invert][hue 96 0x0033ee]

supported !bangs

!grdMagickSet <module> <magic/fx> <options>

<module> see *grdMagick

<magic/fx> see *grdMagick

<options> see *grdMagick

Examples:
!grdMagickSet popup2 invert !grdMagickSet grdTray3 invbluehue

builtin effects

desat(urate) <amount>

<amount> [0-255]
amount of desaturation, where 0 is colored and 255 is grayscale.

invert

filter <m11> <m12> <m13> <m21> ... <m33> <factor>

<mXX> this is a three-by-three matrix:
|m11 m12 m13| |m21 m22 m23| |m31 m32 m33|
for every pixel in the image, this matrix will be applied.

Example:
filter-matrix: image-info: |0 1 0| |0x000000 0x110000 0x000000| |0 0 4| |0x110000 0x110000 0x001100| |2 3 0| |0x000000 0x110000 0x000000|
the pixels are all multiplied with their factor-components, and then summarized
cl = 1 * 0x110000 + 4 * 0x001100 + 3 * 0x110000 = 0x444400

<factor> this is the normalizor of the above matrix.
continuing from above, (with factor = 4)
cl = (cl / 4) = 0x444400 / 4 = 0x111100

hue <amount> <color>

<amount> [0-255]
the amount of the new color to be blended into the source.

<color> the color that should be blended into the source.

gaus/blur

replace <from-color> <to-color>

<from-color> the color, that should be substituted.

<to-color> the substituting color.

rect <left> <top> <right> <bottom> <effect>

<left> <top> <right> <bottom> the coordinates of the box which should be painted with the effect.

<effect> reference to another effect (may include arguments), that should be used.

known issues

I think grdMagick has to be loaded BEFORE other modules you want to have the effects apply.

additional notes

Nothing here yet, except the fact that I'd like to be presented with a lot of ideas, help and stuff like that.

source license

The code is avaliable for free and you can get it by contacting me through e-mail or another way.
Even if the code is free, and you're allowed to do almost whatever you like with it, I have to restrict it a little. The requirements to use it is:

source-code has to be included
this documentatory file has to be included

those were the requirements, my wishes are that:

you tell me about using my source-code
you also mention Carl Milano

the man

Gustav Munkby, online known as grimreaper or grd. I'm the one man behind the concept "grd" which stands for; grim reaper designs, which is my web-page and what I do on the computer.

This is where you find my domains online:

e-mail: grimreaperdesigns@gmx.net

www: http://floach.pimpin.net/grd

ls@www: <www>/ls

grdmagick: <ls@www>/grdmagick.zip

icq: 1349988

irc: #lsdev/#ls2k (nick: grd)

`*grdMagick <module> <magic/fx> <options>`
`<module>`	the name of the module you want to add your magic to. Path and extension is ignored.
`<magic/fx>`	could be any magic effect, read about them in the section called effects.
`<options>`	depending on what magic effect you've choosen. this is all different.
Examples: `grdMagick popup2 invert grdMagick grdtray3 hue 96 0xff00ff *grdMagick popup2 desaturnation 96`

`*grdMagickChain <name> [? <vars> ?][<magic/fx> <options>]`
`<name>`	the name used to reference this effect in a `*grdMagick` statement.
`<vars>`	[optional], containing variables referenced in the later specified magic/fx. This enables specifying options to a userdefined chain of effects.
`<magic/fx>`	see *grdMagick
`<options>`	see *grdMagick
Examples: `grdMagickChain ghue [?am cl?][invert][hue ?am? ?cl?] grdMagickChain invbluehue [invert][hue 96 0x0033ee]`

`desat(urate) <amount>`
`<amount>`	[0-255] amount of desaturation, where 0 is colored and 255 is grayscale.

`filter <m11> <m12> <m13> <m21> ... <m33> <factor>`
`<mXX>`	this is a three-by-three matrix: `\|m11 m12 m13\| \|m21 m22 m23\| \|m31 m32 m33\|` for every pixel in the image, this matrix will be applied. Example: `filter-matrix: image-info: \|0 1 0\| \|0x000000 0x110000 0x000000\| \|0 0 4\| \|0x110000 0x110000 0x001100\| \|2 3 0\| \|0x000000 0x110000 0x000000\|` the pixels are all multiplied with their factor-components, and then summarized `cl = 1 * 0x110000 + 4 * 0x001100 + 3 * 0x110000 = 0x444400`
`<factor>`	this is the normalizor of the above matrix. continuing from above, (with factor = 4) `cl = (cl / 4) = 0x444400 / 4 = 0x111100`

`hue <amount> <color>`
`<amount>`	[0-255] the amount of the new color to be blended into the source.
`<color>`	the color that should be blended into the source.

`replace <from-color> <to-color>`
`<from-color>`	the color, that should be substituted.
`<to-color>`	the substituting color.

`rect <left> <top> <right> <bottom> <effect>`
`<left> <top> <right> <bottom>`	the coordinates of the box which should be painted with the effect.
`<effect>`	reference to another effect (may include arguments), that should be used.

e-mail:	grimreaperdesigns@gmx.net
www:	http://floach.pimpin.net/grd
ls@www:	<www>/ls
grdmagick:	<ls@www>/grdmagick.zip
icq:	1349988
irc:	#lsdev/#ls2k (nick: grd)