![]() ![]() ![]()
|
BREW C++ Class Library & GUI Framework & XML Middleware : SophiaFramework 4.1 |
The SFXRGBColor class represents the RGBA (Red, Green, Blue, and Alpha)color.
In the functions of the SFXFrameColor class, 255 or 0 will be returned as return value when result value of color operation is over 255 or under 0, respectively.
| Constructor/Destructor |
|---|
|
SFXRGBColor( Void ) Constructor of SFXRGBColor class.
|
|
SFXRGBColor(
SFXRGBColorConstRef param
) Constructor of SFXRGBColor class.
|
|
SFXRGBColor(
UInt08 red
, UInt08 green
, UInt08 blue
, UInt08 alpha
) Constructor of SFXRGBColor class.
|
|
SFXRGBColor(
UInt08 mono
, UInt08 alpha
) Constructor of SFXRGBColor class.
|
|
SFXRGBColor(
RGBVAL rgbval
) Constructor of SFXRGBColor class.
|
| Public Functions | |
|---|---|
| SFXRGBColorRef |
Add(
SFXRGBColorConstRef param
) Add( UInt08 mono , UInt08 alpha ) Add( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha ) Add a specified value to the RGBA value.
|
| SFXRGBColorRef |
AddAlpha(
UInt08 param
) Add a specified value to the A value.
|
| SFXRGBColorRef |
AddBlue(
UInt08 param
) Add a specified value to the B value.
|
| SFXRGBColorRef |
AddGreen(
UInt08 param
) Add a specified value to the G value.
|
| SFXRGBColorRef |
AddRGB(
UInt08 red
, UInt08 green
, UInt08 blue
) AddRGB( UInt08 mono ) Add a specified value to the RGB value.
|
| SFXRGBColorRef |
AddRed(
UInt08 param
) Add a specified value to the R value.
|
| RGBVAL |
AsRGBVAL( Void ) Convert SFXRGBColor into RGBVAL of BREW.
|
| Bool |
Equals(
SFXRGBColorConstRef param
) Equals( UInt08 mono , UInt08 alpha ) Equals( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha ) Check whether the RGBA values of this color equal those of a specified color or not.
|
| Bool |
EqualsRGB(
SFXRGBColorConstRef param
) EqualsRGB( UInt08 mono ) EqualsRGB( UInt08 red , UInt08 green , UInt08 blue ) Check whether the RGB values of this color equal those of a specified color or not.
|
| UInt08 |
GetAlpha( Void ) Get the A value.
|
| UInt08 |
GetBlue( Void ) Get the B value.
|
| UInt08 |
GetGreen( Void ) Get the G value.
|
| UInt08 |
GetRed( Void ) Get the R value.
|
| SFXRGBColorRef |
Set(
SFXRGBColorConstRef param
) Set( RGBVAL rgbval ) Set( UInt08 mono , UInt08 alpha ) Set( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha ) Set the RGBA value.
|
| SFXRGBColorRef |
SetAlpha(
UInt08 param
) Set the A value.
|
| SFXRGBColorRef |
SetBlue(
UInt08 param
) Set the B value.
|
| SFXRGBColorRef |
SetGreen(
UInt08 param
) Set the G value.
|
| SFXRGBColorRef |
SetRGB(
UInt08 red
, UInt08 green
, UInt08 blue
) SetRGB( UInt08 mono ) Set the RGB value.
|
| SFXRGBColorRef |
SetRed(
UInt08 param
) Set the R value.
|
| SFXRGBColorRef |
Sub(
SFXRGBColorConstRef param
) Sub( UInt08 mono , UInt08 alpha ) Sub( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha ) Subtract a specified value from the RGBA value.
|
| SFXRGBColorRef |
SubAlpha(
UInt08 param
) Subtract a specified value from the A value.
|
| SFXRGBColorRef |
SubBlue(
UInt08 param
) Subtract a specified value from the B value.
|
| SFXRGBColorRef |
SubGreen(
UInt08 param
) Subtract a specified value from the G value.
|
| SFXRGBColorRef |
SubRGB(
UInt08 red
, UInt08 green
, UInt08 blue
) SubRGB( UInt08 mono ) Subtract a specified value from the RGB value.
|
| SFXRGBColorRef |
SubRed(
UInt08 param
) Subtract a specified value from the R value.
|
| static SFXRGBColorConstRef |
ZeroInstance( Void ) Get the instance that represents 0.
|
| SFXRGBColorRef |
operator+=(
SFXRGBColorConstRef param
) Add a specified value to the RGBA value.
|
| SFXRGBColorRef |
operator-=(
SFXRGBColorConstRef param
) Subtract a specified value from the RGBA value
|
| SFXRGBColorRef |
operator=(
SFXRGBColorConstRef param
) Assign a RGBA value.
|
| SFXRGBColor::AtomRec * |
atomic_cast(
SFXRGBColor * param
) Convert SFXRGBColor into SFXRGBColor::AtomRec.
|
| SFXRGBColor::AtomRec const * |
atomic_cast(
SFXRGBColor const * param
) Convert SFXRGBColor into SFXRGBColor::AtomRec.
|
| Bool |
operator==(
SFXRGBColorConstRef left
, SFXRGBColorConstRef right
) Check the "==" relation.
|
| SFXRGBColor |
operator-(
SFXRGBColorConstRef left
, SFXRGBColorConstRef right
) Subtract a specified value from the RGBA value
|
| Bool |
operator!=(
SFXRGBColorConstRef left
, SFXRGBColorConstRef right
) Check the "!=" relation.
|
| SFXRGBColor |
operator+(
SFXRGBColorConstRef left
, SFXRGBColorConstRef right
) Add a specified value to the RGBA value.
|
| Types |
|---|
|
AtomRec
Structure that represents the RGBA color.
|
| Global Functions | |
|---|---|
| SFXRGBColor::AtomRec * |
atomic_cast(
SFXRGBColor * param
) Convert SFXRGBColor into SFXRGBColor::AtomRec.
|
| SFXRGBColor::AtomRec const * |
atomic_cast(
SFXRGBColor const * param
) Convert SFXRGBColor into SFXRGBColor::AtomRec.
|
| Bool |
operator==(
SFXRGBColorConstRef left
, SFXRGBColorConstRef right
) Check the "==" relation.
|
| SFXRGBColor |
operator-(
SFXRGBColorConstRef left
, SFXRGBColorConstRef right
) Subtract a specified value from the RGBA value
|
| Bool |
operator!=(
SFXRGBColorConstRef left
, SFXRGBColorConstRef right
) Check the "!=" relation.
|
| SFXRGBColor |
operator+(
SFXRGBColorConstRef left
, SFXRGBColorConstRef right
) Add a specified value to the RGBA value.
|
[ public, explicit ] SFXRGBColor(Void);
[ public ]
SFXRGBColor(
SFXRGBColorConstRef param // source color
);
[ public, explicit ]
SFXRGBColor(
UInt08 red // R value
UInt08 green // G value
UInt08 blue // B value
UInt08 alpha // A value
);
[ public, explicit ]
SFXRGBColor(
UInt08 mono // RGB value
UInt08 alpha // A value
);
[ public, explicit ]
SFXRGBColor(
RGBVAL rgbval // color of RGBVAL type
);
[ public ] SFXRGBColorRef Add( SFXRGBColorConstRef param // value to add to color );
[ public ] SFXRGBColorRef Add( UInt08 red // value to add to the R value UInt08 green // value to add to the G value UInt08 blue // value to add to the B value UInt08 alpha // value to add to the A value );
[ public ] SFXRGBColorRef Add( UInt08 mono // value to add to the RGB value UInt08 alpha // value to add to the A value );
SFXRGBColor::AddAlpha | SFXRGBColor::AddBlue | SFXRGBColor::AddGreen | SFXRGBColor::AddRed | SFXRGBColor::AddRGB
[ public ] SFXRGBColorRef AddAlpha( UInt08 param // value to add to the A value );
SFXRGBColor::Add | SFXRGBColor::AddBlue | SFXRGBColor::AddGreen | SFXRGBColor::AddRed | SFXRGBColor::AddRGB
[ public ] SFXRGBColorRef AddBlue( UInt08 param // value to add to the B value );
SFXRGBColor::Add | SFXRGBColor::AddAlpha | SFXRGBColor::AddGreen | SFXRGBColor::AddRed | SFXRGBColor::AddRGB | SFXRGBColor::SubBlue
[ public ] SFXRGBColorRef AddGreen( UInt08 param // value to add to the G value );
SFXRGBColor::Add | SFXRGBColor::AddAlpha | SFXRGBColor::AddBlue | SFXRGBColor::AddRed | SFXRGBColor::AddRGB | SFXRGBColor::SubRed
[ public ] SFXRGBColorRef AddRGB( UInt08 red // value to add to the R value UInt08 green // value to add to the G value UInt08 blue // value to add to the B value );
[ public ] SFXRGBColorRef AddRGB( UInt08 mono // value to add to the RGB value );
SFXRGBColor::Add | SFXRGBColor::AddAlpha | SFXRGBColor::AddBlue | SFXRGBColor::AddGreen | SFXRGBColor::AddRed
[ public ] SFXRGBColorRef AddRed( UInt08 param // value to add to the R value );
SFXRGBColor::Add | SFXRGBColor::AddAlpha | SFXRGBColor::AddBlue | SFXRGBColor::AddGreen | SFXRGBColor::AddRGB | SFXRGBColor::SubGreen
[ public, const ] RGBVAL AsRGBVAL(Void);
[ public, const ] Bool Equals( SFXRGBColorConstRef param // color to compare );
[ public, const ] Bool Equals( UInt08 red // R value to compare UInt08 green // G value to compare UInt08 blue // B value to compare UInt08 alpha // A value to compare );
[ public, const ] Bool Equals( UInt08 mono // RGB value to compare UInt08 alpha // A value to compare );
[ public, const ] Bool EqualsRGB( SFXRGBColorConstRef param // color to compare );
[ public, const ] Bool EqualsRGB( UInt08 red // R value to compare UInt08 green // G value to compare UInt08 blue // B value to compare );
[ public, const ] Bool EqualsRGB( UInt08 mono // RGB value to compare );
[ public, const ] UInt08 GetAlpha(Void);
SFXRGBColor::GetBlue | SFXRGBColor::GetGreen | SFXRGBColor::GetRed | SFXRGBColor::SetAlpha
[ public, const ] UInt08 GetBlue(Void);
SFXRGBColor::GetAlpha | SFXRGBColor::GetGreen | SFXRGBColor::GetRed | SFXRGBColor::SetBlue
[ public, const ] UInt08 GetGreen(Void);
SFXRGBColor::GetAlpha | SFXRGBColor::GetBlue | SFXRGBColor::GetRed | SFXRGBColor::SetGreen
[ public, const ] UInt08 GetRed(Void);
SFXRGBColor::GetAlpha | SFXRGBColor::GetBlue | SFXRGBColor::GetGreen | SFXRGBColor::SetRed
[ public ] SFXRGBColorRef Set( SFXRGBColorConstRef param // color to set );
[ public ] SFXRGBColorRef Set( UInt08 red // R value UInt08 green // G value UInt08 blue // B value UInt08 alpha // A value );
[ public ] SFXRGBColorRef Set( UInt08 mono // RGB value UInt08 alpha // A value );
[ public ] SFXRGBColorRef Set( RGBVAL rgbval // color of RGBVAL type to set );
SFXRGBColor::SFXRGBColor | SFXRGBColor::GetAlpha | SFXRGBColor::GetBlue | SFXRGBColor::GetGreen | SFXRGBColor::GetRed | SFXRGBColor::SetAlpha | SFXRGBColor::SetBlue | SFXRGBColor::SetGreen | SFXRGBColor::SetRed | SFXRGBColor::SetRGB | SFXRGBColor::operator=
[ public ] SFXRGBColorRef SetAlpha( UInt08 param // A value );
SFXRGBColor::GetAlpha | SFXRGBColor::Set | SFXRGBColor::SetBlue | SFXRGBColor::SetGreen | SFXRGBColor::SetRed | SFXRGBColor::SetRGB
[ public ] SFXRGBColorRef SetBlue( UInt08 param // B value );
SFXRGBColor::GetBlue | SFXRGBColor::Set | SFXRGBColor::SetAlpha | SFXRGBColor::SetGreen | SFXRGBColor::SetRed | SFXRGBColor::SetRGB
[ public ] SFXRGBColorRef SetGreen( UInt08 param // G value );
SFXRGBColor::GetGreen | SFXRGBColor::Set | SFXRGBColor::SetAlpha | SFXRGBColor::SetBlue | SFXRGBColor::SetRed | SFXRGBColor::SetRGB
[ public ] SFXRGBColorRef SetRGB( UInt08 red // R value UInt08 green // G value UInt08 blue // B value );
[ public ] SFXRGBColorRef SetRGB( UInt08 mono // RGB value );
SFXRGBColor::SFXRGBColor | SFXRGBColor::GetBlue | SFXRGBColor::GetGreen | SFXRGBColor::GetRed | SFXRGBColor::Set | SFXRGBColor::SetAlpha
[ public ] SFXRGBColorRef SetRed( UInt08 param // R value );
SFXRGBColor::GetRed | SFXRGBColor::Set | SFXRGBColor::SetAlpha | SFXRGBColor::SetBlue | SFXRGBColor::SetGreen | SFXRGBColor::SetRGB
[ public ] SFXRGBColorRef Sub( SFXRGBColorConstRef param // value to subtract from the color );
[ public ] SFXRGBColorRef Sub( UInt08 red // value to subtract from the R value UInt08 green // value to subtract from the G value UInt08 blue // value to subtract from the B value UInt08 alpha // A value to subtract );
[ public ] SFXRGBColorRef Sub( UInt08 mono // value to subtract from the RGB value UInt08 alpha // A value to subtract );
[ public ] SFXRGBColorRef SubAlpha( UInt08 param // A value to subtract );
SFXRGBColor::Sub | SFXRGBColor::SubBlue | SFXRGBColor::SubGreen | SFXRGBColor::SubRed | SFXRGBColor::SubRGB
[ public ] SFXRGBColorRef SubBlue( UInt08 param // value to subtract from the B value );
SFXRGBColor::AddBlue | SFXRGBColor::Sub | SFXRGBColor::SubAlpha | SFXRGBColor::SubGreen | SFXRGBColor::SubRed | SFXRGBColor::SubRGB
[ public ] SFXRGBColorRef SubGreen( UInt08 param // value to subtract from the G value );
SFXRGBColor::AddGreen | SFXRGBColor::Sub | SFXRGBColor::SubAlpha | SFXRGBColor::SubBlue | SFXRGBColor::SubRed | SFXRGBColor::SubRGB
[ public ] SFXRGBColorRef SubRGB( UInt08 red // value to subtract from the R value UInt08 green // value to subtract from the G value UInt08 blue // value to subtract from the B value );
[ public ] SFXRGBColorRef SubRGB( UInt08 mono // value to subtract from the RGB value );
SFXRGBColor::Sub | SFXRGBColor::SubAlpha | SFXRGBColor::SubBlue | SFXRGBColor::SubGreen | SFXRGBColor::SubRed
[ public ] SFXRGBColorRef SubRed( UInt08 param // value to subtract from the R value );
SFXRGBColor::AddRed | SFXRGBColor::Sub | SFXRGBColor::SubAlpha | SFXRGBColor::SubBlue | SFXRGBColor::SubGreen | SFXRGBColor::SubRGB
[ public, static ] SFXRGBColorConstRef ZeroInstance(Void);
This function returns the 0 instance, which means that 0 or null is set to all the member variables of its corresponding AtomRec structure.
[ public, friend ]
SFXRGBColor::AtomRec * atomic_cast(
SFXRGBColor * param // RGB color to cast
);
[ public, friend ]
SFXRGBColor::AtomRec const * atomic_cast(
SFXRGBColor const * param // RGB color to cast
);
[ public ] SFXRGBColorRef operator=( SFXRGBColorConstRef param // color to set );
[ public, friend ] Bool operator==( SFXRGBColorConstRef left // color to compare SFXRGBColorConstRef right // color to compare );
[ public ] SFXRGBColorRef operator-=( SFXRGBColorConstRef param // value to subtract from the color );
[ public, friend ] SFXRGBColor operator-( SFXRGBColorConstRef left // color to be subtracted from SFXRGBColorConstRef right // value to subtract from the color );
[ public, friend ] Bool operator!=( SFXRGBColorConstRef left // color to compare SFXRGBColorConstRef right // color to compare );
[ public, inline to add ] SFXRGBColorRef operator+=( SFXRGBColorConstRef param // color to add );
[ public, friend to add ] SFXRGBColor operator+( SFXRGBColorConstRef left // color to be added SFXRGBColorConstRef right // value to add to the color );
struct AtomRec {
UInt08 alpha; // A value
UInt08 red; // R value
UInt08 green; // G value
UInt08 blue; // B value
};
|
Copyright (C) 2002 - 2009 Sophia Cradle, Inc. All Rights Reserved. |
![]() ![]() ![]()
|