GKDebugOverlay class
A debug overlay that displays real-time FPS, uniform values, and memory information on top of its child widget.
Useful during development to monitor performance of shader effects. The overlay appears as a small draggable pill in the top-right corner. Tap to expand or collapse the details.
{@tool snippet}
GKDebugOverlay(
showFps: true,
showUniforms: true,
showMemory: false,
child: MyApp(),
)
{@end-tool}
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- GKDebugOverlay
Constructors
- GKDebugOverlay({Key? key, required Widget child, bool showFps = true, bool showUniforms = false, bool showMemory = false})
-
Creates a GKDebugOverlay.
const
Properties
- child → Widget
-
The widget tree rendered beneath the overlay.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showFps → bool
-
Whether to display the FPS counter.
final
- showMemory → bool
-
Whether to display memory usage.
final
- showUniforms → bool
-
Whether to display current uniform values.
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< GKDebugOverlay> -
Creates the mutable state for this widget at a given location in the tree.
override
-
debugDescribeChildren(
) → List< DiagnosticsNode> -
Returns a list of DiagnosticsNode objects describing this node's
children.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent 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 DiagnosticsNode.toStringDeep.
inherited
-
toString(
{DiagnosticLevel minLevel = DiagnosticLevel.info}) → String -
A string representation of this object.
inherited
-
toStringDeep(
{String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → 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 ==(
Object other) → bool -
The equality operator.
inherited