performance_overlay.dart 6.62 KB
Newer Older
1 2 3 4
// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
import 'box.dart';
6
import 'layer.dart';
7
import 'object.dart';
8

9 10 11 12 13 14
/// The options that control whether the performance overlay displays certain
/// aspects of the compositor.
enum PerformanceOverlayOption {
  // these must be in the order needed for their index values to match the
  // constants in //engine/src/sky/compositor/performance_overlay_layer.h

15 16 17 18 19 20 21 22
  /// Display the frame time and FPS of the last frame rendered. This field is
  /// updated every frame.
  ///
  /// This is the time spent by the rasterizer as it tries
  /// to convert the layer tree obtained from the widgets into OpenGL commands
  /// and tries to flush them onto the screen. When the total time taken by this
  /// step exceeds the frame slice, a frame is lost.
  displayRasterizerStatistics,
23

24 25 26 27 28
  /// Display the rasterizer frame times as they change over a set period of
  /// time in the form of a graph. The y axis of the graph denotes the total
  /// time spent by the rasterizer as a fraction of the total frame slice. When
  /// the bar turns red, a frame is lost.
  visualizeRasterizerStatistics,
29

30 31 32 33 34 35 36
  /// Display the frame time and FPS at which the interface can construct a
  /// layer tree for the rasterizer (whose behavior is described above) to
  /// consume.
  ///
  /// This involves all layout, animations, etc. When the total time taken by
  /// this step exceeds the frame slice, a frame is lost.
  displayEngineStatistics,
37

38 39
  /// Display the engine frame times as they change over a set period of time
  /// in the form of a graph. The y axis of the graph denotes the total time
40
  /// spent by the engine as a fraction of the total frame slice. When the bar
41 42 43
  /// turns red, a frame is lost.
  visualizeEngineStatistics,
}
44

45 46
/// Displays performance statistics.
///
Sigurd Meldgaard's avatar
Sigurd Meldgaard committed
47 48 49 50 51 52 53 54
/// The overlay shows two time series. The first shows how much time was
/// required on this thread to produce each frame. The second shows how much
/// time was required on the GPU thread to produce each frame. Ideally, both
/// these values would be less than the total frame budget for the hardware on
/// which the app is running. For example, if the hardware has a screen that
/// updates at 60 Hz, each thread should ideally spend less than 16ms producing
/// each frame. This ideal condition is indicated by a green vertical line for
/// each thread. Otherwise, the performance overlay shows a red vertical line.
55 56 57
///
/// The simplest way to show the performance overlay is to set
/// [MaterialApp.showPerformanceOverlay] or [WidgetsApp.showPerformanceOverlay]
58
/// to true.
59
class RenderPerformanceOverlay extends RenderBox {
60 61
  /// Creates a performance overlay render object.
  ///
62 63
  /// The [optionsMask], [rasterizerThreshold], [checkerboardRasterCacheImages],
  /// and [checkerboardOffscreenLayers] arguments must not be null.
64
  RenderPerformanceOverlay({
65 66 67 68
    int optionsMask = 0,
    int rasterizerThreshold = 0,
    bool checkerboardRasterCacheImages = false,
    bool checkerboardOffscreenLayers = false,
69 70 71 72 73 74 75 76
  }) : assert(optionsMask != null),
       assert(rasterizerThreshold != null),
       assert(checkerboardRasterCacheImages != null),
       assert(checkerboardOffscreenLayers != null),
       _optionsMask = optionsMask,
       _rasterizerThreshold = rasterizerThreshold,
       _checkerboardRasterCacheImages = checkerboardRasterCacheImages,
       _checkerboardOffscreenLayers = checkerboardOffscreenLayers;
77

78
  /// The mask is created by shifting 1 by the index of the specific
79
  /// [PerformanceOverlayOption] to enable.
80
  int get optionsMask => _optionsMask;
81
  int _optionsMask;
82 83 84
  set optionsMask(int value) {
    assert(value != null);
    if (value == _optionsMask)
85
      return;
86
    _optionsMask = value;
87 88 89
    markNeedsPaint();
  }

90 91 92
  /// The rasterizer threshold is an integer specifying the number of frame
  /// intervals that the rasterizer must miss before it decides that the frame
  /// is suitable for capturing an SkPicture trace for further analysis.
93
  int get rasterizerThreshold => _rasterizerThreshold;
94
  int _rasterizerThreshold;
95
  set rasterizerThreshold(int value) {
96 97
    assert(value != null);
    if (value == _rasterizerThreshold)
98
      return;
99
    _rasterizerThreshold = value;
100 101 102
    markNeedsPaint();
  }

103 104 105
  /// Whether the raster cache should checkerboard cached entries.
  bool get checkerboardRasterCacheImages => _checkerboardRasterCacheImages;
  bool _checkerboardRasterCacheImages;
106
  set checkerboardRasterCacheImages(bool value) {
107 108
    assert(value != null);
    if (value == _checkerboardRasterCacheImages)
109
      return;
110
    _checkerboardRasterCacheImages = value;
111 112 113
    markNeedsPaint();
  }

114 115 116 117 118 119 120 121 122 123 124
  /// Whether the compositor should checkerboard layers rendered to offscreen bitmaps.
  bool get checkerboardOffscreenLayers => _checkerboardOffscreenLayers;
  bool _checkerboardOffscreenLayers;
  set checkerboardOffscreenLayers(bool value) {
    assert(value != null);
    if (value == _checkerboardOffscreenLayers)
      return;
    _checkerboardOffscreenLayers = value;
    markNeedsPaint();
  }

125
  @override
126
  bool get sizedByParent => true;
127 128

