2022-05-18 15:23:10 -05:00
// dear imgui: Renderer for WebGPU
2025-12-26 18:12:14 -05:00
// This needs to be used along with a Platform Binding (e.g. GLFW, SDL2, SDL3)
// (Please note that WebGPU is a recent API, may not be supported by all browser, and its ecosystem is generally a mess)
2022-05-18 15:23:10 -05:00
2025-12-26 18:12:14 -05:00
// When targeting native platforms:
// - One of IMGUI_IMPL_WEBGPU_BACKEND_DAWN or IMGUI_IMPL_WEBGPU_BACKEND_WGPU *must* be provided.
// When targeting Emscripten:
// - We now defaults to IMGUI_IMPL_WEBGPU_BACKEND_DAWN is Emscripten version is 4.0.10+, which correspond to using Emscripten '--use-port=emdawnwebgpu'.
// - We can still define IMGUI_IMPL_WEBGPU_BACKEND_WGPU to use Emscripten '-s USE_WEBGPU=1' which is marked as obsolete by Emscripten.
2025-08-11 14:06:16 -05:00
// Add #define to your imconfig.h file, or as a compilation flag in your build system.
2025-12-26 18:12:14 -05:00
// This requirement may be removed once WebGPU stabilizes and backends converge on a unified interface.
2025-08-11 14:06:16 -05:00
//#define IMGUI_IMPL_WEBGPU_BACKEND_DAWN
//#define IMGUI_IMPL_WEBGPU_BACKEND_WGPU
2022-05-18 15:23:10 -05:00
// Implemented features:
2025-08-11 20:40:50 -05:00
// [X] Renderer: User texture binding. Use 'WGPUTextureView' as ImTextureID. Read the FAQ about ImTextureID/ImTextureRef!
2025-08-11 15:50:18 -05:00
// [X] Renderer: Large meshes support (64k+ vertices) even with 16-bit indices (ImGuiBackendFlags_RendererHasVtxOffset).
2025-08-11 14:52:57 -05:00
// [X] Renderer: Expose selected render state for draw callbacks to use. Access in '(ImGui_ImplXXXX_RenderState*)GetPlatformIO().Renderer_RenderState'.
2025-08-11 20:40:50 -05:00
// [X] Renderer: Texture updates support for dynamic font system (ImGuiBackendFlags_RendererHasTextures).
// Missing features or Issues:
// [ ] Renderer: Multi-viewport support (multiple windows), useful for desktop.
2022-05-18 15:23:10 -05:00
2023-06-08 00:29:16 -05:00
// You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
2022-05-18 15:23:10 -05:00
// Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
2025-08-09 21:26:36 -05:00
// Learn about Dear ImGui:
// - FAQ https://dearimgui.com/faq
// - Getting Started https://dearimgui.com/getting-started
// - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
// - Introduction, links and more at the top of imgui.cpp
2022-05-18 15:23:10 -05:00
# pragma once
# include "imgui.h" // IMGUI_IMPL_API
2023-08-30 00:42:51 -05:00
# ifndef IMGUI_DISABLE
2025-12-26 18:12:14 -05:00
// Setup Emscripten default if not specified.
# if defined(__EMSCRIPTEN__) && !defined(IMGUI_IMPL_WEBGPU_BACKEND_DAWN) && !defined(IMGUI_IMPL_WEBGPU_BACKEND_WGPU)
# include <emscripten/version.h>
# if (__EMSCRIPTEN_major__ >= 4) && (__EMSCRIPTEN_minor__ >= 0) && (__EMSCRIPTEN_tiny__ >= 10)
# define IMGUI_IMPL_WEBGPU_BACKEND_DAWN
# else
# define IMGUI_IMPL_WEBGPU_BACKEND_WGPU
# endif
# endif
2022-05-18 15:23:10 -05:00
# include <webgpu/webgpu.h>
2025-12-26 18:12:14 -05:00
# if defined(IMGUI_IMPL_WEBGPU_BACKEND_WGPU) && !defined(__EMSCRIPTEN__)
# include <webgpu/wgpu.h> // WGPULogLevel
# endif
2022-05-18 15:23:10 -05:00
2025-08-10 03:37:21 -05:00
// Initialization data, for ImGui_ImplWGPU_Init()
struct ImGui_ImplWGPU_InitInfo
{
2025-12-26 17:28:40 -05:00
WGPUDevice Device = nullptr ;
2025-08-10 03:37:21 -05:00
int NumFramesInFlight = 3 ;
WGPUTextureFormat RenderTargetFormat = WGPUTextureFormat_Undefined ;
WGPUTextureFormat DepthStencilFormat = WGPUTextureFormat_Undefined ;
WGPUMultisampleState PipelineMultisampleState = { } ;
ImGui_ImplWGPU_InitInfo ( )
{
PipelineMultisampleState . count = 1 ;
2025-08-10 04:01:31 -05:00
PipelineMultisampleState . mask = UINT32_MAX ;
2025-08-10 03:37:21 -05:00
PipelineMultisampleState . alphaToCoverageEnabled = false ;
}
} ;
2025-08-10 05:07:58 -05:00
// Follow "Getting Started" link and check examples/ folder to learn about using backends!
2025-08-10 03:37:21 -05:00
IMGUI_IMPL_API bool ImGui_ImplWGPU_Init ( ImGui_ImplWGPU_InitInfo * init_info ) ;
2022-05-18 15:23:10 -05:00
IMGUI_IMPL_API void ImGui_ImplWGPU_Shutdown ( ) ;
IMGUI_IMPL_API void ImGui_ImplWGPU_NewFrame ( ) ;
IMGUI_IMPL_API void ImGui_ImplWGPU_RenderDrawData ( ImDrawData * draw_data , WGPURenderPassEncoder pass_encoder ) ;
// Use if you want to reset your rendering device without losing Dear ImGui state.
IMGUI_IMPL_API bool ImGui_ImplWGPU_CreateDeviceObjects ( ) ;
2025-08-11 15:09:28 -05:00
IMGUI_IMPL_API void ImGui_ImplWGPU_InvalidateDeviceObjects ( ) ;
2023-08-30 00:42:51 -05:00
2025-08-11 20:40:50 -05:00
// (Advanced) Use e.g. if you need to precisely control the timing of texture updates (e.g. for staged rendering), by setting ImDrawData::Textures = NULL to handle this manually.
IMGUI_IMPL_API void ImGui_ImplWGPU_UpdateTexture ( ImTextureData * tex ) ;
2025-08-11 14:52:57 -05:00
// [BETA] Selected render state data shared with callbacks.
// This is temporarily stored in GetPlatformIO().Renderer_RenderState during the ImGui_ImplWGPU_RenderDrawData() call.
// (Please open an issue if you feel you need access to more data)
struct ImGui_ImplWGPU_RenderState
{
WGPUDevice Device ;
WGPURenderPassEncoder RenderPassEncoder ;
} ;
2025-12-26 18:12:14 -05:00
//-------------------------------------------------------------------------
// Internal Helpers
// Those are currently used by our example applications.
//-------------------------------------------------------------------------
// (Optional) Helper to wrap some of the Dawn/WGPU/Emscripten quirks
bool ImGui_ImplWGPU_IsSurfaceStatusError ( WGPUSurfaceGetCurrentTextureStatus status ) ;
bool ImGui_ImplWGPU_IsSurfaceStatusSubOptimal ( WGPUSurfaceGetCurrentTextureStatus status ) ; // Return whether the texture is suboptimal and may need to be recreated.
// (Optional) Helper for debugging/logging
void ImGui_ImplWGPU_DebugPrintAdapterInfo ( const WGPUAdapter & adapter ) ;
const char * ImGui_ImplWGPU_GetBackendTypeName ( WGPUBackendType type ) ;
const char * ImGui_ImplWGPU_GetAdapterTypeName ( WGPUAdapterType type ) ;
# if defined(IMGUI_IMPL_WEBGPU_BACKEND_DAWN)
const char * ImGui_ImplWGPU_GetDeviceLostReasonName ( WGPUDeviceLostReason type ) ;
const char * ImGui_ImplWGPU_GetErrorTypeName ( WGPUErrorType type ) ;
# elif defined(IMGUI_IMPL_WEBGPU_BACKEND_WGPU) && !defined(__EMSCRIPTEN__)
const char * ImGui_ImplWGPU_GetLogLevelName ( WGPULogLevel level ) ;
# endif
// (Optional) Helper to create a surface on macOS/Wayland/X11/Window
# ifndef __EMSCRIPTEN__
struct ImGui_ImplWGPU_CreateSurfaceInfo
{
WGPUInstance Instance ;
const char * System ; // "cocoa" | "wayland" | "x11" | "win32"
void * RawWindow ; // NSWindow* | 0 | Window | HWND
void * RawDisplay ; // 0 | wl_display* | Display* | 0
void * RawSurface ; // | wl_surface* | 0 | 0
void * RawInstance ; // 0 | 0 | 0 | HINSTANCE
} ;
WGPUSurface ImGui_ImplWGPU_CreateWGPUSurfaceHelper ( ImGui_ImplWGPU_CreateSurfaceInfo * info ) ;
# endif // #ifndef __EMSCRIPTEN__
2023-08-30 00:42:51 -05:00
# endif // #ifndef IMGUI_DISABLE