BGE: Adding docs for bge.logic.getProfileInfo().

2013-03-19 04:56:51 +00:00 · 2013-03-19 04:56:51 +00:00 · 460d21af6f
commit 460d21af6f
parent e6020cd320
1 changed files with 4 additions and 0 deletions
--- a/doc/python_api/rst/bge.logic.rst
+++ b/doc/python_api/rst/bge.logic.rst
@ -398,6 +398,10 @@ Utility functions
 .. function:: PrintMemInfo()

   Prints engine statistics into the console
+
+.. function:: getProfileInfo()
+
+   Returns a Python dictionary that contains the same information as the on screen profiler. The keys are the profiler categories and the values are tuples with the first element being time taken (in ms) and the second element being the percentage of total time.
   
 *********
 Constants