FunctionalLightCommandFlags Enumeration

Enumeration used to determine which function will be applied to the image, FreeHandLight, Free Light, or Trigonometry Light.

Syntax

C#
Visual Basic
WinRT C#
Objective-C
Java
WinRT JavaScript
C++

[FlagsAttribute()]
public enum FunctionalLightCommandFlags : System.Enum, System.IComparable, System.IConvertible, System.IFormattable

'Declaration
 
<FlagsAttribute()>
Public Enum FunctionalLightCommandFlags 
   Inherits System.Enum
   Implements System.IComparable, System.IConvertible, System.IFormattable

'Usage
 
Dim instance As FunctionalLightCommandFlags

[FlagsAttribute()]
public enum FunctionalLightCommandFlags : System.IComparable, System.IConvertible, System.IFormattable

Leadtools.ImageProcessing.SpecialEffects.FunctionalLightCommandFlags = function() { };
Leadtools.ImageProcessing.SpecialEffects.FunctionalLightCommandFlags.prototype = {

  None = 0x00000000,
	LinearInner = 0x00000001,
	LinearOuter = 0x00000002,
	QuadraticInner = 0x00000004,
	QuadraticOuter = 0x00000008,
	Unidirection = 0x00000010,
	Circles = 0x00000020,
	Addition = 0x00000040,
	Multiply = 0x00000080,
	LinearQuadratic = 0x00001000,
	Trigonometry = 0x00002000,
	Freehand = 0x00004000,
	
 };

[FlagsAttribute()]
public enum class FunctionalLightCommandFlags : public System.Enum, System.IComparable, System.IConvertible, System.IFormattable

Members

Value	Member	Description
0x00000000	None	No Flags selected.
0x00000001	LinearInner	The light will be concentrated at the center and will decrease outwards. The center can be found in the Origin property or the origin parameter. This flag is valid only if LinearQuadratic is also set.
0x00000002	LinearOuter	The light will be concentrated at the far points from the center and will decrease inwards towards the center. The center can be found in the Origin property or the origin parameter. This flag is valid only if LinearQuadratic is also set.
0x00000004	QuadraticInner	The light will be concentrated at the center and will decrease outwards. The center can be found in the Origin property or the origin parameter. This flag is valid only if LinearQuadratic is also set.
0x00000008	QuadraticOuter	The light will be concentrated at the far points from the center and will decrease inwards towards the center. The center can be found in the Origin property or the origin parameter. This flag is valid only if LinearQuadratic is also set.
0x00000010	Unidirection	A sine or cosine function will generate the light as lines. This flag is valid only if Trigonometry is also set. The lines are parallel and have no center. The Angle property of the FunctionalLightCommand class or the angle parameter of the Constructor determines the angle formed by these lines with the X axis.
0x00000020	Circles	Sine or cosine function will generate the light as circles around the center. The center can be found in the Origin property, or the origin parameter of the Constructor. This flag is valid only if Trigonometry is also set.
0x00000040	Addition	The amplitude values 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 functions as well as the real buffer values are from -1 to 1. This flag is valid only if Trigonometry or Freehand are also set.
0x00000080	Multiply	Multiply the color factor specified by the RedAmplitude property of the FunctionalLightCommand class, or the redAmplitude parameter of the Constructor, with the results of the selected function (sine, cosine, freehand). The results are multiplied with every channel value. This flag is valid only if Trigonometry or Freehand are also set.
0x00001000	LinearQuadratic	If this flag is set, the light will be computed according to the distance from the center, which is in the Origin property or the origin parameter in the Constructor of the FunctionalLightCommand class. The brightness increase for every pixel is proportional to the distance to the effect's center. If this flag is set, do not set Trigonometry or Freehand.
0x00002000	Trigonometry	If this flag is set then the light will be generated by a sine or cosine function. If this is set, the frequency, angle and origin information are used to compute the light. If this flag is set, do not set LinearQuadratic or Freehand.
0x00004000	Freehand	If this flag is set, the user will pass the light shape in the Buffer property of the FunctionalLightCommand class or the buffer parameter of the Constructor for the FunctionalLightCommand class. If this flag is set, the angle and buffer information will be used. The Angle property, or angle parameter, will determine the angle of the light lines compared to the X axis. If this flag is set, do not set LinearQuadratic or Trigonometry.

Inheritance Hierarchy

System.Object
   System.ValueType
      System.Enum
         Leadtools.ImageProcessing.SpecialEffects.FunctionalLightCommandFlags

Requirements

Target Platforms

Reference

Leadtools.ImageProcessing.SpecialEffects Namespace