DirectOutput
DirectOutput framework R2 for virtual pinball cabinets.
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Events Macros Pages
DirectOutput.General.Color.RGBAColorNamed Class Reference

This class stores information on colors used for toys (e.g. RGBLed). More...

Inheritance diagram for DirectOutput.General.Color.RGBAColorNamed:
Collaboration diagram for DirectOutput.General.Color.RGBAColorNamed:

Public Member Functions

 RGBAColorNamed ()
 Initializes a new instance of the RGBAColorNamed class. More...
 
 RGBAColorNamed (string Name, int BrightnessRed, int BrightnessGreen, int BrightnessBlue)
 Initializes a new instance of the RGBAColorNamed class. If all color components are set to 0, the alpha value will be set to 0, otherwise the alpha value will be set to 255. More...
 
 RGBAColorNamed (string Name, int BrightnessRed, int BrightnessGreen, int BrightnessBlue, int Alpha)
 Initializes a new instance of the RGBAColorNamed class. More...
 
 RGBAColorNamed (string Name, string Color)
 Initializes a new instance of the RGBAColorNamed class. The parameter string Color is first parsed for hexadecimal color codes and afterwards checked for comma separated color values.
The following values are accepted:
More...
 
 RGBAColorNamed (string Name, RGBColor RGBColor)
 Initializes a new instance of the RGBAColorNamed class. The Alpha value is set to 0 if all color components are set to 0, otherwise the Alpha value will be set to 255. More...
 
- Public Member Functions inherited from DirectOutput.General.Color.RGBAColor
RGBAColor Clone ()
 Clones this instance. More...
 
RGBAColor GetRGBAColor ()
 Gets a new RGBAColor instance with the same color values. More...
 
bool SetColor (int Red, int Green, int Blue, int Alpha)
 Sets the RGBA components of the Color. More...
 
bool SetColor (int Red, int Green, int Blue)
 Sets the RGB components of the Color.
The Alpha value is set to 0 if all color components are set to 0, otherwise the Alpha value will be set to 255. More...
 
bool SetColor (RGBColor Color)
 Sets the RGB components of the RGBAColor.
The Alpha value is set to 0 if all color components are set to 0, otherwise the Alpha value will be set to 255. More...
 
bool SetColor (string Color)
 Sets the RGBA components of the Color.
The parameter string Color ist first parsed for hexadecimal color codes and afterwards checked for comma separated color values.
The following values are accepted:
More...
 
 RGBAColor ()
 Initializes a new instance of the RGBAColor class. More...
 
 RGBAColor (int BrightnessRed, int BrightnessGreen, int BrightnessBlue)
 Initializes a new instance of the RGBAColor class.
If all color components are set to 0, the alpha value will be set to 0, otherwise the alpha value will be set to 255. More...
 
 RGBAColor (int BrightnessRed, int BrightnessGreen, int BrightnessBlue, int Alpha)
 Initializes a new instance of the RGBAColor class. More...
 
 RGBAColor (string Color)
 Initializes a new instance of the RGBAColor class.
The parameter string Color is first parsed for hexadecimal color codes and afterwards checked for comma separated color values.
The following values are accepted:
More...
 
 RGBAColor (RGBColor RGBColor)
 Initializes a new instance of the RGBAColor class. The Alpha value is set to 0 if all color components are set to 0, otherwise the Alpha value will be set to 255. More...
 

Properties

string Name [get, set]
 Name of the Named item.
Triggers BeforeNameChange before a new Name is set.
Triggers AfterNameChanged after a new name has been set. More...
 
- Properties inherited from DirectOutput.General.Color.RGBAColor
int Red [get, set]
 Brightness for Red. More...
 
int Green [get, set]
 Brightness for Green. More...
 
int Blue [get, set]
 Brightness for Blue. More...
 
int Alpha [get, set]
 Alpha value for the color. More...
 
string HexColor [get, set]
 Returns the hexadecimal code for the color. More...
 
