Changes between Version 6 and Version 7 of EngineProfiling

Timestamp:

Sep 7, 2013, 5:46:33 AM (11 years ago)

Author:

historic_bruno

Comment:

Add stub for profiler2

EngineProfiling

@@ -33 +33 @@
 
 Pressing Shift+F11 will save `profile.txt` in the game's logs folder (see GameDataPaths). Pressing it multiple times (without restarting the game) will append new measurements to that file.
+
+== Profiler2 ==
+
+The in-game profiler is designed to show average performance data at an instant in time. While this is adequate for some purposes, it's not as good for analyzing rapid fluctuations in game performance. It also doesn't support multiple threads, so only the engine thread can be analyzed. To solve these shortcomings, proflier2 was [http://www.wildfiregames.com/forum/index.php?showtopic=15270&st=20#entry228237 created].
+
+Profiler2 collects profiling data across multiple threads and runs a small web server in the engine. When enabled, an HTML page and script can request, analyze and render this profiling data. Profiler2 is currently enabled by pressing F11 while the game is open, similar to the in-game profiler. Then the HTML page included with the profiler2 tool ([source:/ps/trunk/source/tools/profiler2 source/tools/profiler2/profiler2.html]) is opened in a web browser supporting HTML5.
+
+TODO screenshot and describe it
+
+Using profiler2 in code works similarly to the in-game profiler, except the scoped macro is named `PROFILER2`:
+{{{
+#include "ps/Profiler2.h"
+...
+{
+  PROFILE2("section name");
+  ... code to measure ...
+}
+}}}
+and it will measure all code from the `PROFILE2` until the end of the current scope. There is also `PROFILE2_EVENT` to record events in profiler2 and `PROFILE2_ATTR` to add printf-style strings to the current region or event (seen in tooltips when hovering the profiler2 rendered output). This allows displaying more contextual data than would typically be possible in a profiler. For convenience, using `PROFILE3` will measure with both the in-game profiler and the new profiler2.
+
+For more detailed GPU profiling data on some systems, `PROFILE2_GPU` and `PROFILE3_GPU` can be used similarly.
+
 
 == Low-overhead timer ==