Scaleform Studio Lua API Reference: scaleform.Cxform object reference
Description
A color transform class that modifies all pixels being rendered.
Constructors and accessors 
Other related reference items
Related help topics
Functions
self : |
The color transform currently in use. |
number |
The alpha multiplier value. |
self : |
The color transform currently in use. |
integer |
The alpha offset value [0-255]. |
 |
Appends the color transformation matrix by multiplying the specified Cxform by the current Cxform and assigns the result to the first Cxform.
|
self : |
The color transform currently in use. | |
cxformParent : |
The color transform to multiply to. |
| This function does not return any values. |
self : |
The color transform currently in use. |
number |
The blue multiplier value. |
self : |
The color transform currently in use. |
integer |
The blue offset value [0-255]. |
self : |
The color transform. |
|
The cloned Cxform object. |
self : |
The color transform currently in use. |
|
The color. |
self : |
The color transform currently in use. |
table |
A 2x4 array of arrays of numbers |
dst : |
The destination color transform. | |
src : |
The source color transform |
| This function does not return any values. |
color : |
An color offset to initialize the cxform with. The ? notation indicates that this type is optional: there may be zero or one instances of it. |
|
The newly created color transform. |
a : | number |
The alpha multiplier added to the color transform. |
|
The modified color transform. |
t : | number |
The tint value. |
r : | number |
The red color value. |
g : | number |
The green color value. |
b : | number |
The blue color value. |
|
The modified color transform. |
self : |
The color transform currently in use. |
number |
The green multiplier value. |
self : |
The color transform currently in use. |
integer |
The green offset value [0-255]. |
self : |
The color transform currently in use. |
boolean |
Whether the cxform is an identity color transformation matrix or not. |
self : |
The color transform currently in use. |
| This function does not return any values. |
| |
Prepend a color transform matrix onto this current matrix by multiplying the current matrix by the passed Cxform.
|
self : |
The color transform currently in use. | |
cxformParent : |
The color matrix to multiply. |
| This function does not return any values. |
self : |
The color transform currently in use. |
number |
The red multiplier value. |
self : |
The color transform currently in use. |
integer |
The red offset value [0-255]. |
self : |
The color transform currently in use. |
boolean |
Whether blending is disabled or not. |
self : |
The color transform currently in use. | |
am : | number |
A decimal value that is multiplied with the alpha transparency channel value, as a decimal value between 0 and 1. |
| This function does not return any values. |
self : |
The color transform currently in use. | |
ao : | integer |
The alpha offset value [0-255]; |
| This function does not return any values. |
self : |
The color transform currently in use. | |
bm : | number |
The percentage to apply the color, as a decimal value between 0 and 1. |
| This function does not return any values. |
self : |
The color transform currently in use. | |
bo : | integer |
The blue offset value [0-255]. |
| This function does not return any values. |
self : |
The color transform currently in use. | |
c : |
A color whose components set those of the current color. |
| This function does not return any values. |
self : |
The color transform currently in use. | |
gm : | number |
The green multiplier value. |
| This function does not return any values. |
self : |
The color transform currently in use. | |
go : | integer |
The green offset value [0-255]. |
| This function does not return any values. |
self : |
The color transform currently in use. |
| This function does not return any values. |
self : |
The color transform currently in use. | |
rm : | number |
The percentage to apply the color, as a decimal value between 0 and 1. |
| This function does not return any values. |
self : |
The color transform currently in use. | |
ro : | integer |
The red offset value [0-255]. |
| This function does not return any values. |
self : |
The color transform currently in use. | |
c0 : |
The color matrix to append. | |
c1 : |
The parent color matrix. |
| This function does not return any values. |
self : |
The color transform currently in use. | |
newColor : |
A color value that needs to be transformed. |
|
The transformed color. |
Transforming a color involves multiplying it by a scale factor and adding an offset factor. The result of the color transform is clamped to the target color numeric range.
scaleform.Actor.cxform (self) : scaleform.CxformReturns the color transformation matrix applied on the actor.
scaleform.Actor.world_cxform (self) : scaleform.CxformReturns the concatenated color transform matrix (all ancestor transforms, times the matrix).
scaleform.Cxform.clone (self) : scaleform.CxformClones the color transform object.
scaleform.Cxform.create (color) : scaleform.CxformCreates a new color transform object.
scaleform.Cxform.create_alpha (a) : scaleform.CxformAdds an alpha value to the color transform.
scaleform.Cxform.create_brightness (b) : scaleform.CxformApplies a brightness to the color transform.
scaleform.Cxform.create_tint (t, r, g, b) : scaleform.CxformApplies tint color.
scaleform.Actor.concatenate_cxform (self, cxform) Concatenates the color transform to the actor.
scaleform.Actor.set_cxform (self, cxform) Sets the color transformation matrix on the actor.
scaleform.Cxform.alpha_multiplier (self) : numberReturns the alpha multiplier value set for color transformation.
self : scaleform.CxformThe color transform currently in use.
number
scaleform.CxformA color transform class that modifies all pixels being rendered. A numeric value.
scaleform.Cxform.alpha_offset (self) : integerReturns the offset value set to the alpha channel value.
self : scaleform.CxformThe color transform currently in use.
integerA strictly integral numeric value, with no decimal component. scaleform.Cxform.append (self, cxformParent) Appends the color transformation matrix by multiplying the specified Cxform by the current Cxform and assigns the result to the first Cxform.
self : scaleform.CxformThe color transform currently in use.
cxformParent : scaleform.CxformThe color transform to multiply to.
scaleform.Cxform.blue_multiplier (self) : numberReturns the blue multiplier value set for color transformation.
self : scaleform.CxformThe color transform currently in use.
number scaleform.Cxform.blue_offset (self) : integerReturns the offset value set to the blue channel value.
self : scaleform.CxformThe color transform currently in use.
integer self : scaleform.CxformThe color transform.
scaleform.CxformThe cloned Cxform object.
scaleform.Cxform.color (self) : scaleform.ColorReturns the color of the transform.
self : scaleform.CxformThe color transform currently in use.
scaleform.ColorThe color.
scaleform.Color{ alpha : integer, blue : integer, green : integer, red : integer, }
scaleform.Cxform.convert_to_table (self) : tableCopies the color transformation matrix into an table.
self : scaleform.CxformThe color transform currently in use.
tableA 2x4 array of arrays of numbersA Lua table consisting of paired keys and values.
scaleform.Cxform.copy (dst, src) Copies a color transform to another one.
dst : scaleform.CxformThe destination color transform.
src : scaleform.CxformThe source color transform
color : scaleform.Color?An color offset to initialize the cxform with.
scaleform.CxformThe newly created color transform.
a : numberThe alpha multiplier added to the color transform.
scaleform.CxformThe modified color transform.
b : numberBrightness value.
scaleform.CxformThe modified color transform.
t : numberThe tint value.
r : numberThe red color value.
g : numberThe green color value.
b : numberThe blue color value.
scaleform.CxformThe modified color transform.
scaleform.Cxform.green_multiplier (self) : numberReturns the green multiplier value set for color transformation.
self : scaleform.CxformThe color transform currently in use.
number scaleform.Cxform.green_offset (self) : integerReturns the offset value set to the green channel value.
self : scaleform.CxformThe color transform currently in use.
integer scaleform.Cxform.is_identity (self) : booleanDetermines if the Cxform is identity color transformation matrix.
self : scaleform.CxformThe color transform currently in use.
booleantrue or false. scaleform.Cxform.normalize (self) Creates a normalized color transformation matrix.
self : scaleform.CxformThe color transform currently in use.
scaleform.Cxform.prepend (self, cxformParent) Prepend a color transform matrix onto this current matrix by multiplying the current matrix by the passed Cxform.
self : scaleform.CxformThe color transform currently in use.
cxformParent : scaleform.CxformThe color matrix to multiply.
scaleform.Cxform.red_multiplier (self) : numberReturns the red multiplier value set for color transformation.
self : scaleform.CxformThe color transform currently in use.
number scaleform.Cxform.red_offset (self) : integerReturns the offset value set to the red channel value.
self : scaleform.CxformThe color transform currently in use.
integer scaleform.Cxform.requires_blend (self) : booleanDisables blending when not required.
self : scaleform.CxformThe color transform currently in use.
boolean scaleform.Cxform.set_alpha_multiplier (self, am) Sets the alpha multiplier for the color.
self : scaleform.CxformThe color transform currently in use.
am : numberA decimal value that is multiplied with the alpha transparency channel value, as a decimal value between 0 and 1.
scaleform.Cxform.set_alpha_offset (self, ao) Sets an offset value to the alpha channel value.
self : scaleform.CxformThe color transform currently in use.
ao : integerThe alpha offset value [0-255];
scaleform.Cxform.set_blue_multiplier (self, bm) Sets the blue multiplier for the color.
self : scaleform.CxformThe color transform currently in use.
bm : numberThe percentage to apply the color, as a decimal value between 0 and 1.
scaleform.Cxform.set_blue_offset (self, bo) Sets an offset value to the blue channel value.
self : scaleform.CxformThe color transform currently in use.
bo : integerThe blue offset value [0-255].
scaleform.Cxform.set_color (self, c) Initializes the red, green, blue, and alpha components of the current color.
self : scaleform.CxformThe color transform currently in use.
c : scaleform.ColorA color whose components set those of the current color.
scaleform.Cxform.set_green_multiplier (self, gm) Sets the green multiplier for the color.
self : scaleform.CxformThe color transform currently in use.
gm : numberThe green multiplier value.
scaleform.Cxform.set_green_offset (self, go) Sets an offset value to the green channel value.
self : scaleform.CxformThe color transform currently in use.
go : integerThe green offset value [0-255].
scaleform.Cxform.set_identity (self) Sets the color transform matrix to identity color transformation matrix.
self : scaleform.CxformThe color transform currently in use.
scaleform.Cxform.set_red_multiplier (self, rm) Sets the red multiplier for the color.
self : scaleform.CxformThe color transform currently in use.
rm : numberThe percentage to apply the color, as a decimal value between 0 and 1.
scaleform.Cxform.set_red_offset (self, ro) Sets an offset value to the red channel value.
self : scaleform.CxformThe color transform currently in use.
ro : integerThe red offset value [0-255].
scaleform.Cxform.set_to_append (self, c0, c1) Initializes the current color matrix to the result of appended matrices.
self : scaleform.CxformThe color transform currently in use.
c0 : scaleform.CxformThe color matrix to append.
c1 : scaleform.CxformThe parent color matrix.
scaleform.Cxform.transform (self, newColor) : scaleform.ColorApplies a color transform to the specified color.
self : scaleform.CxformThe color transform currently in use.
newColor : scaleform.ColorA color value that needs to be transformed.
scaleform.ColorThe transformed color.
self : scaleform.ActorThe actor whose color transformation is retrieved.
scaleform.CxformThe color transformation matrix.
self : scaleform.ActorThe actor whose color transform matrix is retrieved.
scaleform.CxformThe concatenated color world matrix.
self : scaleform.ActorThe actor to which color transformation is concatenated.
cxform : scaleform.CxformThe color transform matrix to concatenate.
self : scaleform.ActorThe actor to which a color transformation is applied.
cxform : scaleform.CxformThe color transform matrix value.
scaleform.ActorGeneric objects located in a scene. Indicates a table.
This documentation uses the term table to mean an anonymous, temporary Lua table that contains named data values. You typically use these tables to pass data or settings to a function, or to hold data returned by a function.Indicates an object.
This documentation uses the term object to mean a named Lua table or userdata value that maintains a state. Some object types may have multiple instances existing at the same time, each with its own state; these objects typically have creation functions or accessors that you must call in order to get an instance. Some object types have only one instance, which you always access through the object's name.Indicates a named variable within a namespace, object or table; or an element within an enumeration.Indicates a code sample.Indicates an enumeration.
This documentation uses the term enumeration to mean a named Lua table that contains only a set of constant values. These values typically identify a predefined set of options for some setting or behavior. You might pass an enumeration value to a function, or test the value returned by a function against the items in the enumeration to see which option is currently set.Indicates a named variable within a namespace or object that has a pre-set constant value.Indicates a category: a semantic grouping of related API elements.Indicates a namespace.
This documentation uses the term namespace to mean a named Lua table that exists in only one single instance, intended as a container for an interface of related objects, functions and data variables.Indicates an output value returned by a function.Indicates a named function within a namespace or object.Indicates an input parameter for a function.