openfl
Version:
A fast, productive library for 2D cross-platform development.
167 lines (142 loc) • 5.95 kB
TypeScript
declare namespace openfl.geom {
/**
* The ColorTransform class 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 class
* * 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.
*
* Color transformations do not apply to the background color of a movie
* clip(such as a loaded SWF object). They apply only to graphics and symbols
* that are attached to the movie clip.
*/
export class ColorTransform {
/**
* A decimal value that is multiplied with the alpha transparency channel
* value.
*
* If you set the alpha transparency value of a display object directly by
* using the `alpha` property of the DisplayObject instance, it
* affects the value of the `alphaMultiplier` property of that
* display object's `transform.colorTransform` property.
*/
public alphaMultiplier:number;
/**
* A number from -255 to 255 that is added to the alpha transparency channel
* value after it has been multiplied by the `alphaMultiplier`
* value.
*/
public alphaOffset:number;
/**
* A decimal value that is multiplied with the blue channel value.
*/
public blueMultiplier:number;
/**
* A number from -255 to 255 that is added to the blue channel value after it
* has been multiplied by the `blueMultiplier` value.
*/
public blueOffset:number;
/**
* The RGB color value for a ColorTransform object.
*
* When you set this property, it changes the three color offset values
* (`redOffset`, `greenOffset`, and
* `blueOffset`) accordingly, and it sets the three color
* multiplier values(`redMultiplier`,
* `greenMultiplier`, and `blueMultiplier`) to 0. The
* alpha transparency multiplier and offset values do not change.
*
* When you pass a value for this property, use the format
* 0x_RRGGBB_. _RR_, _GG_, and _BB_ each consist of two
* hexadecimal digits that specify the offset of each color component. The 0x
* tells the ActionScript compiler that the number is a hexadecimal
* value.
*/
public color:number;
protected get_color ():number;
protected set_color (value:number):number;
/**
* A decimal value that is multiplied with the green channel value.
*/
public greenMultiplier:number;
/**
* A number from -255 to 255 that is added to the green channel value after
* it has been multiplied by the `greenMultiplier` value.
*/
public greenOffset:number;
/**
* A decimal value that is multiplied with the red channel value.
*/
public redMultiplier:number;
/**
* A number from -255 to 255 that is added to the red channel value after it
* has been multiplied by the `redMultiplier` value.
*/
public redOffset:number;
/**
* Creates a ColorTransform object for a display object with the specified
* color channel values and alpha values.
*
* @param redMultiplier The value for the red multiplier, in the range from
* 0 to 1.
* @param greenMultiplier The value for the green multiplier, in the range
* from 0 to 1.
* @param blueMultiplier The value for the blue multiplier, in the range
* from 0 to 1.
* @param alphaMultiplier The value for the alpha transparency multiplier, in
* the range from 0 to 1.
* @param redOffset The offset value for the red color channel, in the
* range from -255 to 255.
* @param greenOffset The offset value for the green color channel, in
* the range from -255 to 255.
* @param blueOffset The offset for the blue color channel value, in the
* range from -255 to 255.
* @param alphaOffset The offset for alpha transparency channel value, in
* the range from -255 to 255.
*/
public constructor (redMultiplier?:number, greenMultiplier?:number, blueMultiplier?:number, alphaMultiplier?:number, redOffset?:number, greenOffset?:number, blueOffset?:number, alphaOffset?:number);
/**
* 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. When you apply the concatenated ColorTransform object,
* the effect is the same as applying the `second` color
* transformation after the _original_ color transformation.
*
* @param second The ColorTransform object to be combined with the current
* ColorTransform object.
*/
public concat (second:ColorTransform):void;
public toString ():string;
}
}
export default openfl.geom.ColorTransform;