# バッチ設計書 46-Makefile (example_sdl3_opengl3)

## 概要

本ドキュメントは、ImGuiライブラリのSDL3 + OpenGL3サンプルをビルドするためのクロスプラットフォーム対応Makefileについて記述したバッチ設計書である。

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

このMakefileは、SDL3をウィンドウシステムとして、OpenGL3をグラフィックスバックエンドとして使用するImGuiサンプルアプリケーションをビルドする処理を行う。Linux、macOS、Windows（MSYS2/MinGW）の各プラットフォームに対応している。

**業務上の目的・背景**：SDL3はSDL2の次世代バージョンであり、改良されたAPIと新機能を提供する。ImGuiをSDL3環境で使用する開発者向けに、OpenGL3と組み合わせた参照実装を提供することで、SDL3環境でのImGui活用方法を示す。SDL3はまだ開発中（unreleased/unpackaged）であるが、将来のSDL3正式リリースに備えた実装を提供している。

**バッチの実行タイミング**：開発者による手動実行（make）。主にImGuiのSDL3バックエンド開発・テスト時、SDL3を使用するアプリケーション開発の参照として使用される。

**主要な処理内容**：
1. プラットフォーム検出（uname -sまたはOS環境変数）
2. プラットフォーム固有のコンパイルフラグ・ライブラリ設定
3. main.cppおよびImGuiコアソースファイルのコンパイル
4. SDL3およびOpenGL3バックエンドファイルのコンパイル
5. 実行ファイル（example_sdl3_opengl3）の生成

**前後の処理との関連**：単独で実行可能。SDL3ライブラリの事前インストールが必要。pkg-configを使用してライブラリのパスとフラグを取得する。

**影響範囲**：カレントディレクトリに生成されるexample_sdl3_opengl3実行ファイルおよびオブジェクトファイル（.o）。

## バッチ種別

ビルド処理 / ネイティブコンパイル

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（手動実行） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動（make） |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| SDL3ライブラリ | SDL3がインストールされていること（開発版） |
| pkg-config | sdl3のpkg-config設定が利用可能であること |
| OpenGLライブラリ | OpenGLがインストールされていること |
| C++11対応コンパイラ | g++またはclang++が利用可能であること |
| ImGuiソースコード | ../..の位置にImGuiのソースコードが存在すること |

### 実行可否判定

SDL3のpkg-config設定が利用可能であり、C++コンパイラが実行可能であること。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| CXX | 文字列 | No | g++ | C++コンパイラの指定 |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| 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ウィジェットソースファイル |
| ../../backends/imgui_impl_sdl3.cpp | C++ソース | SDL3バックエンド実装 |
| ../../backends/imgui_impl_opengl3.cpp | C++ソース | OpenGL3バックエンド実装 |

## 出力仕様

### 出力データ

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

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | example_sdl3_opengl3 |
| 出力先 | カレントディレクトリ |
| 文字コード | バイナリ |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. プラットフォーム検出
   └─ uname -sでOS種別を判定（Linux/Darwin/Windows_NT）
2. コンパイルフラグの設定
   └─ プラットフォームに応じたCXXFLAGS/LIBSの設定
3. pkg-configによるライブラリ情報取得
   └─ sdl3のcflags/libsを取得
4. ソースファイルのコンパイル
   └─ 各.cppファイルを.oファイルにコンパイル
5. リンク処理
   └─ オブジェクトファイルをリンクして実行ファイルを生成
6. ビルド完了メッセージの出力
   └─ "Build complete for [Platform]"
```

### フローチャート

```mermaid
flowchart TD
    A[make実行開始] --> B{プラットフォーム判定}
    B -->|Linux| C[Linux用フラグ設定]
    B -->|Darwin| D[macOS用フラグ設定]
    B -->|Windows_NT| E[MinGW用フラグ設定]
    C --> F[pkg-config sdl3実行]
    D --> F
    E --> F
    F --> G[ソースファイルコンパイル]
    G --> H[main.oの生成]
    H --> I[imgui*.oの生成]
    I --> J[imgui_impl_*.oの生成]
    J --> K[リンク処理]
    K --> L[example_sdl3_opengl3生成]
    L --> M[ビルド完了]
```

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

### 操作別データベース影響一覧

本バッチはデータベースを使用しない。

### テーブル別操作詳細

N/A（データベース操作なし）

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | コンパイルエラー | ソースコードに構文エラーがある場合 | エラーメッセージを確認し、ソースコードを修正 |
| N/A | リンクエラー | シンボル未定義、ライブラリ不足の場合 | SDL3/OpenGLのインストール状況を確認 |
| N/A | pkg-configエラー | sdl3の設定が見つからない場合 | SDL3を正しくインストール（ソースからビルド） |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | N/A（手動リトライ） |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

ビルドエラー発生時は、コンパイラ出力のエラーメッセージを確認し、依存ライブラリのインストール状況やソースコードを修正後、再度makeを実行する。

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

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A（ファイルシステム操作のみ） |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 8ソースファイル |
| 目標処理時間 | 数秒〜数十秒 |
| メモリ使用量上限 | 通常のC++コンパイルに必要なメモリ |

## 排他制御

同一ディレクトリで同時に複数のmakeプロセスを実行しないこと。オブジェクトファイルの競合が発生する可能性がある。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| 進捗ログ | コンパイル時 | 各ソースファイルのコンパイルコマンド |
| 終了ログ | ビルド完了時 | "Build complete for [Platform]" |
| エラーログ | エラー発生時 | コンパイラ/リンカーのエラーメッセージ |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | N/A | N/A（手動実行のため監視対象外） |

## 備考

- SDL3は開発中（unreleased/unpackaged）のため、ソースからのビルドが必要な場合がある
- Linuxでは-lGL -ldlおよびpkg-config sdl3を使用（LINUX_GL_LIBS変数で指定）
- macOSでは-framework OpenGL/Cocoa/IOKit/CoreVideoおよびpkg-config sdl3を使用
- Windowsでは-lgdi32 -lopengl32 -limm32およびpkg-config --staticを使用
- OpenGL ES対応オプションがコメントアウト状態で提供（-DIMGUI_IMPL_OPENGL_ES2）
- Raspberry Pi用のレガシーGL ESオプションも用意されている
- C++11標準を使用（-std=c++11）
- デバッグシンボル付きでビルド（-g）
