PerformanceOverlay class

Displays performance statistics.

The overlay show 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.

The simplest way to show the performance overlay is to set MaterialApp.showPerformanceOverlay or WidgetsApp.showPerformanceOverlay to true.

Inheritance

Constructors

PerformanceOverlay({Key key, int optionsMask: 0, int rasterizerThreshold: 0, bool checkerboardRasterCacheImages: false, bool checkerboardOffscreenLayers: false })
Create a performance overlay that only displays specific statistics. The mask is created by shifting 1 by the index of the specific PerformanceOverlayOption to enable.
const
PerformanceOverlay.allEnabled({Key key, int rasterizerThreshold: 0, bool checkerboardRasterCacheImages: false, bool checkerboardOffscreenLayers: false })
Create a performance overlay that displays all available statistics

Properties

checkerboardOffscreenLayers → bool
Whether the compositor should checkerboard layers that are rendered to offscreen bitmaps. This can be useful for debugging rendering performance. [...]
final
checkerboardRasterCacheImages → bool
Whether the raster cache should checkerboard cached entries. [...]
final
optionsMask → int
The mask is created by shifting 1 by the index of the specific PerformanceOverlayOption to enable.
final
rasterizerThreshold → int
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. [...]
final
hashCode → int
The hash code for this object. [...]
read-only, inherited
key → Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

createRenderObject(BuildContext context) → RenderPerformanceOverlay
Creates an instance of the RenderObject class that this RenderObjectWidget represents, using the configuration described by this RenderObjectWidget. [...]
override
updateRenderObject(BuildContext context, covariant RenderPerformanceOverlay renderObject) → void
Copies the configuration described by this RenderObjectWidget to the given RenderObject, which will be of the same type as returned by this object's createRenderObject. [...]
override
createElement() → LeafRenderObjectElement
RenderObjectWidgets always inflate to a RenderObjectElement subclass.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
inherited
didUnmountRenderObject(covariant RenderObject renderObject) → void
A render object previously associated with this widget has been removed from the tree. The given RenderObject will be of the same type as returned by this object's createRenderObject.
@protected, inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toDiagnosticsNode({String name, DiagnosticsTreeStyle style }) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by toStringDeep. [...]
inherited
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String
Returns a string representation of this object.
inherited
toStringDeep({String prefixLineOne: '', String prefixOtherLines, DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String
Returns a string representation of this node and its descendants. [...]
inherited
toStringShallow({String joiner: ', ', DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String
Returns a one-line detailed description of the object. [...]
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator. [...]
inherited