ColorUtilities.AdjustBrightness(Variable, Variable) Method

Top

Description

Gets the specified color with an adjust brightness given a specified factor. If the factor is less than 1 the color is darker, 1 has no effect, and more than 1 is lighter. If any of the red, green, and/or blue components of the input color is equal to 1, the color cannot be brightened, so that setting a brightness factor greater than 1 will have no effect.

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

Method Signature

ColorUtilities.AdjustBrightness(	Variable color,
	Variable factor)

Arguments

color
Description:	Variable color.

factor
Description:	Brightness factor.
Valid Range:	0 ≤ factor ≤ 1.79769E+308

Return Value

Type:

number

Returns a color with an adjust brightness.

Syntax

myVariable1 = ColorTools.AdjustBrightness(myVariable2, myVariable3);