BGE: Adding docs for bge.logic.getProfileInfo().
authorMitchell Stokes <mogurijin@gmail.com>
Tue, 19 Mar 2013 04:56:51 +0000 (04:56 +0000)
committerMitchell Stokes <mogurijin@gmail.com>
Tue, 19 Mar 2013 04:56:51 +0000 (04:56 +0000)
doc/python_api/rst/bge.logic.rst

index 270299144874725d4097389efcef9cfc23aa5c81..4dd0614700e8133d52467483d17ecae8bb48b866 100644 (file)
@@ -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