Introduction

The GetFullPerformanceInformation is a quick way to determine why your game may be experiencing poor performance. This method will not always reveal performance problems, but it's a great place to start when working on your game's performance.

Code Example

This method returns a string which can be printed out to screen using the Debugger's Write. The following code can be added to your Screen's CustomActivity to see information about your game:

FlatRedBall.Debugging.Debugger.TextCorner = FlatRedBall.Debugging.Debugger.Corner.TopLeft;
FlatRedBall.Debugging.Debugger.Write(FlatRedBall.Debugging.Debugger.GetFullPerformanceInformation());

[subpages depth="1"]

Introduction

WriteAutomaticallyUpdatedObjectInformation provides information about the automatically updated objects in the FlatRedBall Engine. Including a large number of automatically updated objects can be a common performance problem in FlatRedBall games, so this method is very useful in helping you diagnose and solve these problems.

Usage

The WriteAutomaticallyUpdatedObjectInformation can be called at any point in your application. To do so, add the following line of code:

FlatRedBall.Debugging.Debugger.WriteAutomaticallyUpdatedObjectInformation();

Note that if you prefer to use a different display method than the Text drawn by the Debugger, you can also call GetAutomaticallyUpdatedObjectInformation . For more information on how to use WriteAutomaticallyUpdatedObjectInformation, see this page.

The CommandLineWrite function can be used to append a single line to the debugger. CommandLineWrite cannot be used at the same time as Write - calling Write will clear the output, wiping out all CommandLineWrite texts. Keep in mind that any function that writes to the output may overwrite the command line buffer. Calling CommandLineWrite will append text and the text will appear on screen for subsequent frames.

Introduction

The TextRed, TextGreen, and TextBlue values control the color of the Text object used by the Debugger class. These three values range between 0 and 1, and the default value is 1,1,1 (white).

Color and CommandLineWrite

Currently the Debugger uses a single Text object for the entire "command line", meaning if you set the color, the color applies to all lines, not just the single line.

Introduction

The Debugger class provides a quick way to get real-time information in your game. It is commonly used to track down bugs which are easier to solve with real-time information, and to verify that implemented features are working as expected.

Write Method

The Write method can be used to display information to the Screen. The following code example shows how to display information about the Cursor to the Screen:

Add the following to Update:

Cursor cursor = FlatRedBall.Gui.GuiManager.Cursor;
string resultString = "World X: " + cursor.WorldXAt(0) + 
   "\nWorld Y: " + cursor.WorldYAt(0);
FlatRedBall.Debugging.Debugger.Write(resultString);