Updated console and capture application markdown files.

markgalvan-intel · planetchili · commit 717c5bf14e80 · 2025-06-06T10:00:56.000+09:00
diff --git a/IntelPresentMon/metrics.csv b/IntelPresentMon/metrics.csv
@@ -13,7 +13,7 @@ PM_METRIC_FRAME_TYPE,,Frame Type,Whether the frame was rendered by the applicati
 ,,,
 PM_METRIC_CPU_START_TIME,,CPU Start Time,The time the CPU started working on this frame.
 PM_METRIC_CPU_START_QPC,1,CPU Start QPC,"The time the CPU started working on this frame, as a QueryPerformanceCounter() value."
-PM_METRIC_CPU_FRAME_TIME,,FrameTime-App,How long it took from the start of this frame until the CPU started working on the next frame.
+PM_METRIC_CPU_FRAME_TIME,1,FrameTime-App,How long it took from the start of this frame until the CPU started working on the next frame.
 PM_METRIC_CPU_BUSY,,Ms CPU Busy,How long the CPU spent working on this frame before presenting it.
 PM_METRIC_CPU_WAIT,,Ms CPU Wait,How long the CPU spent waiting before starting the next frame.
 ,,,
@@ -100,6 +100,6 @@ PM_METRIC_UNTIL_DISPLAYED,,Ms Until Displayed,"The time between the Present() ca
 PM_METRIC_RENDER_PRESENT_LATENCY,,Ms Render Present Latency,"The time between the Present() call and when GPU work for this frame completed, in milliseconds."
 PM_METRIC_BETWEEN_SIMULATION_START,,Ms Between Simulation Start,"The time between the start of simulation processing of the previous frame and this one, in milliseconds."
 PM_METRIC_PC_LATENCY,,Ms PC Latency,"Time between PC receiving input and frame being sent to the display, in milliseconds."
-PM_METRIC_DISPLAYED_FRAME_TIME,,FrameTime-Display,"The time between when the previous frame was displayed and this frame was, in milliseconds."
-PM_METRIC_PRESENTED_FRAME_TIME,,FrameTime-Presents,"The time between this Present call and the previous one, in milliseconds."
+PM_METRIC_DISPLAYED_FRAME_TIME,1,FrameTime-Display,"The time between when the previous frame was displayed and this frame was, in milliseconds."
+PM_METRIC_PRESENTED_FRAME_TIME,1,FrameTime-Presents,"The time between this Present call and the previous one, in milliseconds."
 PM_METRIC_BETWEEN_APP_START,,Ms Between App Start,"How long it took from the start of this frame until the CPU started working on the next frame, in milliseconds."
diff --git a/README-CaptureApplication.md b/README-CaptureApplication.md
@@ -54,6 +54,8 @@ In Debug configuration, the application will halt with a modal error dialog when
 |GPU Wait|GPUWait|How long the GPU spent waiting while working on this frame|DF|
 |Dropped Frames||Indicates if the frame was not displayed|DF|
 |Displayed Time|DisplayedTime|How long this frame was displayed on screen|DF|
+|Animation Error|MsAnimationError|The difference between the previous frame's CPU delta and display delta|DF|
+|Animation Time|AnimationTime|The difference between the previous frame's CPU delta and display delta|F|
 |Sync Interval|SyncInterval|The application's requested interval between presents measured in vertical sync/vblank events|DF|
 |Present Flags|PresentFlags|Flags used to configure the present operation|DF|
 |Present Mode|PresentMode|Method used to present the frame|DF|
@@ -62,7 +64,7 @@ In Debug configuration, the application will halt with a modal error dialog when
 |Frame Type|FrameType|Whether the frame was rendered by the application or interpolated by a driver/SDK.|DF|
 |GPU Latency|GPULatency|How long it took until GPU work for this frame started|DF|
 |Display Latency|DisplayLatency|Time between frame submission and scan out to display|DF|
