# 機能設計書 5-GetIO

## 概要

本ドキュメントはDear ImGuiライブラリのGetIO関数に関する機能設計書である。GetIOはImGuiIO構造体への参照を取得し、入出力設定やアプリケーション構成にアクセスする関数である。

### 本機能の処理概要

GetIO関数は、現在のImGuiコンテキストに含まれるImGuiIO構造体への参照を返す。この構造体はマウス・キーボード・ゲームパッド入力、時間情報、各種設定オプションへのアクセスを提供する。

**業務上の目的・背景**：ImGuiライブラリはプラットフォーム非依存で設計されており、入力処理や時間管理はアプリケーション側で行う必要がある。GetIOを通じてImGuiIO構造体にアクセスし、入力情報を設定したり、構成オプションを変更したりする。これにより、様々なプラットフォームやバックエンドからImGuiを利用できる柔軟性が実現される。

**機能の利用シーン**：
- フレーム開始時の入力状態設定（マウス位置、ボタン状態、キーボード入力等）
- DeltaTime（フレーム間経過時間）の設定
- フォントアトラスへのアクセス
- 設定フラグの変更（NavEnableKeyboard、DockingEnable等）
- 入力キャプチャ状態の確認（WantCaptureMouse、WantCaptureKeyboard等）
- ディスプレイサイズの設定

**主要な処理内容**：
1. 現在のコンテキストの存在確認（アサート）
2. GImGui->IOへの参照を返す

**関連システム・外部連携**：
- プラットフォームバックエンド：入力データの設定
- レンダラーバックエンド：ディスプレイサイズ、フレームバッファスケール
- フォントアトラス：io.Fontsメンバを通じてアクセス
- クリップボード：io.ClipboardUserData等

**権限による制御**：特になし

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 全ての画面の入出力基盤 |

## 機能種別

データアクセス / 構成管理

## 入力仕様

### 入力パラメータ

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

### 入力データソース

- GImGuiグローバル変数（現在のコンテキスト）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | ImGuiIO& | 現在のコンテキストのImGuiIO構造体への参照 |

### 出力先

- 呼び出し元への参照返却

## 処理フロー

### 処理シーケンス

```
1. コンテキスト存在確認
   └─ IM_ASSERTでGImGui != NULLを確認

2. IO構造体参照を返す
   └─ return GImGui->IO;
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B{GImGui != NULL?}
    B -->|Yes| C[GImGui->IOを返す]
    B -->|No| D[アサート失敗]
    C --> E[終了]
    D --> F[プログラム停止]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | コンテキスト必須 | CreateContextが呼ばれていない場合、アサート失敗 | GImGui == NULL |
| BR-02 | 参照返却 | コピーではなく参照を返すため、変更が即座に反映される | 常に |
| BR-03 | マルチスレッド対応 | コンテキスト引数付きオーバーロード(GetIO(ctx))が存在 | マルチスレッド時 |

### 計算ロジック

特になし

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| IM_ASSERT | アサート失敗 | コンテキストが存在しない | CreateContext()を呼び出す |

### リトライ仕様

特になし

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

該当なし

## パフォーマンス要件

- インライン可能な非常に軽量な関数
- 毎フレーム複数回呼び出されることを想定

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

- 特になし

## 備考

- ImGuiIOはアプリケーションとImGui間の主要な橋渡し構造体
- バックエンド実装ではこの構造体を通じて入力を設定する
- フレーム中の読み取りは安全だが、書き込みはNewFrame前に行うことを推奨

---

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

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

### 推奨読解順序

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

ImGuiIO構造体は非常に大きく、多数のメンバを持つ。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImGuiIO構造体の定義。主要メンバ: ConfigFlags, BackendFlags, DisplaySize, DeltaTime, Fonts等 |

**読解のコツ**: ImGuiIOは以下のカテゴリに分類される:
- **設定オプション**: ConfigFlags, BackendFlags, FontGlobalScale等
- **入力**: MousePos, MouseDown[], KeysData[], WantCaptureMouse等
- **出力**: WantCaptureMouse, WantCaptureKeyboard, Framerate等
- **その他**: Fonts, UserData, LogFilename等

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.h | `imgui.h` | 398行目: GetIOのAPI宣言 |
| 2-2 | imgui.cpp | `imgui.cpp` | 5107-5111行目: GetIO関数の実装 |

**主要処理フロー**:
1. **5109行目**: コンテキスト確認 `IM_ASSERT(GImGui != NULL && "No current context...")`
2. **5110行目**: IO返却 `return GImGui->IO;`

#### Step 3: マルチスレッド対応オーバーロードを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | 5114-5118行目: GetIO(ImGuiContext* ctx)オーバーロード |

**読解のコツ**:
- マルチスレッド環境で並列コンテキストを使用する場合に便利
- Issue #8069, #6293, #5856で議論されている機能

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

```
ImGui::GetIO()
    │
    ├─ IM_ASSERT(GImGui != NULL)
    │
    └─ return GImGui->IO
```

### データフロー図

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

（なし）                  GetIO() ────────────────────────▶ ImGuiIO&
                                   │                       (GImGui->IOの参照)
                                   │
                                   ▼
                          GImGui->IOへの
                          参照を返す
```

### ImGuiIO構造体の主要メンバ

| カテゴリ | メンバ名 | 説明 |
|---------|---------|------|
| 設定 | ConfigFlags | 構成フラグ（NavEnableKeyboard等） |
| 設定 | BackendFlags | バックエンドフラグ |
| 入力 | DisplaySize | ディスプレイサイズ |
| 入力 | DeltaTime | フレーム間経過時間 |
| 入力 | MousePos | マウス位置 |
| 入力 | MouseDown[5] | マウスボタン状態 |
| 出力 | WantCaptureMouse | ImGuiがマウス入力を要求しているか |
| 出力 | WantCaptureKeyboard | ImGuiがキーボード入力を要求しているか |
| 出力 | Framerate | 現在のフレームレート |
| フォント | Fonts | フォントアトラスへのポインタ |

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | パブリックAPI宣言（398行目）、ImGuiIO構造体定義 |
| imgui.cpp | `imgui.cpp` | ソース | 実装（5107-5111行目） |
| imgui.cpp | `imgui.cpp` | ソース | マルチスレッド版（5114-5118行目） |
