diff --git a/README.md b/README.md index 94aaa5b..8310cca 100644 --- a/README.md +++ b/README.md @@ -274,11 +274,11 @@ You can use the following [Runtime Settings](#runtime-settings) to generate .csv | Setting Name | Value | Comment | | -------------------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `GpuProfilerMode` | 0: disable
1: enable with sqtt off
2: enable with sqtt for thread trace
3: enable with sqtt for RGP | Enables and sets the SQTT mode for the GPU performance profiler layer. Actual capture of performance data must be specified via frame number with GpuProfilerConfig_StartFrame or by pressing shift-F11. | -| `GpuProfilerConfig_LogDirectory` | <directory-path> | The directory path is relative to $AMD_DEBUG_DIR or $TMPDIR or /var/tmp/, default value is "amdpal/". Your application must have write permissions to the directory. The profiling logs are output to a subdirectory that is named in the format like <AppName>_<yyyy-MM-dd>_<HH:mm:ss>. | -| `GpuProfilerConfig_Granularity` | 0: per-draw
1: per-cmdbuf | Defines what is measured/profiled. *Per-draw* times individual commands (such as draw, dispatch, etc.) inside command buffers, while *per-cmdbuf* only profiles entire command buffers in aggregate. | -| `GpuProfilerConfig_StartFrame` | Positive integer | First frame to capture data for. If StartFrame and FrameCount are not set, all frames will be profiled. | -| `GpuProfilerConfig_FrameCount` | Positive integer | Number of frames to capture data for. | -| `GpuProfilerConfig_RecordPipelineStats` | 0, 1 | Gathers pipeline statistic query data per entry if enabled. | +| `GpuProfilerConfig.LogDirectory` | <directory-path> | The directory path is relative to $AMD_DEBUG_DIR or $TMPDIR or /var/tmp/, default value is "amdpal/". Your application must have write permissions to the directory. The profiling logs are output to a subdirectory that is named in the format like <AppName>_<yyyy-MM-dd>_<HH:mm:ss>. | +| `GpuProfilerConfig.Granularity` | 0: per-draw
1: per-cmdbuf | Defines what is measured/profiled. *Per-draw* times individual commands (such as draw, dispatch, etc.) inside command buffers, while *per-cmdbuf* only profiles entire command buffers in aggregate. | +| `GpuProfilerConfig.StartFrame` | Positive integer | First frame to capture data for. If StartFrame and FrameCount are not set, all frames will be profiled. | +| `GpuProfilerConfig.FrameCount` | Positive integer | Number of frames to capture data for. | +| `GpuProfilerConfig.RecordPipelineStats` | 0, 1 | Gathers pipeline statistic query data per entry if enabled. | You can use the script [timingReport.py](https://github.com/GPUOpen-Drivers/pal/tree/master/tools/gpuProfilerTools/timingReport.py) to analyze the profiling log: ``` @@ -305,12 +305,12 @@ PipelineDumpDir is a sub-path relative to $AMD_DEBUG_DIR or $TMPDIR or /var/tmp/ ## PAL Debug Overlay PAL's debug overlay can be enabled to display real time statistics and information on top of a running application. This includes a rolling FPS average, CPU and GPU frame times, and a ledger tracking how much video memory has been allocated from each available heap. Benchmarking (i.e., "Benchmark (F11)") is currently unsupported. -| Setting Name | Value | Comment | -| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| `DebugOverlayEnabled` | 0, 1 | Enables the debug overlay. | -| `DebugOverlayLocation` | 0: top-left
1: top-right
2: bottom-left
3: bottom-right | Determines where the overlay text should be displayed. Can be used to avoid collision with important rendering by the application. | -| `PrintFrameNumber` | 0, 1 | Reports the current frame number. Useful when determining a good frame range for profiling with the GpuProfiler layer. | -| `TimeGraphEnable` | 0, 1 | Enables rendering of a graph of recent CPU and GPU frame times. | +| Setting Name | Value | Comment | +| ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| `DebugOverlayEnabled` | 0, 1 | Enables the debug overlay. | +| `DebugOverlayConfig.DebugOverlayLocation` | 0: top-left
1: top-right
2: bottom-left
3: bottom-right | Determines where the overlay text should be displayed. Can be used to avoid collision with important rendering by the application. | +| `DebugOverlayConfig.PrintFrameNumber` | 0, 1 | Reports the current frame number. Useful when determining a good frame range for profiling with the GpuProfiler layer. | +| `DebugOverlayConfig.TimeGraphEnable` | 0, 1 | Enables rendering of a graph of recent CPU and GPU frame times. | ## Third Party Software