uFlags

Flag that indicates how the light is generated. Possible values are:

Value

Meaning

FL_LINEAR_QUADRATIC

[$1000] If this flag is set, the light will be computed according to distance from the center, which is represented by the uXOrigin and uYOrigin parameters, The brightness increase for every pixel is proportional to the distance to the effect's center. If this flag is set, do not set FL_TRIGONOMETRY, FL_FREEHAND.

FL_TRIGONOMETRY

[$2000] If this flag is set then the light will be generated by a sine or cosine function. If this is set, uFreq, nAngle, uXOrigin and uYOrigin are used to compute the light. If this flag is set, do not set FL_LINEAR_QUADRATIC or FL_FREEHAND.

FL_FREEHAND

[$4000] If this flag is set, the user will pass the light shape in the pBuff parameter. If this flag is set, the nAngle, pBuff and nBuffCount parameters will be used. The nAngle will determine the angle of the light lines compared to the X axis. If this flag is set, do not set FL_LINEAR_QUADRATIC or FL_TRIGONOMETRY.

FL_LINEAR_INNER

[$0001] The linear light will be concentrated at the center (uXOrigin, uYOrigin) and will decreases as it moves away from the center. This flag is valid only if FL_LINEAR_QUADRATIC is also set.

FL_LINEAR_OUTER

[$0002] The linear light will be concentrated at the far points from the center and will decrease inwards towards the center (uXOrigin, uYOrigin). This flag is valid only if FL_LINEAR_QUADRATIC is also set.

FL_QUADRATIC_INNER

[$0004] The Quadratic light will be concentrated at the center (uXOrigin, uYOrigin) and will decrease as it moves away from the center. This flag is valid only if FL_LINEAR_QUADRATIC is also set.

FL_QUADRATIC_OUTER

[$0008] The Quadratic light will be concentrated at the far points from the center and will decrease inwards towards the center (uXOrigin, uYOrigin). This flag is valid only if FL_LINEAR_QUADRATIC is also set.

FL_UNIDIRECTION

[$0010] A sine or cosine function will generate the light as lines. This flag is valid only if FL_TRIGONOMETRY is also set. The lines are parallel and have no center. The nAngle parameter determines the angle formed by these lines with the X axis.

FL_CIRCLES

[$0020] Sine or cosine function will generate the light as circles around the center (uXOrigin, uYOrigin). This flag is valid only if FL_TRIGONOMETRY is also set.

FL_ADD

[$0040] The amplitude parameters (uRAmp, uGAmp, and uBAmp) are multiplied with the results of the selected function (sine, cosine, freehand). The results are then added to the pixel values of the equivalent channel. These values as well as the real buffer values are from –1 to 1. This flag is valid only if FL_TRIGONOMETRY or FL_FREEHAND is also set.

FL_MUL

[$0080] Multiply the color factor specified by uRAmp with the results of the selected function (sine, cosine, freehand). The results are multiplied with every channel value. This flag is valid only if FL_TRIGONOMETRY or FL_FREEHAND are also set.