
# デバッグタブ

スターターは、Flutter のスターターの [デバッグパネル](../spring-boot-starter-flutter/debug-panel.md) に "Scenes" というタブを追加します。エンジン、画面上のすべてのシーン、すべてのモデルを名前で、それぞれのコストとともに示します。

## 使う理由

「遅いのはシーンか、ページか」や「このモデルのコストはどれだけか」は、デバイス上で実行中のアプリに尋ねる質問です。タブは、名前で答えます。名前は、各 `SpringSceneView` の `name` と、`spring.flutter.scene.models` と `spring.flutter.scene.materials` の名前です。

## 例

デバッグビルドでは、書くものは何もありません。タブはそこにあり、⌘⇧D (それ以外では Ctrl+Shift+D) がパネルを開きます。すべてのビルドに入れるには、次のようにします。

```yaml
# lib/resources/application.yml
spring:
  flutter:
    debug:
      enabled: true          # すべてのビルドにデバッグパネル
    scene:
      debug:
        enabled: true        # シーンのタブ。未設定: デバッグビルドとプロファイルビルド
```

## 表示するもの

- **エンジン**: 状態、起動の時間、シーンが描画されるモードと `spring.flutter.scene.when` の条件 (それぞれが見ているもの)、Web のページがクロスオリジン分離されているかどうか、言葉で表した起動のステップ。
- **画面上のすべてのシーンを名前で**: 一秒あたりのフレーム数と描画してよいフレーム数、静止している理由、サーフェス、最後のフレームについてのエンジンの数値 (ドローコール、頂点、フレームの中でバインドされたプログラムとビルドされたプログラム)、各パスとそのページのスレッド上の時間。
- **すべてのモデルを名前で**: ファイル、大きさ、読む時間とインポートの時間、何でできているか、そしてそれをすべての場所で隠すスイッチ。それがある場合とない場合のフレームの数値が、そのコストです。
- **すべてのマテリアルを名前で**: ファイル、照明の方式とブレンドされるかどうか、パラメーター、最初の読み込みにかかった時間とそれがスプラッシュとともにだったかアプリの実行中だったか、精度、シーンごとの画面上の使用、そして同じスイッチ。各シーン自身の行が、そのシーンが描画に使うマテリアルを示します。
- **メモリー**: エンジンのキャッシュが保持しているもの。

エンジンは、GPU 上の時間も、モデルごとの数値も与えません。モデルのコストは、それを隠すことで分かります。

## 行

