# 機能設計書 58-シェーダーエフェクト切替

## 概要

本ドキュメントは、Windows Terminal における「シェーダーエフェクト切替」機能の設計を記述する。ToggleShaderEffects アクションにより、レトロターミナルエフェクトやカスタムピクセルシェーダーのオン/オフを切り替える機能である。

### 本機能の処理概要

**業務上の目的・背景**：ターミナルの視覚的な演出として、レトロCRTモニター風のエフェクト（走査線、グリーン蛍光、画面湾曲）やユーザー定義のカスタムピクセルシェーダーを適用できる。これらのエフェクトをワンアクションで切り替え可能にすることで、通常作業時と演出時の切り替えを容易にする。

**機能の利用シーン**：ユーザーがレトロターミナルの雰囲気を楽しみたい場合や、カスタムシェーダーによる独自の視覚効果を適用/解除したい場合に利用する。キーバインドでの素早い切り替えが主な操作方法。

**主要な処理内容**：
1. ユーザーが ToggleShaderEffects アクションを実行
2. _ApplyToActiveControls で全アクティブコントロールに処理を適用
3. ControlCore::ToggleShaderEffects が実行される
4. カスタムシェーダーパスの有無に応じた切り替え
   - パスが空の場合：レトロターミナルエフェクトのトグル
   - パスが指定されている場合：カスタムシェーダーの有効/無効トグル
5. レンダラーの全体再描画をトリガー

**関連システム・外部連携**：DirectX レンダリングエンジン（Atlas）のピクセルシェーダー機構と連携する。プロファイル設定の PixelShaderPath 値を参照する。

**権限による制御**：特になし。すべてのユーザーが利用可能。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 1 | TerminalPage（メイン画面） | 主画面 | _HandleToggleShaderEffectsによりピクセルシェーダーを切替 |
| 6 | TermControl（ターミナル表示） | 主画面 | ToggleShaderEffectsによりエフェクトを切替 |

## 機能種別

外観設定操作 / トグル操作

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| なし | - | - | パラメータなし。トグル操作 | - |

### 入力データソース

キーバインド設定またはコマンドパレットからの ToggleShaderEffects アクション。プロファイル設定の PixelShaderPath を参照して動作を決定する。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| Handled | bool | 処理結果（_ApplyToActiveControls の戻り値） |

### 出力先

レンダリングエンジンのシェーダー設定が変更され、画面全体が再描画される。

## 処理フロー

### 処理シーケンス

```
1. TerminalPage::_HandleToggleShaderEffects がアクションイベントを受信
2. _ApplyToActiveControls で control.ToggleShaderEffects() を呼び出し
3. ControlCore::ToggleShaderEffects が実行される
   └─ _settings.PixelShaderPath() でカスタムシェーダーパスを取得
4. ターミナルの書き込みロックを取得（LockForWriting）
5. シェーダーパスの判定
   ├─ パスが空の場合:
   │   └─ SetRetroTerminalEffect(!GetRetroTerminalEffect()) でレトロエフェクトをトグル
   └─ パスが指定されている場合:
       └─ SetPixelShaderPath で空パス/設定パスを切り替え
6. _renderer->TriggerRedrawAll() で全体再描画
```

### フローチャート

