Skip to content

Commit afe2069

Browse files
committed
docs: Update manual with detailed information on HUD Debug screen
1 parent fbb4773 commit afe2069

File tree

3 files changed

+39
-22
lines changed

3 files changed

+39
-22
lines changed

Source/Documentation/Manual/driving.rst

Lines changed: 39 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2222,35 +2222,52 @@ This applies to both Timetable Mode and Activity Mode.
22222222
Extended HUD for Debug Information
22232223
----------------------------------
22242224

2225-
The last extended HUD display shows Debug information.
2225+
The last extended HUD display shows Debug information containing:
2226+
2227+
- Logging enabled: :ref:`logging status <driving-logfile>`
2228+
- Build: date and time Open Rails was compiled
2229+
- CPU: processor utilization by Open Rails
2230+
- GPU: frame rate, frame time percentiles and graphics feature level
2231+
- Memory: number of core memory objects loaded (textures, materials, shapes, and tiles) plus garbage collection statistics
2232+
- CPU Memory:
2233+
2234+
- Private: virtual memory allocated just for Open Rails (not shared with other applications)
2235+
- Working set: physical memory in use by Open Rails (including any shared with other applications)
2236+
- Private working set: physical memory in use just for Open Rails
2237+
- Managed: virtual memory allocated by the .NET runtime (CLR)
2238+
- Virtual: virtual memory allocated for any purpose (private + shared + others)
2239+
2240+
- GPU Memory:
2241+
2242+
- Committed: all graphics memory allocated for Open Rails
2243+
- Dedicated: physical graphics card memory in use by Open Rails
2244+
- Shared: system memory shared with the graphics card in use by Open Rails
2245+
2246+
- Adapter: name and dedicated physical memory of graphics card
2247+
- Shadow maps: distance and size of each shadow map level (and texture size)
2248+
- Shadow primitives: total primitives (rendered items) and breakdown by shadow map level
2249+
- Render primitives: total primitives (rendered items) and breakdown by rendering sequence (``RenderPrimitiveSequence`` in the code)
2250+
- Render/Updater/Loader/Sound process: percentage of time each process is active and waiting
2251+
- Camera: tile X, tile Z, X, Y, Z, altitude, LOD bias, effective viewing distance, effective distant mountain viewing distance
22262252

2227-
The first line (``Logging enabled``) refers to logging as described in
2228-
paragraphs 6.6 and 6.7.
2253+
.. image:: images/driving-hud-debug.png
22292254

2230-
A wide variety of parameters is shown, from frame wait and render speeds
2231-
in milliseconds, to number of primitives, Process Thread resource
2232-
utilization and number of Logical CPUs from the system's bios. They are
2233-
very useful in case of OR stuttering, to find out where the bottleneck is.
2255+
The primary measurements for comparing and analysing performance are the first column of values (some lines are skipped), so for the image above we have:
22342256

2235-
.. index::
2236-
single: tile
2257+
- CPU: 10% - *very low (warning at 75%)*
2258+
- GPU: 58 FPS - *good (warning at <55 FPS with 60 Hz vertical sync)*
2259+
- CPU Memory: 211 MB private - *very low (~3% of 8 GB)*
2260+
- GPU Memory: 493 MB committed - *low (~24% of 2 GB)*
2261+
- Highest process (Render): 47% - *moderate (warning at 75%)*
22372262

2238-
The values in the ``Camera`` line refer to the two tile coordinates and to
2239-
the three coordinates within the tile.
2263+
Also shown are the following graphs of:
22402264

2241-
.. image:: images/driving-hud-debug.png
2242-
:align: center
2243-
:scale: 80%
2265+
- Memory: working set
2266+
- GCs: garbage collections
2267+
- Frame time: how long each frame takes to render
2268+
- Render/Updater/Loader/Sound process: same as textual display above
22442269

22452270
.. image:: images/driving-hud-debug-graphs.png
2246-
:align: center
2247-
:scale: 80%
2248-
2249-
At the bottom of the picture, some moving graphs are displayed that show
2250-
the actual load of the computer.
2251-
2252-
Referring to memory use, about at least 400 MB must remain free to
2253-
avoid out-of-memory exceptions
22542271

22552272
Viewing Interactive Track Items
22562273
-------------------------------
Loading
Loading

0 commit comments

Comments
 (0)