ImGuiPlatformIO

Static Members #

Set ImGuiPlatformIO::Platform_GetWindowWorkAreaInsets in a C-compatible mannner

Set ImGuiPlatformIO::Platform_GetWindowFramebufferScale in a C-compatible mannner

Set ImGuiPlatformIO::Platform_GetWindowPos in a C-compatible mannner

Set ImGuiPlatformIO::Platform_GetWindowSize in a C-compatible mannner

Clear all Platform_XXX fields. Typically called on Platform Backend shutdown.

Clear all Renderer_XXX fields. Typically called on Renderer Backend shutdown.

Instance Members #

Should return NULL on failure (e.g. clipboard data is not text).

'.'

Request to reset the graphics/render state.

Request backend to set texture sampling to Linear.

Request backend to set texture sampling to Nearest/Point.

. . U . . // Create a new platform window for the given viewport

N . U . D //

. . U . . // Newly created windows are initially hidden so SetWindowPos/Size/Title can be called on them before showing the window

. . U . . // Set platform window position (given the upper-left corner of client area)

N . . . . // (Use ImGuiPlatformIO_SetPlatform_GetWindowPos() to set this from C, otherwise you will likely encounter stack corruption)

. . U . . // Set platform window client area size (ignoring OS decorations such as OS title bar etc.)

N . . . . // Get platform window client area size (Use ImGuiPlatformIO_SetPlatform_GetWindowSize() to set this from C, otherwise you will likely encounter stack corruption)

N . . . . // Return viewport density. Always 1,1 on Windows, often 2,2 on Retina display on macOS/iOS. MUST BE INTEGER VALUES. (Use ImGuiPlatformIO_SetPlatform_GetWindowFramebufferScale() to set this from C, otherwise you will likely encounter stack corruption)

N . . . . // Move window to front and set input focus

. . U . . //

N . . . . // Get platform window minimized state. When minimized, we generally won't attempt to get/set size and contents will be culled more easily

. . U . . // Set platform window title (given an UTF-8 string)

. . U . . // (Optional) Setup global transparency (not per-pixel transparency)

. . U . . // (Optional) Called by UpdatePlatformWindows(). Optional hook to allow the platform backend from doing general book-keeping every frame.

. . . R . // (Optional) Main rendering (platform side! This is often unused, or just setting a "current" context for OpenGL bindings). 'render_arg' is the value passed to RenderPlatformWindowsDefault().

. . . R . // (Optional) Call Present/SwapBuffers (platform side! This is often unused!). 'render_arg' is the value passed to RenderPlatformWindowsDefault().

N . . . . // (Optional) [BETA] FIXME-DPI: DPI handling: Return DPI scale for this viewport. 1.0f = 96 DPI.

. F . . . // (Optional) [BETA] FIXME-DPI: DPI handling: Called during Begin() every time the viewport we are outputting into changes, so backend has a chance to swap fonts to adjust style.

N . . . . // (Optional) [BETA] Get initial work area inset for the viewport (won't be covered by main menu bar, dockspace over viewport etc.). Default to (0,0),(0,0). 'safeAreaInsets' in iOS land, 'DisplayCutout' in Android land. (Use ImGuiPlatformIO_SetPlatform_GetWindowWorkAreaInsets() to set this from C, otherwise you will likely encounter stack corruption)

(Optional) For a Vulkan Renderer to call into Platform code (since the surface creation needs to tie them both).

. . U . . // Create swap chain, frame buffers etc. (called after Platform_CreateWindow)

N . U . D // Destroy swap chain, frame buffers etc. (called before Platform_DestroyWindow)

. . U . . // Resize swap chain, frame buffers etc. (called after Platform_SetWindowSize)

. . . R . // (Optional) Clear framebuffer, setup render target, then render the viewport->DrawData. 'render_arg' is the value passed to RenderPlatformWindowsDefault().

. . . R . // (Optional) Call Present/SwapBuffers. 'render_arg' is the value passed to RenderPlatformWindowsDefault().

List of textures used by Dear ImGui (most often 1) + contents of external texture list is automatically appended into this.

Main viewports, followed by all secondary viewports.

Metadata #