-|Click To Photon Latency|ClickToPhotonLatency|Time between input and display|DF|
+|Click To Photon Latency|MsClickToPhotonLatency|Time between mouse click input and display|DF|
 |GPU Sustained Power Limit||Sustained power limit of the GPU|DS|
 |GPU Power|GPUPower|Power consumed by the graphics adapter|DF|
 |GPU Voltage|GPUVoltage|Voltage consumed by the graphics adapter|DF|
@@ -99,6 +101,29 @@ In Debug configuration, the application will halt with a modal error dialog when
 |CPU Temperature|CPUTemperature|Temperature of the CPU|DF|
 |CPU Frequency|CPUFrequency|Clock speed of the CPU|DF|
 |CPU Core Utility||Amount of CPU processing utility being used per core|D|
+|All Input To Photon Latency|MsAllInputToPhotonLatency|Time between any input and display|DF|
+|Instrumented Latency|InstrumentedLatency|How long it took from the instrumented start of this frame until the frame was displayed on the screen|DF|
+|GPU Effective Frequency||Effective clock speed of the GPU cores|DF|
+|GPU Voltage Regulator Temperature||Voltage regulator temperature|DF|
+|GPU Memory Effective Bandwidth||Data transfer rate that the memory modules can sustain based on current clock frequency|DF|
+|GPU Overvoltage Percent||GPU overvoltage increment as a ratio of the maximum increment|DF|
+|GPU Temperature Percent||GPU temperature as a ratio of the thermal margin|DF|
+|GPU Power Percent||GPU power draw as a ratio of default maximum power|DF|
+|GPU Fan Speed Percent||GPU fan speed as a ratio of the max speed for that fan|DF|
+|GPU Card Power||,Total power consumption of the graphics adapter board|DF|
+|Present Start Time|TimeInSeconds|The time the Present() call was made, in seconds|F|
+|Present Start QPC|Present Start QPC|The time the Present() call was made as a QueryPerformanceCounter() value|F|
+|Between Presents|MsBetweenPresents|The time between this Present() call and the previous one, in milliseconds|F|
+|In Present API|MsInPresentAPI|The time spent inside the Present() call, in milliseconds.|F|
+|Between Display Change|MsBetweenDisplayChange|How long the previous frame was displayed before this Present() was displayed, in milliseconds|DF|
+|Until Displayed|MsUntilDisplayed|The time between the Present() call and when the frame was displayed, in milliseconds|DF|
+|Render Present Latency|MsRenderPresentLatency|The time between the Present() call and when GPU work for this frame completed, in milliseconds|F|
+|Between Simulation Start|MsBetweenSimulationStart|The time between the start of simulation processing of the previous frame and this one, in milliseconds.|F|
+|PC Latency|MsPCLatency|Time between PC receiving input and frame being sent to the display, in milliseconds|DF|
+|Displayed Frame Time||The time between when the previous frame was displayed and this frame was, in milliseconds|D|
+|Presented Frame Time||The time between this Present call and the previous one, in milliseconds|D|
+|Between App Start|MsBetweenAppStart|How long it took from the start of this frame until the CPU started working on the next frame, in milliseconds.|F|
+
 *Query Type Codes: **D** = Dynamic Query, **F** = Frame Event Query, **S** = Static Query
 
 ## Comma-separated value (CSV) file output
diff --git a/README-ConsoleApplication.md b/README-ConsoleApplication.md
@@ -5,7 +5,7 @@ The PresentMon/ directory contains source for a standalone console application t
 CSV file(s).
 
 A binary of the console application is provided in the release, e.g.:
