SFXRGBColor

RGBA カラーを表すクラスです。

#include <SFXRGBColor.h.hpp>

class SFXRGBColor;

SFMTYPEDEFCLASS(SFXRGBColor)

解説

SFXRGBColor クラスは、RGBA( Red Green Blue Alpha ）カラーを表すクラスです。

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

SFXRGBColor::AtomRec 構造体は RGBA カラーを表す構造体であり、 R（赤） / G（緑） / B（青） / A（アルファ）値を持ちます。

定数の SFXRGBColor インスタンスは、コンストラクタを呼び出すことなく、 SFXRGBColor::AtomRec 構造体を利用して高速に設定することが可能です。

	注意
	BREW の仕様により、アルファ値（A 値）を設定しても無効です。

参照

SFXRGBColor::AtomRec | SFXFrameColor | SFXBevelColor | BREW API RGBVAL

メンバ

コンストラクタ/デストラクタ
SFXRGBColor( `Void` ) SFXRGBColor クラスのコンストラクタです。
SFXRGBColor( `SFXRGBColorConstRef` param ) SFXRGBColor クラスのコンストラクタです。
SFXRGBColor( `UInt08` red , `UInt08` green , `UInt08` blue , `UInt08` alpha ) SFXRGBColor クラスのコンストラクタです。
SFXRGBColor( `UInt08` mono , `UInt08` alpha ) SFXRGBColor クラスのコンストラクタです。
SFXRGBColor( `RGBVAL` rgbval ) SFXRGBColor クラスのコンストラクタです。

パブリック関数
`SFXRGBColorRef`	Add( `SFXRGBColorConstRef` param ) この RGB カラーの RGBA 値に指定された値を加算します。
`SFXRGBColorRef`	Add( `UInt08` red , `UInt08` green , `UInt08` blue , `UInt08` alpha ) この RGB カラーの RGBA 値に指定された値を加算します。
`SFXRGBColorRef`	Add( `UInt08` mono , `UInt08` alpha ) この RGB カラーの RGBA 値に指定された値を加算します。
`SFXRGBColorRef`	AddAlpha( `UInt08` param ) この RGB カラーの A 値に指定された値を加算します。
`SFXRGBColorRef`	AddBlue( `UInt08` param ) この RGB カラーの B 値に指定された値を加算します。
`SFXRGBColorRef`	AddGreen( `UInt08` param ) この RGB カラーの G 値に指定された値を加算します。
`SFXRGBColorRef`	AddRGB( `UInt08` red , `UInt08` green , `UInt08` blue ) この RGB カラーの RGB 値に指定された値を加算します。
`SFXRGBColorRef`	AddRGB( `UInt08` mono ) この RGB カラーの RGB 値に指定された値を加算します。
`SFXRGBColorRef`	AddRed( `UInt08` param ) この RGB カラーの R 値に指定された値を加算します。
`RGBVAL`	AsRGBVAL( `Void` ) この RGB カラーを RGBVAL 型に変換した結果を取得します。
`Bool`	Equals( `SFXRGBColorConstRef` param ) この RGB カラーの RGBA 値が指定された値と等しいか判定します。
`Bool`	Equals( `UInt08` red , `UInt08` green , `UInt08` blue , `UInt08` alpha ) この RGB カラーの RGBA 値が指定された値と等しいか判定します。
`Bool`	Equals( `UInt08` mono , `UInt08` alpha ) この RGB カラーの RGBA 値が指定された値と等しいか判定します。
`Bool`	EqualsRGB( `SFXRGBColorConstRef` param ) この RGB カラーの RGB 値が指定された値と等しいか判定します。
`Bool`	EqualsRGB( `UInt08` red , `UInt08` green , `UInt08` blue ) この RGB カラーの RGB 値が指定された値と等しいか判定します。
`Bool`	EqualsRGB( `UInt08` mono ) この RGB カラーの RGB 値が指定された値と等しいか判定します。
`UInt08`	GetAlpha( `Void` ) この RGB カラーの A 値を取得します。
`UInt08`	GetBlue( `Void` ) この RGB カラーの B 値を取得します。
`UInt08`	GetBrightness( `Void` ) この RGB カラーの明度を取得します。
`UInt08`	GetGreen( `Void` ) この RGB カラーの G 値を取得します。
`UInt08`	GetRed( `Void` ) この RGB カラーの R 値を取得します。
`SFXRGBColorRef`	Set( `SFXRGBColorConstRef` param ) この RGB カラーの RGBA 値を指定された値に設定します。
`SFXRGBColorRef`	Set( `UInt08` red , `UInt08` green , `UInt08` blue , `UInt08` alpha ) この RGB カラーの RGBA 値を指定された値に設定します。
`SFXRGBColorRef`	Set( `UInt08` mono , `UInt08` alpha ) この RGB カラーの RGBA 値を指定された値に設定します。
`SFXRGBColorRef`	Set( `RGBVAL` rgbval ) この RGB カラーの RGBA 値を指定された値に設定します。
`SFXRGBColorRef`	SetAlpha( `UInt08` param ) この RGB カラーの A 値を指定された値に設定します。
`SFXRGBColorRef`	SetBlue( `UInt08` param ) この RGB カラーの B 値を指定された値に設定します。
`SFXRGBColorRef`	SetGreen( `UInt08` param ) この RGB カラーの G 値を指定された値に設定します。
`SFXRGBColorRef`	SetRGB( `UInt08` red , `UInt08` green , `UInt08` blue ) この RGB カラーの RGB 値を指定された値に設定します。
`SFXRGBColorRef`	SetRGB( `UInt08` mono ) この RGB カラーの RGB 値を指定された値に設定します。
`SFXRGBColorRef`	SetRed( `UInt08` param ) この RGB カラーの R 値を指定された値に設定します。
`SFXRGBColorRef`	Sub( `SFXRGBColorConstRef` param ) この RGB カラーの RGBA 値から指定された値を減算します。
`SFXRGBColorRef`	Sub( `UInt08` red , `UInt08` green , `UInt08` blue , `UInt08` alpha ) この RGB カラーの RGBA 値から指定された値を減算します。
`SFXRGBColorRef`	Sub( `UInt08` mono , `UInt08` alpha ) この RGB カラーの RGBA 値から指定された値を減算します。
`SFXRGBColorRef`	SubAlpha( `UInt08` param ) この RGB カラーの A 値から指定された値を減算します。
`SFXRGBColorRef`	SubBlue( `UInt08` param ) この RGB カラーの B 値から指定された値を減算します。
`SFXRGBColorRef`	SubGreen( `UInt08` param ) この RGB カラーの G 値から指定された値を減算します。
`SFXRGBColorRef`	SubRGB( `UInt08` red , `UInt08` green , `UInt08` blue ) この RGB カラーの RGB 値から指定された値を減算します。
`SFXRGBColorRef`	SubRGB( `UInt08` mono ) この RGB カラーの RGB 値から指定された値を減算します。
`SFXRGBColorRef`	SubRed( `UInt08` param ) この RGB カラーの R 値から指定された値を減算します。
static `SFXRGBColorConstRef`	ZeroInstance( `Void` ) 0 を表す SFXRGBColor インスタンスを取得します。
`SFXRGBColorRef`	operator+=( `SFXRGBColorConstRef` param ) 左側の RGB カラーに右側の RGB カラーを加算します。
`SFXRGBColorRef`	operator-=( `SFXRGBColorConstRef` param ) 左側の RGB カラーから右側の RGB カラーを減算します。
`SFXRGBColorRef`	operator=( `SFXRGBColorConstRef` param ) 左側の RGB カラーに右側の RGB カラーを代入します。
`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 ) 左側の RGB カラーが右側の RGB カラーと等しいか判定します。
`SFXRGBColor`	operator-( `SFXRGBColorConstRef` left , `SFXRGBColorConstRef` right ) 左側の RGB カラーから右側の RGB カラーを減算した RGB カラーをコピーして返します。
`Bool`	operator!=( `SFXRGBColorConstRef` left , `SFXRGBColorConstRef` right ) 左側の RGB カラーが右側の RGB カラーと異なるか判定します。
`SFXRGBColor`	operator+( `SFXRGBColorConstRef` left , `SFXRGBColorConstRef` right ) 左側の RGB カラーに右側の RGB カラーを加算した RGB カラーをコピーして返します。

型
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 ) 左側の RGB カラーが右側の RGB カラーと等しいか判定します。
`SFXRGBColor`	operator-( `SFXRGBColorConstRef` left , `SFXRGBColorConstRef` right ) 左側の RGB カラーから右側の RGB カラーを減算した RGB カラーをコピーして返します。
`Bool`	operator!=( `SFXRGBColorConstRef` left , `SFXRGBColorConstRef` right ) 左側の RGB カラーが右側の RGB カラーと異なるか判定します。
`SFXRGBColor`	operator+( `SFXRGBColorConstRef` left , `SFXRGBColorConstRef` right ) 左側の RGB カラーに右側の RGB カラーを加算した RGB カラーをコピーして返します。

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::Set 関数を呼び出して指定された値でこの RGB 色を初期設定します。

参照

SFXRGBColor::Set | BREW API RGBVAL

SFXRGBColor::Add

この RGB カラーの RGBA 値に指定された値を加算します。

[ public ]
SFXRGBColorRef Add(
    SFXRGBColorConstRef param   // 加算する RGB カラー
);

[ public ]
SFXRGBColorRef Add(
    UInt08 red     // 加算する R 値
    UInt08 green   // 加算する G 値
    UInt08 blue    // 加算する B 値
    UInt08 alpha   // 加算する A 値
);

[ public ]
SFXRGBColorRef Add(
    UInt08 mono    // 加算する RGB 値
    UInt08 alpha   // 加算する A 値
);

戻り値

この RGB カラーの RGBA 値に指定された値を加算した後のこの RGB カラー

解説

この関数は、この RGB カラーの RGBA 値に指定された値を加算します。

	注意
	R / G / B / A の各値は、0 以上 255 以下です。加算の結果、255 を超える場合は 255 になります。

	注意
	BREW の仕様により、アルファ値（A 値）を設定しても無効です。

参照

SFXRGBColor::AddAlpha

この RGB カラーの A 値に指定された値を加算します。

[ public ]
SFXRGBColorRef AddAlpha(
    UInt08 param   // 加算する値
);

戻り値

この RGB カラーの A 値に指定された値を加算した後のこの RGB カラー

解説

この関数は、この RGB カラーの A 値に指定された値を加算します。

	注意
	A 値は、0 以上 255 以下です。加算の結果、255 を超える場合は 255 になります。

	注意
	BREW の仕様により、アルファ値（A 値）を設定しても無効です。

参照

SFXRGBColor::AddBlue

この RGB カラーの B 値に指定された値を加算します。

[ public ]
SFXRGBColorRef AddBlue(
    UInt08 param   // 加算する値
);

戻り値

この RGB カラーの B 値に指定された値を加算した後のこの RGB カラー

解説

この関数は、この RGB カラーの B 値に指定された値を加算します。

	注意
	B 値は、0 以上 255 以下です。加算の結果、255 を超える場合は 255 になります。

参照

SFXRGBColor::AddGreen

この RGB カラーの G 値に指定された値を加算します。

[ public ]
SFXRGBColorRef AddGreen(
    UInt08 param   // 加算する値
);

戻り値

この RGB カラーの G 値に指定された値を加算した後のこの RGB カラー

解説

この関数は、この RGB カラーの G 値に指定された値を加算します。

	注意
	G 値は、0 以上 255 以下です。加算の結果、255 を超える場合は 255 になります。

参照

SFXRGBColor::AddRGB

この RGB カラーの RGB 値に指定された値を加算します。

[ public ]
SFXRGBColorRef AddRGB(
    UInt08 red     // 加算する R 値
    UInt08 green   // 加算する G 値
    UInt08 blue    // 加算する B 値
);

[ public ]
SFXRGBColorRef AddRGB(
    UInt08 mono   // 加算する RGB 値
);

戻り値

この RGB カラーの RGB 値に指定された値を加算した後のこの RGB カラー

解説

この関数は、この RGB カラーの RGB 値に指定された値を加算します。

	注意
	R / G / B の各値は、0 以上 255 以下です。加算の結果、255 を超える場合は 255 になります。

参照

SFXRGBColor::AddRed

この RGB カラーの R 値に指定された値を加算します。

[ public ]
SFXRGBColorRef AddRed(
    UInt08 param   // 加算する値
);

戻り値

この RGB カラーの R 値に指定された値を加算した後のこの RGB カラー

解説

この関数は、この RGB カラーの R 値に指定された値を加算します。

	注意
	R 値は、0 以上 255 以下です。加算の結果、255 を超える場合は 255 になります。

参照

SFXRGBColor::AsRGBVAL

この RGB カラーを RGBVAL 型に変換した結果を取得します。

[ public, const ]
RGBVAL AsRGBVAL(Void);

戻り値

この RGB カラーを BREW API RGBVAL 型に変換した結果

解説

この関数は、この RGB カラーを BREW API RGBVAL 型に変換した結果を取得します。

参照

BREW API RGBVAL

SFXRGBColor::Equals

この RGB カラーの RGBA 値が指定された値と等しいか判定します。

[ public, const ]
Bool Equals(
    SFXRGBColorConstRef param   // 比較対象の RGB カラー
);

[ 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

解説

この関数は、この RGB カラーの RGBA 値が指定された値と等しいか判定します。

	注意
	BREW の仕様により、アルファ値（A 値）を設定しても無効です。

参照

SFXRGBColor::EqualsRGB | operator== | operator!= | BREW API RGBVAL

SFXRGBColor::EqualsRGB

この RGB カラーの RGB 値が指定された値と等しいか判定します。

[ public, const ]
Bool EqualsRGB(
    SFXRGBColorConstRef param   // 比較対象の RGB カラー
);

[ public, const ]
Bool EqualsRGB(
    UInt08 red     // 比較する R 値
    UInt08 green   // 比較する G 値
    UInt08 blue    // 比較する B 値
);

[ public, const ]
Bool EqualsRGB(
    UInt08 mono   // 比較する RGB 値
);

戻り値

等しいとき: true
そうでないとき: false

解説

この関数は、この RGB カラーの RGB 値が指定された値と等しいか判定します。

参照

SFXRGBColor::Equals | BREW API RGBVAL

SFXRGBColor::GetAlpha

この RGB カラーの A 値を取得します。

[ public, const ]
UInt08 GetAlpha(Void);

戻り値

この RGB カラーの A 値

解説

この関数は、この RGB カラーの A 値を取得します。

	注意
	BREW の仕様により、アルファ値（A 値）を設定しても無効です。

参照

SFXRGBColor::SetAlpha | SFXRGBColor::GetBlue | SFXRGBColor::GetGreen | SFXRGBColor::GetRed | BREW API RGBVAL

SFXRGBColor::GetBlue

この RGB カラーの B 値を取得します。

[ public, const ]
UInt08 GetBlue(Void);

戻り値

この RGB カラーの B 値

解説

この関数は、この RGB カラーの B 値を取得します。

参照

SFXRGBColor::SetBlue | SFXRGBColor::GetAlpha | SFXRGBColor::GetGreen | SFXRGBColor::GetRed | BREW API RGBVAL

SFXRGBColor::GetBrightness

この RGB カラーの明度を取得します。

[ public, const ]
UInt08 GetBrightness(Void);

戻り値

0x00 ～ 0xFF の範囲の明度を返します。(白色の明度は 0xFF、黒色の明度は 0x00 です。)

解説

この関数は、この RGB カラーの RGB 色を YCrCb 色に変換し、その Y 値(明るさ)を返します。

RGB 色と YCrCb 色の相互変換の式は以下の通りです(内部的には、パフォーマンスを劣化させないよう整数演算で実装しています)。

Y の値が 0x00 以下の場合は 0x00 を返し、Y の値が 0xFF 以上の場合は 0xFF を返します。

// RGB 色から YCrCb 色への変換式
Y  =  0.29900×R + 0.58700×G + 0.11400×B
Cr =  0.50000×R - 0.41869×G - 0.08131×B
Cb = -0.16874×R - 0.33126×G + 0.50000×B

// YCrCb 色から RGB 色への変換式
R  = Y                 + 1.40200×Cr
G  = Y - 0.34414×Cb - 0.71414×Cr
B  = Y + 1.77200×Cb

SFXRGBColor::GetGreen

この RGB カラーの G 値を取得します。

[ public, const ]
UInt08 GetGreen(Void);

戻り値

この RGB カラーの G 値

解説

この関数は、この RGB カラーの G 値を取得します。

参照

SFXRGBColor::SetGreen | SFXRGBColor::GetAlpha | SFXRGBColor::GetBlue | SFXRGBColor::GetRed | BREW API RGBVAL

SFXRGBColor::GetRed

この RGB カラーの R 値を取得します。

[ public, const ]
UInt08 GetRed(Void);

戻り値

この RGB カラーの R 値

解説

この関数は、この RGB カラーの R 値を取得します。

参照

SFXRGBColor::SetRed | SFXRGBColor::GetAlpha | SFXRGBColor::GetBlue | SFXRGBColor::GetGreen | BREW API RGBVAL

SFXRGBColor::Set

この RGB カラーの 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 型のカラー
);

戻り値

指定された値に設定した後のこの RGB カラー

解説

この関数は、この RGB カラーの RGBA 値を指定された値に設定します。

参照

SFXRGBColor::SetAlpha

この RGB カラーの A 値を指定された値に設定します。

[ public ]
SFXRGBColorRef SetAlpha(
    UInt08 param   // A 値
);

戻り値

指定された値に設定した後のこの RGB カラー

解説

この関数は、この RGB カラーの A 値を指定された値に設定します。

	注意
	BREW の仕様により、アルファ値（A 値）を設定しても無効です。

参照

SFXRGBColor::SetBlue

この RGB カラーの B 値を指定された値に設定します。

[ public ]
SFXRGBColorRef SetBlue(
    UInt08 param   // B 値
);

戻り値

指定された値に設定した後のこの RGB カラー

解説

この関数は、この RGB カラーの B 値を指定された値に設定します。

参照

SFXRGBColor::SetGreen

この RGB カラーの G 値を指定された値に設定します。

[ public ]
SFXRGBColorRef SetGreen(
    UInt08 param   // G 値
);

戻り値

指定された値に設定した後のこの RGB カラー

解説

この関数は、この RGB カラーの G 値を指定された値に設定します。

参照

SFXRGBColor::SetRGB

この RGB カラーの RGB 値を指定された値に設定します。

[ public ]
SFXRGBColorRef SetRGB(
    UInt08 red     // R 値
    UInt08 green   // G 値
    UInt08 blue    // B 値
);

[ public ]
SFXRGBColorRef SetRGB(
    UInt08 mono   // RGB 値
);

戻り値

指定された値に設定した後のこの RGB カラー

解説

この関数は、この RGB カラーの RGB 値を指定された値に設定します。

参照

SFXRGBColor::SetRed

この RGB カラーの R 値を指定された値に設定します。

[ public ]
SFXRGBColorRef SetRed(
    UInt08 param   // R 値
);

戻り値

指定された値に設定した後のこの RGB カラー

解説

この関数は、この RGB カラーの R 値を指定された値に設定します。

参照

SFXRGBColor::Sub

この RGB カラーの 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 値
);

戻り値

この RGB カラーの RGBA 値から指定された値を減算した後のこの RGB カラー

解説

この関数は、この RGB カラーの RGBA 値から指定された値を減算します。

	注意
	R / G / B / A の各値は、0 以上 255 以下です。減算の結果、0 を下回る場合は 0 になります。

	注意
	BREW の仕様により、アルファ値（A 値）を設定しても無効です。

参照

SFXRGBColor::SubAlpha

この RGB カラーの A 値から指定された値を減算します。

[ public ]
SFXRGBColorRef SubAlpha(
    UInt08 param   // 減算する値
);

戻り値

この RGB カラーの A 値から指定された値を減算した後のこの RGB カラー

解説

この関数は、この RGB カラーの A 値から指定された値を減算します。

	注意
	A 値は、0 以上 255 以下です。減算の結果、0 を下回る場合は 0 になります。

	注意
	BREW の仕様により、アルファ値（A 値）を設定しても無効です。

参照

SFXRGBColor::SubBlue

この RGB カラーの B 値から指定された値を減算します。

[ public ]
SFXRGBColorRef SubBlue(
    UInt08 param   // 減算する値
);

戻り値

この RGB カラーの B 値から指定された値を減算した後のこの RGB カラー

解説

この関数は、この RGB カラーの B 値から指定された値を減算します。

	注意
	B 値は、0 以上 255 以下です。減算の結果、0 を下回る場合は 0 になります。

参照

SFXRGBColor::SubGreen

この RGB カラーの G 値から指定された値を減算します。

[ public ]
SFXRGBColorRef SubGreen(
    UInt08 param   // 減算する値
);

戻り値

この RGB カラーの G 値から指定された値を減算した後のこの RGB カラー

解説

この関数は、この RGB カラーの G 値から指定された値を減算します。

	注意
	G 値は、0 以上 255 以下です。減算の結果、0 を下回る場合は 0 になります。

参照

SFXRGBColor::SubRGB

この RGB カラーの RGB 値から指定された値を減算します。

[ public ]
SFXRGBColorRef SubRGB(
    UInt08 red     // 減算する R 値
    UInt08 green   // 減算する G 値
    UInt08 blue    // 減算する B 値
);

[ public ]
SFXRGBColorRef SubRGB(
    UInt08 mono   // RGB 値から減算する値
);

戻り値

この RGB カラーの RGB 値から指定された値を減算した後のこの RGB カラー

解説

この関数は、この RGB カラーの RGB 値から指定された値を減算します。

	注意
	R / G / B 値は、0 以上 255 以下です。減算の結果、0 を下回る場合は 0 になります。

参照

SFXRGBColor::SubRed

この RGB カラーの R 値から指定された値を減算します。

[ public ]
SFXRGBColorRef SubRed(
    UInt08 param   // 減算する値
);

戻り値

この RGB カラーの R 値から指定された値を減算した後のこの RGB カラー

解説

この関数は、この RGB カラーの R 値から指定された値を減算します。

	注意
	R 値は、0 以上 255 以下です。減算の結果、0 を下回る場合は 0 になります。

参照

SFXRGBColor::ZeroInstance

0 を表す SFXRGBColor インスタンスを取得します。

[ public, static ]
SFXRGBColorConstRef ZeroInstance(Void);

戻り値

0 を表す SFXRGBColor インスタンス

解説

この関数は、0 を表す SFXRGBColor インスタンスを返します。

	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 クラスを SFXRGBColor::AtomRec 構造体に型変換します。

参照

SFXRGBColor::AtomRec

SFXRGBColor::operator=

左側の RGB カラーに右側の RGB カラーを代入します。

[ public ]
SFXRGBColorRef operator=(
    SFXRGBColorConstRef param   // 設定する RGB カラー
);

戻り値

右側の RGB カラーを代入した左側の RGB カラー

解説

このオペレーターは、左側の RGB カラーに右側の RGB カラーを代入します。

	注意
	このオペレーターは左側の RGB カラーに影響を及ぼします。

参照

SFXRGBColor::Set | BREW API RGBVAL

operator==

左側の RGB カラーが右側の RGB カラーと等しいか判定します。

[ public, friend ]
Bool operator==(
    SFXRGBColorConstRef left    // 左側の RGB カラー
    SFXRGBColorConstRef right   // 右側の RGB カラー
);

戻り値

等しいとき: true
そうでないとき: false

解説

このオペレーターは、左側の RGB カラーが右側の RGB カラーと等しいか判定します。

参照

SFXRGBColor::Equals | operator!= | BREW API RGBVAL

SFXRGBColor::operator-=

左側の RGB カラーから右側の RGB カラーを減算します。

[ public ]
SFXRGBColorRef operator-=(
    SFXRGBColorConstRef param   // 右側の RGB カラー
);

戻り値

右側の RGB カラーを減算した後の左側の RGB カラー

解説

このオペレーターは、左側の RGB カラーから右側の RGB カラーを減算します。

	注意
	R / G / B / A の各値は、0 以上 255 以下です。減算の結果、0 を下回る場合は 0 になります。

	注意
	BREW の仕様により、アルファ値（A 値）を設定しても無効です。

	注意
	このオペレーターは左側の RGB カラーに影響を及ぼします。

参照

SFXRGBColor::Sub | operator- | BREW API RGBVAL

operator-

左側の RGB カラーから右側の RGB カラーを減算した RGB カラーをコピーして返します。

[ public, friend ]
SFXRGBColor operator-(
    SFXRGBColorConstRef left    // 左側の RGB カラー
    SFXRGBColorConstRef right   // 右側の RGB カラー
);

戻り値

左側の RGB カラーから右側の RGB カラーを減算した RGB カラー

解説

このオペレーターは、左側の RGB カラーから右側の RGB カラーを減算した RGB カラーをコピーして返します。

	注意
	R / G / B / A の各値は、0 以上 255 以下です。減算の結果、0 を下回る場合は 0 になります。

	注意
	BREW の仕様により、アルファ値（A 値）を設定しても無効です。

	注意
	このオペレーターは左側の RGB カラーに影響を及ぼしません。

参照

SFXRGBColor::Sub | SFXRGBColor::operator-= | BREW API RGBVAL

operator!=

左側の RGB カラーが右側の RGB カラーと異なるか判定します。

[ public, friend ]
Bool operator!=(
    SFXRGBColorConstRef left    // 左側の RGB カラー
    SFXRGBColorConstRef right   // 右側の RGB カラー
);

戻り値

異なるとき: true
そうでないとき: false

解説

このオペレーターは、左側の RGB カラーが右側の RGB カラーと異なるか判定します。

参照

SFXRGBColor::Equals | operator== | BREW API RGBVAL

SFXRGBColor::operator+=

左側の RGB カラーに右側の RGB カラーを加算します。

[ public ]
SFXRGBColorRef operator+=(
    SFXRGBColorConstRef param   // 右側の RGB カラー
);

戻り値

右側の RGB カラーを加算した後の左側の RGB カラー

解説

このオペレーターは、左側の RGB カラーに右側の RGB カラーを加算します。

	注意
	R / G / B / A の各値は、0 以上 255 以下です。加算の結果、255 を超える場合は 255 になります。

	注意
	BREW の仕様により、アルファ値（A 値）を設定しても無効です。

	注意
	このオペレーターは左側の RGB カラーに影響を及ぼします。

参照

SFXRGBColor::Add | operator+ | BREW API RGBVAL

operator+

左側の RGB カラーに右側の RGB カラーを加算した RGB カラーをコピーして返します。

[ public, friend ]
SFXRGBColor operator+(
    SFXRGBColorConstRef left    // 左側の RGB カラー
    SFXRGBColorConstRef right   // 左側の RGB カラー
);

戻り値

左側の RGB カラーから右側の RGB カラーを減算した RGB カラー

解説

このオペレーターは、左側の RGB カラーに右側の RGB カラーを加算した RGB カラーをコピーして返します。

	注意
	R / G / B / A の各値は、0 以上 255 以下です。加算の結果、255 を超える場合は 255 になります。

	注意
	BREW の仕様により、アルファ値（A 値）を設定しても無効です。

	注意
	このオペレーターは左側の RGB カラーに影響を及ぼしません。

参照

SFXRGBColor::Add | SFXRGBColor::operator+= | BREW API RGBVAL

SFXRGBColor::AtomRec

RGBA カラーを表す構造体です。

struct AtomRec {
    UInt08     alpha;  // A（アルファ）値
    UInt08     red;    // R（赤色）値
    UInt08     green;  // G（緑色）値
    UInt08     blue;   // B（青色）値
};