  @override
129
  bool get alwaysNeedsCompositing => true;
130

131
  @override
132
  double computeMinIntrinsicWidth(double height) {
133
    return 0.0;
134 135
  }

136
  @override
137
  double computeMaxIntrinsicWidth(double height) {
138
    return 0.0;
139 140
  }

141
  double get _intrinsicHeight {
Hixie's avatar
Hixie committed
142
    const double kDefaultGraphHeight = 80.0;
143
    double result = 0.0;
144 145
    if ((optionsMask | (1 << PerformanceOverlayOption.displayRasterizerStatistics.index) > 0) ||
        (optionsMask | (1 << PerformanceOverlayOption.visualizeRasterizerStatistics.index) > 0))
Hixie's avatar
Hixie committed
146
      result += kDefaultGraphHeight;
147 148
    if ((optionsMask | (1 << PerformanceOverlayOption.displayEngineStatistics.index) > 0) ||
        (optionsMask | (1 << PerformanceOverlayOption.visualizeEngineStatistics.index) > 0))
Hixie's avatar
Hixie committed
149
      result += kDefaultGraphHeight;
150
    return result;
151 152
  }

153
  @override
154
  double computeMinIntrinsicHeight(double width) {
155
    return _intrinsicHeight;
156 157
  }

158
  @override
159
  double computeMaxIntrinsicHeight(double width) {
160
    return _intrinsicHeight;
161 162
  }

163
  @override
164
  void performResize() {
165
    size = constraints.constrain(Size(double.infinity, _intrinsicHeight));
166 167
  }

168
  @override
169
  void paint(PaintingContext context, Offset offset) {
170
    assert(needsCompositing);
171 172
    context.addLayer(PerformanceOverlayLayer(
      overlayRect: Rect.fromLTWH(offset.dx, offset.dy, size.width, size.height),
173
      optionsMask: optionsMask,
174 175
      rasterizerThreshold: rasterizerThreshold,
      checkerboardRasterCacheImages: checkerboardRasterCacheImages,
176
      checkerboardOffscreenLayers: checkerboardOffscreenLayers,
177
    ));
178 179
  }
}