Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pthom committed Sep 27, 2023
1 parent f20ee48 commit 5e93153
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions src/hello_imgui/hello_imgui_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,8 @@ int main(){
Select the wanted backend type between `Sdl`, `Glfw` and `Qt`. Only useful when multiple backend are compiled
and available.
* `fpsIdling`: _FpsIdling_. Idling parameters (set fpsIdling.enableIdling to false to disable Idling)
* `useImGuiTestEngine`: _bool, default=false_.
Set this to true if you intend to use imgui_test_engine (please read note below)
* `iniFilename`: _string, default = ""_
Sets the ini filename under which imgui will save its params. Path is relative to the current app working dir.
If empty, then the ini file name will be derived from appWindowParams.windowTitle (if both are empty, the ini filename will be imgui.ini).
Expand All @@ -145,6 +147,13 @@ int main(){
* `emscripten_fps`: _int, default = 0_.
Set the application refresh rate (only used on emscripten: 0 stands for "let the app or the browser decide")

Notes about the use of [Dear ImGui Test & Automation Engine](https://github.com/ocornut/imgui_test_engine):
* HelloImGui must be compiled with the option HELLOIMGUI_WITH_TEST_ENGINE (-DHELLOIMGUI_WITH_TEST_ENGINE=ON)
* See demo in src/hello_imgui_demos/hello_imgui_demo_test_engine.
* imgui_test_engine is subject to a [specific license](https://github.com/ocornut/imgui_test_engine/blob/main/imgui_test_engine/LICENSE.txt)
TL;DR: free for individuals, educational, open-source and small businesses uses. Paid for larger businesses.


#### Fps Idling

**FpsIdling** is a struct that contains Fps Idling parameters
Expand Down

0 comments on commit 5e93153

Please sign in to comment.