Debug features¶
FPS counter¶
Flame provides the FPSCounter
mixin for recording the fps; this mixin can be applied on any class
that extends from Game
. Once applied you can access the current fps by using the fps
method,
like shown in the example below.
class MyGame extends FlameGame with FPSCounter {
static final fpsTextConfig = TextConfig(color: BasicPalette.white.color);
@override
void render(Canvas canvas) {
super.render(canvas);
final fpsCount = fps(120); // The average FPS for the last 120 microseconds.
fpsTextConfig.render(canvas, fpsCount.toString(), Vector2(0, 50));
}
}
FlameGame features¶
Flame provides some debugging features for the FlameGame
class. These features are enabled when
the debugMode
property is set to true
(or overridden to be true
).
When debugMode
is enabled, each PositionComponent
will be rendered with their bounding size, and
have their positions written on the screen. This way, you can visually verify the components
boundaries and positions.
To see a working example of the debugging features of the FlameGame
, check this
example.
The content on this page is licensed under the CC BY 4.0 License,
and code samples under the MIT License.