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 showPerformanceOverlay to true.

Inheritance

Constructors

PerformanceOverlay({Key key, int optionsMask: 0, int rasterizerThreshold: 0, bool checkerboardRasterCacheImages: false })

Create a performance overlay that only displays specific statistics. The mask is created by shifting 1 by the index of the specific StatisticOption to enable.

PerformanceOverlay.allEnabled({Key key, int rasterizerThreshold: 0, bool checkerboardRasterCacheImages: false })

Create a performance overlay that displays all available statistics

Properties

checkerboardRasterCacheImages → bool

Whether the raster cache should checkerboard cached entries.

read-only
optionsMask → int

The mask is created by shifting 1 by the index of the specific PerformanceOverlayOption to enable.

read-only
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.

read-only
hashCode → int

Get a hash code for this object.

read-only, inherited
key → Key

Controls how one widget replaces another widget in the tree.

read-only, inherited
runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited

Operators

operator ==(other) → bool

The equality operator.

inherited

Methods

createRenderObject(BuildContext context) → RenderPerformanceOverlay

Creates an instance of the RenderObject class that this RenderObjectWidget represents, using the configuration described by this RenderObjectWidget.

updateRenderObject(BuildContext context, 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.

createElement() → LeafRenderObjectElement

RenderObjectWidgets always inflate to a RenderObjectElement subclass.

inherited
debugFillDescription(List<String> description) → void

Add additional information to the given description for use by toString.

inherited
didUnmountRenderObject(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.

inherited
noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited
toString() → String

Returns a string representation of this object.

inherited
toStringShort() → String

A short, textual description of this widget.

inherited