```mermaid
flowchart TD
    A[ToggleShaderEffects アクション受信] --> B[_ApplyToActiveControls]
    B --> C[ControlCore::ToggleShaderEffects]
    C --> D[PixelShaderPath を取得]
    D --> E[LockForWriting 取得]
    E --> F{PixelShaderPath が空?}
    F -->|Yes| G[SetRetroTerminalEffect をトグル]
    F -->|No| H{現在のシェーダーパスが空?}
    H -->|Yes| I[SetPixelShaderPath に設定パスを設定]
    H -->|No| J[SetPixelShaderPath を空に設定]
    G --> K[TriggerRedrawAll で全体再描画]
    I --> K
    J --> K
    K --> L[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-58-1 | レトロエフェクト優先 | PixelShaderPath が未設定の場合、レトロターミナルエフェクトをトグルする | PixelShaderPath が空 |
| BR-58-2 | カスタムシェーダートグル | PixelShaderPath が設定されている場合、カスタムシェーダーの有効/無効をトグルする | PixelShaderPath が非空 |
| BR-58-3 | 即時再描画 | エフェクト変更後は即座に全体再描画を行う（フォーカスの有無にかかわらず） | 常時 |

### 計算ロジック

- レトロエフェクトトグル: `SetRetroTerminalEffect(!GetRetroTerminalEffect())`
- カスタムシェーダートグル: 現在のパスが空なら設定パスを適用、非空なら空に設定

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

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

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

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| なし | シェーダーコンパイル失敗 | カスタムシェーダーのHLSLコードが不正な場合 | レンダリングエンジンがエラーハンドリング |

### リトライ仕様

リトライ処理は不要。

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

ターミナルの書き込みロック（LockForWriting）を取得して排他制御を行う。

## パフォーマンス要件

シェーダーの切り替え自体は即座に完了する。TriggerRedrawAll による全体再描画が発生する。

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

カスタムシェーダーパスはユーザーのローカルファイルシステム上のHLSLファイルを参照する。外部からのパスインジェクションリスクはプロファイル設定レベルで制御される。

## 備考

- レトロターミナルエフェクトは settings.json の `experimental.retroTerminalEffect` で初期状態を設定可能
- カスタムシェーダーは `experimental.pixelShaderPath` で HLSL ファイルを指定

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | ControlCore.h | `src/cascadia/TerminalControl/ControlCore.h` | ToggleShaderEffects の宣言 |
| 1-2 | ControlCore.idl | `src/cascadia/TerminalControl/ControlCore.idl` | ToggleShaderEffects の IDL 定義 |

**読解のコツ**: ToggleShaderEffects にはパラメータがない。内部で _settings.PixelShaderPath() を参照して動作を分岐する。レンダリングエンジンの SetRetroTerminalEffect / SetPixelShaderPath が直接操作される。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | _HandleToggleShaderEffects メソッド（591-598行目） |

**主要処理フロー**:
1. **591-598行目**: _ApplyToActiveControls で control.ToggleShaderEffects() を呼び出し、戻り値で Handled を設定

#### Step 3: ControlCore のシェーダー切替処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | ToggleShaderEffects メソッド（793-813行目） |

**主要処理フロー**:
- **793行目**: _settings.PixelShaderPath() でカスタムシェーダーパスを取得
- **796行目**: LockForWriting 取得
- **802-804行目**: パスが空の場合、SetRetroTerminalEffect をトグル
- **808行目**: パスが非空の場合、SetPixelShaderPath をトグル
- **812行目**: TriggerRedrawAll() で全体再描画

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

```
TerminalPage::_HandleToggleShaderEffects (AppActionHandlers.cpp:591)
    │
    └─ _ApplyToActiveControls
           │
           └─ ControlCore::ToggleShaderEffects (ControlCore.cpp:793)
                  │
                  ├─ _settings.PixelShaderPath() → パス判定
                  │
                  ├─ [パス空] _renderEngine->SetRetroTerminalEffect(toggle)
                  │
                  ├─ [パス非空] _renderEngine->SetPixelShaderPath(toggle)
                  │
                  └─ _renderer->TriggerRedrawAll()
```

### データフロー図

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

ToggleShaderEffects ───▶ TerminalPage                   ───▶ シェーダー設定変更
アクション                   ::_HandleToggleShaderEffects        + 全体再描画
(パラメータなし)                  │
                                 ▼
                            ControlCore::ToggleShaderEffects
                                 │
                                 ├─ PixelShaderPath ◀── プロファイル設定
                                 │
                                 ▼
                            RenderEngine
                            ├─ SetRetroTerminalEffect ──▶ レトロエフェクト
                            └─ SetPixelShaderPath ──────▶ カスタムシェーダー
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| AppActionHandlers.cpp | `src/cascadia/TerminalApp/AppActionHandlers.cpp` | ソース | _HandleToggleShaderEffects アクションハンドラー |
| ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | ソース | ToggleShaderEffects の実装 |
| ControlCore.h | `src/cascadia/TerminalControl/ControlCore.h` | ヘッダー | ToggleShaderEffects メソッド宣言 |
| ControlCore.idl | `src/cascadia/TerminalControl/ControlCore.idl` | IDL | ToggleShaderEffects の IDL 定義 |
| AllShortcutActions.h | `src/cascadia/TerminalSettingsModel/AllShortcutActions.h` | ヘッダー | ToggleShaderEffects アクション登録 |
| TermControl.cpp | `src/cascadia/TerminalControl/TermControl.cpp` | ソース | TermControl の ToggleShaderEffects ラッパー |
| defaults.json | `src/cascadia/TerminalSettingsModel/defaults.json` | 設定 | デフォルトキーバインド定義 |