-[PresentMon-2.3.0-x64.exe](https://github.com/GameTechDev/PresentMon/releases/download/v2.3.0/PresentMon-2.3.0-x64.exe).
+[PresentMon-2.3.1-x64.exe](https://github.com/GameTechDev/PresentMon/releases/download/v2.3.1/PresentMon-2.3.1-x64.exe).
 
 ## Command line options
 
@@ -28,6 +28,7 @@ A binary of the console application is provided in the release, e.g.:
 | `--date_time`                  | Output the CPU start time as a date and time with nanosecond precision. |
 | `--exclude_dropped`            | Exclude frames that were not displayed to the screen from the CSV output. |
 | `--v1_metrics`                 | Output a CSV using PresentMon 1.x metrics. |
+| `--v2_metrics`                 | Output a CSV using PresentMon 2.x metrics. |
 
 | Recording Options              |     |
 | ------------------------------ | --- |
@@ -53,7 +54,8 @@ A binary of the console application is provided in the release, e.g.:
 | ------------------------------ | --- |
 | `--track_frame_type`           | Track the type of each displayed frame; requires application and/or driver instrumentation using Intel-PresentMon provider. |
 | `--track_hw_measurements`      | Tracks HW-measured latency and/or power data coming from a LMT and/or PCAT device. |
-| `--track_app_timing`           | Track app timines for each displayed frame; requires application and/or driver instrumentation using Intel-PresentMon provider. |
+| `--track_app_timing`           | Track app times for each displayed frame; requires application and/or driver instrumentation using Intel-PresentMon provider. |
+| `--track_hybrid_present`       | Tracks if the present is a hybrid present and is performing a cross adapter copy. |
 
 ## Comma-separated value (CSV) file output
 
@@ -89,21 +91,28 @@ Default metrics include:
 | *PresentMode*          | The presentation mode used by the system for this frame.  See the table below for more details. |
 | *FrameType*            | Whether the frame was rendered by the application or generated by a driver/SDK. |
 | *CPUStartTime<br>(CPUStartQPC)<br>(CPUStartQPCTime)<br>(CPUStartDateTime)* | The time the CPU started working on this frame.  By default, this is the time since recording started unless:<br>&bull; When `--qpc_time` is used, the value is a [performance counter value](https://docs.microsoft.com/en-us/windows/win32/api/profileapi/nf-profileapi-queryperformancecounter) and the column is named *CPUStartQPC*.<br>&bull; When `--qpc_time_ms` is used, the value is the query performance counter value converted to milliseconds and the column is named *CPUStartQPCTime*.<br>&bull; When `--date_time` is used, the value is a date and the column is named *CPUStartDateTime*. |
-| *FrameTime*            | How long it took from the start of this frame until the CPU started working on the next frame. |
-| *CPUBusy*              | How long the CPU spent working on this frame before presenting it. |
-| *CPUWait*              | How long the CPU spent waiting before starting the next frame. |
-| *GPULatency*           | How long it took from the start of this frame until the GPU started working on it. |
-| *GPUTime*              | The total amount of time that GPU was working on this frame. |
-| *GPUBusy*              | How long the GPU was actively working on this frame (i.e., the time during which at least one GPU engine is executing work from the target process). |
-| *GPUWait*              | How long the GPU was idle while working on this frame. |
+| *MsCPUBusy*            | How long the CPU spent working on this frame before presenting it. |
+| *MsCPUWait*            | How long the CPU spent waiting before starting the next frame. |
+| *MsGPULatency*         | How long it took from the start of this frame until the GPU started working on it. |
+| *MsGPUTime*            | The total amount of time that GPU was working on this frame. |
+| *MsGPUBusy*            | How long the GPU was actively working on this frame (i.e., the time during which at least one GPU engine is executing work from the target process). |
+| *MsGPUWait*            | How long the GPU was idle while working on this frame. |
 | *VideoBusy*            | How long the GPU video encode/decode engines were actively working on this frame. |
 | *DisplayLatency*       | How long it took from the start of this frame until the frame was displayed on the screen. |
 | *DisplayedTime*        | How long the frame was displayed on the screen, or 'NA' if the frame was not displayed. |
-| *AnimationError*       | The difference between the previous frame's CPU delta and display delta. |
+| *MsAnimationError*     | The difference between the previous frame's CPU delta and display delta. |
 | *AnimationTime*        | The time the CPU started animation work on this frame. |
-| *ClickToPhotonLatency* | How long it took from the earliest mouse click that contributed to this frame until this frame was displayed.  When supported HW measuring devices are not available, this is the software-visible subset of the full click-to-photon latency and doesn't include:<br>&bull; time spent processing input in the keyboard/controller hardware or drivers (typically a fixed additional overhead),<br>&bull; time spent processing the output in the display hardware or drivers (typically a fixed additional overhead), and<br>&bull; a combination of display blanking interval and scan time (which varies, depending on timing and tearing). |
-| *AllInputToPhotonLatency* | How long it took from the earliest keyboard or mouse interaction that contributed to this frame until this frame was displayed. |
+| *MsClickToPhotonLatency* | How long it took from the earliest mouse click that contributed to this frame until this frame was displayed. |
+| *MsAllInputToPhotonLatency* | How long it took from the earliest keyboard or mouse interaction that contributed to this frame until this frame was displayed. |
 | *InstrumentedLatency*  | Instrumented Frame Start To Display Latency |
+| *MsBetweenPresents*    | The time between this Present() call and the previous one, in milliseconds. |
+| *MsInPresentAPI*       | The time spent inside the Present() call, in milliseconds. |
+| *MsBetweenDisplayChange* | How long the previous frame was displayed before this Present() was displayed, in milliseconds. |
+| *MsUntilDisplayed*     | The time between the Present() call and when the frame was displayed, in milliseconds. |
+| *MsRenderPresentLatency* | The time between the Present() call and when GPU work for this frame completed, in milliseconds. |
+| *MsBetweenSimulationStart* | The time between the start of simulation processing of the previous frame and this one, in milliseconds. |
+| *MsPCLatency*          | Time between PC receiving input and frame being sent to the display, in milliseconds. |
+| *MsBetweenAppStart*    | How long it took from the start of this frame until the CPU started working on the next frame, in milliseconds. |
 
 Some metrics are enabled or disabled depending on the command line options:
 
@@ -115,6 +124,7 @@ Some metrics are enabled or disabled depending on the command line options:
 | `--no_track_input`   |                 | *ClickToPhotonLatency* |
 | `--no_track_display`<br>(requires `--no_track_gpu` and `--no_track_input` as well) | | *AllowsTearing<br>PresentMode<br>DisplayLatency<br>DisplayedTime* |
 | `--v1_metrics`       |                 | Most of the above metrics.  See a [1.x README.md](https://github.com/GameTechDev/PresentMon/blob/v1.9.2/README.md#csv-columns) for details on Presentmon 1.x metrics. |
+| `--v2_metrics`       |                 | Most of the above metrics.  See a [2.x README.md](https://github.com/GameTechDev/PresentMon/blob/v2.3.0/README-ConsoleApplication.md#csv-columns) for details on Presentmon 2.x metrics. |
 
 The following values are used in the PresentMode column:
 
diff --git a/Tools/generate/readme/CSVOutro.md b/Tools/generate/readme/CSVOutro.md
@@ -9,6 +9,7 @@ Some metrics are enabled or disabled depending on the command line options:
 | `--no_track_input`   |                 | *ClickToPhotonLatency* |
 | `--no_track_display`<br>(requires `--no_track_gpu` and `--no_track_input` as well) | | *AllowsTearing<br>PresentMode<br>DisplayLatency<br>DisplayedTime* |
 | `--v1_metrics`       |                 | Most of the above metrics.  See a [1.x README.md](https://github.com/GameTechDev/PresentMon/blob/v1.9.2/README.md#csv-columns) for details on Presentmon 1.x metrics. |
+| `--v2_metrics`       |                 | Most of the above metrics.  See a [2.x README.md](https://github.com/GameTechDev/PresentMon/blob/v2.3.0/README-ConsoleApplication.md#csv-columns) for details on Presentmon 2.x metrics. |
 
 The following values are used in the PresentMode column:
 
