Skip to content

Commit 1820fe5

Browse files
committed
Comments, minor alignments tweaks.
1 parent 11b3a7c commit 1820fe5

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

imgui.h

+13-13
Original file line numberDiff line numberDiff line change
@@ -1090,11 +1090,11 @@ namespace ImGui
10901090
// (Optional) Platform/OS interface for multi-viewport support
10911091
// Read comments around the ImGuiPlatformIO structure for more details.
10921092
// Note: You may use GetWindowViewport() to get the current viewport of the current window.
1093-
IMGUI_API void UpdatePlatformWindows(); // call in main loop. will call CreateWindow/ResizeWindow/etc. platform functions for each secondary viewport, and DestroyWindow for each inactive viewport.
1094-
IMGUI_API void RenderPlatformWindowsDefault(void* platform_render_arg = NULL, void* renderer_render_arg = NULL); // call in main loop. will call RenderWindow/SwapBuffers platform functions for each secondary viewport which doesn't have the ImGuiViewportFlags_Minimized flag set. May be reimplemented by user for custom rendering needs.
1095-
IMGUI_API void DestroyPlatformWindows(); // call DestroyWindow platform functions for all viewports. call from backend Shutdown() if you need to close platform windows before imgui shutdown. otherwise will be called by DestroyContext().
1096-
IMGUI_API ImGuiViewport* FindViewportByID(ImGuiID id); // this is a helper for backends.
1097-
IMGUI_API ImGuiViewport* FindViewportByPlatformHandle(void* platform_handle); // this is a helper for backends. the type platform_handle is decided by the backend (e.g. HWND, MyWindow*, GLFWwindow* etc.)
1093+
IMGUI_API void UpdatePlatformWindows(); // call in main loop. will call CreateWindow/ResizeWindow/etc. platform functions for each secondary viewport, and DestroyWindow for each inactive viewport.
1094+
IMGUI_API void RenderPlatformWindowsDefault(void* platform_render_arg = NULL, void* renderer_render_arg = NULL); // call in main loop. will call RenderWindow/SwapBuffers platform functions for each secondary viewport which doesn't have the ImGuiViewportFlags_Minimized flag set. May be reimplemented by user for custom rendering needs.
1095+
IMGUI_API void DestroyPlatformWindows(); // call DestroyWindow platform functions for all viewports. call from backend Shutdown() if you need to close platform windows before imgui shutdown. otherwise will be called by DestroyContext().
1096+
IMGUI_API ImGuiViewport* FindViewportByID(ImGuiID id); // this is a helper for backends.
1097+
IMGUI_API ImGuiViewport* FindViewportByPlatformHandle(void* platform_handle); // this is a helper for backends. the type platform_handle is decided by the backend (e.g. HWND, MyWindow*, GLFWwindow* etc.)
10981098

10991099
} // namespace ImGui
11001100

@@ -3740,7 +3740,7 @@ struct ImGuiPlatformIO
37403740
IMGUI_API ImGuiPlatformIO();
37413741

37423742
//------------------------------------------------------------------
3743-
// Interface with OS and Platform backend (basic)
3743+
// Input - Interface with OS and Platform backend (most common stuff)
37443744
//------------------------------------------------------------------
37453745

37463746
// Optional: Access OS clipboard
@@ -3765,14 +3765,14 @@ struct ImGuiPlatformIO
37653765
ImWchar Platform_LocaleDecimalPoint; // '.'
37663766

37673767
//------------------------------------------------------------------
3768-
// Interface with Renderer Backend
3768+
// Input - Interface with Renderer Backend
37693769
//------------------------------------------------------------------
37703770

37713771
// Written by some backends during ImGui_ImplXXXX_RenderDrawData() call to point backend_specific ImGui_ImplXXXX_RenderState* structure.
37723772
void* Renderer_RenderState;
37733773

37743774
//------------------------------------------------------------------
3775-
// Input - Interface with OS/backends (Multi-Viewport support!)
3775+
// Input - Interface with Platform & Renderer backends for Multi-Viewport support
37763776
//------------------------------------------------------------------
37773777

37783778
// For reference, the second column shows which function are generally calling the Platform Functions:
@@ -3826,7 +3826,7 @@ struct ImGuiPlatformIO
38263826

38273827
// Viewports list (the list is updated by calling ImGui::EndFrame or ImGui::Render)
38283828
// (in the future we will attempt to organize this feature to remove the need for a "main viewport")
3829-
ImVector<ImGuiViewport*> Viewports; // Main viewports, followed by all secondary viewports.
3829+
ImVector<ImGuiViewport*> Viewports; // Main viewports, followed by all secondary viewports.
38303830
};
38313831

38323832
// (Optional) This is required when enabling multi-viewport. Represent the bounds of each connected monitor/display and their DPI.
@@ -3843,11 +3843,11 @@ struct ImGuiPlatformMonitor
38433843
// (Optional) Support for IME (Input Method Editor) via the platform_io.Platform_SetImeDataFn() function.
38443844
struct ImGuiPlatformImeData
38453845
{
3846-
bool WantVisible; // A widget wants the IME to be visible
3847-
ImVec2 InputPos; // Position of the input cursor
3848-
float InputLineHeight; // Line height
3846+
bool WantVisible; // A widget wants the IME to be visible
3847+
ImVec2 InputPos; // Position of the input cursor
3848+
float InputLineHeight; // Line height
38493849

3850-
ImGuiPlatformImeData() { memset(this, 0, sizeof(*this)); }
3850+
ImGuiPlatformImeData() { memset(this, 0, sizeof(*this)); }
38513851
};
38523852

38533853
//-----------------------------------------------------------------------------

0 commit comments

Comments
 (0)