Skip to content

Commit 3f92b5f

Browse files
authored
Merge pull request #3860 from Microsoft/mrtk_development
Visual Profiler docs from mrtk_development -> stabilization
2 parents ea7430c + 2a953e3 commit 3f92b5f

File tree

7 files changed

+62
-4
lines changed

7 files changed

+62
-4
lines changed

Documentation/Diagnostics/ConfiguringDiagnostics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,4 @@ The speed at which to move the profiler window to maintain visibility within the
4646
## See Also
4747

4848
- [Diagnostics System](DiagnosticsSystemGettingStarted.md)
49-
- [Using the Visual Profiler](../TODO.md)
49+
- [Using the Visual Profiler](UsingVisualProfiler.md)

Documentation/Diagnostics/DiagnosticsSystemGettingStarted.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,5 +59,5 @@ accurately reflect actual application performance when run from within the edito
5959

6060
- [Diagnostics API documentation](xref:Microsoft.MixedReality.Toolkit.Diagnostics)
6161
- [Configuring the Diagnostics System](ConfiguringDiagnostics.md)
62-
- [Using the Visual Profiler](../TODO.md)
62+
- [Using the Visual Profiler](UsingVisualProfiler.md)
6363

Documentation/Diagnostics/UsingVisualProfiler.md

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,64 @@
11
# Using the Visual Profiler
22

3-
<< >>
3+
The VisualProfiler provides an easy to use, in application view of a mixed reality application's performance. The profiler is supported on all Mixed Reality Toolkit platforms, including:
4+
5+
- Microsoft HoloLens
6+
- Microsoft HoloLens 2
7+
- Windows Mixed Reality Immersive headsets
8+
- OpenVR
9+
10+
While developing an application, be sure to focus on multiple parts of the scene as the Visual Profiler displays data relative to the current view.
11+
12+
> Focus attention on portions of the scene with complex objects, particle effects or activity. These and other factors often contribute to reduction in application performance and a less than ideal user experience.
13+
14+
## Visual Profiler Interface
15+
16+
![Visual Profiler Interface](../../External/ReadMeImages/Diagnostics/VisualProfiler.png)
17+
18+
The Visual Profiler interface includes the following components:
19+
20+
- [Frame Rate](#frame-rate)
21+
- [Frame Time](#frame-time)
22+
- [Frame Graph](#frame-graph)
23+
- [Memory Utilization](#memory-utilization)
24+
25+
### Frame Rate
26+
27+
In the upper left corner of the interface is the frame rate, measured in frames per second. For the best user experience and comfort, this value should be as high as possible.
28+
29+
The specific platform and hardware configuration will play a significant role in the maximum achievable frame rate. Some common target values include:
30+
31+
- Microsoft HoloLens: 60
32+
- Windows Mixed Reality Ultra: 90
33+
34+
### Frame Time
35+
36+
To the right of the frame rate is the frame time, in milliseconds, spent on the CPU. To achieve the target frame rates mentioned previously, an application can spend the following amount of time per frame:
37+
38+
- 60 fps: 16.6 ms
39+
- 90 fps: 11.1 ms
40+
41+
> GPU time is planned to be added in a future release.
42+
43+
### Frame Graph
44+
45+
The frame graph provides a graphical display of the application frame rate history.
46+
47+
![Visual Profiler Frame Graph](../../External/ReadMeImages/Diagnostics/VisualProfilerMissedFrames.png)
48+
49+
> When using the application, look for missed frames. Missed frames indicate the application is not hitting its target frame rate and may need optimization work.
50+
51+
### Memory Utilization
52+
53+
The memory utilization display allows for easy understanding of how the current view is impacting an application's memory consumption.
54+
55+
![Visual Profiler Frame Graph](../../External/ReadMeImages/Diagnostics/VisualProfilerMemory.png)
56+
57+
> When using application, look for total memory usage. Key indicators include: nearing the memory limit and rapid changes in usage.
58+
59+
## Customizing the Visual Profiler
60+
61+
The Visual Profiler's appearance and behavior are customizable via the diagnostics system profile. Please see [Configuring the Diagnostics System](ConfiguringDiagnostics.md) for more information.
462

563
## See Also
664

Documentation/toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@
9090
- name: Configuring the Diagnostics System
9191
href: Diagnostics/ConfiguringDiagnostics.md
9292
- name: Using the Visual Profiler
93-
href: TODO.md
93+
href: Diagnostics/UsingVisualProfiler.md
9494
- name: Other Features
9595
items:
9696
- name: QR Tracking
24.1 KB
Loading
14.8 KB
Loading
26.1 KB
Loading

0 commit comments

Comments
 (0)