MGL::Color

概要

MGL::Colorは色の各要素をfloat型で表現するための構造体です。

宣言

namespace MGL
{
    struct Color;
}

メンバ情報

種類	名前	内容	バージョン
変数	公開メンバ変数		1.0.0+
関数	コンストラクタ		1.0.0+
その他	定義済みの定数一覧		1.0.0+

---

公開メンバ変数

宣言

namespace MGL
{
    struct Color
    {
        float red;      //!< 赤成分
        float green;    //!< 緑成分
        float blue;     //!< 青成分
        float alpha;    //!< アルファ値
    };
}

説明

red

色の赤成分です。有効範囲は0.0fから1.0fの間になります。

green

色の緑成分です。有効範囲は0.0fから1.0fの間になります。

blue

色の青成分です。有効範囲は0.0fから1.0fの間になります。

alpha

半透明などに使用されるアルファ値です。有効範囲は0.0fから1.0fの間になります。用途は利用するアルゴリズムによって異なる場合があります。

バージョン情報

MGL 1.0.0から利用可能

---

コンストラクタ

宣言

// (1) 各要素をゼロでクリア
constexpr Color() noexcept

// (2) 値を指定して初期化
constexpr Color(float inRed, float inGreen, float inBlue, float inAlpha = 1.0f) noexcept

// (3) 32ビット RGBA値で初期化
constexpr Color(uint32_t rgba) noexcept;

// (4) XColorで初期化
constexpr Color(XColor xcolor) noexcept

引数

(1) 各要素をゼロでクリア

引数なし。

(2) 値を指定して初期化

float inRed

初期化する赤成分を指定します。

float inGreen

初期化する緑成分を指定します。

float inBlue

初期化する青成分を指定します。

float inAlpha

初期化するアルファ値を指定します。省略時は1.0が指定されます。

(3) 32ビットRGBA値で初期化

uint32_t rgba

32ビットで表現されるRGBA値を用いてメンバを初期化します。引数の値は上位ビットから順に赤、緑、青、アルファの成分が、それぞれ8ビットづつ格納されている必要があります。

(4) XColorで初期化

MGL::XColor xcolor

xterm-256カラーに準拠した値で表現される色を用いてメンバを初期化します。

説明

各要素をゼロクリア、または各要素を指定して初期化するためのコンストラクタです。

利用例

// (1) 各要素をゼロでクリア
MGL::Color color1;

// (2) 値を指定して初期化
MGL::Color color2(0.0f, 1.0f, 0.0f);    // 緑色を指定

// (3) 32ビット RGBA値で初期化
MGL::Color color3(0x0000FFFF);          // 青色を指定

// (4) XColorで初期化
MGL::Color color4(MGL::XColor::Red);    // 赤色を指定

バージョン情報

(1)および(2)はMGL 1.0.0から利用可能。

(3)および(4)はMGL 1.1.2から利用可能。

関連

• MGL::XColor

---

定義済みの定数一覧

一覧

型	定数名	内容	値
Color	kColorRed	赤色	Color(1.0f, 0.0f, 0.0f, 1.0f)
Color	kColorGreen	緑色	Color(1.0f, 0.0f, 0.0f, 1.0f)
Color	kColorBlue	青色	Color(1.0f, 0.0f, 0.0f, 1.0f)
Color	kColorBlack	黒色	Color(1.0f, 0.0f, 0.0f, 1.0f)
Color	kColorWhite	白色	Color(1.0f, 0.0f, 0.0f, 1.0f)

宣言

namespace MGL
{
    constexpr Color kColorRed    = Color(1.0f, 0.0f, 0.0f, 1.0f);    //!< 赤
    constexpr Color kColorGreen  = Color(0.0f, 1.0f, 0.0f, 1.0f);    //!< 緑
    constexpr Color kColorBlue   = Color(0.0f, 0.0f, 1.0f, 1.0f);    //!< 青
    constexpr Color kColorBlack  = Color(0.0f, 0.0f, 0.0f, 1.0f);    //!< 黒
    constexpr Color kColorWhite  = Color(1.0f, 1.0f, 1.0f, 1.0f);    //!< 白
}

バージョン情報

MGL 1.0.0から利用可能