Color::ModulateFactor

Color::ModulateFactor
static inline Color ModulateFactor(Color c1, UByte factor);
inline Color& ModulateFactor(UByte factor);
Description

ModulateFactor scales a color by taking the clamped product of each channel and a factor (c1 * f). For Color objects, the actual equation used for each 8 bit channel is: min(c1*(f+1), 255).

Parameters
Parameters 
Description 
Color c1 
The destination color that is multiplied by the factor to form a new color (return value). * 
UByte factor 
The factor that is combined with each channel of the color to form a new color (return value). * 
Return Value

The member function, taking one parameter (factor), returns a Color reference to the current string, which was formed by multiplying the factor with each channel of the original color (this * f). 

The static function, taking two parameters (c1 and factor), returns a new Color by value, which is formed from the product of the passed color and factor (c1 * f). * 

* - pertains to static function only. 

See Also