update doc

pthom · Sep 28, 2023 · 249308a · 249308a
1 parent 26d13f0
commit 249308a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -110,6 +110,9 @@ __Other utilities:__
 * `FrameRate(durationForMean = 0.5)`: Returns the current FrameRate.
   May differ from ImGui::GetIO().FrameRate, since one can choose the duration for the calculation of the mean value of the fps
 
+* `ImGuiTestEngine* GetImGuiTestEngine()`: returns a pointer to the global instance of ImGuiTestEngine that was
+  initialized by HelloImGui (iif ImGui Test Engine is active).
+
 Although the API is extremely simple, it is highly customizable, and you can set many options by filling the elements in the `RunnerParams` struct, or in the simpler  `SimpleRunnerParams`, or even by giving a subset of params to `HelloImGui::Run`.
 
 Click on the image below to access the [full API doc](src/hello_imgui/hello_imgui_api.md)

diff --git a/src/hello_imgui/hello_imgui_api.md b/src/hello_imgui/hello_imgui_api.md
@@ -61,6 +61,9 @@ __Other utilities:__
 * `FrameRate(durationForMean = 0.5)`: Returns the current FrameRate.
   May differ from ImGui::GetIO().FrameRate, since one can choose the duration for the calculation of the mean value of the fps
 
+* `ImGuiTestEngine* GetImGuiTestEngine()`: returns a pointer to the global instance of ImGuiTestEngine that was
+  initialized by HelloImGui (iif ImGui Test Engine is active).
+
 ## Runner params
 
 See [runner_params.h](runner_params.h).