Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make Dear ImGui support explicit multiple contexts used in parallel #5856

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Make Dear ImGui support explicit multiple contexts used in parallel #5856

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
5ecc29d
pre-generation: Make ImGui classes not depend on the implicit GImGui …
ocornut Mar 8, 2023
eec2b43
pre-generation: Remove DebugAllocHook from MemAlloc and MemFree
Dragnalith Nov 1, 2022
65ea0d1
pre-generation: Make ImGui::ShowFontAtlas be a public API
Dragnalith May 18, 2023
5560f2a
[generated] Convert Dear ImGui API to use an explicit ImGuiContext.
Dragnalith Nov 23, 2023
4801b80
post-generation: Remove global ImGuiContext
Dragnalith Nov 23, 2023
b250199
post-generation: Remove OnceUponAFrame helper
Dragnalith Nov 23, 2023
58915c2
post-generation: Fix corner cases related to API conversion to explic…
Dragnalith Nov 23, 2023
c336836
post-generation: Convert Win32 backend to use explicit context API
Dragnalith Nov 23, 2023
65f3b52
post-generation: Convert DX12 backend to use explicit context API
Dragnalith Nov 23, 2023
6d6b190
post-generation: Convert DX12 example to use explicit context API
Dragnalith Nov 23, 2023
6743576
post-generation: Update README.md
Dragnalith Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 27 additions & 27 deletions backends/imgui_impl_dx12.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,9 @@ struct ImGui_ImplDX12_Data

// Backend data stored in io.BackendRendererUserData to allow support for multiple Dear ImGui contexts
// It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
static ImGui_ImplDX12_Data* ImGui_ImplDX12_GetBackendData()
static ImGui_ImplDX12_Data* ImGui_ImplDX12_GetBackendData(ImGuiContext* ctx)
{
return ImGui::GetCurrentContext() ? (ImGui_ImplDX12_Data*)ImGui::GetIO().BackendRendererUserData : nullptr;
return ctx ? (ImGui_ImplDX12_Data*)ImGui::GetIO(ctx).BackendRendererUserData : nullptr;
}

// Buffers used during the rendering of a frame
Expand All @@ -95,9 +95,9 @@ struct VERTEX_CONSTANT_BUFFER_DX12
};

// Functions
static void ImGui_ImplDX12_SetupRenderState(ImDrawData* draw_data, ID3D12GraphicsCommandList* ctx, ImGui_ImplDX12_RenderBuffers* fr)
static void ImGui_ImplDX12_SetupRenderState(ImGuiContext* imctx, ImDrawData* draw_data, ID3D12GraphicsCommandList* ctx, ImGui_ImplDX12_RenderBuffers* fr)
{
ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData(imctx);

// Setup orthographic projection matrix into our constant buffer
// Our visible imgui space lies from draw_data->DisplayPos (top left) to draw_data->DisplayPos+data_data->DisplaySize (bottom right).
Expand Down Expand Up @@ -161,15 +161,15 @@ static inline void SafeRelease(T*& res)
}

