# 機能設計書 11-GetDrawData

## 概要

本ドキュメントは、Dear ImGuiライブラリにおけるGetDrawData関数の機能設計を記載する。この関数はレンダリングに必要な描画データを取得するための重要なAPIである。

### 本機能の処理概要

GetDrawData関数は、ImGuiフレームの描画に必要なすべての描画コマンドとデータを含むImDrawData構造体へのポインタを返す。この関数は、Render()呼び出し後から次のNewFrame()呼び出しまでの間に有効なデータを返し、バックエンドレンダラーがGPUへの描画コマンドを発行する際に使用される。

**業務上の目的・背景**：GUIアプリケーションにおいて、ImGuiが生成した描画命令を実際のグラフィックスAPIに渡す必要がある。GetDrawDataは、ImGuiの内部描画コマンドリストをレンダラーバックエンドに渡すための標準的なインターフェースを提供する。これにより、DirectX、OpenGL、Vulkan、Metalなど様々なグラフィックスAPIに対して統一的な方法で描画データを提供できる。

**機能の利用シーン**：
- メインレンダリングループで、Render()呼び出し後に描画データを取得する場合
- カスタムレンダラーバックエンドを実装する場合
- マルチビューポート環境で各ビューポートの描画データを処理する場合

**主要な処理内容**：
1. 現在のImGuiコンテキストからメインビューポートを取得
2. ビューポートに関連付けられたDrawDataPの有効性を確認
3. 有効な場合はDrawDataPへのポインタを返却、無効な場合はNULLを返却

**関連システム・外部連携**：
- レンダラーバックエンド（imgui_impl_opengl3、imgui_impl_dx11、imgui_impl_vulkan等）
- プラットフォームバックエンド経由でのGPU描画

**権限による制御**：本機能に権限制御はない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | (全ウィンドウ) | 結果表示画面 | すべてのImGuiウィンドウの描画データを統合して提供 |

## 機能種別

データ取得 / フレーム描画データアクセス

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| (なし) | - | - | パラメータなし | - |

### 入力データソース

- ImGuiContext内のViewports配列（メインビューポート: Viewports[0]）
- Render()関数で確定されたDrawDataP構造体

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | ImDrawData* | 描画データへのポインタ、無効な場合はNULL |

### ImDrawData構造体の主要フィールド

| 項目名 | 型 | 説明 |
|--------|-----|------|
| Valid | bool | Render()後かつ次のNewFrame()前の間trueとなる |
| CmdListsCount | int | 描画コマンドリストの数（= CmdLists.Size） |
| TotalIdxCount | int | 全コマンドリストのインデックス総数 |
| TotalVtxCount | int | 全コマンドリストの頂点総数 |
| CmdLists | ImVector<ImDrawList*> | 描画コマンドリストの配列 |
| DisplayPos | ImVec2 | 描画領域の左上座標 |
| DisplaySize | ImVec2 | 描画領域のサイズ |
| FramebufferScale | ImVec2 | フレームバッファスケール（Retina対応等） |
| OwnerViewport | ImGuiViewport* | 所有ビューポート |
| Textures | ImVector<ImTextureData*>* | 更新が必要なテクスチャリスト |

### 出力先

- レンダラーバックエンド関数（ImGui_ImplXXXX_RenderDrawData）への引数として使用

## 処理フロー

### 処理シーケンス

```
1. グローバルコンテキストの取得
   └─ GImGuiからImGuiContext参照を取得
2. メインビューポートの取得
   └─ Viewports[0]からビューポートを取得
3. DrawDataの有効性確認
   └─ viewport->DrawDataP.Validをチェック
4. 結果の返却
   └─ 有効: &viewport->DrawDataPを返す
   └─ 無効: NULLを返す
```

### フローチャート

```mermaid
flowchart TD
    A[GetDrawData呼び出し] --> B[GImGuiコンテキスト参照取得]
    B --> C[Viewports配列からメインビューポート取得]
    C --> D{DrawDataP.Valid?}
    D -->|true| E[&DrawDataPを返却]
    D -->|false| F[NULLを返却]
    E --> G[終了]
    F --> G
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | 有効期間制約 | Render()呼び出し後から次のNewFrame()呼び出しまでの間のみ有効 | 常時 |
| BR-02 | 呼び出し順序 | Render()を呼び出す前にGetDrawData()を呼んではならない | 常時 |
| BR-03 | 所有権 | 返却されたポインタはImGuiContextが所有、呼び出し側でfreeしてはならない | 常時 |

### 計算ロジック

該当なし（データ取得のみ）

## データベース操作仕様

該当なし（インメモリデータ構造へのアクセスのみ）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| NULL返却 | 無効データ | Render()呼び出し前、またはNewFrame()後 | Render()を呼び出してから使用する |

### リトライ仕様

リトライ不要（同一フレーム内で再呼び出し可能）

## トランザクション仕様

該当なし

## パフォーマンス要件

- O(1)の時間計算量（単純なポインタ参照のみ）
- メモリ割り当てなし

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

該当なし（ローカルメモリアクセスのみ）

## 備考

- マルチビューポート環境では、各ビューポートごとにDrawDataが存在する
- 1.92以降、ImTextureRefによるテクスチャ管理がサポートされた
- レガシーバックエンドでは、io.RenderDrawListsFn経由で描画が行われていた（現在は非推奨）

---

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

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

### 推奨読解順序

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

まず、GetDrawDataが返すImDrawData構造体の定義を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImDrawData構造体の定義（3422-3441行目） |
| 1-2 | imgui.h | `imgui.h` | ImDrawList構造体の概要 |

**読解のコツ**: ImDrawDataは描画に必要なすべての情報を集約した構造体。CmdLists配列が実際の描画コマンドを保持する。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | GetDrawData関数の宣言（404行目） |
| 2-2 | imgui.cpp | `imgui.cpp` | GetDrawData関数の実装（5134-5139行目） |

**主要処理フロー**:
1. **5136行目**: ImGuiContext参照の取得（GImGui）
2. **5137行目**: メインビューポートの取得（g.Viewports[0]）
3. **5138行目**: 有効性チェックと戻り値の決定

#### Step 3: 関連するRender関数を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | Render関数の実装（描画データの確定処理） |
| 3-2 | imgui.cpp | `imgui.cpp` | EndFrame関数との関係 |

**主要処理フロー**:
- Render()内でDrawDataが構築され、Validフラグがtrueに設定される

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

```
アプリケーションコード
    │
    ├─ ImGui::Render()
    │      └─ DrawDataの構築とValid=true設定
    │
    └─ ImGui::GetDrawData()
           └─ g.Viewports[0]->DrawDataP参照
                  └─ ImGui_ImplXXXX_RenderDrawData()
                         └─ GPU描画コマンド発行
```

### データフロー図

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

ImGuiContext          GetDrawData()                ImDrawData*
    │                      │                           │
    └─ Viewports[0] ──────▶ 有効性確認 ─────────────────▶ レンダラー
       DrawDataP                                       バックエンド
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | API宣言、ImDrawData構造体定義 |
| imgui.cpp | `imgui.cpp` | ソース | GetDrawData実装（5134-5139行目） |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | ImGuiViewportP等の内部構造体定義 |
| imgui_impl_opengl3.cpp | `backends/imgui_impl_opengl3.cpp` | バックエンド | 使用例（OpenGL3） |
| imgui_impl_dx11.cpp | `backends/imgui_impl_dx11.cpp` | バックエンド | 使用例（DirectX11） |
| imgui_impl_vulkan.cpp | `backends/imgui_impl_vulkan.cpp` | バックエンド | 使用例（Vulkan） |