- Properties inherited from DirectOutput.General.Generic.INamedItem
string Name [get, set]
 Gets or sets the name of the item.
Must fire the BeforeNameChange and AfterNameChange events when the value of the property is changed. More...
 

Events

EventHandler< NameChangeEventArgsAfterNameChanged
 Event is fired after the value of the property Name has changed. More...
 
EventHandler< NameChangeEventArgsBeforeNameChange
 Event is fired before the value of the property Name is changed. More...
 
- Events inherited from DirectOutput.General.Generic.INamedItem
EventHandler< NameChangeEventArgsBeforeNameChange
 Occurs before the name of the item changes. More...
 
EventHandler< NameChangeEventArgsAfterNameChanged
 Occurs when after the name of the item has changed. More...
 

Detailed Description

This class stores information on colors used for toys (e.g. RGBLed).

Constructor & Destructor Documentation

DirectOutput.General.Color.RGBAColorNamed.RGBAColorNamed ( )

Initializes a new instance of the RGBAColorNamed class.

DirectOutput.General.Color.RGBAColorNamed.RGBAColorNamed ( string  Name,
int  BrightnessRed,
int  BrightnessGreen,
int  BrightnessBlue 
)

Initializes a new instance of the RGBAColorNamed class. If all color components are set to 0, the alpha value will be set to 0, otherwise the alpha value will be set to 255.

Parameters
NameThe name of the color.
BrightnessRedThe brightness for red.
BrightnessGreenThe brightness for green.
BrightnessBlueThe brightness for blue.
DirectOutput.General.Color.RGBAColorNamed.RGBAColorNamed ( string  Name,
int  BrightnessRed,
int  BrightnessGreen,
int  BrightnessBlue,
int  Alpha 
)

Initializes a new instance of the RGBAColorNamed class.

Parameters
NameThe name of the color.
BrightnessRedThe brightness for red.
BrightnessGreenThe brightness for green.
BrightnessBlueThe brightness for blue.
AlphaThe alpha value for the color.
DirectOutput.General.Color.RGBAColorNamed.RGBAColorNamed ( string  Name,
string  Color 
)

Initializes a new instance of the RGBAColorNamed class. The parameter string Color is first parsed for hexadecimal color codes and afterwards checked for comma separated color values.
The following values are accepted:

  • Hexadecimal color code including alpha channel (e.g. &#35;ff0000FF for fully opaque red).
  • Hexadecimal color code without alpha channel (e.g. &#35;ff0000 for red). If all color components are set to 0 (that equals black) the alpha value is set to 0 (fully transparent), otherwise to 255 (fully opaque).
  • Comma separated color components including alpha channel (e.g. 255,0,0,128 for half transparent red).
  • Comma separated color components without alpha channel (e.g. 255,0,0 for for fully opque red). If all color components are set to 0 (that equals black) the alpha value is set to 0 (fully transparent), otherwise to 255 (fully opaque).
Parameters
NameThe name of the color.
ColorThe color string.
DirectOutput.General.Color.RGBAColorNamed.RGBAColorNamed ( string  Name,
RGBColor  RGBColor 
)

Initializes a new instance of the RGBAColorNamed class. The Alpha value is set to 0 if all color components are set to 0, otherwise the Alpha value will be set to 255.

Parameters
NameThe name of the color.
RGBColorRGBColor object.

Property Documentation

string DirectOutput.General.Color.RGBAColorNamed.Name
getset

Name of the Named item.
Triggers BeforeNameChange before a new Name is set.
Triggers AfterNameChanged after a new name has been set.

Event Documentation

EventHandler<NameChangeEventArgs> DirectOutput.General.Color.RGBAColorNamed.AfterNameChanged

Event is fired after the value of the property Name has changed.

EventHandler<NameChangeEventArgs> DirectOutput.General.Color.RGBAColorNamed.BeforeNameChange

Event is fired before the value of the property Name is changed.


The documentation for this class was generated from the following file: