前のページ次のページ上に戻るホーム SophiaFramework 2.1
SFUColor
RGBA カラーを表すクラスです。
#include <SFUColor.hpp>
class SFUColor;
typedef SFUColor&          SFUColorRef;
typedef SFUColor*          SFUColorPtr;
typedef SFUColor**         SFUColorHandle;
typedef const SFUColor     ConstSFUColor;
typedef const SFUColor&    ConstSFUColorRef;
typedef const SFUColor*    ConstSFUColorPtr;
typedef const SFUColor**   ConstSFUColorHandle;

解説

SFUColor は RGBA カラーを表すクラスです。 カラーを操作するための関数が定義されています。

参照

SFUColor3D | SFUShadow3D

メンバ

コンストラクタ/デストラクタ
public
SFUColor SFUColor クラスのコンストラクタです。
public
~SFUColor SFUColor のデストラクタです。
パブリック関数
public
A カラーのアルファ値を取得/設定します。
public
AddAlpha アルファ値に値を加算します。
public
AddRgb RGB 値に値を加算します。
public
Alpha カラーのアルファ値を設定します。
public
B カラーの B 値を取得/設定します。
public
Equal 2 つのカラーが等しいか判定します。
public
EqualAlpha 2 つのカラーのアルファ値が等しいか判定します。
public
EqualRgb 2 つのカラーの RGB 値が等しいか判定します。
public
G カラーの G 値を取得/設定します。
public
R カラーの R 値を取得/設定します。
public
Rgb カラーの RGB 値を設定します。
public
Set カラーの各要素を設定します。
public
SubAlpha アルファ値から値を減算します。
public
SubRgb RGB 値から値を減算します。
public
operator RGBVAL SFUColor を RGBVAL に変換した値を返します。
public
operator+ カラーの各要素を加算します。
public
operator- カラーの各要素を減算します。
public
operator== 2 つのカラーが等しいか判定します。

SFUColor::SFUColor
SFUColor クラスのコンストラクタです。
[ public ]
SFUColor(Void);
[ public ]
SFUColor(
    SFUColor color   // コピー元のカラー
);
[ public ]
SFUColor(
    UInt08 r          // 赤
    UInt08 g          // 緑
    UInt08 b          // 青
    UInt08 a = 0x00   // アルファ
);
[ public ]
SFUColor(
    RGBVAL rgb   // RGB値
);

参照

RGBVAL


SFUColor::~SFUColor
SFUColor のデストラクタです。
[ public ]
~SFUColor(Void);

SFUColor::A
カラーのアルファ値を取得/設定します。
[ public ]
Void A(
    UInt08 a   // 設定するアルファ値
);
[ public, const ]
UInt08 A(Void);

参照

SFUColor::B | SFUColor::G | SFUColor::R


SFUColor::AddAlpha
アルファ値に値を加算します。
[ public ]
ConstSFUColorRef AddAlpha(
    SInt16 alpha   // アルファ値に加算する値
);

戻り値

自分自身を返します。

解説

アルファ値に値を加算します。 負の数を指定することで減算することもできます。 加算の結果が 255 を超える場合は 255 に制限されます。 減算の結果が 0 を下回る場合は 0 に制限されます。

参照

SFUColor::AddRgb


SFUColor::AddRgb
RGB 値に値を加算します。
[ public ]
SFUColorRef AddRgb(
    SInt16 r   // R 値に加算する値
    SInt16 g   // G 値に加算する値
    SInt16 b   // B 値に加算する値
);
[ public ]
SFUColorRef AddRgb(
    SInt16 value   // RGB 値に加算する値
);

戻り値

自分自身を返します。

解説

カラーの RGB 値に値を加算します。 負の数を指定することで減算することもできます。 加算の結果が 255 を超える場合は 255 に制限され、 減算の結果が 0 を下回る場合は 0 に制限されます。

参照

SFUColor::AddAlpha


SFUColor::Alpha
カラーのアルファ値を設定します。
[ public ]
ConstSFUColorRef Alpha(
    UInt08 alpha   // 設定するアルファ値
);
[ public ]
ConstSFUColorRef Alpha(
    RGBVAL rgb   // アルファ値のコピー元の RGBVAL
);

戻り値

自分自身を返します。

参照

SFUColor::Rgb | SFUColor::Set


SFUColor::B
カラーの B 値を取得/設定します。
[ public ]
Void B(
    UInt08 b   // 設定する B 値
);
[ public, const ]
UInt08 B(Void);

参照

SFUColor::A | SFUColor::G | SFUColor::R


SFUColor::Equal
2 つのカラーが等しいか判定します。
[ public, const ]
Bool Equal(
    ConstSFUColorRef color   // 比較対象のカラー
);

戻り値

