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

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

Inheritance diagram for DirectOutput.General.Color.RGBColor:

Public Member Functions

bool SetColor (int Red, int Green, int Blue)
 Sets the RGB components of the Color. More...
 
bool SetColor (string Color)
 Sets the RGB components of the Color.
The parameter string Color ist first parsed for hexadecimal color codes and afterwards checked for comma separated color values. More...
 
 RGBColor ()
 Initializes a new instance of the RGBColor class. More...
 
 RGBColor (int BrightnessRed, int BrightnessGreen, int BrightnessBlue)
 Initializes a new instance of the RGBColor class. More...
 
 RGBColor (string Color)
 Initializes a new instance of the RGBColor class. The parameter string Color ist first parsed for hexadecimal color codes and afterwards checked for comma separated color values. More...
 

Properties

int Red [get, set]
 Brightness for Red. More...
 
int Green [get, set]
 Brightness for Green. More...
 
int Blue [get, set]
 Brightness for Blue. More...
 
string HexColor [get, set]
 Returns the hexadecimal code for the color. More...
 

Detailed Description

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

Constructor & Destructor Documentation

DirectOutput.General.Color.RGBColor.RGBColor ( )

Initializes a new instance of the RGBColor class.

DirectOutput.General.Color.RGBColor.RGBColor ( int  BrightnessRed,
int  BrightnessGreen,
int  BrightnessBlue 
)

Initializes a new instance of the RGBColor class.

Parameters
BrightnessRedThe brightness for red.
BrightnessGreenThe brightness for green.
BrightnessBlueThe brightness for blue.
DirectOutput.General.Color.RGBColor.RGBColor ( string  Color)

Initializes a new instance of the RGBColor class. The parameter string Color ist first parsed for hexadecimal color codes and afterwards checked for comma separated color values.

Parameters
ColorThe color string.

Member Function Documentation

bool DirectOutput.General.Color.RGBColor.SetColor ( int  Red,
int  Green,
int  Blue 
)

Sets the RGB components of the Color.

Parameters
RedRed brightness
GreenGreen brightness
BlueBlue brightness
Returns
true
bool DirectOutput.General.Color.RGBColor.SetColor ( string  Color)

Sets the RGB components of the Color.
The parameter string Color ist first parsed for hexadecimal color codes and afterwards checked for comma separated color values.

Parameters
ColorHexadecimal color code (e.g. #ff0000 for red) or comma separated color (e.g. 0,255,0 for green).
Returns
true if the parameter string contained a valid color codes, otherwise false.

Property Documentation

int DirectOutput.General.Color.RGBColor.Blue
getset

Brightness for Blue.

Brightness between 0 and 255.

int DirectOutput.General.Color.RGBColor.Green
getset

Brightness for Green.

Brightness between 0 and 255.

string DirectOutput.General.Color.RGBColor.HexColor
getset

Returns the hexadecimal code for the color.

6 digit hexadecimal color code with leading #(e.g. #ff0000 for red).

int DirectOutput.General.Color.RGBColor.Red
getset

Brightness for Red.

Brightness between 0 and 255.


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