# 機能設計書 34-GetWindowSize

## 概要

本ドキュメントは、Dear ImGuiライブラリにおける `GetWindowSize` 関数の機能設計書である。この関数は、現在のウィンドウのサイズ（幅と高さ）を取得するためのAPIを提供する。

### 本機能の処理概要

**業務上の目的・背景**：GUIアプリケーションにおいて、ウィンドウのサイズを知る必要がある場面がある。GetWindowSize関数は、現在処理中のウィンドウ（Begin/End ブロック内）のサイズを返す。ただし、多くの場合は GetCursorScreenPos() と GetContentRegionAvail() の組み合わせで目的を達成できるため、この関数の直接使用は稀である。

**機能の利用シーン**：
- ウィンドウサイズに応じたレイアウト調整が必要な場合
- ウィンドウ内のカスタム描画でサイズを基準にした計算を行う場合
- リサイズ検出やアスペクト比計算が必要な場合
- デバッグ目的でウィンドウのサイズを確認する場合

**主要な処理内容**：
1. 現在のウィンドウを取得（GetCurrentWindowRead）
2. ウィンドウのSizeプロパティを返却

**関連システム・外部連携**：GetContentRegionAvail、SetWindowSize、SetNextWindowSize などのサイズ関連APIと連携。

**権限による制御**：特になし。すべてのウィンドウで利用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本機能は直接的に画面に関連付けられていないが、すべてのウィンドウで使用可能 |

## 機能種別

状態取得API

## 入力仕様

### 入力パラメータ

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

### 入力データソース

ImGuiコンテキストから GetCurrentWindowRead() を使用して現在のウィンドウを参照。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | ImVec2 | ウィンドウのサイズ（width, height） |

### 出力先

呼び出し元に直接返却。

## 処理フロー

### 処理シーケンス

```
1. 現在のウィンドウを取得
   └─ GetCurrentWindowRead() を呼び出し

2. サイズを返却
   └─ window->Size を返す
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[GetCurrentWindowRead]
    B --> C[window->Size取得]
    C --> D[ImVec2を返却]
    D --> E[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | Begin/End必須 | この関数はBegin/End ブロック内で呼び出す必要がある | 常時 |
| BR-02 | 推奨代替API | 多くの場合、GetContentRegionAvail() の使用を推奨 | 常時 |
| BR-03 | 装飾含む | 返されるサイズはタイトルバー等の装飾部分を含む | 常時 |

### 計算ロジック

- ウィンドウの幅のみが必要な場合: `GetWindowWidth()` がショートカットとして使用可能
- ウィンドウの高さのみが必要な場合: `GetWindowHeight()` がショートカットとして使用可能

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

本機能はデータベース操作を行わない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | 未定義動作 | Begin/End ブロック外で呼び出した場合 | Begin/End ブロック内で呼び出す |

### リトライ仕様

リトライは不要。

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

該当なし。

## パフォーマンス要件

- O(1) の計算量（単純なプロパティ取得のみ）

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

特になし。

## 備考

- imgui.h のコメントでは「IT IS UNLIKELY YOU EVER NEED TO USE THIS」と記載されており、多くの場合は GetContentRegionAvail() を使用することを推奨している
- GetWindowWidth() と GetWindowHeight() はこの関数の各軸へのショートカットである
- ウィンドウがまだ計算されていない場合（初回フレーム）は (0, 0) を返す可能性がある（TODO項目として存在）

---

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

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

### 推奨読解順序

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

ImGuiWindow 構造体の Size メンバを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | imgui.h | `imgui.h` | ImVec2 構造体の定義 |
| 1-2 | imgui_internal.h | `imgui_internal.h` | ImGuiWindow 構造体の Size, SizeFull メンバ |

**読解のコツ**: ImGuiWindow には Size と SizeFull の2つのサイズ関連プロパティがある。GetWindowSize は Size を返す。

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

GetWindowSize 関数の実装を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | imgui.cpp | `imgui.cpp` | GetWindowSize 関数の実装（8477-8481行） |

**主要処理フロー**:
1. **8479行目**: GetCurrentWindowRead() で現在のウィンドウを取得
2. **8480行目**: window->Size を返却

#### Step 3: 関連APIを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | imgui.cpp | `imgui.cpp` | GetWindowWidth / GetWindowHeight 関数（8423-8432行） |
| 3-2 | imgui.cpp | `imgui.cpp` | GetContentRegionAvail 関数（推奨代替API） |
| 3-3 | imgui.cpp | `imgui.cpp` | SetWindowSize 関数（サイズ設定API） |

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

```
GetWindowSize()
    │
    └─ GetCurrentWindowRead()
           │
           └─ window->Size
                   │
                   └─ ImVec2 を返却

[関連ショートカット]
GetWindowWidth()  -> window->Size.x
GetWindowHeight() -> window->Size.y
```

### データフロー図

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

（なし）
        │
        └──────────────▶ GetCurrentWindowRead() ────────▶ ImVec2 (width, height)
                               │                              │
                               ▼                              ▼
                         window->Size ─────────────▶ サイズとして使用
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| imgui.h | `imgui.h` | ヘッダー | GetWindowSize, GetWindowWidth, GetWindowHeight 関数の宣言 |
| imgui.cpp | `imgui.cpp` | ソース | GetWindowSize 関数の実装（8477-8481行） |
| imgui_internal.h | `imgui_internal.h` | ヘッダー | ImGuiWindow 構造体の定義 |
| imgui_demo.cpp | `imgui_demo.cpp` | デモ | GetWindowSize の使用例（2618行、10164行） |
