# 機能設計書 106-OpenGL

## 概要

本ドキュメントは、Avalonia UIフレームワークにおけるOpenGL統合機能の機能設計書である。OpenGLレンダリング対応とカスタムOpenGLコントロールの基盤を提供する。

### 本機能の処理概要

OpenGL統合機能は、Avaloniaアプリケーション内でOpenGLを使用したカスタム描画を可能にする。OpenGLControlBaseを継承することで、ゲーム、3Dビジュアライゼーション、科学計算の可視化など、高パフォーマンスなグラフィックス描画をUIコントロールとして組み込める。

**業務上の目的・背景**：標準的な2D UIコントロールだけでなく、3Dグラフィックスや高度なビジュアルエフェクトを必要とするアプリケーションが増えている。OpenGL統合により、CADソフトウェア、ゲームエンジン、科学計算ビューワーなど、高性能グラフィックスを必要とするアプリケーションをAvaloniaで構築可能になる。

**機能の利用シーン**：
- 3DモデルビューワーやCADアプリケーション
- ゲームや対話型シミュレーション
- 科学計算データの3Dビジュアライゼーション
- 動画編集ソフトウェアのプレビュー画面
- GPUアクセラレーションを活用したカスタム描画

**主要な処理内容**：
1. OpenGLコンテキストの作成と管理
2. EGL（Embedded Graphics Library）サポート
3. GlInterfaceを通じたOpenGL関数呼び出し
4. Compositionシステムとの統合
5. フレームバッファオブジェクト（FBO）管理
6. コンテキストロスト時のリカバリ

**関連システム・外部連携**：
- EGL（EGLDisplay、EGLContext、EGLSurface）
- プラットフォーム固有OpenGL実装（WGL、GLX、CGL等）
- Avalonia Compositionシステム

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

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 42 | OpenGL | 主機能 | OpenGL描画のデモ。OpenGLレンダリング |
| 43 | OpenGL Lease | 主機能 | OpenGL Leaseのデモ。OpenGLコンテキスト管理 |

## 機能種別

GPUレンダリング / グラフィックスAPI統合 / コントロール基盤

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| GlVersion | GlVersion | No | OpenGLバージョン情報 | - |
| Extensions | HashSet&lt;string&gt; | No | サポートするGL拡張機能 | - |

### 入力データソース

- システムOpenGLドライバー
- EGLディスプレイ/コンテキスト

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| GlInterface | GlInterface | OpenGL関数インターフェース |
| Framebuffer | int | 描画先フレームバッファID |

### 出力先

- Avalonia Compositionサーフェス
- 画面表示

## 処理フロー

### 処理シーケンス

```
1. OpenGlControlBase継承クラスの作成
2. ビジュアルツリーへのアタッチ
   └─ OnAttachedToVisualTreeでCompositor取得
3. 初期化（非同期）
   └─ TryGetCompositionGpuInterop
   └─ TryGetRenderInterfaceFeature
   └─ コンテキスト作成
4. OnOpenGlInit呼び出し
   └─ ユーザーのGL初期化コード
5. レンダリングループ
   └─ RequestNextFrameRendering
   └─ OnOpenGlRender呼び出し
6. クリーンアップ
   └─ OnOpenGlDeinit呼び出し
```

### フローチャート

```mermaid
flowchart TD
    A[OnAttachedToVisualTree] --> B[GetPresentationSource]
    B --> C[Compositor取得]
    C --> D[InitializeAsync]
    D --> E[TryGetCompositionGpuInterop]
    E --> F{interop取得成功?}
    F -->|No| G[エラーログ]
    F -->|Yes| H[コンテキスト作成]
    H --> I[OpenGlControlBaseResources作成]
    I --> J[OnOpenGlInit呼び出し]
    J --> K[RequestNextFrameRendering]
    K --> L[Update]
    L --> M[BeginDraw]
    M --> N[OnOpenGlRender呼び出し]
    N --> O{更新要求あり?}
    O -->|Yes| K
    O -->|No| P[待機]
    P --> O
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-106-1 | コンテキスト管理 | GL操作はOnOpenGlInit/Render/Deinit内でのみ実行可能 | 常時 |
| BR-106-2 | コンテキスト共有 | 可能な場合はRenderInterfaceとコンテキスト共有 | contextSharingFeature利用可能時 |
| BR-106-3 | コンテキストロスト | IsLost=trueの場合は再初期化 | デバイスロスト時 |
| BR-106-4 | フレームバッファサイズ | 表示スケーリングを考慮したピクセルサイズ | レンダリング時 |

### 計算ロジック

ピクセルサイズ計算:
```csharp
new PixelSize(
    Math.Max(1, (int)(Bounds.Width * scaling)),
    Math.Max(1, (int)(Bounds.Height * scaling)))
