# 通知設計書 22-ImGuiCol_PopupBg

## 概要

本ドキュメントは、ImGuiライブラリにおける`ImGuiCol_PopupBg`スタイルカラーの仕様と動作を定義する設計書である。このカラー設定は、ポップアップ、メニュー、ツールチップウィンドウの背景色を制御する。

### 本通知の処理概要

`ImGuiCol_PopupBg`は、ImGuiのスタイルシステムにおけるカラー定数であり、ポップアップ系ウィンドウの背景描画に使用される色を定義する。この設定により、アプリケーション全体のポップアップの外観を統一的に制御できる。

**業務上の目的・背景**：GUIアプリケーションにおいて、ポップアップメニューやツールチップは頻繁に表示される要素であり、その視認性と一貫性は重要である。通常のウィンドウ背景（ImGuiCol_WindowBg）とは異なる色を設定することで、ポップアップがメインコンテンツの上に重なっていることを視覚的に明示できる。また、ダークテーマやライトテーマに応じた適切な背景色の設定が必要となる。

**通知の送信タイミング**：このカラー値は、ポップアップウィンドウのレンダリング時に参照される。具体的には、`BeginPopup()`、`BeginPopupModal()`、`BeginTooltip()`などの関数内でウィンドウ背景を描画する際に使用される。スタイル変更は`PushStyleColor()`/`PopStyleColor()`または`ImGuiStyle::Colors[]`配列への直接代入で行う。

**通知の受信者**：ImGuiの描画システム（レンダラー）が受信者である。`ImDrawList`を通じて背景矩形の描画命令が発行される際にこの色が適用される。

**通知内容の概要**：RGBA形式の色情報を伝達する。デフォルト値はテーマによって異なるが、ダークテーマでは`ImVec4(0.08f, 0.08f, 0.08f, 0.94f)`、クラシックテーマでは異なる値が設定される。

**期待されるアクション**：開発者はアプリケーションのデザインに合わせてこの色をカスタマイズする。ユーザーにとっては、ポップアップが明確に識別可能な視覚的フィードバックを提供する。

## 通知種別

スタイルカラー定数

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（即時反映） |
| 優先度 | 中 |
| リトライ | 無 |

### 送信先決定ロジック

スタイルカラーは`ImGuiStyle::Colors[ImGuiCol_PopupBg]`に格納され、ポップアップウィンドウの描画時に自動的に参照される。

## 通知テンプレート

### カラー定義

| 項目 | 内容 |
|-----|------|
| カラー名 | ImGuiCol_PopupBg |
| インデックス | ImGuiCol_列挙型内の5番目（0起算で4） |
| 定義場所 | imgui.h:1740 |

### デフォルト値

| テーマ | R | G | B | A |
|-------|---|---|---|---|
| Dark (StyleColorsDark) | 0.08 | 0.08 | 0.08 | 0.94 |
| Classic (StyleColorsClassic) | 0.11 | 0.11 | 0.14 | 0.92 |
| Light (StyleColorsLight) | 1.00 | 1.00 | 1.00 | 0.98 |

### 使用例

```cpp
// スタイル全体で設定
ImGuiStyle& style = ImGui::GetStyle();
style.Colors[ImGuiCol_PopupBg] = ImVec4(0.1f, 0.1f, 0.1f, 0.95f);

// 一時的に変更
ImGui::PushStyleColor(ImGuiCol_PopupBg, ImVec4(0.2f, 0.2f, 0.3f, 1.0f));
if (ImGui::BeginPopup("my_popup"))
{
    ImGui::Text("Custom background popup");
    ImGui::EndPopup();
}
ImGui::PopStyleColor();
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| R | 赤成分 (0.0-1.0) | ImVec4.x | Yes |
| G | 緑成分 (0.0-1.0) | ImVec4.y | Yes |
| B | 青成分 (0.0-1.0) | ImVec4.z | Yes |
| A | 透明度 (0.0-1.0) | ImVec4.w | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 描画 | ポップアップウィンドウ描画 | ポップアップが開いている | 背景色として使用 |
| API呼び出し | StyleColorsDark等 | テーマ変更時 | デフォルト値が設定 |
| API呼び出し | PushStyleColor | 一時的変更時 | スタック上に色を積む |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| ポップアップ未表示 | ポップアップが開いていない場合は参照されない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[BeginPopup/BeginTooltip呼び出し] --> B[ウィンドウ背景描画]
    B --> C[GetStyleColorVec4呼び出し]
    C --> D[Colors配列参照]
    D --> E[ImGuiCol_PopupBg取得]
    E --> F[RenderWindowBackground]
    F --> G[ImDrawList::AddRectFilled]
    G --> H[描画完了]
```