| 部分 | 行 | 示すもの |
|---|---|---|
| Engine | Backend | エンジンの名前: `flutter_scene` |
| | State | `idle`、`starting`、`ready`、`failed` |
| | Start | 起動にかかった時間 |
| | Failure | 起動が失敗したときに投げられたもの |
| | Render | シーンがいま描画されるモードと、それを変えた条件 (`still (touch)`。警告)、そしてフレームの上限 |
| | When `<name>` | 条件 (`touch`、`slow`、アプリ独自の条件) ごとに一行。その条件が見ているものと、それが何をするか。`a touch screen: still` (成り立っている。警告)、`a mouse or none (still when it holds)`、`a touch screen: not followed` (`when` に書かれていない)。`slow` では、まず `measuring the first scenes (12 of 24 frames)`、その後はビートの中央値と `slow.frame-time` の半分 (`3.1 ms a beat of the scenes, of 8.0 ms`)。遅いビートで印が付くと `holds when no scene moves` が加わる。[コストがかかりすぎる場所で描画を減らす](speed.md#コストがかかりすぎる場所で描画を減らす) を参照 |
| | Page isolated | Web で: Flutter がワーカーで描画するか、ページのスレッドで描画するか |
| | Frames | Web で: エンジンのフレームが Flutter にどう届くか。`premultiplied`、あるいはブラウザー (WebKit) が WebGL のフレームをアルファで割る場合は乗算済みアルファなしで ([Safari: WebGL のフレームとそのアルファ](engine-notes.md#safari-webgl-のフレームとそのアルファ)) |
| | ステップ | これまでの起動のすべてのステップ。言葉で |
| Scenes on the screen | Frames | 直前の一秒に描画したフレーム数と、ビューが描画してよいフレーム数。または "a still frame" とその理由 |
| | Surface | ピクセルでのサーフェスの大きさと、ビュー独自のピクセル比 |
| | Frame | 最後のフレームの、ページのスレッド上の時間、ドローコール、頂点 |
| | Programs | バインドされたプログラムと、フレームの中でビルドされたプログラム |
| | Items | 検討されたアイテム、カリングされたアイテム、インスタンス |
| | Materials | シーンが描画に使うマテリアルと、その回数 |
| | パス | 各パスと、その時間とドローコール |
| Models | Source | プロパティが示すファイルの場所 |
| | State | `idle`、`loading`、`ready`、`failed` と、`eager` または `lazy` |
| | File | ファイルの大きさ |
| | Load | 読む時間とインポートの時間 |
| | Made of | ノード、メッシュ、一回の使用あたりのドローコール、マテリアル |
| Materials | Source | プロパティが示す `.fmat` ファイル |
| | State | `idle`、`loading`、`ready`、`failed` と、`eager` または `lazy` |
| | Shading | 照明の方式 (`unlit`、`lit` など) と、`opaque` または `blended` |
| | Precision | `highp` (どこでも float32)、あるいは `mediump` と `highp` と書かれた箇所: スマートフォンでは半精度、デスクトップでは float32。一つもない `mediump` は警告 ([精度](materials.md#精度-スマートフォンで描画が変わるもの)) |
| | Load | 最初の読み込みにかかった時間と、それがスプラッシュとともにだったかアプリの実行中だったか。実行中に 1 フレームより長くかかったもの (そのシーンが待った) は、事前に読み込むよう警告する |
| | Used | シーンごとの画面上の使用: `match-header x2` |
| | Parameters | パラメーターの名前 |
| Memory | | エンジンの各キャッシュが保持しているものと、合計 |

ビューが静止している理由は、三つのうちの一つです。`still` (プロパティ、または `spring.flutter.scene.when` の条件)、`motion` (システムが動きを減らすよう求めている)、`off-screen` です。

数値は一秒に二回読まれます。そのため、パネルがシーンのフレームごとにページを描画し直すことはありません。

## タブがアプリに含まれる時

`spring.flutter.scene.debug.enabled` は、デバッグパネル自身のプロパティと同じく、ジェネレーターが `main.spring.dart` を書き出すときに読みます。

| 値 | タブ |
|---|---|
| 未設定 (デフォルト) | デバッグビルドとプロファイルビルドだけ。リリースビルドではコンパイル時に取り除かれる |
| `true` | リリースを含むすべてのビルド |
| `false` | どのビルドにもない。アプリはそのコードを一切持たない |

タブは、ビルドにデバッグパネルがある場所 (`spring.flutter.debug.enabled`) に表示されます。プロファイルのファイルで `false` に設定すると、ビルドがタブを持つ実行中のアプリでも、タブは無効になります。[モジュールがアプリに含まれる時](../spring-boot-starter-flutter/debug-panel.md#モジュールがアプリに含まれる時) を参照してください。

## Bean

| Bean | 型 | 内容 |
|---|---|---|
| `sceneDebugSection` | `SceneDebugSection`。`DebugPanelSection` | タブ |
| `sceneDebug` | `SceneDebug`。`SceneViewObserver` | 画面上のビュー: `views`。それぞれが `name`、`state`、`framesPerSecond`、`frameCount`、`lastFrame`、`stats` を持つ |

これらの Bean がなければ (リリースビルド)、何も計測されません。

## 関連項目

- [デバッグパネル](../spring-boot-starter-flutter/debug-panel.md)
- [エンジンのログ](engine-log.md)
- [シーンのコスト](cost.md)
- [スマートフォンでの速さ](speed.md)
- [フレームメーター](../spring-boot-starter-flutter/frame-meter.md)
- [ビルドから外されるモジュール](../spring-core-dart-generator/optimizations/build-conditions.md)
