前のページ次のページ上に戻るホーム BREW C++ ライブラリ & GUI フレームワーク & XML ミドルウェア : SophiaFramework UNIVERSE 5.0
SFXRGBColor
RGBA カラーを表すクラスです。
#include <SFXRGBColor.h.hpp>
class SFXRGBColor;
SFMTYPEDEFCLASS(SFXRGBColor)

解説

SFXRGBColor クラスは RGBA( Red Green Blue Alpha )カラーを表します。

SFXRGBColor クラスの関数では、演算結果のカラー値が 255 を超える場合は 255 に、0 を下回る場合は 0 に、それぞれ設定されます。

参照

SFXFrameColor | SFXBevelColor

メンバ

コンストラクタ/デストラクタ
SFXRGBColor( Void )
SFXRGBColor( SFXRGBColorConstRef param )
SFXRGBColor( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
SFXRGBColor( UInt08 mono , UInt08 alpha )
SFXRGBColor( RGBVAL rgbval )
SFXRGBColor クラスのコンストラクタです。
パブリック関数
SFXRGBColorRef Add( SFXRGBColorConstRef param )
Add( UInt08 mono , UInt08 alpha )
Add( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
RGBA 値を加算します。
SFXRGBColorRef AddAlpha( UInt08 param )
A 値を加算します。
SFXRGBColorRef AddBlue( UInt08 param )
B 値を加算します。
SFXRGBColorRef AddGreen( UInt08 param )
G 値を加算します。
SFXRGBColorRef AddRGB( UInt08 red , UInt08 green , UInt08 blue )
AddRGB( UInt08 mono )
RGB 値を加算します。
SFXRGBColorRef AddRed( UInt08 param )
R 値を加算します。
RGBVAL AsRGBVAL( Void )
RGBVAL に変換します。
Bool Equals( SFXRGBColorConstRef param )
Equals( UInt08 mono , UInt08 alpha )
Equals( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
指定したカラーの RGBA 値と等しいか判定します。
Bool EqualsRGB( SFXRGBColorConstRef param )
EqualsRGB( UInt08 mono )
EqualsRGB( UInt08 red , UInt08 green , UInt08 blue )
指定したカラーの RGB 値と等しいか判定します。
UInt08 GetAlpha( Void )
A 値を取得します。
UInt08 GetBlue( Void )
B 値を取得します。
UInt08 GetGreen( Void )
G 値を取得します。
UInt08 GetRed( Void )
R 値を取得します。
SFXRGBColorRef Set( SFXRGBColorConstRef param )
Set( RGBVAL rgbval )
Set( UInt08 mono , UInt08 alpha )
Set( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
RGBA 値を設定します。
SFXRGBColorRef SetAlpha( UInt08 param )
A 値を設定します。
SFXRGBColorRef SetBlue( UInt08 param )
B 値を設定します。
SFXRGBColorRef SetGreen( UInt08 param )
G 値を設定します。
SFXRGBColorRef SetRGB( UInt08 red , UInt08 green , UInt08 blue )
SetRGB( UInt08 mono )
RGB 値を設定します。
SFXRGBColorRef SetRed( UInt08 param )
R 値を設定します。
SFXRGBColorRef Sub( SFXRGBColorConstRef param )
Sub( UInt08 mono , UInt08 alpha )
Sub( UInt08 red , UInt08 green , UInt08 blue , UInt08 alpha )
RGBA 値を減算します。
SFXRGBColorRef SubAlpha( UInt08 param )
A 値を減算します。
SFXRGBColorRef SubBlue( UInt08 param )
B 値を減算します。
SFXRGBColorRef SubGreen( UInt08 param )
G 値を減算します。
SFXRGBColorRef SubRGB( UInt08 red , UInt08 green , UInt08 blue )
SubRGB( UInt08 mono )
RGB 値を減算します。
SFXRGBColorRef SubRed( UInt08 param )
R 値を減算します。
static
SFXRGBColorConstRef
ZeroInstance( Void )
0 を表すインスタンスを取得します。
SFXRGBColorRef operator+=( SFXRGBColorConstRef param )
RGBA 値を加算します。
SFXRGBColorRef operator-=( SFXRGBColorConstRef param )
RGBA 値を減算します。
SFXRGBColorRef operator=( SFXRGBColorConstRef param )
RGBA 値を代入します。
SFXRGBColor::AtomRec * atomic_cast( SFXRGBColor * param )
SFXRGBColor を SFXRGBColor::AtomRec に変換します。
SFXRGBColor::AtomRec const * atomic_cast( SFXRGBColor const * param )
SFXRGBColor を SFXRGBColor::AtomRec に変換します。
Bool operator==( SFXRGBColorConstRef left , SFXRGBColorConstRef right )
== の関係を判定します。
SFXRGBColor operator-( SFXRGBColorConstRef left , SFXRGBColorConstRef right )
RGBA 値を減算します。
Bool operator!=( SFXRGBColorConstRef left , SFXRGBColorConstRef right )
!= の関係を判定します。
SFXRGBColor operator+( SFXRGBColorConstRef left , SFXRGBColorConstRef right )
RGBA 値を加算します。
AtomRec
RGBA カラーを表す構造体です。
グローバル関数
SFXRGBColor::AtomRec * atomic_cast( SFXRGBColor * param )
SFXRGBColor を SFXRGBColor::AtomRec に変換します。
SFXRGBColor::AtomRec const * atomic_cast( SFXRGBColor const * param )
SFXRGBColor を SFXRGBColor::AtomRec に変換します。
Bool operator==( SFXRGBColorConstRef left , SFXRGBColorConstRef right )
== の関係を判定します。
SFXRGBColor operator-( SFXRGBColorConstRef left , SFXRGBColorConstRef right )
RGBA 値を減算します。
Bool operator!=( SFXRGBColorConstRef left , SFXRGBColorConstRef right )
!= の関係を判定します。
SFXRGBColor operator+( SFXRGBColorConstRef left , SFXRGBColorConstRef right )
RGBA 値を加算します。

SFXRGBColor::SFXRGBColor
SFXRGBColor クラスのコンストラクタです。
[ public, explicit ]
SFXRGBColor(Void);
[ public ]
SFXRGBColor(
    SFXRGBColorConstRef param   // コピー元のカラー
);
[ public, explicit ]
SFXRGBColor(
    UInt08 red     // R 値
    UInt08 green   // G 値
    UInt08 blue    // B 値
    UInt08 alpha   // A 値
);
[ public, explicit ]
SFXRGBColor(
    UInt08 mono    // RGB 値
    UInt08 alpha   // A 値
);
[ public, explicit ]
SFXRGBColor(
    RGBVAL rgbval   // RGBVAL 型のカラー
);

SFXRGBColor::Add
RGBA 値を加算します。
[ public ]
SFXRGBColorRef Add(
    SFXRGBColorConstRef param   // 加算するカラー
);
[ public ]
SFXRGBColorRef Add(
    UInt08 red     // 加算する R 値
    UInt08 green   // 加算する G 値
    UInt08 blue    // 加算する B 値
    UInt08 alpha   // 加算する A 値
);
[ public ]
SFXRGBColorRef Add(
    UInt08 mono    // 加算する RGB 値
    UInt08 alpha   // 加算する A 値
);

参照

SFXRGBColor::AddAlpha | SFXRGBColor::AddBlue | SFXRGBColor::AddGreen | SFXRGBColor::AddRed | SFXRGBColor::AddRGB


SFXRGBColor::AddAlpha
A 値を加算します。
[ public ]
SFXRGBColorRef AddAlpha(
    UInt08 param   // 加算する A 値
);

参照

SFXRGBColor::Add | SFXRGBColor::AddBlue | SFXRGBColor::AddGreen | SFXRGBColor::AddRed | SFXRGBColor::AddRGB


SFXRGBColor::AddBlue
B 値を加算します。
[ public ]
SFXRGBColorRef AddBlue(
    UInt08 param   // 加算する B 値
);

参照

SFXRGBColor::Add | SFXRGBColor::AddAlpha | SFXRGBColor::AddGreen | SFXRGBColor::AddRed | SFXRGBColor::AddRGB | SFXRGBColor::SubBlue


SFXRGBColor::AddGreen
G 値を加算します。
[ public ]
SFXRGBColorRef AddGreen(
    UInt08 param   // 加算する G 値
);

参照

SFXRGBColor::Add | SFXRGBColor::AddAlpha | SFXRGBColor::AddBlue | SFXRGBColor::AddRed | SFXRGBColor::AddRGB | SFXRGBColor::SubRed


SFXRGBColor::AddRGB
RGB 値を加算します。
[ public ]
SFXRGBColorRef AddRGB(
    UInt08 red     // 加算する R 値
    UInt08 green   // 加算する G 値
    UInt08 blue    // 加算する B 値
);
[ public ]
SFXRGBColorRef AddRGB(
    UInt08 mono   // 加算する RGB 値
);

参照

SFXRGBColor::Add | SFXRGBColor::AddAlpha | SFXRGBColor::AddBlue | SFXRGBColor::AddGreen | SFXRGBColor::AddRed


SFXRGBColor::AddRed
R 値を加算します。
[ public ]
SFXRGBColorRef AddRed(
    UInt08 param   // 加算する R 値
);

参照

SFXRGBColor::Add | SFXRGBColor::AddAlpha | SFXRGBColor::AddBlue | SFXRGBColor::AddGreen | SFXRGBColor::AddRGB | SFXRGBColor::SubGreen


SFXRGBColor::AsRGBVAL
RGBVAL に変換します。
[ public, const ]
RGBVAL AsRGBVAL(Void);

SFXRGBColor::Equals
指定したカラーの RGBA 値と等しいか判定します。
[ public, const ]
Bool Equals(
    SFXRGBColorConstRef param   // 比較対象のカラー
);
[ public, const ]
Bool Equals(
    UInt08 red     // 比較する R 値
    UInt08 green   // 比較する G 値
    UInt08 blue    // 比較する B 値
    UInt08 alpha   // 比較する A 値
);
[ public, const ]
Bool Equals(
    UInt08 mono    // 比較する RGB 値
    UInt08 alpha   // 比較する A 値
);

戻り値

  • 等しいとき: true
  • 異なるとき : false

参照

SFXRGBColor::EqualsRGB | operator== | operator!=


SFXRGBColor::EqualsRGB
指定したカラーの RGB 値と等しいか判定します。
[ public, const ]
Bool EqualsRGB(
    SFXRGBColorConstRef param   // 比較対象のカラー
);
[ public, const ]
Bool EqualsRGB(
    UInt08 red     // 比較する R 値
    UInt08 green   // 比較する G 値
    UInt08 blue    // 比較する B 値
);
[ public, const ]
Bool EqualsRGB(
    UInt08 mono   // 比較する RGB 値
);

戻り値

  • 等しいとき : true
  • 異なるとき : false

参照

SFXRGBColor::Equals


SFXRGBColor::GetAlpha
A 値を取得します。
[ public, const ]
UInt08 GetAlpha(Void);

参照

SFXRGBColor::GetBlue | SFXRGBColor::GetGreen | SFXRGBColor::GetRed | SFXRGBColor::SetAlpha


SFXRGBColor::GetBlue
B 値を取得します。
[ public, const ]
UInt08 GetBlue(Void);

参照

SFXRGBColor::GetAlpha | SFXRGBColor::GetGreen | SFXRGBColor::GetRed | SFXRGBColor::SetBlue


SFXRGBColor::GetGreen
G 値を取得します。
[ public, const ]
UInt08 GetGreen(Void);

参照

SFXRGBColor::GetAlpha | SFXRGBColor::GetBlue | SFXRGBColor::GetRed | SFXRGBColor::SetGreen


SFXRGBColor::GetRed
R 値を取得します。
[ public, const ]
UInt08 GetRed(Void);

参照

SFXRGBColor::GetAlpha | SFXRGBColor::GetBlue | SFXRGBColor::GetGreen | SFXRGBColor::SetRed


SFXRGBColor::Set
RGBA 値を設定します。
[ public ]
SFXRGBColorRef Set(
    SFXRGBColorConstRef param   // 設定するカラー
);
[ public ]
SFXRGBColorRef Set(
    UInt08 red     // R 値
    UInt08 green   // G 値
    UInt08 blue    // B 値
    UInt08 alpha   // A 値
);
[ public ]
SFXRGBColorRef Set(
    UInt08 mono    // RGB 値
    UInt08 alpha   // A 値
);
[ public ]
SFXRGBColorRef Set(
    RGBVAL rgbval   // 設定する RGBVAL 型のカラー
);

参照

SFXRGBColor::SFXRGBColor | SFXRGBColor::GetAlpha | SFXRGBColor::GetBlue | SFXRGBColor::GetGreen | SFXRGBColor::GetRed | SFXRGBColor::SetAlpha | SFXRGBColor::SetBlue | SFXRGBColor::SetGreen | SFXRGBColor::SetRed | SFXRGBColor::SetRGB | SFXRGBColor::operator=


SFXRGBColor::SetAlpha
A 値を設定します。
[ public ]
SFXRGBColorRef SetAlpha(
    UInt08 param   // A 値
);

参照

SFXRGBColor::GetAlpha | SFXRGBColor::Set | SFXRGBColor::SetBlue | SFXRGBColor::SetGreen | SFXRGBColor::SetRed | SFXRGBColor::SetRGB


SFXRGBColor::SetBlue
B 値を設定します。
[ public ]
SFXRGBColorRef SetBlue(
    UInt08 param   // B 値
);

参照

SFXRGBColor::GetBlue | SFXRGBColor::Set | SFXRGBColor::SetAlpha | SFXRGBColor::SetGreen | SFXRGBColor::SetRed | SFXRGBColor::SetRGB


SFXRGBColor::SetGreen
G 値を設定します。
[ public ]
SFXRGBColorRef SetGreen(
    UInt08 param   // G 値
);

参照

SFXRGBColor::GetGreen | SFXRGBColor::Set | SFXRGBColor::SetAlpha | SFXRGBColor::SetBlue | SFXRGBColor::SetRed | SFXRGBColor::SetRGB


SFXRGBColor::SetRGB
RGB 値を設定します。
[ public ]
SFXRGBColorRef SetRGB(
    UInt08 red     // R 値
    UInt08 green   // G 値
    UInt08 blue    // B 値
);
[ public ]
SFXRGBColorRef SetRGB(
    UInt08 mono   // RGB 値
);

参照

SFXRGBColor::SFXRGBColor | SFXRGBColor::GetBlue | SFXRGBColor::GetGreen | SFXRGBColor::GetRed | SFXRGBColor::Set | SFXRGBColor::SetAlpha


SFXRGBColor::SetRed
R 値を設定します。
[ public ]
SFXRGBColorRef SetRed(
    UInt08 param   // R 値
);

参照

SFXRGBColor::GetRed | SFXRGBColor::Set | SFXRGBColor::SetAlpha | SFXRGBColor::SetBlue | SFXRGBColor::SetGreen | SFXRGBColor::SetRGB


SFXRGBColor::Sub
RGBA 値を減算します。
[ public ]
SFXRGBColorRef Sub(
    SFXRGBColorConstRef param   // 減算するカラー
);
[ public ]
SFXRGBColorRef Sub(
    UInt08 red     // R 値
    UInt08 green   // G 値
    UInt08 blue    // B 値
    UInt08 alpha   // A 値
);
[ public ]
SFXRGBColorRef Sub(
    UInt08 mono    // RGB 値
    UInt08 alpha   // A 値
);

参照

SFXRGBColor::SubAlpha | SFXRGBColor::SubRGB | operator-


SFXRGBColor::SubAlpha
A 値を減算します。
[ public ]
SFXRGBColorRef SubAlpha(
    UInt08 param   // 減算する A 値
);

参照

SFXRGBColor::Sub | SFXRGBColor::SubBlue | SFXRGBColor::SubGreen | SFXRGBColor::SubRed | SFXRGBColor::SubRGB


SFXRGBColor::SubBlue
B 値を減算します。
[ public ]
SFXRGBColorRef SubBlue(
    UInt08 param   // 減算する B 値
);

参照

SFXRGBColor::AddBlue | SFXRGBColor::Sub | SFXRGBColor::SubAlpha | SFXRGBColor::SubGreen | SFXRGBColor::SubRed | SFXRGBColor::SubRGB


SFXRGBColor::SubGreen
G 値を減算します。
[ public ]
SFXRGBColorRef SubGreen(
    UInt08 param   // 減算する G 値
);

参照

SFXRGBColor::AddGreen | SFXRGBColor::Sub | SFXRGBColor::SubAlpha | SFXRGBColor::SubBlue | SFXRGBColor::SubRed | SFXRGBColor::SubRGB


SFXRGBColor::SubRGB
RGB 値を減算します。
[ public ]
SFXRGBColorRef SubRGB(
    UInt08 red     // 減算する R 値
    UInt08 green   // 減算する G 値
    UInt08 blue    // 減算する B 値
);
[ public ]
SFXRGBColorRef SubRGB(
    UInt08 mono   // RGB 値から減算する値
);

参照

SFXRGBColor::Sub | SFXRGBColor::SubAlpha | SFXRGBColor::SubBlue | SFXRGBColor::SubGreen | SFXRGBColor::SubRed


SFXRGBColor::SubRed
R 値を減算します。
[ public ]
SFXRGBColorRef SubRed(
    UInt08 param   // 減算する R 値
);

参照

SFXRGBColor::AddRed | SFXRGBColor::Sub | SFXRGBColor::SubAlpha | SFXRGBColor::SubBlue | SFXRGBColor::SubGreen | SFXRGBColor::SubRGB


SFXRGBColor::ZeroInstance
0 を表すインスタンスを取得します。
[ public, static ]
SFXRGBColorConstRef ZeroInstance(Void);

解説

RGBA カラーの変数の値が 0 であるインスタンスを返します。

[Note] 0 を表すインスタンスとは

0 を表すインスタンスとは、対応する AtomRec 構造体のすべてのメンバ変数が 0 または null に設定されたインスタンスのことです。

参照

SFXRGBColor::AtomRec


atomic_cast
SFXRGBColor を SFXRGBColor::AtomRec に変換します。
[ public, friend ]
SFXRGBColor::AtomRec * atomic_cast(
    SFXRGBColor * param   // キャストする RGB カラー
);
[ public, friend ]
SFXRGBColor::AtomRec const * atomic_cast(
    SFXRGBColor const * param   // キャストする RGB カラー
);

参照

SFXRGBColor::AtomRec


SFXRGBColor::operator=
RGBA 値を代入します。
[ public ]
SFXRGBColorRef operator=(
    SFXRGBColorConstRef param   // 設定するカラー
);

参照

SFXRGBColor::Set


operator==
== の関係を判定します。
[ public, friend ]
Bool operator==(
    SFXRGBColorConstRef left    // 比較するカラー
    SFXRGBColorConstRef right   // 比較するカラー
);

戻り値

  • 等しいとき : true
  • 異なるとき : false

参照

SFXRGBColor::Equals | operator!=


SFXRGBColor::operator-=
RGBA 値を減算します。
[ public ]
SFXRGBColorRef operator-=(
    SFXRGBColorConstRef param   // 減算するカラー
);

参照

SFXRGBColor::Sub


operator-
RGBA 値を減算します。
[ public, friend ]
SFXRGBColor operator-(
    SFXRGBColorConstRef left    // 減算されるカラー
    SFXRGBColorConstRef right   // 減算するカラー
);

参照

SFXRGBColor::Sub


operator!=
!= の関係を判定します。
[ public, friend ]
Bool operator!=(
    SFXRGBColorConstRef left    // 比較するカラー
    SFXRGBColorConstRef right   // 比較するカラー
);

戻り値

  • 異なるとき : true
  • 等しいとき : false

参照

SFXRGBColor::Equals | operator==


SFXRGBColor::operator+=
RGBA 値を加算します。
[ public ]
SFXRGBColorRef operator+=(
    SFXRGBColorConstRef param   // 加算するカラー
);

参照

SFXRGBColor::Add


operator+
RGBA 値を加算します。
[ public, friend ]
SFXRGBColor operator+(
    SFXRGBColorConstRef left    // 加算されるカラー
    SFXRGBColorConstRef right   // 加算するカラー
);

参照

SFXRGBColor::Add


SFXRGBColor::AtomRec
RGBA カラーを表す構造体です。
struct AtomRec {
    UInt08                      alpha;  // A 値
    UInt08                      red;    // R 値
    UInt08                      green;  // G 値
    UInt08                      blue;   // B 値
};