// Render function
void ImGui_ImplDX12_RenderDrawData(ImDrawData* draw_data, ID3D12GraphicsCommandList* ctx)
void ImGui_ImplDX12_RenderDrawData(ImGuiContext* imctx, ImDrawData* draw_data, ID3D12GraphicsCommandList* ctx)
{
// Avoid rendering when minimized
if (draw_data->DisplaySize.x <= 0.0f || draw_data->DisplaySize.y <= 0.0f)
return;

// FIXME: I'm assuming that this only gets called once per frame!
// If not, we can't just re-allocate the IB or VB, we'll have to do a proper allocator.
ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData(imctx);
bd->frameIndex = bd->frameIndex + 1;
ImGui_ImplDX12_RenderBuffers* fr = &bd->pFrameResources[bd->frameIndex % bd->numFramesInFlight];

Expand Down Expand Up @@ -243,7 +243,7 @@ void ImGui_ImplDX12_RenderDrawData(ImDrawData* draw_data, ID3D12GraphicsCommandL
fr->IndexBuffer->Unmap(0, &range);

// Setup desired DX state
ImGui_ImplDX12_SetupRenderState(draw_data, ctx, fr);
ImGui_ImplDX12_SetupRenderState(imctx, draw_data, ctx, fr);

// Render command lists
// (Because we merged all buffers into a single one, we maintain our own offset into them)
Expand All @@ -261,7 +261,7 @@ void ImGui_ImplDX12_RenderDrawData(ImDrawData* draw_data, ID3D12GraphicsCommandL
// User callback, registered via ImDrawList::AddCallback()
// (ImDrawCallback_ResetRenderState is a special callback value used by the user to request the renderer to reset render state.)
if (pcmd->UserCallback == ImDrawCallback_ResetRenderState)
ImGui_ImplDX12_SetupRenderState(draw_data, ctx, fr);
ImGui_ImplDX12_SetupRenderState(imctx, draw_data, ctx, fr);
else
pcmd->UserCallback(cmd_list, pcmd);
}
Expand All @@ -287,11 +287,11 @@ void ImGui_ImplDX12_RenderDrawData(ImDrawData* draw_data, ID3D12GraphicsCommandL
}
}

static void ImGui_ImplDX12_CreateFontsTexture()
static void ImGui_ImplDX12_CreateFontsTexture(ImGuiContext* ctx)
{
// Build texture atlas
ImGuiIO& io = ImGui::GetIO();
ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
ImGuiIO& io = ImGui::GetIO(ctx);
ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData(ctx);
unsigned char* pixels;
int width, height;
io.Fonts->GetTexDataAsRGBA32(&pixels, &width, &height);
Expand Down Expand Up @@ -444,13 +444,13 @@ static void ImGui_ImplDX12_CreateFontsTexture()
io.Fonts->SetTexID((ImTextureID)bd->hFontSrvGpuDescHandle.ptr);
}

bool ImGui_ImplDX12_CreateDeviceObjects()
bool ImGui_ImplDX12_CreateDeviceObjects(ImGuiContext* ctx)
{
ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData(ctx);
if (!bd || !bd->pd3dDevice)
return false;
if (bd->pPipelineState)
ImGui_ImplDX12_InvalidateDeviceObjects();
ImGui_ImplDX12_InvalidateDeviceObjects(ctx);

// Create the root signature
{
Expand Down Expand Up @@ -673,18 +673,18 @@ bool ImGui_ImplDX12_CreateDeviceObjects()
if (result_pipeline_state != S_OK)
return false;

ImGui_ImplDX12_CreateFontsTexture();
ImGui_ImplDX12_CreateFontsTexture(ctx);

return true;
}

void ImGui_ImplDX12_InvalidateDeviceObjects()
void ImGui_ImplDX12_InvalidateDeviceObjects(ImGuiContext* ctx)
{
ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData(ctx);
if (!bd || !bd->pd3dDevice)
return;

ImGuiIO& io = ImGui::GetIO();
ImGuiIO& io = ImGui::GetIO(ctx);
SafeRelease(bd->pRootSignature);
SafeRelease(bd->pPipelineState);
SafeRelease(bd->pFontTextureResource);
Expand All @@ -698,10 +698,10 @@ void ImGui_ImplDX12_InvalidateDeviceObjects()
}
}

bool ImGui_ImplDX12_Init(ID3D12Device* device, int num_frames_in_flight, DXGI_FORMAT rtv_format, ID3D12DescriptorHeap* cbv_srv_heap,
bool ImGui_ImplDX12_Init(ImGuiContext* ctx, ID3D12Device* device, int num_frames_in_flight, DXGI_FORMAT rtv_format, ID3D12DescriptorHeap* cbv_srv_heap,
D3D12_CPU_DESCRIPTOR_HANDLE font_srv_cpu_desc_handle, D3D12_GPU_DESCRIPTOR_HANDLE font_srv_gpu_desc_handle)
{
ImGuiIO& io = ImGui::GetIO();
ImGuiIO& io = ImGui::GetIO(ctx);
IM_ASSERT(io.BackendRendererUserData == nullptr && "Already initialized a renderer backend!");

// Setup backend capabilities flags
Expand Down Expand Up @@ -732,28 +732,28 @@ bool ImGui_ImplDX12_Init(ID3D12Device* device, int num_frames_in_flight, DXGI_FO
return true;
}

void ImGui_ImplDX12_Shutdown()
void ImGui_ImplDX12_Shutdown(ImGuiContext* ctx)
{
ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData(ctx);
IM_ASSERT(bd != nullptr && "No renderer backend to shutdown, or already shutdown?");
ImGuiIO& io = ImGui::GetIO();
ImGuiIO& io = ImGui::GetIO(ctx);

// Clean up windows and device objects
ImGui_ImplDX12_InvalidateDeviceObjects();
ImGui_ImplDX12_InvalidateDeviceObjects(ctx);
delete[] bd->pFrameResources;
io.BackendRendererName = nullptr;
io.BackendRendererUserData = nullptr;
io.BackendFlags &= ~ImGuiBackendFlags_RendererHasVtxOffset;
IM_DELETE(bd);
}

void ImGui_ImplDX12_NewFrame()
void ImGui_ImplDX12_NewFrame(ImGuiContext* ctx)
{
ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData(ctx);
IM_ASSERT(bd != nullptr && "Did you call ImGui_ImplDX12_Init()?");

if (!bd->pPipelineState)
ImGui_ImplDX12_CreateDeviceObjects();
ImGui_ImplDX12_CreateDeviceObjects(ctx);
}

//-----------------------------------------------------------------------------
Expand Down
12 changes: 6 additions & 6 deletions backends/imgui_impl_dx12.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ struct D3D12_GPU_DESCRIPTOR_HANDLE;
// Before calling the render function, caller must prepare cmd_list by resetting it and setting the appropriate
// render target and descriptor heap that contains font_srv_cpu_desc_handle/font_srv_gpu_desc_handle.
// font_srv_cpu_desc_handle and font_srv_gpu_desc_handle are handles to a single SRV descriptor to use for the internal font texture.
IMGUI_IMPL_API bool ImGui_ImplDX12_Init(ID3D12Device* device, int num_frames_in_flight, DXGI_FORMAT rtv_format, ID3D12DescriptorHeap* cbv_srv_heap,
IMGUI_IMPL_API bool ImGui_ImplDX12_Init(ImGuiContext* ctx, ID3D12Device* device, int num_frames_in_flight, DXGI_FORMAT rtv_format, ID3D12DescriptorHeap* cbv_srv_heap,
D3D12_CPU_DESCRIPTOR_HANDLE font_srv_cpu_desc_handle, D3D12_GPU_DESCRIPTOR_HANDLE font_srv_gpu_desc_handle);
IMGUI_IMPL_API void ImGui_ImplDX12_Shutdown();
IMGUI_IMPL_API void ImGui_ImplDX12_NewFrame();
IMGUI_IMPL_API void ImGui_ImplDX12_RenderDrawData(ImDrawData* draw_data, ID3D12GraphicsCommandList* graphics_command_list);
IMGUI_IMPL_API void ImGui_ImplDX12_NewFrame(ImGuiContext* ctx);
IMGUI_IMPL_API void ImGui_ImplDX12_Shutdown(ImGuiContext* ctx);
IMGUI_IMPL_API void ImGui_ImplDX12_RenderDrawData(ImGuiContext* ctx, ImDrawData* draw_data, ID3D12GraphicsCommandList* graphics_command_list);

// Use if you want to reset your rendering device without losing Dear ImGui state.
IMGUI_IMPL_API void ImGui_ImplDX12_InvalidateDeviceObjects();
IMGUI_IMPL_API bool ImGui_ImplDX12_CreateDeviceObjects();
IMGUI_IMPL_API void ImGui_ImplDX12_InvalidateDeviceObjects(ImGuiContext* ctx);
IMGUI_IMPL_API bool ImGui_ImplDX12_CreateDeviceObjects(ImGuiContext* ctx);

#endif // #ifndef IMGUI_DISABLE
Loading