The ColorTransform object lets you adjust the color values in a display object. The color adjustment or color transformation can be applied to all four channels: red, green, blue, and alpha transparency.

When a ColorTransform object is applied to a display object, a new value for each color channel is calculated like this:


New red value = (old red value * redMultiplier) + redOffset

New green value = (old green value * greenMultiplier) + greenOffset

New blue value = (old blue value * blueMultiplier) + blueOffset

New alpha value = (old alpha value * alphaMultiplier) + alphaOffset

If any of the color channel values is greater than 255 after the calculation, it is set to 255. If it is less than 0, it is set to 0.


You can use ColorTransform objects in the following ways:


In the colorTransform parameter of the colorTransform() method of the BitmapData object

As the colorTransform property of a Transform object (which can be used as the transform property of a display object)

You must use the new ColorTransform() constructor to create a ColorTransform object before you can call the methods of the ColorTransform object.


Can be created with method new:

Lib.Media.Geom.ColorTransform.new(redMultiplier, greenMultiplier, blueMultiplier, alphaMultiplier, redOffset, greenOffset, blueOffset, alphaOffset)

Creates a ColorTransform object for a display object with the specified color channel values and alpha values.

redMultiplier - (default = 1.0) - The value for the red multiplier, in the range from 0 to 1.

greenMultiplier - (default = 1.0) - The value for the green multiplier, in the range from 0 to 1. 

blueMultiplier - (default = 1.0) - The value for the blue multiplier, in the range from 0 to 1.

alphaMultiplier - (default = 1.0) - The value for the alpha transparency multiplier, in the range from 0 to 1.

redOffset - (default = 0) - The offset value for the red color channel, in the range from -255 to 255.

greenOffset - (default = 0) - The offset value for the green color channel, in the range from -255 to 255.

blueOffset - (default = 0) - The offset for the blue color channel value, in the range from -255 to 255.

alphaOffset - (default = 0) - The offset for alpha transparency channel value, in the range from -255 to 255.


Created ColorTransform object has properties:

alphaMultiplier

A decimal value that is multiplied with the alpha transparency channel value.

alphaOffset

A number from -255 to 255 that is added to the alpha transparency channel value after it has been multiplied by the alphaMultiplier value.

blueMultiplier

A decimal value that is multiplied with the blue channel value.

blueOffset

A number from -255 to 255 that is added to the blue channel value after it has been multiplied by the blueMultiplier value.

color

The RGB color value for a ColorTransform object.

greenMultiplier

A decimal value that is multiplied with the green channel value.

greenOffset

A number from -255 to 255 that is added to the green channel value after it has been multiplied by the greenMultiplier value.

redMultiplier

A decimal value that is multiplied with the red channel value.

redOffset

A number from -255 to 255 that is added to the red channel value after it has been multiplied by the redMultiplier value.


methods:

concat(second)

Concatenates the ColorTranform object specified by the second parameter with the current ColorTransform object and sets the current object as the result, which is an additive combination of the two color transformations.

second - The ColorTransform object to be combined with the current ColorTransform object.

toString()

Formats and returns a string that describes all of the properties of the ColorTransform object.

Created with the Personal Edition of HelpNDoc: Free HTML Help documentation generator