Color::ModulateFactorRGB

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

ModulateFactorRGB combines two colors by taking the alpha component of the first color and the clamped product of the RGB channel with the passed factor (c1.rgb * f). For Color objects, the actual equation used for each of the 8 bit channels is: min(c1.rgb*(f+1), 255).

Parameters
Parameters 
Description 
Color c1 
The destination color whose alpha component is set directly to the new color, while its RGB channels are multiplied with the factor to form the new color (return value). * 
UByte factor 
The factor that is combined with the RGB channels of the color to form a new color (return value). * 
Return Value

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

The static function, taking two parameters (c1 and factor), returns a new Color by value, which is formed from the first color's alpha component and the product of the color's RGB channels and passed factor ((c1.rgb * f), c1.a). * 

* - pertains to static function only. 

See Also