2
0
Эх сурвалжийг харах

Added resource profiler docs

Björn Ritzl 6 жил өмнө
parent
commit
2ccd69bc43

BIN
docs/en/manuals/images/profiling/webprofiler_frame_timechart.png


BIN
docs/en/manuals/images/profiling/webprofiler_mode.png


BIN
docs/en/manuals/images/profiling/webprofiler_page.png


BIN
docs/en/manuals/images/profiling/webprofiler_resources_page.png


+ 17 - 3
docs/en/manuals/profiling.md

@@ -29,9 +29,13 @@ To access the profiler:
 1. Start your game on your target device.
 2. Open a web browser and point it to `http://<device IP>:8002` where `<device IP>` is the IP address of the device. You can find the IP numbers of your target devices in the <kbd>Project ▸ Target</kbd> menu. If you are running your game on your desktop computer, http://localhost:8002 will bring up the profiler.
 
-![Web profiler](images/profiling/webprofiler_page.png)
+![Web profiler mode](images/profiling/webprofiler_mode.png)
+At the top, next to the *Capture* button there are radio buttons to switch between the *CPU/Frame profiler* and the *Resource profiler*.
+
+### CPU/Frame profiler
+The CPU profiler is divided into 4 sections that all give different views into the current sample data. To update the sample data, press the *Capture* button at the top.
 
-The profiler is divided into 4 sections that all give different views into the current sample data. To update the sample data, press the *Capture* button at the top.
+![Web profiler](images/profiling/webprofiler_page.png)
 
 Frames overview
 : The frames overview plots the currently sampled 20 frames side by side. The height of each bar shows the time spent in the frame. The number on the left hand side shows the max time spent in a frame in the current sample data.
@@ -59,6 +63,17 @@ Frame time chart
 
   ![Frame timechart](images/profiling/webprofiler_frame_timechart.png)
 
+### Resource profiler
+The resource profiler is divided into 2 sections, one showing a hierarchical view of the collections, game objects and components currently instantiated in your game, and the other showing all currently loaded resources.
+
+![Resource profiler](images/profiling/webprofiler_resources_page.png)
+
+Collection view
+: The collection view shows hierarchical list of all game objects and components currently instantiated in the game and from which collection they originate. This is a very useful tool when you need to dig into and understand what you have instanced in your game at any given time and from where the objects originate.
+
+Resources view
+: The resources view shows all resources currently loaded into memory, their size and the number of references to each resource. This is useful when optimizing memory usage in your application when you need to understand what is loaded into memory at any given time.
+
 ## Build reports
 
 When bundling your game there is an option to create a build report. This is very useful to get a grip on the size of all the assets that are part of your game bundle. Simply check the *Generate build report* checkbox when bundling the game.
@@ -111,4 +126,3 @@ Graphics API Debugger (Android)
   This is a collection of tools that allows you to inspect, tweak and replay calls from an application to a graphics driver. To use the tool requires that you set `android:debuggable="true"` in "AndroidManifest.xml".
 
   ![graphics api debugger](images/profiling/gapid.png)
-