# バッチ設計書 34-Makefile (example_glfw_opengl3)

## 概要

本ドキュメントは、ImGuiプロジェクトにおけるGLFW + OpenGL3サンプル「example_glfw_opengl3」のMakefileビルドシステムの設計仕様を記述するものである。

### 本バッチの処理概要

このMakefileは、GLFWウィンドウシステムとOpenGL3（モダンOpenGL）グラフィックスAPIを組み合わせたImGuiサンプルアプリケーションをビルドするためのクロスプラットフォーム対応ビルドスクリプトである。Linux、macOS、Windows（MSYS2/MinGW）の3つの主要プラットフォームに対応し、オプションでOpenGL ES2もサポートする。

**業務上の目的・背景**：OpenGL3（モダンOpenGL）は、シェーダーベースのレンダリングパイプラインを提供し、より高性能なグラフィックス処理を実現する。ImGuiをモダンなOpenGLアプリケーションに統合する際の標準的なリファレンス実装として、このサンプルは広く参照される。また、OpenGL ES2サポートにより、組み込みシステムやモバイルデバイスへの移植も容易になる。

**バッチの実行タイミング**：開発者による手動実行、またはCI/CDパイプラインでの自動実行時。

**主要な処理内容**：
1. プラットフォーム検出（Linux/macOS/Windows）
2. GLFWライブラリの検出とリンク設定
3. OpenGL3（または ES2）ライブラリのリンク設定
4. ImGuiコアおよびバックエンドソースのコンパイル
5. 実行可能ファイル「example_glfw_opengl3」の生成

**前後の処理との関連**：GLFWライブラリが事前にインストールされている必要がある。

**影響範囲**：ローカルビルド環境にexample_glfw_opengl3実行ファイルとオブジェクトファイルを生成する。

## バッチ種別

ビルドスクリプト / Makefile

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時 |
| 実行時刻 | - |
| 実行曜日 | - |
| 実行日 | - |
| トリガー | 手動 / CI/CD |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| C++コンパイラ | g++またはclang++がインストールされていること |
| make | GNU Makeがインストールされていること |
| GLFW3 | GLFWライブラリがインストールされていること |
| OpenGL | OpenGL3またはOpenGL ES2ライブラリが利用可能であること |

### 実行可否判定

GLFWライブラリとOpenGL3/ES2ライブラリが利用可能であれば実行可能。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| CXX | 文字列 | No | システム依存 | C++コンパイラの指定（g++/clang++） |
| IMGUI_IMPL_OPENGL_ES2 | 定義 | No | 未定義 | OpenGL ES2を使用する場合に定義 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| main.cpp | C++ソース | サンプルアプリケーションのメインファイル |
| imgui.cpp | C++ソース | ImGuiコアライブラリ |
| imgui_demo.cpp | C++ソース | ImGuiデモ機能 |
| imgui_draw.cpp | C++ソース | ImGui描画機能 |
| imgui_tables.cpp | C++ソース | ImGuiテーブル機能 |
| imgui_widgets.cpp | C++ソース | ImGuiウィジェット機能 |
| imgui_impl_glfw.cpp | C++ソース | GLFWバックエンド実装 |
| imgui_impl_opengl3.cpp | C++ソース | OpenGL3バックエンド実装 |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| example_glfw_opengl3 | 実行ファイル | ビルドされたサンプルアプリケーション |
| *.o | オブジェクトファイル | コンパイル中間生成物 |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | example_glfw_opengl3 |
| 出力先 | examples/example_glfw_opengl3/ |
| 文字コード | バイナリ |
| 区切り文字 | - |

## 処理フロー

### 処理シーケンス

```
1. プラットフォーム検出
   └─ uname -sでLinux/Darwin/Windows_NTを判定
2. OpenGL ES2オプション確認
   └─ IMGUI_IMPL_OPENGL_ES2定義時はES2ライブラリを使用
3. GLFWライブラリ設定
   └─ pkg-configまたは固定パスでGLFW設定を取得
4. OpenGL3ライブラリ設定
   └─ プラットフォーム固有のOpenGL3リンク設定
5. コンパイルフラグ設定
   └─ C++11標準、インクルードパス、警告オプション
6. オブジェクトファイル生成
   └─ 各.cppファイルを.oにコンパイル
7. リンク処理
   └─ GLFW、OpenGL3とリンクして実行ファイル生成
8. 完了メッセージ出力
   └─ "Build complete for [Platform]"
```

### フローチャート

```mermaid
flowchart TD
    A[make実行] --> B[プラットフォーム検出]
    B --> C{OpenGL ES2使用?}
    C -->|Yes| D[ES2ライブラリ設定]
    C -->|No| E[OpenGL3ライブラリ設定]
    D --> F{OS判定}
    E --> F
    F -->|Linux| G[Linux: pkg-config glfw3 + lGL]
    F -->|macOS| H[macOS: framework OpenGL + lglfw]
    F -->|Windows| I[MinGW: lglfw3 + lopengl32]
    G --> J[ソースコンパイル]
    H --> J
    I --> J
    J --> K[リンク処理]
    K --> L[example_glfw_opengl3生成]
    L --> M[完了]
```

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

該当なし（データベース操作を行わないビルドスクリプト）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| 1 | コンパイルエラー | ソースコードの構文エラー | エラーメッセージを確認し修正 |
| 1 | リンクエラー | GLFW/OpenGLライブラリ不足 | 必要なライブラリをインストール |
| 127 | コマンド未発見 | pkg-config未インストール | pkg-configをインストール |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（手動再実行） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

### 障害時対応

GLFWライブラリのインストール状況を確認し、プラットフォームに応じたインストールコマンドを実行する。

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

該当なし

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 8ファイルのコンパイル |
| 目標処理時間 | 数秒〜1分程度 |
| メモリ使用量上限 | 通常のコンパイル処理に依存 |

## 排他制御

同一ディレクトリでの並列make実行は非推奨。`make -j`オプションで並列コンパイルは可能。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 完了ログ | ビルド完了時 | "Build complete for [Platform]" |
| エラーログ | エラー発生時 | コンパイラのエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| ビルド失敗 | 1回 | CI/CD通知 |

## 備考

- OpenGL3（モダンOpenGL）はシェーダーベースのレンダリングをサポート
- OpenGL ES2オプションを有効にすると組み込みシステム向けビルドが可能
- libGLESv2.soがシステムに存在する場合、ES2を使用可能
- macOSではHomebrew、MacPorts、またはopt/homebrew経由でGLFWを検索