2 つのカラーの RGB 値とアルファ値がすべて等しいとき TRUE を返します。 そうでなければ FALSE を返します。

参照

SFUColor::operator==


SFUColor::EqualAlpha
2 つのカラーのアルファ値が等しいか判定します。
[ public, const ]
Bool EqualAlpha(
    ConstSFUColorRef color   // 比較対象のカラー
);

参照

SFUColor::Equal | SFUColor::EqualRgb


SFUColor::EqualRgb
2 つのカラーの RGB 値が等しいか判定します。
[ public, const ]
Bool EqualRgb(
    ConstSFUColorRef color   // 比較対象のカラー
);

参照

SFUColor::Equal | SFUColor::EqualAlpha


SFUColor::G
カラーの G 値を取得/設定します。
[ public ]
Void G(
    UInt08 g   // 設定する G 値
);
[ public, const ]
UInt08 G(Void);

参照

SFUColor::A | SFUColor::B | SFUColor::R


SFUColor::R
カラーの R 値を取得/設定します。
[ public ]
Void R(
    UInt08 r   // 設定する R 値
);
[ public, const ]
UInt08 R(Void);

参照

SFUColor::A | SFUColor::B | SFUColor::G


SFUColor::Rgb
カラーの RGB 値を設定します。
[ public ]
ConstSFUColorRef Rgb(
    UInt08 r   // R 値
    UInt08 g   // G 値
    UInt08 b   // B 値
);
[ public ]
ConstSFUColorRef Rgb(
    RGBVAL    // コピー元の RGBVAL
);

戻り値

自分自身を返します。

参照

SFUColor::Alpha | SFUColor::Set


SFUColor::Set
カラーの各要素を設定します。
[ public ]
ConstSFUColorRef Set(
    UInt08 r   // R 値
    UInt08 g   // G 値
    UInt08 b   // B 値
    UInt08 a   // アルファ値
);
[ public ]
ConstSFUColorRef Set(
    RGBVAL rgb   // コピーする RGBVAL
);

参照

SFUColor::SFUColor


SFUColor::SubAlpha
アルファ値から値を減算します。
[ public ]
ConstSFUColorRef SubAlpha(
    SInt16 alpha   // アルファ値から減算する値
);

戻り値

自分自身を返します。

解説

アルファ値から値を減算します。 負の数を指定することで加算することもできます。 加算の結果が 255 を超える場合は 255 に制限されます。 減算の結果が 0 を下回る場合は 0 に制限されます。

参照

SFUColor::SubRgb


SFUColor::SubRgb
RGB 値から値を減算します。
[ public ]
ConstSFUColorRef SubRgb(
    SInt16 r   // R 値から減算する値
    SInt16 g   // G 値から減算する値
    SInt16 b   // B 値から減算する値
);
[ public ]
ConstSFUColorRef SubRgb(
    SInt16 value   // RGB 値に減算する値
);

戻り値

自分自身を返します。

解説

カラーの RGB 値から値を減算します。 負の数を指定することで加算することもできます。 加算の結果が 255 を超える場合は 255 に制限され、 減算の結果が 0 を下回る場合は 0 に制限されます。

参照

SFUColor::SubAlpha


SFUColor::operator==
2 つのカラーが等しいか判定します。
[ public, friend ]
Bool operator==(
    ConstSFUColorRef color1   
    ConstSFUColorRef color2   
);
[ public, friend ]
Bool operator!=(
    ConstSFUColorRef color1   
    ConstSFUColorRef color2   
);

戻り値

2 つのカラーの RGB 値とアルファ値がすべて等しいとき TRUE を返します。 そうでなければ FALSE を返します。

参照

SFUColor::Equal


SFUColor::operator-
カラーの各要素を減算します。
[ public, friend ]
SFUColor operator-(
    ConstSFUColorRef color1   
    ConstSFUColorRef color2   
);
[ public ]
ConstSFUColorRef operator-=(
    ConstSFUColorRef color   
);

戻り値

2 つのカラーの RGB 値とアルファ値をそれぞれ減算した結果のカラーを返します。 各要素値が 0 を下回る場合は 0 に制限されます。

参照

SFUColor::operator+


SFUColor::operator+
カラーの各要素を加算します。
[ public, friend ]
SFUColor operator+(
    ConstSFUColorRef color1   
    ConstSFUColorRef color2   
);
[ public ]
ConstSFUColorRef operator+=(
    ConstSFUColorRef color   
);

戻り値

2 つのカラーの RGB 値とアルファ値をそれぞれ加算した結果のカラーを返します。 各要素値が 255 を超える場合は 255 に制限されます。

参照

SFUColor::operator-


SFUColor::operator RGBVAL
SFUColor を RGBVAL に変換した値を返します。
[ public, const ]
operator RGBVAL(Void);