# 機能設計書 12-カスタムシェーダー

## 概要

本ドキュメントは、GhosttyのカスタムシェーダーDr機能の設計について記述する。Shadertoyスタイルのカスタムシェーダーを適用することで、端末画面にポストプロセッシングエフェクトを追加できる機能である。

### 本機能の処理概要

**業務上の目的・背景**：
ターミナルエミュレータの視覚的なカスタマイズ性を向上させるため、ユーザーがGLSLシェーダーを記述して独自のビジュアルエフェクトを適用できる機能を提供する。CRTモニター風のエフェクト、スキャンライン、グロー効果など、様々な視覚演出が可能となり、ユーザーエクスペリエンスの個性化に貢献する。

**機能の利用シーン**：
- CRTモニター風のレトロな見た目を再現
- スキャンラインやグローエフェクトの適用
- フォーカス時/非フォーカス時の視覚的フィードバック
- クリエイティブなターミナル表示のカスタマイズ

**主要な処理内容**：
1. Shadertoyスタイルのシェーダーファイル読み込み
2. GLSLからSPIR-Vへの変換（glslang使用）
3. SPIR-VからターゲットフォーマットへのCross-Compile（spirv-cross使用）
4. MSL（Metal Shading Language）またはGLSL 430への変換
5. ユニフォーム変数によるシェーダーへのパラメータ渡し
6. フレームごとのシェーダー実行とポストプロセッシング

**関連システム・外部連携**：
- glslang（GLSL → SPIR-V変換）
- spirv-cross（SPIR-V → MSL/GLSL変換）
- Metalレンダラー（macOS）
- OpenGLレンダラー（Linux）

**権限による制御**：
特になし。設定ファイルでシェーダーパスを指定することで有効化。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | メインターミナルウィンドウ | 主画面 | シェーダーエフェクトの適用・表示 |

## 機能種別

レンダリング処理（ポストプロセッシング）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| paths | RepeatablePath | Yes | シェーダーファイルパス | 有効なファイルパス |
| target | Target | Yes | 出力ターゲット（glsl/msl） | enum値 |
| src | []const u8 | Yes | シェーダーソースコード | 有効なShadertoyシェーダー |

### 入力データソース

- 設定ファイル（custom-shader設定）
- シェーダーソースファイル（.glsl）

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| shader | [:0]const u8 | コンパイル済みシェーダーコード |
| uniforms | Uniforms | シェーダーに渡すユニフォーム値 |

### 出力先

- Metalレンダラー（MSL形式）
- OpenGLレンダラー（GLSL 430形式）

## 処理フロー

### 処理シーケンス

```
1. シェーダーファイル読み込み
   └─ loadFromFilesで複数ファイルを読み込み
2. Shadertoyプレフィックス追加
   └─ glslFromShaderでユニフォーム定義を追加
3. GLSL → SPIR-V変換
   └─ spirvFromGlslでglslangを使用
4. SPIR-V → ターゲット変換
   └─ mslFromSpvまたはglslFromSpvでspirv-crossを使用
5. シェーダープログラム生成
   └─ レンダラーでパイプライン作成
6. フレームごとのユニフォーム更新
   └─ 時間・マウス位置・フォーカス状態等を更新
```

### フローチャート

