Skip to content

Commit 77ca9e1

Browse files
committed
readme table update
Signed-off-by: Wojciech Czerski <[email protected]>
1 parent 0017cf8 commit 77ca9e1

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

readme.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -356,8 +356,10 @@ This functionality can be accessed in c++, lua and script canvas.
356356

357357
> *To start using the tool, add a `FPSProfiler` to the **Level** entity.*
358358
359+
## Component Functionality
359360
![FpsProfiler Editor](doc/FpsProfiler.png)
360361

362+
### Save Settings
361363
| File Save Settings | Description |
362364
|----------------------|----------------------------------------------------------------------------------------------------------------|
363365
| Select Csv File Path | Button that opens a File Dialog. |
@@ -366,20 +368,23 @@ This functionality can be accessed in c++, lua and script canvas.
366368
| Auto Save At Frame | Specifies the frame interval for auto-saving. |
367369
| Timestamp | Includes timestamps in the FPS log file name.</br>Allows to save automatically without manual input each time. |
368370

371+
### Recording Settings
369372
| Recording Settings | Description |
370373
|------------------------|----------------------------------------------------------------------------------------------------------------------|
371374
| Record Type | Specify when to start recording:</br>- at game start</br>- selected frame</br>- await for other system to call start |
372-
| Frames To Skip | Number of frames to skip before recording. Only enabled when type is `SelectFrame`. |
375+
| Frames To Skip | Number of frames to skip before recording.</br>Only enabled when type is `SelectFrame`. |
373376
| Frames To Record | Total number of frames to record. If set to 0 - unlimited. |
374377
| Record Stats | Specifies what type of stats to record (FPS data, CPU and GPU). |
375378

376-
| Precision Settings | Description |
377-
|------------------------|--------------------------------------------------------------------------------------------------------|
378-
| Near Zero Precision | Precision threshold for near-zero values. |
379-
| Moving Average Type | Type of moving average used for smoothing average FPS:</br>- Simple</br>- Exponential |
380-
| Alpha Smoothing Factor | Factor applied to control smoothing effect when `Exponential` enabled. |
381-
| Keep History | Keeps a history of recorded FPS data or clear after every auto-save. For better effect - keep enabled. |
379+
### Precision Settings
380+
| Precision Settings | Description |
381+
|------------------------|------------------------------------------------------------------------------------------------------------|
382+
| Near Zero Precision | Precision threshold for near-zero values. |
383+
| Moving Average Type | Type of moving average used for smoothing average FPS:</br>- Simple</br>- Exponential |
384+
| Alpha Smoothing Factor | Factor applied to control smoothing effect when `Exponential` enabled. |
385+
| Keep History | Keeps a history of recorded FPS data or clear after every auto-save.</br>For better effect - keep enabled. |
382386

387+
### Debug Settings
383388
| Debug Settings | Description |
384389
|------------------------|-----------------------------------------|
385390
| Print Debug Info | Displays debug information in the logs. |

0 commit comments

Comments
 (0)