## データベース参照・更新仕様

### 参照テーブル一覧

該当なし（ImGuiはメモリベースの即時モードGUI）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 無効な色値 | 範囲外の値を設定 | クランプされる（0.0-1.0） |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0 |
| リトライ間隔 | 該当なし |
| リトライ対象エラー | なし |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 無制限 |
| 1日あたり上限 | 無制限 |

### 配信時間帯

制限なし（フレームごとに評価）

## セキュリティ考慮事項

特になし。色設定は視覚的な表示のみに影響する。

## 備考

- ツールチップもこの色を使用する
- メニューの背景色にも適用される
- 透明度（Alpha値）を調整することで、背後のコンテンツを透過表示できる
- `ImGuiCol_WindowBg`とは別に設定可能

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

カラー定数の定義位置を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiCol_列挙型（1734-1796行目） |
| 1-2 | imgui.h | `imgui.h` | ImGuiStyle構造体のColors配列 |

**読解のコツ**: `ImGuiCol_PopupBg`は列挙型の5番目の要素として定義されている。コメントで用途が明記されている。

#### Step 2: デフォルト値の設定を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui_draw.cpp | `imgui_draw.cpp` | StyleColorsDark関数（196行目） |
| 2-2 | imgui_draw.cpp | `imgui_draw.cpp` | StyleColorsClassic関数（263行目） |
| 2-3 | imgui_draw.cpp | `imgui_draw.cpp` | StyleColorsLight関数（331行目） |

**主要処理フロー**:
1. **196行目**: ダークテーマでのPopupBg設定 `ImVec4(0.08f, 0.08f, 0.08f, 0.94f)`
2. **263行目**: クラシックテーマでの設定
3. **331行目**: ライトテーマでの設定

#### Step 3: 使用箇所を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | RenderWindowBackground関連処理 |

**主要処理フロー**:
- ウィンドウタイプに応じてPopupBgまたはWindowBgを選択

### プログラム呼び出し階層図

```
StyleColorsDark() / StyleColorsClassic() / StyleColorsLight()
    |
    +-- colors[ImGuiCol_PopupBg] = ImVec4(...)

BeginPopup() / BeginTooltip()
    |
    +-- Begin() [with popup window flags]
           |
           +-- RenderWindowBackground()
                  |
                  +-- GetStyleColorVec4(ImGuiCol_PopupBg)
                  |
                  +-- ImDrawList::AddRectFilled()
```

### データフロー図

```
[入力]                    [処理]                         [出力]

ImGuiStyle.Colors[] ───> GetStyleColorVec4() ───> ImVec4 色値
                              |
                              v
                        RenderWindowBackground()
                              |
                              v
                        ImDrawList描画コマンド
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダ | ImGuiCol_PopupBg定義（1740行目） |
| imgui_draw.cpp | `imgui_draw.cpp` | ソース | デフォルト色設定（196, 263, 331行目） |
| imgui.cpp | `imgui.cpp` | ソース | ウィンドウ背景描画処理 |
| imgui_demo.cpp | `imgui_demo.cpp` | デモ | スタイルエディタでの変更例 |