```mermaid
flowchart TD
    A[シェーダーファイル読み込み] --> B[Shadertoyプレフィックス追加]
    B --> C[GLSL → SPIR-V変換]
    C --> D{ターゲット}
    D -->|macOS| E[SPIR-V → MSL]
    D -->|Linux| F[SPIR-V → GLSL 430]
    E --> G[パイプライン作成]
    F --> G
    G --> H[フレームレンダリング]
    H --> I[ユニフォーム更新]
    I --> H
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-01 | ファイルサイズ制限 | シェーダーファイルは最大4MBまで | ファイル読み込み時 |
| BR-02 | オプショナルパス | optionalプレフィックスでファイル不在を許容 | パス指定時 |
| BR-03 | シェーダー順序保持 | 複数シェーダーは指定順序で適用 | 複数シェーダー時 |

### 計算ロジック

ユニフォーム値の算出：
- `iTime`: 最初のフレームからの経過秒数
- `iTimeDelta`: 前フレームからの経過秒数
- `iResolution`: ビューポートの解像度（ピクセル）
- `iMouse`: マウス位置（ピクセル座標）

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

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| FileNotFound | ファイルエラー | シェーダーファイルが見つからない | オプショナルなら無視、必須ならエラー |
| GlslangFailed | コンパイルエラー | GLSL構文エラー | エラーログ出力 |
| SpvcFailed | 変換エラー | SPIR-V変換失敗 | エラーログ出力 |
| SpirvInvalid | 検証エラー | SPIR-Vバイナリが不正 | エラー返却 |

### リトライ仕様

リトライなし。エラー時はシェーダーなしで描画継続。

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

該当なし

## パフォーマンス要件

- シェーダーコンパイルは起動時に1回のみ
- フレームごとのユニフォーム更新は軽量
- 複雑なシェーダーでもフレームレートへの影響を最小化

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

- シェーダーコードはローカルファイルからのみ読み込み
- 外部URLからのシェーダー読み込みは不可
- シェーダー実行はGPU上で隔離されて実行

## 備考

- Shadertoyとの互換性：mainImage関数のみサポート
- iChannel等のテクスチャ入力は未サポート

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | shadertoy.zig | `src/renderer/shadertoy.zig` | Uniforms構造体（12-40行目）の各フィールドの意味 |

**読解のコツ**: Uniforms構造体はShadertoyの標準ユニフォーム（iTime, iResolution等）にGhostty固有の拡張（cursor_*, palette等）を追加したもの。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | shadertoy.zig | `src/renderer/shadertoy.zig` | loadFromFiles関数（47-74行目） |
| 2-2 | shadertoy.zig | `src/renderer/shadertoy.zig` | loadFromFile関数（78-139行目） |

**主要処理フロー**:
1. **47-74行目**: loadFromFilesで複数のシェーダーパスを処理、オプショナル/必須の判定
2. **88-98行目**: ファイル読み込み（最大4MB）
3. **100-106行目**: glslFromShaderでShadertoyプレフィックス追加
4. **108-130行目**: spirvFromGlslでSPIR-V変換

#### Step 3: シェーダー変換処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | shadertoy.zig | `src/renderer/shadertoy.zig` | glslFromShader関数（147-152行目） |
| 3-2 | shadertoy.zig | `src/renderer/shadertoy.zig` | spirvFromGlsl関数（155-208行目） |
| 3-3 | shadertoy.zig | `src/renderer/shadertoy.zig` | mslFromSpv/glslFromSpv関数（241-274行目） |

**主要処理フロー**:
- **147-152行目**: Shadertoyプレフィックス（shadertoy_prefix.glsl）を追加してフルGLSLに変換
- **163-178行目**: glslangの入力設定（Vulkan 1.2、SPV 1.5ターゲット）
- **180-202行目**: シェーダーのプリプロセス・パース・リンク
- **243-256行目**: spirv-crossでMSLに変換（decoration binding有効化）
- **259-274行目**: spirv-crossでGLSL 430に変換

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

```
loadFromFiles()
    │
    ├─ loadFromFile()
    │      │
    │      ├─ glslFromShader()
    │      │      └─ shadertoy_prefix.glsl を埋め込み
    │      │
    │      ├─ spirvFromGlsl()
    │      │      ├─ glslang.Shader.create()
    │      │      ├─ shader.preprocess()
    │      │      ├─ shader.parse()
    │      │      ├─ program.link()
    │      │      └─ program.spirvGenerate()
    │      │
    │      └─ mslFromSpv() / glslFromSpv()
    │             └─ spvCross()
    │                    ├─ spvc_context_parse_spirv()
    │                    ├─ spvc_context_create_compiler()
    │                    └─ spvc_compiler_compile()
    │
    └─ ArrayList.append()
```

### データフロー図

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

シェーダーファイル ───▶ glslFromShader() ───▶ フルGLSL
        │
        ▼
フルGLSL ──────────▶ spirvFromGlsl() ────▶ SPIR-V Binary
        │
        ▼
SPIR-V Binary ─────▶ mslFromSpv() ──────▶ MSL (macOS)
        │
        └──────────▶ glslFromSpv() ─────▶ GLSL 430 (Linux)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| shadertoy.zig | `src/renderer/shadertoy.zig` | ソース | シェーダー変換メイン処理 |
| shadertoy_prefix.glsl | `src/renderer/shaders/shadertoy_prefix.glsl` | シェーダー | Shadertoy互換用プレフィックス |
| test_shadertoy_crt.glsl | `src/renderer/shaders/test_shadertoy_crt.glsl` | テスト | CRTエフェクトテスト用シェーダー |
| generic.zig | `src/renderer/generic.zig` | ソース | シェーダー適用のレンダリング処理 |
| Metal.zig | `src/renderer/Metal.zig` | ソース | Metalレンダラーでのシェーダー使用 |
| OpenGL.zig | `src/renderer/OpenGL.zig` | ソース | OpenGLレンダラーでのシェーダー使用 |