```

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

データベース操作なし。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| GL_INIT_FAIL | Exception | OpenGLコンテキスト作成失敗 | ドライバー/ハードウェア確認 |
| INTEROP_NOT_SUPPORTED | Error | GPUインターオペレーション未サポート | ソフトウェアレンダリングへフォールバック |
| CONTEXT_LOST | - | デバイスロスト | OnOpenGlLost呼び出し後再初期化 |

### リトライ仕様

コンテキストロスト時は自動再初期化を試行。

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

トランザクションなし。

## パフォーマンス要件

- GPUアクセラレーションによる高パフォーマンス描画
- コンテキスト共有によるリソース効率化
- RequestNextFrameRenderingで不要な描画を抑制

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

- OpenGLドライバーのセキュリティに依存
- シェーダーコードのインジェクション対策はアプリケーション責任

## 備考

- OpenGL ES 2.0/3.0、OpenGL 3.0以上をサポート
- プラットフォームによりEGL、WGL、GLXを使い分け

---

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

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

### 推奨読解順序

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

GLインターフェースとコンテキスト情報の構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | GlInterface.cs | `src/Avalonia.OpenGL/GlInterface.cs` | GL関数ラッパー、GlContextInfo、GetProcAddress |
| 1-2 | GlVersion.cs | `src/Avalonia.OpenGL/GlVersion.cs` | OpenGLバージョン情報 |

**読解のコツ**: GetProcAddress属性でGL関数をpartialメソッドとして宣言。GlMinVersionEntryPointで最小バージョン指定。

#### Step 2: コントロール基盤を理解する

OpenGLコントロールの抽象基底クラスを理解。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | OpenGlControlBase.cs | `src/Avalonia.OpenGL/Controls/OpenGlControlBase.cs` | 抽象基底クラス、ライフサイクル管理 |

**主要処理フロー**:
- **83-87行目**: OnDetachedFromVisualTreeでクリーンアップ
- **90-95行目**: OnAttachedToVisualTreeでCompositor取得
- **161-197行目**: EnsureInitialized()で初期化状態管理
- **201-209行目**: Update()でレンダリング実行
- **277-304行目**: 仮想メソッド（OnOpenGlInit/Deinit/Render/Lost）

#### Step 3: EGL統合を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | EglInterface.cs | `src/Avalonia.OpenGL/Egl/EglInterface.cs` | EGL関数ラッパー |
| 3-2 | EglContext.cs | `src/Avalonia.OpenGL/Egl/EglContext.cs` | EGLコンテキスト管理 |
| 3-3 | EglDisplay.cs | `src/Avalonia.OpenGL/Egl/EglDisplay.cs` | EGLディスプレイ管理 |

#### Step 4: サーフェス管理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | IGlPlatformSurface.cs | `src/Avalonia.OpenGL/Surfaces/IGlPlatformSurface.cs` | プラットフォームサーフェスインターフェース |

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

```
OpenGlControlBase (ユーザー継承クラス)
    │
    ├─ OnAttachedToVisualTree
    │      └─ RequestNextFrameRendering
    │
    ├─ EnsureInitialized
    │      └─ InitializeAsync
    │             │
    │             ├─ TryGetCompositionGpuInterop
    │             ├─ TryGetRenderInterfaceFeature
    │             │
    │             └─ EnsureInitializedCore
    │                    │
    │                    ├─ CreateDrawingSurface
    │                    ├─ OpenGlControlBaseResources.TryCreate
    │                    │      └─ IGlContext作成
    │                    │
    │                    └─ OnOpenGlInit (ユーザー実装)
    │
    └─ Update
           │
           └─ OnOpenGlRender (ユーザー実装)
                  └─ GlInterface経由でGL呼び出し
```

### データフロー図

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

システムGL ───────────▶ GlInterface.GetProcAddress ────▶ GL関数ポインタ
                              │
                              ▼
ユーザーGL呼び出し ────▶ GlInterface.Xxx() ─────────▶ GPUコマンド
                              │
                              ▼
Compositionサーフェス ◀── OpenGlControlBaseResources ◀── FBO描画
                              │
                              ▼
                         Compositor ──────────────────▶ 画面表示
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| GlInterface.cs | `src/Avalonia.OpenGL/GlInterface.cs` | ソース | OpenGL関数ラッパー |
| GlBasicInfoInterface.cs | `src/Avalonia.OpenGL/GlBasicInfoInterface.cs` | ソース | 基本GL情報取得 |
| GlConsts.cs | `src/Avalonia.OpenGL/GlConsts.cs` | ソース | GL定数定義 |
| GlVersion.cs | `src/Avalonia.OpenGL/GlVersion.cs` | ソース | バージョン情報 |
| IGlContext.cs | `src/Avalonia.OpenGL/IGlContext.cs` | ソース | コンテキストインターフェース |
| OpenGlControlBase.cs | `src/Avalonia.OpenGL/Controls/OpenGlControlBase.cs` | ソース | コントロール基底クラス |
| OpenGlControlResources.cs | `src/Avalonia.OpenGL/Controls/OpenGlControlResources.cs` | ソース | コントロールリソース管理 |
| CompositionOpenGlSwapchain.cs | `src/Avalonia.OpenGL/Controls/CompositionOpenGlSwapchain.cs` | ソース | スワップチェーン管理 |
| EglInterface.cs | `src/Avalonia.OpenGL/Egl/EglInterface.cs` | ソース | EGL関数ラッパー |
| EglContext.cs | `src/Avalonia.OpenGL/Egl/EglContext.cs` | ソース | EGLコンテキスト |
| EglDisplay.cs | `src/Avalonia.OpenGL/Egl/EglDisplay.cs` | ソース | EGLディスプレイ |
| EglSurface.cs | `src/Avalonia.OpenGL/Egl/EglSurface.cs` | ソース | EGLサーフェス |
