diff --git a/src/hello_imgui/app_window_params.h b/src/hello_imgui/app_window_params.h index 06c2f783..1d2931a6 100644 --- a/src/hello_imgui/app_window_params.h +++ b/src/hello_imgui/app_window_params.h @@ -148,7 +148,7 @@ struct EdgeInsets // @@md#AppWindowParams // // AppWindowParams is a struct that defines the application window display params. -//See https://raw.githubusercontent.com/pthom/hello_imgui/master/src/hello_imgui/doc_src/hello_imgui_diagram.png +//See https://raw.githubusercontent.com/pthom/hello_imgui/master/src/hello_imgui/doc_src/hello_imgui_diagram.jpg // for details. struct AppWindowParams { diff --git a/src/hello_imgui/doc_params.md b/src/hello_imgui/doc_params.md index ea6c833d..6a84d7cf 100644 --- a/src/hello_imgui/doc_params.md +++ b/src/hello_imgui/doc_params.md @@ -3,7 +3,7 @@ _RunnerParams_ contains all the settings and callbacks in order to run an application. The diagram below summarize all the possible settings and callbacks (which are explained in detail later in this document). -[![diagram](https://raw.githubusercontent.com/pthom/hello_imgui/master/src/hello_imgui/doc_src/hello_imgui_diagram.png)](https://raw.githubusercontent.com/pthom/hello_imgui/master/src/hello_imgui/doc_src/hello_imgui_diagram.png) +[![diagram](https://raw.githubusercontent.com/pthom/hello_imgui/master/src/hello_imgui/doc_src/hello_imgui_diagram.jpg)](https://raw.githubusercontent.com/pthom/hello_imgui/master/src/hello_imgui/doc_src/hello_imgui_diagram.jpg) # RunnerParams @@ -510,7 +510,7 @@ See [app_window_params.h](https://github.com/pthom/hello_imgui/blob/master/src/h ```cpp // // AppWindowParams is a struct that defines the application window display params. -//See https://raw.githubusercontent.com/pthom/hello_imgui/master/src/hello_imgui/doc_src/hello_imgui_diagram.png +//See https://raw.githubusercontent.com/pthom/hello_imgui/master/src/hello_imgui/doc_src/hello_imgui_diagram.jpg // for details. struct AppWindowParams { diff --git a/src/hello_imgui/doc_params.src.md b/src/hello_imgui/doc_params.src.md index 310c9f33..28c616f3 100644 --- a/src/hello_imgui/doc_params.src.md +++ b/src/hello_imgui/doc_params.src.md @@ -3,7 +3,7 @@ _RunnerParams_ contains all the settings and callbacks in order to run an application. The diagram below summarize all the possible settings and callbacks (which are explained in detail later in this document). -[![diagram](https://raw.githubusercontent.com/pthom/hello_imgui/master/src/hello_imgui/doc_src/hello_imgui_diagram.png)](https://raw.githubusercontent.com/pthom/hello_imgui/master/src/hello_imgui/doc_src/hello_imgui_diagram.png) +[![diagram](https://raw.githubusercontent.com/pthom/hello_imgui/master/src/hello_imgui/doc_src/hello_imgui_diagram.jpg)](https://raw.githubusercontent.com/pthom/hello_imgui/master/src/hello_imgui/doc_src/hello_imgui_diagram.jpg) # RunnerParams diff --git a/src/hello_imgui/doc_src/hello_imgui_diagram.jpg b/src/hello_imgui/doc_src/hello_imgui_diagram.jpg new file mode 100644 index 00000000..bb19e99f Binary files /dev/null and b/src/hello_imgui/doc_src/hello_imgui_diagram.jpg differ diff --git a/src/hello_imgui/doc_src/hello_imgui_diagram.puml b/src/hello_imgui/doc_src/hello_imgui_diagram.puml index 6f7444d7..f75cc412 100644 --- a/src/hello_imgui/doc_src/hello_imgui_diagram.puml +++ b/src/hello_imgui/doc_src/hello_imgui_diagram.puml @@ -17,12 +17,6 @@ class _ { _ --> SimpleRunnerParams: uses _ --> RunnerParams: or uses -enum BackendType { - + FirstAvailable - + Sdl - + Glfw - + Qt -} class FpsIdling { float fpsIdle = 9 @@ -35,14 +29,23 @@ class RunnerParams { + RunnerCallbacks callbacks + AppWindowParams appWindowParams + ImGuiWindowParams imGuiWindowParams + --- + DockingParams dockingParams + + vector alternativeDockingLayouts + --- + BackendPointers backendPointers - + BackendType backendType = FirstAvailable + + RendererBackendOptions rendererBackendOptions + + PlatformBackendType platformBackendType + + RendererBackendType rendererBackendType + --- + FpsIdling fpsIdling - + + DpiAwareParams dpiAwareParams + --- + + iniFolderType + iniFilename = "" + bool iniFilename_useAppWindowTitle = true - + --- + --- + bool appShallExit = false } @@ -98,6 +101,35 @@ class MobileCallbacks { } RunnerCallbacks *-- MobileCallbacks +enum PlatformBackendType { + FirstAvailable, + Glfw, + Sdl, +} + +RunnerParams +-- PlatformBackendType + +enum RendererBackendType { + FirstAvailable, + OpenGL3, + Metal, + Vulkan, + DirectX11, + DirectX12, +} + +RunnerParams +-- RendererBackendType + + +class DpiAwareParams { + + float dpiWindowSizeFactor = 0.0f; + + float fontRenderingScale = 0.0f; + + float DpiFontLoadingFactor() +} + +RunnerParams +-- DpiAwareParams + + enum FullScreenMode { + NoFullScreen + FullScreen @@ -228,7 +260,6 @@ class DockingSplit { } RunnerParams *-- FpsIdling -RunnerParams *-- BackendType RunnerParams *-- RunnerCallbacks RunnerParams *-- AppWindowParams RunnerParams *-- ImGuiWindowParams diff --git a/src/hello_imgui/runner_params.h b/src/hello_imgui/runner_params.h index 8f3a054f..d93c275e 100644 --- a/src/hello_imgui/runner_params.h +++ b/src/hello_imgui/runner_params.h @@ -182,6 +182,10 @@ struct RunnerParams // These pointers will be filled when the application starts BackendPointers backendPointers; + // `rendererBackendOptions`: _see renderer_backend_options.h_ + // Options for the renderer backend + RendererBackendOptions rendererBackendOptions; + // `backendType`: _enum BackendType, default=PlatformBackendType::FirstAvailable_ // Select the wanted platform backend type between `Sdl`, `Glfw`. // if `FirstAvailable`, Glfw will be preferred over Sdl when both are available. @@ -195,9 +199,6 @@ struct RunnerParams // Only useful when multiple rendering backend are compiled and available. RendererBackendType rendererBackendType = RendererBackendType::FirstAvailable; - // `rendererBackendOptions`: _see renderer_backend_options.h_ - // Options for the renderer backend - RendererBackendOptions rendererBackendOptions; // --------------- Settings -------------------