PrevNextUpHome SophiaFramework UNIVERSE 5.3
SFXFrameColor
Class which represents the frame color(F) and the shadow colow(S) for the 3-D looking rectangle(frame).
#include <SFXFrameColor.h.hpp>
class SFXFrameColor;
SFMTYPEDEFCLASS(SFXFrameColor)

Collaboration diagram

 Collaboration diagram of SFXFrameColorClass

Description

The SFXFrameColor class is composed of 2 colors of the SFXRGBColor class: the frame color(F) and the shadow colow(S) for the 3-D looking rectangle(frame). This class is used to draw the responders.

The frame color(F) is the color to draw the inside of the frame. The shadow color(S) is the color to draw the shadow of the frame. By using these 2 colors, the frame could be drawn in 3D effect.

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.

Reference

SFXRGBColor | SFXBevelColor

Member

Constructor/Destructor
SFXFrameColor( Void )
Constructor of the SFXFrameColor class.
SFXFrameColor( SFXFrameColorConstRef param )
Constructor of the SFXFrameColor class.
SFXFrameColor( SFXRGBColorConstRef frame , SFXRGBColorConstRef shadow )
Constructor of the SFXFrameColor class.
SFXFrameColor( SFXRGBColorConstRef plain )
Constructor of the SFXFrameColor class.
SFXFrameColor( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
Constructor of the SFXFrameColor class.
SFXFrameColor( UInt08 mono , UInt08 alpha )
Constructor of the SFXFrameColor class.
Public Functions
SFXFrameColorRef Add( SFXFrameColorConstRef param )
Add the specified value to the RGBA value.
SFXFrameColorRef Add( SFXRGBColorConstRef frame , SFXRGBColorConstRef shadow )
Add the specified value to the RGBA value.
SFXFrameColorRef Add( SFXRGBColorConstRef plain )
Add the specified value to the RGBA value.
SFXFrameColorRef Add( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
Add the specified value to the RGBA value.
SFXFrameColorRef Add( UInt08 mono , UInt08 alpha )
Add the specified value to the RGBA value.
SFXFrameColorRef AddAlpha( UInt08 param )
Add the specified value to the A value.
SFXFrameColorRef AddBlue( UInt08 param )
Add the specified value to the B value.
SFXFrameColorRef AddFrame( SFXRGBColorConstRef param )
Add the specified value to the RGBA value of frame color.
SFXFrameColorRef AddFrame( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
Add the specified value to the RGBA value of frame color.
SFXFrameColorRef AddFrame( UInt08 mono , UInt08 alpha )
Add the specified value to the RGBA value of frame color.
SFXFrameColorRef AddFrameAlpha( UInt08 param )
Add the specified value to the A value of frame color.
SFXFrameColorRef AddFrameBlue( UInt08 param )
Add the specified value to the B value of frame color.
SFXFrameColorRef AddFrameGreen( UInt08 param )
Add the specified value to the G value of frame color.
SFXFrameColorRef AddFrameRGB( UInt08 red , UInt08 green , UInt08 blue )
Add the specified value to the RGB value of frame color.
SFXFrameColorRef AddFrameRGB( UInt08 mono )
Add the specified value to the RGB value of frame color.
SFXFrameColorRef AddFrameRed( UInt08 param )
Add the specified value to the R value of frame color.
SFXFrameColorRef AddGreen( UInt08 param )
Add the specified value to the G value.
SFXFrameColorRef AddRGB( UInt08 red , UInt08 green , UInt08 blue )
Add the specified value to the RGB value.
SFXFrameColorRef AddRGB( UInt08 mono )
Add the specified value to the RGB value.
SFXFrameColorRef AddRed( UInt08 param )
Add the specified value to the R value.
SFXFrameColorRef AddShadow( SFXRGBColorConstRef param )
Add the specified value to the RGBA value of shadow color.
SFXFrameColorRef AddShadow( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
Add the specified value to the RGBA value of shadow color.
SFXFrameColorRef AddShadow( UInt08 mono , UInt08 alpha )
Add the specified value to the RGBA value of shadow color.
SFXFrameColorRef AddShadowAlpha( UInt08 param )
Add the specified value to the A value of shadow color.
SFXFrameColorRef AddShadowBlue( UInt08 param )
Add the specified value to the B value of shadow color.
SFXFrameColorRef AddShadowGreen( UInt08 param )
Add the specified value to the G value of shadow color.
SFXFrameColorRef AddShadowRGB( UInt08 red , UInt08 green , UInt08 blue )
Add the specified value to the RGB value of shadow color.
SFXFrameColorRef AddShadowRGB( UInt08 mono )
Add the specified value to the RGB value of shadow color.
SFXFrameColorRef AddShadowRed( UInt08 param )
Add the specified value to the R value of shadow color.
Bool Equals( SFXFrameColorConstRef param )
Check whether the RGBA values of this frame color equal those of the specified frame color or not.
Bool Equals( SFXRGBColorConstRef frame , SFXRGBColorConstRef shadow )
Check whether the RGBA values of this frame color equal those of the specified frame color or not.
Bool Equals( SFXRGBColorConstRef plain )
Check whether the RGBA values of this frame color equal those of the specified frame color or not.
Bool Equals( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
Check whether the RGBA values of this frame color equal those of the specified frame color or not.
Bool Equals( UInt08 mono , UInt08 alpha )
Check whether the RGBA values of this frame color equal those of the specified frame color or not.
Bool EqualsRGB( SFXFrameColorConstRef param )
Check whether the RGB values of this frame color equal those of the specified frame color or not.
Bool EqualsRGB( SFXRGBColorConstRef frame , SFXRGBColorConstRef shadow )
Check whether the RGB values of this frame color equal those of the specified frame color or not.
Bool EqualsRGB( SFXRGBColorConstRef plain )
Check whether the RGB values of this frame color equal those of the specified frame color or not.
Bool EqualsRGB( UInt08 red , UInt08 green , UInt08 blue )
Check whether the RGB values of this frame color equal those of the specified frame color or not.
Bool EqualsRGB( UInt08 mono )
Check whether the RGB values of this frame color equal those of the specified frame color or not.
SFXRGBColorConstRef GetFrame( Void )
Get the RGBA value of the frame color.
UInt08 GetFrameAlpha( Void )
Get the A value of the frame color.
UInt08 GetFrameBlue( Void )
Get the B value of the frame color.
UInt08 GetFrameGreen( Void )
Get the G value of the frame color.
UInt08 GetFrameRed( Void )
Get R value of the frame color.
SFXRGBColorConstRef GetShadow( Void )
Get the RGBA value of the shadow color.
UInt08 GetShadowAlpha( Void )
Get the A value of the shadow color.
UInt08 GetShadowBlue( Void )
Get the B value of the shadow color.
UInt08 GetShadowGreen( Void )
Get the G value of the shadow color.
UInt08 GetShadowRed( Void )
Get R value of the shadow color.
SFXFrameColorRef Set( SFXFrameColorConstRef param )
Set the RGBA value.
SFXFrameColorRef Set( SFXRGBColorConstRef frame , SFXRGBColorConstRef shadow )
Set the RGBA value.
SFXFrameColorRef Set( SFXRGBColorConstRef plain )
Set the RGBA value.
SFXFrameColorRef Set( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
Set the RGBA value.
SFXFrameColorRef Set( UInt08 mono , UInt08 alpha )
Set the RGBA value.
SFXFrameColorRef SetAlpha( UInt08 param )
Set the A value.
SFXFrameColorRef SetBlue( UInt08 param )
Set the B value.
SFXFrameColorRef SetFrame( SFXRGBColorConstRef param )
Set the RGBA value of the frame color.
SFXFrameColorRef SetFrame( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
Set the RGBA value of the frame color.
SFXFrameColorRef SetFrame( UInt08 mono , UInt08 alpha )
Set the RGBA value of the frame color.
SFXFrameColorRef SetFrameAlpha( UInt08 param )
Set the A value of the frame color.
SFXFrameColorRef SetFrameBlue( UInt08 param )
Set the B value of the frame color.
SFXFrameColorRef SetFrameGreen( UInt08 param )
Set the G value of the frame color.
SFXFrameColorRef SetFrameRGB( UInt08 red , UInt08 green , UInt08 blue )
Set the RGB value of the frame color.
SFXFrameColorRef SetFrameRGB( UInt08 mono )
Set the RGB value of the frame color.
SFXFrameColorRef SetFrameRed( UInt08 param )
Set the R value of the frame color.
SFXFrameColorRef SetGreen( UInt08 param )
Set the G value.
SFXFrameColorRef SetRGB( UInt08 red , UInt08 green , UInt08 blue )
Set the RGB value.
SFXFrameColorRef SetRGB( UInt08 mono )
Set the RGB value.
SFXFrameColorRef SetRed( UInt08 param )
Set the R value.
SFXFrameColorRef SetShadow( SFXRGBColorConstRef param )
Set the RGBA value of the shadow color.
SFXFrameColorRef SetShadow( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
Set the RGBA value of the shadow color.
SFXFrameColorRef SetShadow( UInt08 mono , UInt08 alpha )
Set the RGBA value of the shadow color.
SFXFrameColorRef SetShadowAlpha( UInt08 param )
Set the A value of the shadow color.
SFXFrameColorRef SetShadowBlue( UInt08 param )
Set the B value of the shadow color.
SFXFrameColorRef SetShadowGreen( UInt08 param )
Set the G value of the shadow color.
SFXFrameColorRef SetShadowRGB( UInt08 red , UInt08 green , UInt08 blue )
Set the RGB value of the shadow color.
SFXFrameColorRef SetShadowRGB( UInt08 mono )
Set the RGB value of the shadow color.
SFXFrameColorRef SetShadowRed( UInt08 param )
Set the R value of the shadow color.
SFXFrameColorRef Sub( SFXFrameColorConstRef param )
Subtract the specified value from the RGBA value.
SFXFrameColorRef Sub( SFXRGBColorConstRef frame , SFXRGBColorConstRef shadow )
Subtract the specified value from the RGBA value.
SFXFrameColorRef Sub( SFXRGBColorConstRef plain )
Subtract the specified value from the RGBA value.
SFXFrameColorRef Sub( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
Subtract the specified value from the RGBA value.
SFXFrameColorRef Sub( UInt08 mono , UInt08 alpha )
Subtract the specified value from the RGBA value.
SFXFrameColorRef SubAlpha( UInt08 param )
Subtract the specified value from the A value.
SFXFrameColorRef SubBlue( UInt08 param )
Subtract the specified value from the B value.
SFXFrameColorRef SubFrame( SFXRGBColorConstRef param )
Subtract the specified value from the RGBA value of frame color.
SFXFrameColorRef SubFrame( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
Subtract the specified value from the RGBA value of frame color.
SFXFrameColorRef SubFrame( UInt08 mono , UInt08 alpha )
Subtract the specified value from the RGBA value of frame color.
SFXFrameColorRef SubFrameAlpha( UInt08 param )
Subtract the specified value from the A value of frame color.
SFXFrameColorRef SubFrameBlue( UInt08 param )
Subtract the specified value from the B value of frame color.
SFXFrameColorRef SubFrameGreen( UInt08 param )
Subtract the specified value from the G value of frame color.
SFXFrameColorRef SubFrameRGB( UInt08 red , UInt08 green , UInt08 blue )
Subtract the specified value from the RGB value of frame color.
SFXFrameColorRef SubFrameRGB( UInt08 mono )
Subtract the specified value from the RGB value of frame color.
SFXFrameColorRef SubFrameRed( UInt08 param )
Subtract the specified value from the R value of frame color.
SFXFrameColorRef SubGreen( UInt08 param )
Subtract the specified value from the G value.
SFXFrameColorRef SubRGB( UInt08 red , UInt08 green , UInt08 blue )
Subtract the specified value from the RGB value.
SFXFrameColorRef SubRGB( UInt08 mono )
Subtract the specified value from the RGB value.
SFXFrameColorRef SubRed( UInt08 param )
Subtract the specified value from the R value.
SFXFrameColorRef SubShadow( SFXRGBColorConstRef param )
Subtract the specified value from the RGBA value of shadow color.
SFXFrameColorRef SubShadow( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
Subtract the specified value from the RGBA value of shadow color.
SFXFrameColorRef SubShadow( UInt08 mono , UInt08 alpha )
Subtract the specified value from the RGBA value of shadow color.
SFXFrameColorRef SubShadowAlpha( UInt08 param )
Subtract the specified value from the A value of shadow color.
SFXFrameColorRef SubShadowBlue( UInt08 param )
Subtract the specified value from the B value of shadow color.
SFXFrameColorRef SubShadowGreen( UInt08 param )
Subtract the specified value from the G value of shadow color.
SFXFrameColorRef SubShadowRGB( UInt08 red , UInt08 green , UInt08 blue )
Subtract the specified value from the RGB value of shadow color.
SFXFrameColorRef SubShadowRGB( UInt08 mono )
Subtract the specified value from the RGB value of shadow color.
SFXFrameColorRef SubShadowRed( UInt08 param )
Subtract the specified value from the R value of shadow color.
static
SFXFrameColorConstRef
ZeroInstance( Void )
Get the instance that represents 0.
SFXFrameColorRef operator+=( SFXFrameColorConstRef param )
Add the specified value to the RGBA value.
SFXFrameColorRef operator-=( SFXFrameColorConstRef param )
Subtract the specified value from the RGBA value.
SFXFrameColorRef operator=( SFXFrameColorConstRef param )
Assign a RGBA value.
SFXFrameColor::AtomRec * atomic_cast( SFXFrameColor * param )
Convert SFXFrameColor into SFXFrameColor::AtomRec.
SFXFrameColor::AtomRec const * atomic_cast( SFXFrameColor const * param )
Convert SFXFrameColor into SFXFrameColor::AtomRec.
Bool operator==( SFXFrameColorConstRef left , SFXFrameColorConstRef right )
Check the "==" relation.
SFXFrameColor operator-( SFXFrameColorConstRef left , SFXFrameColorConstRef right )
Subtract the specified value from the RGBA value.
Bool operator!=( SFXFrameColorConstRef left , SFXFrameColorConstRef right )
Check the "!=" relation.
SFXFrameColor operator+( SFXFrameColorConstRef left , SFXFrameColorConstRef right )
Add the specified value to the RGBA value.
Types
AtomRec
Structure that represents the frame color (F) and shadow color (S).
Global Functions
SFXFrameColor::AtomRec * atomic_cast( SFXFrameColor * param )
Convert SFXFrameColor into SFXFrameColor::AtomRec.
SFXFrameColor::AtomRec const * atomic_cast( SFXFrameColor const * param )
Convert SFXFrameColor into SFXFrameColor::AtomRec.
Bool operator==( SFXFrameColorConstRef left , SFXFrameColorConstRef right )
Check the "==" relation.
SFXFrameColor operator-( SFXFrameColorConstRef left , SFXFrameColorConstRef right )
Subtract the specified value from the RGBA value.
Bool operator!=( SFXFrameColorConstRef left , SFXFrameColorConstRef right )
Check the "!=" relation.
SFXFrameColor operator+( SFXFrameColorConstRef left , SFXFrameColorConstRef right )
Add the specified value to the RGBA value.

SFXFrameColor::SFXFrameColor
Constructor of the SFXFrameColor class.
[ public, explicit ]
SFXFrameColor(Void);
[ public ]
SFXFrameColor(
    SFXFrameColorConstRef param   // source SFXFrameColor
);
[ public, explicit ]
SFXFrameColor(
    SFXRGBColorConstRef frame    // frame color
    SFXRGBColorConstRef shadow   // shadow color
);
[ public, explicit ]
SFXFrameColor(
    SFXRGBColorConstRef plain   // frame color and shadow color
);
[ public, explicit ]
SFXFrameColor(
    UInt08 red     // R value of frame color and shadow color
    UInt08 green   // G value of frame color and shadow color
    UInt08 blue    // B value of frame color and shadow color
    UInt08 alpha   // A value of frame color and shadow color
);
[ public, explicit ]
SFXFrameColor(
    UInt08 mono    // RGB value of frame color and shadow color
    UInt08 alpha   // A value of frame color and shadow color
);

Reference

SFXFrameColor::Set


SFXFrameColor::Add
Add the specified value to the RGBA value.
[ public ]
SFXFrameColorRef Add(
    SFXFrameColorConstRef param   // value to add to SFXFrameColor color
);
[ public ]
SFXFrameColorRef Add(
    SFXRGBColorConstRef frame    // value to add to the frame color
    SFXRGBColorConstRef shadow   // value to add to the shadow color
);
[ public ]
SFXFrameColorRef Add(
    SFXRGBColorConstRef plain   // color
);
[ public ]
SFXFrameColorRef 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 ]
SFXFrameColorRef Add(
    UInt08 mono    // value to add to the RGB value
    UInt08 alpha   // value to add to the A value
);

Reference

SFXFrameColor::AddRed | SFXFrameColor::AddGreen | SFXFrameColor::AddBlue | SFXFrameColor::AddAlpha | SFXFrameColor::AddRGB | SFXFrameColor::AddFrame | SFXFrameColor::AddShadow | SFXFrameColor::Sub | operator+ | SFXFrameColor::operator+=


SFXFrameColor::AddAlpha
Add the specified value to the A value.
[ public ]
SFXFrameColorRef AddAlpha(
    UInt08 param   // value to add to the A value
);

Reference

SFXFrameColor::Add | SFXFrameColor::AddRed | SFXFrameColor::AddGreen | SFXFrameColor::AddBlue | SFXFrameColor::AddRGB | SFXFrameColor::AddFrameAlpha | SFXFrameColor::AddShadowAlpha | SFXFrameColor::SubAlpha


SFXFrameColor::AddBlue
Add the specified value to the B value.
[ public ]
SFXFrameColorRef AddBlue(
    UInt08 param   // value to add to the B value
);

Reference

SFXFrameColor::Add | SFXFrameColor::AddRed | SFXFrameColor::AddGreen | SFXFrameColor::AddAlpha | SFXFrameColor::AddRGB | SFXFrameColor::AddFrameBlue | SFXFrameColor::AddShadowBlue | SFXFrameColor::SubBlue


SFXFrameColor::AddFrame
Add the specified value to the RGBA value of frame color.
[ public ]
SFXFrameColorRef AddFrame(
    SFXRGBColorConstRef param   // color
);
[ public ]
SFXFrameColorRef AddFrame(
    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 ]
SFXFrameColorRef AddFrame(
    UInt08 mono    // value to add to the RGB value
    UInt08 alpha   // value to add to the A value
);

Reference

SFXFrameColor::Add | SFXFrameColor::AddFrameRed | SFXFrameColor::AddFrameGreen | SFXFrameColor::AddFrameBlue | SFXFrameColor::AddFrameAlpha | SFXFrameColor::AddFrameRGB | SFXFrameColor::AddShadow | SFXFrameColor::SubFrame


SFXFrameColor::AddFrameAlpha
Add the specified value to the A value of frame color.
[ public ]
SFXFrameColorRef AddFrameAlpha(
    UInt08 param   // value to add to the A value
);

Reference

SFXFrameColor::AddAlpha | SFXFrameColor::AddFrame | SFXFrameColor::AddFrameRed | SFXFrameColor::AddFrameGreen | SFXFrameColor::AddFrameBlue | SFXFrameColor::AddFrameRGB | SFXFrameColor::AddShadowAlpha | SFXFrameColor::SubFrameAlpha


SFXFrameColor::AddFrameBlue
Add the specified value to the B value of frame color.
[ public ]
SFXFrameColorRef AddFrameBlue(
    UInt08 param   // value to add to the B value
);

Reference

SFXFrameColor::AddBlue | SFXFrameColor::AddFrame | SFXFrameColor::AddFrameRed | SFXFrameColor::AddFrameGreen | SFXFrameColor::AddFrameAlpha | SFXFrameColor::AddFrameRGB | SFXFrameColor::AddShadowBlue | SFXFrameColor::SubFrameBlue


SFXFrameColor::AddFrameGreen
Add the specified value to the G value of frame color.
[ public ]
SFXFrameColorRef AddFrameGreen(
    UInt08 param   // value to add to the G value
);

Reference

SFXFrameColor::AddGreen | SFXFrameColor::AddFrame | SFXFrameColor::AddFrameRed | SFXFrameColor::AddFrameBlue | SFXFrameColor::AddFrameAlpha | SFXFrameColor::AddFrameRGB | SFXFrameColor::AddShadowGreen | SFXFrameColor::SubFrameGreen


SFXFrameColor::AddFrameRGB
Add the specified value to the RGB value of frame color.
[ public ]
SFXFrameColorRef AddFrameRGB(
    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 ]
SFXFrameColorRef AddFrameRGB(
    UInt08 mono   // value to add to the RGB value
);

Reference

SFXFrameColor::AddRGB | SFXFrameColor::AddFrame | SFXFrameColor::AddFrameRed | SFXFrameColor::AddFrameGreen | SFXFrameColor::AddFrameBlue | SFXFrameColor::AddFrameAlpha | SFXFrameColor::AddShadowRGB | SFXFrameColor::SubFrameRGB


SFXFrameColor::AddFrameRed
Add the specified value to the R value of frame color.
[ public ]
SFXFrameColorRef AddFrameRed(
    UInt08 param   // value to add to the R value
);

Reference

SFXFrameColor::AddRed | SFXFrameColor::AddFrame | SFXFrameColor::AddFrameGreen | SFXFrameColor::AddFrameBlue | SFXFrameColor::AddFrameAlpha | SFXFrameColor::AddFrameRGB | SFXFrameColor::AddShadowRed | SFXFrameColor::SubFrameRed


SFXFrameColor::AddGreen
Add the specified value to the G value.
[ public ]
SFXFrameColorRef AddGreen(
    UInt08 param   // value to add to the G value
);

Reference

SFXFrameColor::Add | SFXFrameColor::AddRed | SFXFrameColor::AddBlue | SFXFrameColor::AddAlpha | SFXFrameColor::AddRGB | SFXFrameColor::AddFrameGreen | SFXFrameColor::AddShadowGreen | SFXFrameColor::SubGreen


SFXFrameColor::AddRGB
Add the specified value to the RGB value.
[ public ]
SFXFrameColorRef 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 ]
SFXFrameColorRef AddRGB(
    UInt08 mono   // value to add to the RGB value
);

Reference

SFXFrameColor::Add | SFXFrameColor::AddRed | SFXFrameColor::AddGreen | SFXFrameColor::AddBlue | SFXFrameColor::AddAlpha | SFXFrameColor::AddFrameRGB | SFXFrameColor::AddShadowRGB | SFXFrameColor::SubRGB


SFXFrameColor::AddRed
Add the specified value to the R value.
[ public ]
SFXFrameColorRef AddRed(
    UInt08 param   // value to add to the R value
);

Reference

SFXFrameColor::Add | SFXFrameColor::AddGreen | SFXFrameColor::AddBlue | SFXFrameColor::AddAlpha | SFXFrameColor::AddRGB | SFXFrameColor::AddFrameRed | SFXFrameColor::AddShadowRed | SFXFrameColor::SubRed


SFXFrameColor::AddShadow
Add the specified value to the RGBA value of shadow color.
[ public ]
SFXFrameColorRef AddShadow(
    SFXRGBColorConstRef param   // color
);
[ public ]
SFXFrameColorRef AddShadow(
    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 ]
SFXFrameColorRef AddShadow(
    UInt08 mono    // value to add to the RGB value
    UInt08 alpha   // value to add to the A value
);

Reference

SFXFrameColor::Add | SFXFrameColor::AddFrame | SFXFrameColor::AddShadowRed | SFXFrameColor::AddShadowGreen | SFXFrameColor::AddShadowBlue | SFXFrameColor::AddShadowAlpha | SFXFrameColor::AddShadowRGB | SFXFrameColor::SubShadow


SFXFrameColor::AddShadowAlpha
Add the specified value to the A value of shadow color.
[ public ]
SFXFrameColorRef AddShadowAlpha(
    UInt08 param   // value to add to the A value
);

Reference

SFXFrameColor::AddAlpha | SFXFrameColor::AddFrameAlpha | SFXFrameColor::AddShadow | SFXFrameColor::AddShadowRed | SFXFrameColor::AddShadowGreen | SFXFrameColor::AddShadowBlue | SFXFrameColor::AddShadowRGB | SFXFrameColor::SubShadowAlpha


SFXFrameColor::AddShadowBlue
Add the specified value to the B value of shadow color.
[ public ]
SFXFrameColorRef AddShadowBlue(
    UInt08 param   // value to add to the B value
);

Reference

SFXFrameColor::AddBlue | SFXFrameColor::AddFrameBlue | SFXFrameColor::AddShadow | SFXFrameColor::AddShadowRed | SFXFrameColor::AddShadowGreen | SFXFrameColor::AddShadowAlpha | SFXFrameColor::AddShadowRGB | SFXFrameColor::SubShadowBlue


SFXFrameColor::AddShadowGreen
Add the specified value to the G value of shadow color.
[ public ]
SFXFrameColorRef AddShadowGreen(
    UInt08 param   // value to add to the G value
);

Reference

SFXFrameColor::AddGreen | SFXFrameColor::AddFrameGreen | SFXFrameColor::AddShadow | SFXFrameColor::AddShadowRed | SFXFrameColor::AddShadowBlue | SFXFrameColor::AddShadowAlpha | SFXFrameColor::AddShadowRGB | SFXFrameColor::SubShadowGreen


SFXFrameColor::AddShadowRGB
Add the specified value to the RGB value of shadow color.
[ public ]
SFXFrameColorRef AddShadowRGB(
    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 ]
SFXFrameColorRef AddShadowRGB(
    UInt08 mono   // value to add to the RGB value
);

Reference

SFXFrameColor::AddRGB | SFXFrameColor::AddFrameRGB | SFXFrameColor::AddShadow | SFXFrameColor::AddShadowRed | SFXFrameColor::AddShadowGreen | SFXFrameColor::AddShadowBlue | SFXFrameColor::AddShadowAlpha | SFXFrameColor::SubShadowRGB


SFXFrameColor::AddShadowRed
Add the specified value to the R value of shadow color.
[ public ]
SFXFrameColorRef AddShadowRed(
    UInt08 param   // value to add to the R value
);

Reference

SFXFrameColor::AddRed | SFXFrameColor::AddFrameRed | SFXFrameColor::AddShadow | SFXFrameColor::AddShadowGreen | SFXFrameColor::AddShadowBlue | SFXFrameColor::AddShadowAlpha | SFXFrameColor::AddShadowRGB | SFXFrameColor::SubShadowRed


SFXFrameColor::Equals
Check whether the RGBA values of this frame color equal those of the specified frame color or not.
[ public, const ]
Bool Equals(
    SFXFrameColorConstRef param   // 
);
[ public, const ]
Bool Equals(
    SFXRGBColorConstRef frame    // frame color of SFXFrameColor to compare
    SFXRGBColorConstRef shadow   // shadow color of SFXFrameColor to compare
);
[ public, const ]
Bool Equals(
    SFXRGBColorConstRef plain   // color of SFXFrameColor to compare
);
[ public, const ]
Bool Equals(
    UInt08 red     // R value of SFXFrameColor to compare
    UInt08 green   // G value of SFXFrameColor to compare
    UInt08 blue    // B value of SFXFrameColor to compare
    UInt08 alpha   // A value of SFXFrameColor to compare
);
[ public, const ]
Bool Equals(
    UInt08 mono    // RGB value of SFXFrameColor to compare
    UInt08 alpha   // A value of SFXFrameColor to compare
);

Return value

  • If yes: true
  • Otherwise: false

Reference

SFXFrameColor::EqualsRGB | operator== | operator!=


SFXFrameColor::EqualsRGB
Check whether the RGB values of this frame color equal those of the specified frame color or not.
[ public, const ]
Bool EqualsRGB(
    SFXFrameColorConstRef param   // SFXFrameColor to compare
);
[ public, const ]
Bool EqualsRGB(
    SFXRGBColorConstRef frame    // frame color of SFXFrameColor to compare
    SFXRGBColorConstRef shadow   // shadow color of SFXFrameColor to compare
);
[ public, const ]
Bool EqualsRGB(
    SFXRGBColorConstRef plain   // color of SFXFrameColor to compare
);
[ public, const ]
Bool EqualsRGB(
    UInt08 red     // R value of SFXFrameColor to compare
    UInt08 green   // G value of SFXFrameColor to compare
    UInt08 blue    // B value of SFXFrameColor to compare
);
[ public, const ]
Bool EqualsRGB(
    UInt08 mono   // RGB value of SFXFrameColor to compare
);

Return value

  • If yes: true
  • Otherwise: false

Reference

SFXFrameColor::Equals | operator== | operator!=


SFXFrameColor::GetFrame
Get the RGBA value of the frame color.
[ public, const ]
SFXRGBColorConstRef GetFrame(Void);

Reference

SFXFrameColor::GetFrameRed | SFXFrameColor::GetFrameGreen | SFXFrameColor::GetFrameBlue | SFXFrameColor::GetFrameAlpha | SFXFrameColor::GetShadow | SFXFrameColor::SetFrame


SFXFrameColor::GetFrameAlpha
Get the A value of the frame color.
[ public, const ]
UInt08 GetFrameAlpha(Void);

Reference

SFXFrameColor::GetFrame | SFXFrameColor::GetFrameRed | SFXFrameColor::GetFrameGreen | SFXFrameColor::GetFrameBlue | SFXFrameColor::GetShadowAlpha | SFXFrameColor::SetFrameAlpha


SFXFrameColor::GetFrameBlue
Get the B value of the frame color.
[ public, const ]
UInt08 GetFrameBlue(Void);

Reference

SFXFrameColor::GetFrame | SFXFrameColor::GetFrameRed | SFXFrameColor::GetFrameGreen | SFXFrameColor::GetFrameAlpha | SFXFrameColor::GetShadowBlue | SFXFrameColor::SetFrameBlue


SFXFrameColor::GetFrameGreen
Get the G value of the frame color.
[ public, const ]
UInt08 GetFrameGreen(Void);

Reference

SFXFrameColor::GetFrame | SFXFrameColor::GetFrameRed | SFXFrameColor::GetFrameBlue | SFXFrameColor::GetFrameAlpha | SFXFrameColor::GetShadowGreen | SFXFrameColor::SetFrameGreen


SFXFrameColor::GetFrameRed
Get R value of the frame color.
[ public, const ]
UInt08 GetFrameRed(Void);

Reference

SFXFrameColor::GetFrame | SFXFrameColor::GetFrameGreen | SFXFrameColor::GetFrameBlue | SFXFrameColor::GetFrameAlpha | SFXFrameColor::GetShadowRed | SFXFrameColor::SetFrameRed


SFXFrameColor::GetShadow
Get the RGBA value of the shadow color.
[ public, const ]
SFXRGBColorConstRef GetShadow(Void);

Reference

SFXFrameColor::GetFrame | SFXFrameColor::GetShadowRed | SFXFrameColor::GetShadowGreen | SFXFrameColor::GetShadowBlue | SFXFrameColor::GetShadowAlpha | SFXFrameColor::SetShadow


SFXFrameColor::GetShadowAlpha
Get the A value of the shadow color.
[ public, const ]
UInt08 GetShadowAlpha(Void);

Reference

SFXFrameColor::GetFrameAlpha | SFXFrameColor::GetShadow | SFXFrameColor::GetShadowRed | SFXFrameColor::GetShadowGreen | SFXFrameColor::GetShadowBlue | SFXFrameColor::SetShadowAlpha


SFXFrameColor::GetShadowBlue
Get the B value of the shadow color.
[ public, const ]
UInt08 GetShadowBlue(Void);

Reference

SFXFrameColor::GetFrameBlue | SFXFrameColor::GetShadow | SFXFrameColor::GetShadowRed | SFXFrameColor::GetShadowGreen | SFXFrameColor::GetShadowAlpha | SFXFrameColor::SetShadowBlue


SFXFrameColor::GetShadowGreen
Get the G value of the shadow color.
[ public, const ]
UInt08 GetShadowGreen(Void);

Reference

SFXFrameColor::GetFrameGreen | SFXFrameColor::GetShadow | SFXFrameColor::GetShadowRed | SFXFrameColor::GetShadowBlue | SFXFrameColor::GetShadowAlpha | SFXFrameColor::SetShadowGreen


SFXFrameColor::GetShadowRed
Get R value of the shadow color.
[ public, const ]
UInt08 GetShadowRed(Void);

Reference

SFXFrameColor::GetFrameRed | SFXFrameColor::GetShadow | SFXFrameColor::GetShadowGreen | SFXFrameColor::GetShadowBlue | SFXFrameColor::GetShadowAlpha | SFXFrameColor::SetShadowRed


SFXFrameColor::Set
Set the RGBA value.
[ public ]
SFXFrameColorRef Set(
    SFXFrameColorConstRef param   // SFXFrameColor to set
);
[ public ]
SFXFrameColorRef Set(
    SFXRGBColorConstRef frame    // frame color to set
    SFXRGBColorConstRef shadow   // shadow color to set
);
[ public ]
SFXFrameColorRef Set(
    SFXRGBColorConstRef plain   // color to set
);
[ public ]
SFXFrameColorRef Set(
    UInt08 red     // R value to set
    UInt08 green   // G value to set
    UInt08 blue    // B value to set
    UInt08 alpha   // A value to set
);
[ public ]
SFXFrameColorRef Set(
    UInt08 mono    // RGB value to set
    UInt08 alpha   // A value to set
);

Reference

SFXFrameColor::SetRed | SFXFrameColor::SetGreen | SFXFrameColor::SetBlue | SFXFrameColor::SetAlpha | SFXFrameColor::SetRGB | SFXFrameColor::SetFrame | SFXFrameColor::SetShadow | SFXFrameColor::operator=


SFXFrameColor::SetAlpha
Set the A value.
[ public ]
SFXFrameColorRef SetAlpha(
    UInt08 param   // A value to set
);

Reference

SFXFrameColor::Set | SFXFrameColor::SetRed | SFXFrameColor::SetGreen | SFXFrameColor::SetBlue | SFXFrameColor::SetRGB | SFXFrameColor::SetFrameAlpha | SFXFrameColor::SetShadowAlpha


SFXFrameColor::SetBlue
Set the B value.
[ public ]
SFXFrameColorRef SetBlue(
    UInt08 param   // B value to set
);

Reference

SFXFrameColor::Set | SFXFrameColor::SetRed | SFXFrameColor::SetGreen | SFXFrameColor::SetAlpha | SFXFrameColor::SetRGB | SFXFrameColor::SetFrameBlue | SFXFrameColor::SetShadowBlue


SFXFrameColor::SetFrame
Set the RGBA value of the frame color.
[ public ]
SFXFrameColorRef SetFrame(
    SFXRGBColorConstRef param   // color to set
);
[ public ]
SFXFrameColorRef SetFrame(
    UInt08 red     // R value to set
    UInt08 green   // G value to set
    UInt08 blue    // B value to set
    UInt08 alpha   // A value to set
);
[ public ]
SFXFrameColorRef SetFrame(
    UInt08 mono    // RGB value to set
    UInt08 alpha   // A value to set
);

Reference

SFXFrameColor::GetFrame | SFXFrameColor::Set | SFXFrameColor::SetFrameRed | SFXFrameColor::SetFrameGreen | SFXFrameColor::SetFrameBlue | SFXFrameColor::SetFrameAlpha | SFXFrameColor::SetFrameRGB | SFXFrameColor::SetShadow


SFXFrameColor::SetFrameAlpha
Set the A value of the frame color.
[ public ]
SFXFrameColorRef SetFrameAlpha(
    UInt08 param   // A value to set
);

Reference

SFXFrameColor::GetFrameAlpha | SFXFrameColor::SetAlpha | SFXFrameColor::SetFrame | SFXFrameColor::SetFrameRed | SFXFrameColor::SetFrameGreen | SFXFrameColor::SetFrameBlue | SFXFrameColor::SetFrameRGB | SFXFrameColor::SetShadowAlpha


SFXFrameColor::SetFrameBlue
Set the B value of the frame color.
[ public ]
SFXFrameColorRef SetFrameBlue(
    UInt08 param   // B value to set
);

Reference

SFXFrameColor::GetFrameBlue | SFXFrameColor::SetBlue | SFXFrameColor::SetFrame | SFXFrameColor::SetFrameRed | SFXFrameColor::SetFrameGreen | SFXFrameColor::SetFrameAlpha | SFXFrameColor::SetFrameRGB | SFXFrameColor::SetShadowBlue


SFXFrameColor::SetFrameGreen
Set the G value of the frame color.
[ public ]
SFXFrameColorRef SetFrameGreen(
    UInt08 param   // G value to set
);

Reference

SFXFrameColor::GetFrameGreen | SFXFrameColor::SetGreen | SFXFrameColor::SetFrame | SFXFrameColor::SetFrameRed | SFXFrameColor::SetFrameBlue | SFXFrameColor::SetFrameAlpha | SFXFrameColor::SetFrameRGB | SFXFrameColor::SetShadowGreen


SFXFrameColor::SetFrameRGB
Set the RGB value of the frame color.
[ public ]
SFXFrameColorRef SetFrameRGB(
    UInt08 red     // R value to set
    UInt08 green   // G value to set
    UInt08 blue    // B value to set
);
[ public ]
SFXFrameColorRef SetFrameRGB(
    UInt08 mono   // RGB value to set
);

Reference

SFXFrameColor::SetRGB | SFXFrameColor::SetFrame | SFXFrameColor::SetFrameRed | SFXFrameColor::SetFrameGreen | SFXFrameColor::SetFrameBlue | SFXFrameColor::SetFrameAlpha | SFXFrameColor::SetShadowRGB


SFXFrameColor::SetFrameRed
Set the R value of the frame color.
[ public ]
SFXFrameColorRef SetFrameRed(
    UInt08 param   // R value to set
);

Reference

SFXFrameColor::GetFrameRed | SFXFrameColor::SetRed | SFXFrameColor::SetFrame | SFXFrameColor::SetFrameGreen | SFXFrameColor::SetFrameBlue | SFXFrameColor::SetFrameAlpha | SFXFrameColor::SetFrameRGB | SFXFrameColor::SetShadowRed


SFXFrameColor::SetGreen
Set the G value.
[ public ]
SFXFrameColorRef SetGreen(
    UInt08 param   // G value to set
);

Reference

SFXFrameColor::Set | SFXFrameColor::SetRed | SFXFrameColor::SetBlue | SFXFrameColor::SetAlpha | SFXFrameColor::SetRGB | SFXFrameColor::SetFrameGreen | SFXFrameColor::SetShadowGreen


SFXFrameColor::SetRGB
Set the RGB value.
[ public ]
SFXFrameColorRef SetRGB(
    UInt08 red     // R value to set
    UInt08 green   // G value to set
    UInt08 blue    // B value to set
);
[ public ]
SFXFrameColorRef SetRGB(
    UInt08 mono   // RGB value to set
);

Reference

SFXFrameColor::Set | SFXFrameColor::SetRed | SFXFrameColor::SetGreen | SFXFrameColor::SetBlue | SFXFrameColor::SetAlpha | SFXFrameColor::SetFrameRGB | SFXFrameColor::SetShadowRGB


SFXFrameColor::SetRed
Set the R value.
[ public ]
SFXFrameColorRef SetRed(
    UInt08 param   // R value to set
);

Reference

SFXFrameColor::Set | SFXFrameColor::SetGreen | SFXFrameColor::SetBlue | SFXFrameColor::SetAlpha | SFXFrameColor::SetRGB | SFXFrameColor::SetFrameRed | SFXFrameColor::SetShadowRed


SFXFrameColor::SetShadow
Set the RGBA value of the shadow color.
[ public ]
SFXFrameColorRef SetShadow(
    SFXRGBColorConstRef param   // color to set
);
[ public ]
SFXFrameColorRef SetShadow(
    UInt08 red     // R value to set
    UInt08 green   // G value to set
    UInt08 blue    // B value to set
    UInt08 alpha   // A value to set
);
[ public ]
SFXFrameColorRef SetShadow(
    UInt08 mono    // RGB value to set
    UInt08 alpha   // A value to set
);

Reference

SFXFrameColor::GetShadow | SFXFrameColor::Set | SFXFrameColor::SetFrame | SFXFrameColor::SetShadowRed | SFXFrameColor::SetShadowGreen | SFXFrameColor::SetShadowBlue | SFXFrameColor::SetShadowAlpha | SFXFrameColor::SetShadowRGB


SFXFrameColor::SetShadowAlpha
Set the A value of the shadow color.
[ public ]
SFXFrameColorRef SetShadowAlpha(
    UInt08 param   // A value to set
);

Reference

SFXFrameColor::GetShadowAlpha | SFXFrameColor::SetAlpha | SFXFrameColor::SetFrameAlpha | SFXFrameColor::SetShadow | SFXFrameColor::SetShadowRed | SFXFrameColor::SetShadowGreen | SFXFrameColor::SetShadowBlue | SFXFrameColor::SetShadowRGB


SFXFrameColor::SetShadowBlue
Set the B value of the shadow color.
[ public ]
SFXFrameColorRef SetShadowBlue(
    UInt08 param   // B value to set
);

Reference

SFXFrameColor::GetShadowBlue | SFXFrameColor::SetBlue | SFXFrameColor::SetFrameBlue | SFXFrameColor::SetShadow | SFXFrameColor::SetShadowRed | SFXFrameColor::SetShadowGreen | SFXFrameColor::SetShadowAlpha | SFXFrameColor::SetShadowRGB


SFXFrameColor::SetShadowGreen
Set the G value of the shadow color.
[ public ]
SFXFrameColorRef SetShadowGreen(
    UInt08 param   // G value to set
);

Reference

SFXFrameColor::GetShadowGreen | SFXFrameColor::SetGreen | SFXFrameColor::SetFrameGreen | SFXFrameColor::SetShadow | SFXFrameColor::SetShadowRed | SFXFrameColor::SetShadowBlue | SFXFrameColor::SetShadowAlpha | SFXFrameColor::SetShadowRGB


SFXFrameColor::SetShadowRGB
Set the RGB value of the shadow color.
[ public ]
SFXFrameColorRef SetShadowRGB(
    UInt08 red     // R value to set
    UInt08 green   // G value to set
    UInt08 blue    // B value to set
);
[ public ]
SFXFrameColorRef SetShadowRGB(
    UInt08 mono   // RGB value to set
);

Reference

SFXFrameColor::SetRGB | SFXFrameColor::SetFrameRGB | SFXFrameColor::SetShadow | SFXFrameColor::SetShadowRed | SFXFrameColor::SetShadowGreen | SFXFrameColor::SetShadowBlue | SFXFrameColor::SetShadowAlpha


SFXFrameColor::SetShadowRed
Set the R value of the shadow color.
[ public ]
SFXFrameColorRef SetShadowRed(
    UInt08 param   // R value to set
);

Reference

SFXFrameColor::GetShadowRed | SFXFrameColor::SetRed | SFXFrameColor::SetFrameRed | SFXFrameColor::SetShadow | SFXFrameColor::SetShadowGreen | SFXFrameColor::SetShadowBlue | SFXFrameColor::SetShadowAlpha | SFXFrameColor::SetShadowRGB


SFXFrameColor::Sub
Subtract the specified value from the RGBA value.
[ public ]
SFXFrameColorRef Sub(
    SFXFrameColorConstRef param   // value to subtract from the color
);
[ public ]
SFXFrameColorRef Sub(
    SFXRGBColorConstRef frame    // value to subtract from the frame color
    SFXRGBColorConstRef shadow   // value to subtract from the shadow color
);
[ public ]
SFXFrameColorRef Sub(
    SFXRGBColorConstRef plain   // value to subtract from the color
);
[ public ]
SFXFrameColorRef 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   // value to subtract from the A value
);
[ public ]
SFXFrameColorRef Sub(
    UInt08 mono    // value to subtract from the RGB value
    UInt08 alpha   // value to subtract from the A value
);

Reference

SFXFrameColor::Add | SFXFrameColor::SubRed | SFXFrameColor::SubGreen | SFXFrameColor::SubBlue | SFXFrameColor::SubAlpha | SFXFrameColor::SubRGB | SFXFrameColor::SubFrame | SFXFrameColor::SubShadow | operator- | SFXFrameColor::operator-=


SFXFrameColor::SubAlpha
Subtract the specified value from the A value.
[ public ]
SFXFrameColorRef SubAlpha(
    UInt08 param   // value to subtract from the A value
);

Reference

SFXFrameColor::AddAlpha | SFXFrameColor::Sub | SFXFrameColor::SubRed | SFXFrameColor::SubGreen | SFXFrameColor::SubBlue | SFXFrameColor::SubRGB | SFXFrameColor::SubFrameAlpha | SFXFrameColor::SubShadowAlpha


SFXFrameColor::SubBlue
Subtract the specified value from the B value.
[ public ]
SFXFrameColorRef SubBlue(
    UInt08 param   // value to subtract from the B value
);

Reference

SFXFrameColor::AddBlue | SFXFrameColor::Sub | SFXFrameColor::SubRed | SFXFrameColor::SubGreen | SFXFrameColor::SubAlpha | SFXFrameColor::SubRGB | SFXFrameColor::SubFrameBlue | SFXFrameColor::SubShadowBlue


SFXFrameColor::SubFrame
Subtract the specified value from the RGBA value of frame color.
[ public ]
SFXFrameColorRef SubFrame(
    SFXRGBColorConstRef param   // value to subtract from the color
);
[ public ]
SFXFrameColorRef SubFrame(
    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   // value to subtract from the A value
);
[ public ]
SFXFrameColorRef SubFrame(
    UInt08 mono    // value to subtract from the RGB value
    UInt08 alpha   // value to subtract from the A value
);

Reference

SFXFrameColor::AddFrame | SFXFrameColor::Sub | SFXFrameColor::SubFrameRed | SFXFrameColor::SubFrameGreen | SFXFrameColor::SubFrameBlue | SFXFrameColor::SubFrameAlpha | SFXFrameColor::SubFrameRGB | SFXFrameColor::SubShadow


SFXFrameColor::SubFrameAlpha
Subtract the specified value from the A value of frame color.
[ public ]
SFXFrameColorRef SubFrameAlpha(
    UInt08 param   // value to subtract from the A value
);

Reference

SFXFrameColor::AddFrameAlpha | SFXFrameColor::SubAlpha | SFXFrameColor::SubFrame | SFXFrameColor::SubFrameRed | SFXFrameColor::SubFrameGreen | SFXFrameColor::SubFrameBlue | SFXFrameColor::SubFrameRGB | SFXFrameColor::SubShadowAlpha


SFXFrameColor::SubFrameBlue
Subtract the specified value from the B value of frame color.
[ public ]
SFXFrameColorRef SubFrameBlue(
    UInt08 param   // value to subtract from the B value
);

Reference

SFXFrameColor::AddFrameBlue | SFXFrameColor::SubBlue | SFXFrameColor::SubFrame | SFXFrameColor::SubFrameRed | SFXFrameColor::SubFrameGreen | SFXFrameColor::SubFrameAlpha | SFXFrameColor::SubFrameRGB | SFXFrameColor::SubShadowBlue


SFXFrameColor::SubFrameGreen
Subtract the specified value from the G value of frame color.
[ public ]
SFXFrameColorRef SubFrameGreen(
    UInt08 param   // value to subtract from the G value
);

Reference

SFXFrameColor::AddFrameGreen | SFXFrameColor::SubGreen | SFXFrameColor::SubFrame | SFXFrameColor::SubFrameRed | SFXFrameColor::SubFrameBlue | SFXFrameColor::SubFrameAlpha | SFXFrameColor::SubFrameRGB | SFXFrameColor::SubShadowGreen


SFXFrameColor::SubFrameRGB
Subtract the specified value from the RGB value of frame color.
[ public ]
SFXFrameColorRef SubFrameRGB(
    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 ]
SFXFrameColorRef SubFrameRGB(
    UInt08 mono   // value to subtract from the RGB value
);

Reference

SFXFrameColor::AddFrameRGB | SFXFrameColor::SubRGB | SFXFrameColor::SubFrame | SFXFrameColor::SubFrameRed | SFXFrameColor::SubFrameGreen | SFXFrameColor::SubFrameBlue | SFXFrameColor::SubFrameAlpha | SFXFrameColor::SubShadowRGB


SFXFrameColor::SubFrameRed
Subtract the specified value from the R value of frame color.
[ public ]
SFXFrameColorRef SubFrameRed(
    UInt08 param   // value to subtract from the R value
);

Reference

SFXFrameColor::AddFrameRed | SFXFrameColor::SubRed | SFXFrameColor::SubFrame | SFXFrameColor::SubFrameGreen | SFXFrameColor::SubFrameBlue | SFXFrameColor::SubFrameAlpha | SFXFrameColor::SubFrameRGB | SFXFrameColor::SubShadowRed


SFXFrameColor::SubGreen
Subtract the specified value from the G value.
[ public ]
SFXFrameColorRef SubGreen(
    UInt08 param   // value to subtract from the G value
);

Reference

SFXFrameColor::AddGreen | SFXFrameColor::Sub | SFXFrameColor::SubRed | SFXFrameColor::SubBlue | SFXFrameColor::SubAlpha | SFXFrameColor::SubRGB | SFXFrameColor::SubFrameGreen | SFXFrameColor::SubShadowGreen


SFXFrameColor::SubRGB
Subtract the specified value from the RGB value.
[ public ]
SFXFrameColorRef 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 ]
SFXFrameColorRef SubRGB(
    UInt08 mono   // value to subtract from the RGB value
);

Reference

SFXFrameColor::AddRGB | SFXFrameColor::Sub | SFXFrameColor::SubRed | SFXFrameColor::SubGreen | SFXFrameColor::SubBlue | SFXFrameColor::SubAlpha | SFXFrameColor::SubFrameRGB | SFXFrameColor::SubShadowRGB


SFXFrameColor::SubRed
Subtract the specified value from the R value.
[ public ]
SFXFrameColorRef SubRed(
    UInt08 param   // value to subtract from the R value
);

Reference

SFXFrameColor::AddRed | SFXFrameColor::Sub | SFXFrameColor::SubGreen | SFXFrameColor::SubBlue | SFXFrameColor::SubAlpha | SFXFrameColor::SubRGB | SFXFrameColor::SubFrameRed | SFXFrameColor::SubShadowRed


SFXFrameColor::SubShadow
Subtract the specified value from the RGBA value of shadow color.
[ public ]
SFXFrameColorRef SubShadow(
    SFXRGBColorConstRef param   // value to subtract from the color
);
[ public ]
SFXFrameColorRef SubShadow(
    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   // value to subtract from the A value
);
[ public ]
SFXFrameColorRef SubShadow(
    UInt08 mono    // value to subtract from the RGB value
    UInt08 alpha   // value to subtract from the A value
);

Reference

SFXFrameColor::AddShadow | SFXFrameColor::Sub | SFXFrameColor::SubFrame | SFXFrameColor::SubShadowRed | SFXFrameColor::SubShadowGreen | SFXFrameColor::SubShadowBlue | SFXFrameColor::SubShadowAlpha | SFXFrameColor::SubShadowRGB


SFXFrameColor::SubShadowAlpha
Subtract the specified value from the A value of shadow color.
[ public ]
SFXFrameColorRef SubShadowAlpha(
    UInt08 param   // value to subtract from the A value
);

Reference

SFXFrameColor::AddShadowAlpha | SFXFrameColor::SubAlpha | SFXFrameColor::SubFrameAlpha | SFXFrameColor::SubShadow | SFXFrameColor::SubShadowRed | SFXFrameColor::SubShadowGreen | SFXFrameColor::SubShadowBlue | SFXFrameColor::SubShadowRGB


SFXFrameColor::SubShadowBlue
Subtract the specified value from the B value of shadow color.
[ public ]
SFXFrameColorRef SubShadowBlue(
    UInt08 param   // value to subtract from the B value
);

Reference

SFXFrameColor::AddShadowBlue | SFXFrameColor::SubBlue | SFXFrameColor::SubFrameBlue | SFXFrameColor::SubShadow | SFXFrameColor::SubShadowRed | SFXFrameColor::SubShadowGreen | SFXFrameColor::SubShadowAlpha | SFXFrameColor::SubShadowRGB


SFXFrameColor::SubShadowGreen
Subtract the specified value from the G value of shadow color.
[ public ]
SFXFrameColorRef SubShadowGreen(
    UInt08 param   // value to subtract from the G value
);

Reference

SFXFrameColor::AddShadowGreen | SFXFrameColor::SubGreen | SFXFrameColor::SubFrameGreen | SFXFrameColor::SubShadow | SFXFrameColor::SubShadowRed | SFXFrameColor::SubShadowBlue | SFXFrameColor::SubShadowAlpha | SFXFrameColor::SubShadowRGB


SFXFrameColor::SubShadowRGB
Subtract the specified value from the RGB value of shadow color.
[ public ]
SFXFrameColorRef SubShadowRGB(
    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 ]
SFXFrameColorRef SubShadowRGB(
    UInt08 mono   // value to subtract from the RGB value
);

Reference

SFXFrameColor::AddShadowRGB | SFXFrameColor::SubRGB | SFXFrameColor::SubFrameRGB | SFXFrameColor::SubShadow | SFXFrameColor::SubShadowRed | SFXFrameColor::SubShadowGreen | SFXFrameColor::SubShadowBlue | SFXFrameColor::SubShadowAlpha


SFXFrameColor::SubShadowRed
Subtract the specified value from the R value of shadow color.
[ public ]
SFXFrameColorRef SubShadowRed(
    UInt08 param   // value to subtract from the R value
);

Reference

SFXFrameColor::AddShadowRed | SFXFrameColor::SubRed | SFXFrameColor::SubFrameRed | SFXFrameColor::SubShadow | SFXFrameColor::SubShadowGreen | SFXFrameColor::SubShadowBlue | SFXFrameColor::SubShadowAlpha | SFXFrameColor::SubShadowRGB


SFXFrameColor::ZeroInstance
Get the instance that represents 0.
[ public, static ]
SFXFrameColorConstRef ZeroInstance(Void);

Description

This function returns the 0 instance, which means that 0 or null is set to all the member variables of its corresponding AtomRec struct.

Reference

SFXFrameColor::AtomRec


atomic_cast
Convert SFXFrameColor into SFXFrameColor::AtomRec.
[ public, friend ]
SFXFrameColor::AtomRec * atomic_cast(
    SFXFrameColor * param   // frame color to cast
);
[ public, friend ]
SFXFrameColor::AtomRec const * atomic_cast(
    SFXFrameColor const * param   // frame color to cast
);

Reference

SFXFrameColor::AtomRec


SFXFrameColor::operator=
Assign a RGBA value.
[ public ]
SFXFrameColorRef operator=(
    SFXFrameColorConstRef param   // source SFXFrameColor
);

Reference

SFXFrameColor::Set


operator==
Check the "==" relation.
[ public, friend ]
Bool operator==(
    SFXFrameColorConstRef left    // SFXFrameColor to compare
    SFXFrameColorConstRef right   // SFXFrameColor to compare
);

Return value

  • If yes: true
  • Otherwise: false

Reference

SFXFrameColor::Equals | SFXFrameColor::EqualsRGB | operator!=


SFXFrameColor::operator-=
Subtract the specified value from the RGBA value.
[ public ]
SFXFrameColorRef operator-=(
    SFXFrameColorConstRef param   // SFXFrameColor to subtract
);

Reference

SFXFrameColor::Add | SFXFrameColor::Sub | operator-


operator-
Subtract the specified value from the RGBA value.
[ public, friend ]
SFXFrameColor operator-(
    SFXFrameColorConstRef left    // SFXFrameColor to be subtracted
    SFXFrameColorConstRef right   // value to subtract from the color
);

Reference

SFXFrameColor::Add | SFXFrameColor::Sub | SFXFrameColor::operator-=


operator!=
Check the "!=" relation.
[ public, friend ]
Bool operator!=(
    SFXFrameColorConstRef left    // SFXFrameColor to compare
    SFXFrameColorConstRef right   // SFXFrameColor to compare
);

Return value

  • Not identical: true
  • Identical: false

Reference

SFXFrameColor::Equals | SFXFrameColor::EqualsRGB | operator==


SFXFrameColor::operator+=
Add the specified value to the RGBA value.
[ public ]
SFXFrameColorRef operator+=(
    SFXFrameColorConstRef param   // SFXFrameColor to add
);

Reference

SFXFrameColor::Add | SFXFrameColor::Sub | operator+


operator+
Add the specified value to the RGBA value.
[ public, friend ]
SFXFrameColor operator+(
    SFXFrameColorConstRef left    // SFXFrameColorto be added 
    SFXFrameColorConstRef right   // SFXFrameColor to add
);

Reference

SFXFrameColor::Add | SFXFrameColor::Sub | SFXFrameColor::operator+=


SFXFrameColor::AtomRec
Structure that represents the frame color (F) and shadow color (S).
struct AtomRec {
    SFXRGBColor::AtomRec        frame;   // frame color
    SFXRGBColor::AtomRec        shadow;  // shadow color
};