imgui_impl_dx12.cpp 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934
  1. // dear imgui: Renderer Backend for DirectX12
  2. // This needs to be used along with a Platform Backend (e.g. Win32)
  3. // Implemented features:
  4. // [X] Renderer: User texture binding. Use 'D3D12_GPU_DESCRIPTOR_HANDLE' as texture identifier. Read the FAQ about ImTextureID/ImTextureRef!
  5. // [X] Renderer: Large meshes support (64k+ vertices) even with 16-bit indices (ImGuiBackendFlags_RendererHasVtxOffset).
  6. // [X] Renderer: Texture updates support for dynamic font atlas (ImGuiBackendFlags_RendererHasTextures).
  7. // [X] Renderer: Expose selected render state for draw callbacks to use. Access in '(ImGui_ImplXXXX_RenderState*)GetPlatformIO().Renderer_RenderState'.
  8. // The aim of imgui_impl_dx12.h/.cpp is to be usable in your engine without any modification.
  9. // IF YOU FEEL YOU NEED TO MAKE ANY CHANGE TO THIS CODE, please share them and your feedback at https://github.com/ocornut/imgui/
  10. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
  11. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
  12. // Learn about Dear ImGui:
  13. // - FAQ https://dearimgui.com/faq
  14. // - Getting Started https://dearimgui.com/getting-started
  15. // - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
  16. // - Introduction, links and more at the top of imgui.cpp
  17. // CHANGELOG
  18. // (minor and older changes stripped away, please see git history for details)
  19. // 2025-06-19: Fixed build on MinGW. (#8702, #4594)
  20. // 2025-06-11: DirectX12: Added support for ImGuiBackendFlags_RendererHasTextures, for dynamic font atlas.
  21. // 2025-05-07: DirectX12: Honor draw_data->FramebufferScale to allow for custom backends and experiment using it (consistently with other renderer backends, even though in normal condition it is not set under Windows).
  22. // 2025-02-24: DirectX12: Fixed an issue where ImGui_ImplDX12_Init() signature change from 2024-11-15 combined with change from 2025-01-15 made legacy ImGui_ImplDX12_Init() crash. (#8429)
  23. // 2025-01-15: DirectX12: Texture upload use the command queue provided in ImGui_ImplDX12_InitInfo instead of creating its own.
  24. // 2024-12-09: DirectX12: Let user specifies the DepthStencilView format by setting ImGui_ImplDX12_InitInfo::DSVFormat.
  25. // 2024-11-15: DirectX12: *BREAKING CHANGE* Changed ImGui_ImplDX12_Init() signature to take a ImGui_ImplDX12_InitInfo struct. Legacy ImGui_ImplDX12_Init() signature is still supported (will obsolete).
  26. // 2024-11-15: DirectX12: *BREAKING CHANGE* User is now required to pass function pointers to allocate/free SRV Descriptors. We provide convenience legacy fields to pass a single descriptor, matching the old API, but upcoming features will want multiple.
  27. // 2024-10-23: DirectX12: Unmap() call specify written range. The range is informational and may be used by debug tools.
  28. // 2024-10-07: DirectX12: Changed default texture sampler to Clamp instead of Repeat/Wrap.
  29. // 2024-10-07: DirectX12: Expose selected render state in ImGui_ImplDX12_RenderState, which you can access in 'void* platform_io.Renderer_RenderState' during draw callbacks.
  30. // 2024-10-07: DirectX12: Compiling with '#define ImTextureID=ImU64' is unnecessary now that dear imgui defaults ImTextureID to u64 instead of void*.
  31. // 2022-10-11: Using 'nullptr' instead of 'NULL' as per our switch to C++11.
  32. // 2021-06-29: Reorganized backend to pull data from a single structure to facilitate usage with multiple-contexts (all g_XXXX access changed to bd->XXXX).
  33. // 2021-05-19: DirectX12: Replaced direct access to ImDrawCmd::TextureId with a call to ImDrawCmd::GetTexID(). (will become a requirement)
  34. // 2021-02-18: DirectX12: Change blending equation to preserve alpha in output buffer.
  35. // 2021-01-11: DirectX12: Improve Windows 7 compatibility (for D3D12On7) by loading d3d12.dll dynamically.
  36. // 2020-09-16: DirectX12: Avoid rendering calls with zero-sized scissor rectangle since it generates a validation layer warning.
  37. // 2020-09-08: DirectX12: Clarified support for building on 32-bit systems by redefining ImTextureID.
  38. // 2019-10-18: DirectX12: *BREAKING CHANGE* Added extra ID3D12DescriptorHeap parameter to ImGui_ImplDX12_Init() function.
  39. // 2019-05-29: DirectX12: Added support for large mesh (64K+ vertices), enable ImGuiBackendFlags_RendererHasVtxOffset flag.
  40. // 2019-04-30: DirectX12: Added support for special ImDrawCallback_ResetRenderState callback to reset render state.
  41. // 2019-03-29: Misc: Various minor tidying up.
  42. // 2018-12-03: Misc: Added #pragma comment statement to automatically link with d3dcompiler.lib when using D3DCompile().
  43. // 2018-11-30: Misc: Setting up io.BackendRendererName so it can be displayed in the About Window.
  44. // 2018-06-12: DirectX12: Moved the ID3D12GraphicsCommandList* parameter from NewFrame() to RenderDrawData().
  45. // 2018-06-08: Misc: Extracted imgui_impl_dx12.cpp/.h away from the old combined DX12+Win32 example.
  46. // 2018-06-08: DirectX12: Use draw_data->DisplayPos and draw_data->DisplaySize to setup projection matrix and clipping rectangle (to ease support for future multi-viewport).
  47. // 2018-02-22: Merged into master with all Win32 code synchronized to other examples.
  48. #include "imgui.h"
  49. #ifndef IMGUI_DISABLE
  50. #include "imgui_impl_dx12.h"
  51. // DirectX
  52. #include <d3d12.h>
  53. #include <dxgi1_4.h>
  54. #include <d3dcompiler.h>
  55. #ifdef _MSC_VER
  56. #pragma comment(lib, "d3dcompiler") // Automatically link with d3dcompiler.lib as we are using D3DCompile() below.
  57. #endif
  58. // Clang/GCC warnings with -Weverything
  59. #if defined(__clang__)
  60. #pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast // yes, they are more terse.
  61. #pragma clang diagnostic ignored "-Wsign-conversion" // warning: implicit conversion changes signedness
  62. #endif
  63. // MinGW workaround, see #4594
  64. typedef decltype(D3D12SerializeRootSignature) *_PFN_D3D12_SERIALIZE_ROOT_SIGNATURE;
  65. // DirectX12 data
  66. struct ImGui_ImplDX12_RenderBuffers;
  67. struct ImGui_ImplDX12_Texture
  68. {
  69. ID3D12Resource* pTextureResource;
  70. D3D12_CPU_DESCRIPTOR_HANDLE hFontSrvCpuDescHandle;
  71. D3D12_GPU_DESCRIPTOR_HANDLE hFontSrvGpuDescHandle;
  72. ImGui_ImplDX12_Texture() { memset((void*)this, 0, sizeof(*this)); }
  73. };
  74. struct ImGui_ImplDX12_Data
  75. {
  76. ImGui_ImplDX12_InitInfo InitInfo;
  77. ID3D12Device* pd3dDevice;
  78. ID3D12RootSignature* pRootSignature;
  79. ID3D12PipelineState* pPipelineState;
  80. ID3D12CommandQueue* pCommandQueue;
  81. bool commandQueueOwned;
  82. DXGI_FORMAT RTVFormat;
  83. DXGI_FORMAT DSVFormat;
  84. ID3D12DescriptorHeap* pd3dSrvDescHeap;
  85. UINT numFramesInFlight;
  86. ImGui_ImplDX12_RenderBuffers* pFrameResources;
  87. UINT frameIndex;
  88. ImGui_ImplDX12_Texture FontTexture;
  89. bool LegacySingleDescriptorUsed;
  90. ImGui_ImplDX12_Data() { memset((void*)this, 0, sizeof(*this)); frameIndex = UINT_MAX; }
  91. };
  92. // Backend data stored in io.BackendRendererUserData to allow support for multiple Dear ImGui contexts
  93. // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
  94. static ImGui_ImplDX12_Data* ImGui_ImplDX12_GetBackendData()
  95. {
  96. return ImGui::GetCurrentContext() ? (ImGui_ImplDX12_Data*)ImGui::GetIO().BackendRendererUserData : nullptr;
  97. }
  98. // Buffers used during the rendering of a frame
  99. struct ImGui_ImplDX12_RenderBuffers
  100. {
  101. ID3D12Resource* IndexBuffer;
  102. ID3D12Resource* VertexBuffer;
  103. int IndexBufferSize;
  104. int VertexBufferSize;
  105. };
  106. struct VERTEX_CONSTANT_BUFFER_DX12
  107. {
  108. float mvp[4][4];
  109. };
  110. // Functions
  111. static void ImGui_ImplDX12_SetupRenderState(ImDrawData* draw_data, ID3D12GraphicsCommandList* command_list, ImGui_ImplDX12_RenderBuffers* fr)
  112. {
  113. ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
  114. // Setup orthographic projection matrix into our constant buffer
  115. // Our visible imgui space lies from draw_data->DisplayPos (top left) to draw_data->DisplayPos+data_data->DisplaySize (bottom right).
  116. VERTEX_CONSTANT_BUFFER_DX12 vertex_constant_buffer;
  117. {
  118. float L = draw_data->DisplayPos.x;
  119. float R = draw_data->DisplayPos.x + draw_data->DisplaySize.x;
  120. float T = draw_data->DisplayPos.y;
  121. float B = draw_data->DisplayPos.y + draw_data->DisplaySize.y;
  122. float mvp[4][4] =
  123. {
  124. { 2.0f/(R-L), 0.0f, 0.0f, 0.0f },
  125. { 0.0f, 2.0f/(T-B), 0.0f, 0.0f },
  126. { 0.0f, 0.0f, 0.5f, 0.0f },
  127. { (R+L)/(L-R), (T+B)/(B-T), 0.5f, 1.0f },
  128. };
  129. memcpy(&vertex_constant_buffer.mvp, mvp, sizeof(mvp));
  130. }
  131. // Setup viewport
  132. D3D12_VIEWPORT vp = {};
  133. vp.Width = draw_data->DisplaySize.x * draw_data->FramebufferScale.x;
  134. vp.Height = draw_data->DisplaySize.y * draw_data->FramebufferScale.y;
  135. vp.MinDepth = 0.0f;
  136. vp.MaxDepth = 1.0f;
  137. vp.TopLeftX = vp.TopLeftY = 0.0f;
  138. command_list->RSSetViewports(1, &vp);
  139. // Bind shader and vertex buffers
  140. unsigned int stride = sizeof(ImDrawVert);
  141. unsigned int offset = 0;
  142. D3D12_VERTEX_BUFFER_VIEW vbv = {};
  143. vbv.BufferLocation = fr->VertexBuffer->GetGPUVirtualAddress() + offset;
  144. vbv.SizeInBytes = fr->VertexBufferSize * stride;
  145. vbv.StrideInBytes = stride;
  146. command_list->IASetVertexBuffers(0, 1, &vbv);
  147. D3D12_INDEX_BUFFER_VIEW ibv = {};
  148. ibv.BufferLocation = fr->IndexBuffer->GetGPUVirtualAddress();
  149. ibv.SizeInBytes = fr->IndexBufferSize * sizeof(ImDrawIdx);
  150. ibv.Format = sizeof(ImDrawIdx) == 2 ? DXGI_FORMAT_R16_UINT : DXGI_FORMAT_R32_UINT;
  151. command_list->IASetIndexBuffer(&ibv);
  152. command_list->IASetPrimitiveTopology(D3D_PRIMITIVE_TOPOLOGY_TRIANGLELIST);
  153. command_list->SetPipelineState(bd->pPipelineState);
  154. command_list->SetGraphicsRootSignature(bd->pRootSignature);
  155. command_list->SetGraphicsRoot32BitConstants(0, 16, &vertex_constant_buffer, 0);
  156. // Setup blend factor
  157. const float blend_factor[4] = { 0.f, 0.f, 0.f, 0.f };
  158. command_list->OMSetBlendFactor(blend_factor);
  159. }
  160. template<typename T>
  161. static inline void SafeRelease(T*& res)
  162. {
  163. if (res)
  164. res->Release();
  165. res = nullptr;
  166. }
  167. // Render function
  168. void ImGui_ImplDX12_RenderDrawData(ImDrawData* draw_data, ID3D12GraphicsCommandList* command_list)
  169. {
  170. // Avoid rendering when minimized
  171. if (draw_data->DisplaySize.x <= 0.0f || draw_data->DisplaySize.y <= 0.0f)
  172. return;
  173. // Catch up with texture updates. Most of the times, the list will have 1 element with an OK status, aka nothing to do.
  174. // (This almost always points to ImGui::GetPlatformIO().Textures[] but is part of ImDrawData to allow overriding or disabling texture updates).
  175. if (draw_data->Textures != nullptr)
  176. for (ImTextureData* tex : *draw_data->Textures)
  177. if (tex->Status != ImTextureStatus_OK)
  178. ImGui_ImplDX12_UpdateTexture(tex);
  179. // FIXME: We are assuming that this only gets called once per frame!
  180. ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
  181. bd->frameIndex = bd->frameIndex + 1;
  182. ImGui_ImplDX12_RenderBuffers* fr = &bd->pFrameResources[bd->frameIndex % bd->numFramesInFlight];
  183. // Create and grow vertex/index buffers if needed
  184. if (fr->VertexBuffer == nullptr || fr->VertexBufferSize < draw_data->TotalVtxCount)
  185. {
  186. SafeRelease(fr->VertexBuffer);
  187. fr->VertexBufferSize = draw_data->TotalVtxCount + 5000;
  188. D3D12_HEAP_PROPERTIES props = {};
  189. props.Type = D3D12_HEAP_TYPE_UPLOAD;
  190. props.CPUPageProperty = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
  191. props.MemoryPoolPreference = D3D12_MEMORY_POOL_UNKNOWN;
  192. D3D12_RESOURCE_DESC desc = {};
  193. desc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER;
  194. desc.Width = fr->VertexBufferSize * sizeof(ImDrawVert);
  195. desc.Height = 1;
  196. desc.DepthOrArraySize = 1;
  197. desc.MipLevels = 1;
  198. desc.Format = DXGI_FORMAT_UNKNOWN;
  199. desc.SampleDesc.Count = 1;
  200. desc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR;
  201. desc.Flags = D3D12_RESOURCE_FLAG_NONE;
  202. if (bd->pd3dDevice->CreateCommittedResource(&props, D3D12_HEAP_FLAG_NONE, &desc, D3D12_RESOURCE_STATE_GENERIC_READ, nullptr, IID_PPV_ARGS(&fr->VertexBuffer)) < 0)
  203. return;
  204. }
  205. if (fr->IndexBuffer == nullptr || fr->IndexBufferSize < draw_data->TotalIdxCount)
  206. {
  207. SafeRelease(fr->IndexBuffer);
  208. fr->IndexBufferSize = draw_data->TotalIdxCount + 10000;
  209. D3D12_HEAP_PROPERTIES props = {};
  210. props.Type = D3D12_HEAP_TYPE_UPLOAD;
  211. props.CPUPageProperty = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
  212. props.MemoryPoolPreference = D3D12_MEMORY_POOL_UNKNOWN;
  213. D3D12_RESOURCE_DESC desc = {};
  214. desc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER;
  215. desc.Width = fr->IndexBufferSize * sizeof(ImDrawIdx);
  216. desc.Height = 1;
  217. desc.DepthOrArraySize = 1;
  218. desc.MipLevels = 1;
  219. desc.Format = DXGI_FORMAT_UNKNOWN;
  220. desc.SampleDesc.Count = 1;
  221. desc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR;
  222. desc.Flags = D3D12_RESOURCE_FLAG_NONE;
  223. if (bd->pd3dDevice->CreateCommittedResource(&props, D3D12_HEAP_FLAG_NONE, &desc, D3D12_RESOURCE_STATE_GENERIC_READ, nullptr, IID_PPV_ARGS(&fr->IndexBuffer)) < 0)
  224. return;
  225. }
  226. // Upload vertex/index data into a single contiguous GPU buffer
  227. // During Map() we specify a null read range (as per DX12 API, this is informational and for tooling only)
  228. void* vtx_resource, *idx_resource;
  229. D3D12_RANGE range = { 0, 0 };
  230. if (fr->VertexBuffer->Map(0, &range, &vtx_resource) != S_OK)
  231. return;
  232. if (fr->IndexBuffer->Map(0, &range, &idx_resource) != S_OK)
  233. return;
  234. ImDrawVert* vtx_dst = (ImDrawVert*)vtx_resource;
  235. ImDrawIdx* idx_dst = (ImDrawIdx*)idx_resource;
  236. for (int n = 0; n < draw_data->CmdListsCount; n++)
  237. {
  238. const ImDrawList* draw_list = draw_data->CmdLists[n];
  239. memcpy(vtx_dst, draw_list->VtxBuffer.Data, draw_list->VtxBuffer.Size * sizeof(ImDrawVert));
  240. memcpy(idx_dst, draw_list->IdxBuffer.Data, draw_list->IdxBuffer.Size * sizeof(ImDrawIdx));
  241. vtx_dst += draw_list->VtxBuffer.Size;
  242. idx_dst += draw_list->IdxBuffer.Size;
  243. }
  244. // During Unmap() we specify the written range (as per DX12 API, this is informational and for tooling only)
  245. range.End = (SIZE_T)((intptr_t)vtx_dst - (intptr_t)vtx_resource);
  246. IM_ASSERT(range.End == draw_data->TotalVtxCount * sizeof(ImDrawVert));
  247. fr->VertexBuffer->Unmap(0, &range);
  248. range.End = (SIZE_T)((intptr_t)idx_dst - (intptr_t)idx_resource);
  249. IM_ASSERT(range.End == draw_data->TotalIdxCount * sizeof(ImDrawIdx));
  250. fr->IndexBuffer->Unmap(0, &range);
  251. // Setup desired DX state
  252. ImGui_ImplDX12_SetupRenderState(draw_data, command_list, fr);
  253. // Setup render state structure (for callbacks and custom texture bindings)
  254. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  255. ImGui_ImplDX12_RenderState render_state;
  256. render_state.Device = bd->pd3dDevice;
  257. render_state.CommandList = command_list;
  258. platform_io.Renderer_RenderState = &render_state;
  259. // Render command lists
  260. // (Because we merged all buffers into a single one, we maintain our own offset into them)
  261. int global_vtx_offset = 0;
  262. int global_idx_offset = 0;
  263. ImVec2 clip_off = draw_data->DisplayPos;
  264. ImVec2 clip_scale = draw_data->FramebufferScale;
  265. for (int n = 0; n < draw_data->CmdListsCount; n++)
  266. {
  267. const ImDrawList* draw_list = draw_data->CmdLists[n];
  268. for (int cmd_i = 0; cmd_i < draw_list->CmdBuffer.Size; cmd_i++)
  269. {
  270. const ImDrawCmd* pcmd = &draw_list->CmdBuffer[cmd_i];
  271. if (pcmd->UserCallback != nullptr)
  272. {
  273. // User callback, registered via ImDrawList::AddCallback()
  274. // (ImDrawCallback_ResetRenderState is a special callback value used by the user to request the renderer to reset render state.)
  275. if (pcmd->UserCallback == ImDrawCallback_ResetRenderState)
  276. ImGui_ImplDX12_SetupRenderState(draw_data, command_list, fr);
  277. else
  278. pcmd->UserCallback(draw_list, pcmd);
  279. }
  280. else
  281. {
  282. // Project scissor/clipping rectangles into framebuffer space
  283. ImVec2 clip_min((pcmd->ClipRect.x - clip_off.x) * clip_scale.x, (pcmd->ClipRect.y - clip_off.y) * clip_scale.y);
  284. ImVec2 clip_max((pcmd->ClipRect.z - clip_off.x) * clip_scale.x, (pcmd->ClipRect.w - clip_off.y) * clip_scale.y);
  285. if (clip_max.x <= clip_min.x || clip_max.y <= clip_min.y)
  286. continue;
  287. // Apply scissor/clipping rectangle
  288. const D3D12_RECT r = { (LONG)clip_min.x, (LONG)clip_min.y, (LONG)clip_max.x, (LONG)clip_max.y };
  289. command_list->RSSetScissorRects(1, &r);
  290. // Bind texture, Draw
  291. D3D12_GPU_DESCRIPTOR_HANDLE texture_handle = {};
  292. texture_handle.ptr = (UINT64)pcmd->GetTexID();
  293. command_list->SetGraphicsRootDescriptorTable(1, texture_handle);
  294. command_list->DrawIndexedInstanced(pcmd->ElemCount, 1, pcmd->IdxOffset + global_idx_offset, pcmd->VtxOffset + global_vtx_offset, 0);
  295. }
  296. }
  297. global_idx_offset += draw_list->IdxBuffer.Size;
  298. global_vtx_offset += draw_list->VtxBuffer.Size;
  299. }
  300. platform_io.Renderer_RenderState = nullptr;
  301. }
  302. static void ImGui_ImplDX12_DestroyTexture(ImTextureData* tex)
  303. {
  304. ImGui_ImplDX12_Texture* backend_tex = (ImGui_ImplDX12_Texture*)tex->BackendUserData;
  305. if (backend_tex == nullptr)
  306. return;
  307. IM_ASSERT(backend_tex->hFontSrvGpuDescHandle.ptr == (UINT64)tex->TexID);
  308. ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
  309. bd->InitInfo.SrvDescriptorFreeFn(&bd->InitInfo, backend_tex->hFontSrvCpuDescHandle, backend_tex->hFontSrvGpuDescHandle);
  310. SafeRelease(backend_tex->pTextureResource);
  311. backend_tex->hFontSrvCpuDescHandle.ptr = 0;
  312. backend_tex->hFontSrvGpuDescHandle.ptr = 0;
  313. IM_DELETE(backend_tex);
  314. // Clear identifiers and mark as destroyed (in order to allow e.g. calling InvalidateDeviceObjects while running)
  315. tex->SetTexID(ImTextureID_Invalid);
  316. tex->SetStatus(ImTextureStatus_Destroyed);
  317. tex->BackendUserData = nullptr;
  318. }
  319. void ImGui_ImplDX12_UpdateTexture(ImTextureData* tex)
  320. {
  321. ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
  322. bool need_barrier_before_copy = true; // Do we need a resource barrier before we copy new data in?
  323. if (tex->Status == ImTextureStatus_WantCreate)
  324. {
  325. // Create and upload new texture to graphics system
  326. //IMGUI_DEBUG_LOG("UpdateTexture #%03d: WantCreate %dx%d\n", tex->UniqueID, tex->Width, tex->Height);
  327. IM_ASSERT(tex->TexID == ImTextureID_Invalid && tex->BackendUserData == nullptr);
  328. IM_ASSERT(tex->Format == ImTextureFormat_RGBA32);
  329. ImGui_ImplDX12_Texture* backend_tex = IM_NEW(ImGui_ImplDX12_Texture)();
  330. bd->InitInfo.SrvDescriptorAllocFn(&bd->InitInfo, &backend_tex->hFontSrvCpuDescHandle, &backend_tex->hFontSrvGpuDescHandle); // Allocate a desctriptor handle
  331. D3D12_HEAP_PROPERTIES props = {};
  332. props.Type = D3D12_HEAP_TYPE_DEFAULT;
  333. props.CPUPageProperty = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
  334. props.MemoryPoolPreference = D3D12_MEMORY_POOL_UNKNOWN;
  335. D3D12_RESOURCE_DESC desc;
  336. ZeroMemory(&desc, sizeof(desc));
  337. desc.Dimension = D3D12_RESOURCE_DIMENSION_TEXTURE2D;
  338. desc.Alignment = 0;
  339. desc.Width = tex->Width;
  340. desc.Height = tex->Height;
  341. desc.DepthOrArraySize = 1;
  342. desc.MipLevels = 1;
  343. desc.Format = DXGI_FORMAT_R8G8B8A8_UNORM;
  344. desc.SampleDesc.Count = 1;
  345. desc.SampleDesc.Quality = 0;
  346. desc.Layout = D3D12_TEXTURE_LAYOUT_UNKNOWN;
  347. desc.Flags = D3D12_RESOURCE_FLAG_NONE;
  348. ID3D12Resource* pTexture = nullptr;
  349. bd->pd3dDevice->CreateCommittedResource(&props, D3D12_HEAP_FLAG_NONE, &desc,
  350. D3D12_RESOURCE_STATE_COPY_DEST, nullptr, IID_PPV_ARGS(&pTexture));
  351. // Create SRV
  352. D3D12_SHADER_RESOURCE_VIEW_DESC srvDesc;
  353. ZeroMemory(&srvDesc, sizeof(srvDesc));
  354. srvDesc.Format = DXGI_FORMAT_R8G8B8A8_UNORM;
  355. srvDesc.ViewDimension = D3D12_SRV_DIMENSION_TEXTURE2D;
  356. srvDesc.Texture2D.MipLevels = desc.MipLevels;
  357. srvDesc.Texture2D.MostDetailedMip = 0;
  358. srvDesc.Shader4ComponentMapping = D3D12_DEFAULT_SHADER_4_COMPONENT_MAPPING;
  359. bd->pd3dDevice->CreateShaderResourceView(pTexture, &srvDesc, backend_tex->hFontSrvCpuDescHandle);
  360. SafeRelease(backend_tex->pTextureResource);
  361. backend_tex->pTextureResource = pTexture;
  362. // Store identifiers
  363. tex->SetTexID((ImTextureID)backend_tex->hFontSrvGpuDescHandle.ptr);
  364. tex->BackendUserData = backend_tex;
  365. need_barrier_before_copy = false; // Because this is a newly-created texture it will be in D3D12_RESOURCE_STATE_COMMON and thus we don't need a barrier
  366. // We don't set tex->Status to ImTextureStatus_OK to let the code fallthrough below.
  367. }
  368. if (tex->Status == ImTextureStatus_WantCreate || tex->Status == ImTextureStatus_WantUpdates)
  369. {
  370. ImGui_ImplDX12_Texture* backend_tex = (ImGui_ImplDX12_Texture*)tex->BackendUserData;
  371. IM_ASSERT(tex->Format == ImTextureFormat_RGBA32);
  372. // We could use the smaller rect on _WantCreate but using the full rect allows us to clear the texture.
  373. // FIXME-OPT: Uploading single box even when using ImTextureStatus_WantUpdates. Could use tex->Updates[]
  374. // - Copy all blocks contiguously in upload buffer.
  375. // - Barrier before copy, submit all CopyTextureRegion(), barrier after copy.
  376. const int upload_x = (tex->Status == ImTextureStatus_WantCreate) ? 0 : tex->UpdateRect.x;
  377. const int upload_y = (tex->Status == ImTextureStatus_WantCreate) ? 0 : tex->UpdateRect.y;
  378. const int upload_w = (tex->Status == ImTextureStatus_WantCreate) ? tex->Width : tex->UpdateRect.w;
  379. const int upload_h = (tex->Status == ImTextureStatus_WantCreate) ? tex->Height : tex->UpdateRect.h;
  380. // Update full texture or selected blocks. We only ever write to textures regions which have never been used before!
  381. // This backend choose to use tex->UpdateRect but you can use tex->Updates[] to upload individual regions.
  382. UINT upload_pitch_src = upload_w * tex->BytesPerPixel;
  383. UINT upload_pitch_dst = (upload_pitch_src + D3D12_TEXTURE_DATA_PITCH_ALIGNMENT - 1u) & ~(D3D12_TEXTURE_DATA_PITCH_ALIGNMENT - 1u);
  384. UINT upload_size = upload_pitch_dst * upload_h;
  385. D3D12_RESOURCE_DESC desc;
  386. ZeroMemory(&desc, sizeof(desc));
  387. desc.Dimension = D3D12_RESOURCE_DIMENSION_BUFFER;
  388. desc.Alignment = 0;
  389. desc.Width = upload_size;
  390. desc.Height = 1;
  391. desc.DepthOrArraySize = 1;
  392. desc.MipLevels = 1;
  393. desc.Format = DXGI_FORMAT_UNKNOWN;
  394. desc.SampleDesc.Count = 1;
  395. desc.SampleDesc.Quality = 0;
  396. desc.Layout = D3D12_TEXTURE_LAYOUT_ROW_MAJOR;
  397. desc.Flags = D3D12_RESOURCE_FLAG_NONE;
  398. D3D12_HEAP_PROPERTIES props;
  399. memset(&props, 0, sizeof(D3D12_HEAP_PROPERTIES));
  400. props.Type = D3D12_HEAP_TYPE_UPLOAD;
  401. props.CPUPageProperty = D3D12_CPU_PAGE_PROPERTY_UNKNOWN;
  402. props.MemoryPoolPreference = D3D12_MEMORY_POOL_UNKNOWN;
  403. // FIXME-OPT: Can upload buffer be reused?
  404. ID3D12Resource* uploadBuffer = nullptr;
  405. HRESULT hr = bd->pd3dDevice->CreateCommittedResource(&props, D3D12_HEAP_FLAG_NONE, &desc,
  406. D3D12_RESOURCE_STATE_GENERIC_READ, nullptr, IID_PPV_ARGS(&uploadBuffer));
  407. IM_ASSERT(SUCCEEDED(hr));
  408. // Create temporary command list and execute immediately
  409. ID3D12Fence* fence = nullptr;
  410. hr = bd->pd3dDevice->CreateFence(0, D3D12_FENCE_FLAG_NONE, IID_PPV_ARGS(&fence));
  411. IM_ASSERT(SUCCEEDED(hr));
  412. HANDLE event = ::CreateEvent(0, 0, 0, 0);
  413. IM_ASSERT(event != nullptr);
  414. // FIXME-OPT: Create once and reuse?
  415. ID3D12CommandAllocator* cmdAlloc = nullptr;
  416. hr = bd->pd3dDevice->CreateCommandAllocator(D3D12_COMMAND_LIST_TYPE_DIRECT, IID_PPV_ARGS(&cmdAlloc));
  417. IM_ASSERT(SUCCEEDED(hr));
  418. // FIXME-OPT: Can be use the one from user? (pass ID3D12GraphicsCommandList* to ImGui_ImplDX12_UpdateTextures)
  419. ID3D12GraphicsCommandList* cmdList = nullptr;
  420. hr = bd->pd3dDevice->CreateCommandList(0, D3D12_COMMAND_LIST_TYPE_DIRECT, cmdAlloc, nullptr, IID_PPV_ARGS(&cmdList));
  421. IM_ASSERT(SUCCEEDED(hr));
  422. // Copy to upload buffer
  423. void* mapped = nullptr;
  424. D3D12_RANGE range = { 0, upload_size };
  425. hr = uploadBuffer->Map(0, &range, &mapped);
  426. IM_ASSERT(SUCCEEDED(hr));
  427. for (int y = 0; y < upload_h; y++)
  428. memcpy((void*)((uintptr_t)mapped + y * upload_pitch_dst), tex->GetPixelsAt(upload_x, upload_y + y), upload_pitch_src);
  429. uploadBuffer->Unmap(0, &range);
  430. if (need_barrier_before_copy)
  431. {
  432. D3D12_RESOURCE_BARRIER barrier = {};
  433. barrier.Type = D3D12_RESOURCE_BARRIER_TYPE_TRANSITION;
  434. barrier.Flags = D3D12_RESOURCE_BARRIER_FLAG_NONE;
  435. barrier.Transition.pResource = backend_tex->pTextureResource;
  436. barrier.Transition.Subresource = D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES;
  437. barrier.Transition.StateBefore = D3D12_RESOURCE_STATE_PIXEL_SHADER_RESOURCE;
  438. barrier.Transition.StateAfter = D3D12_RESOURCE_STATE_COPY_DEST;
  439. cmdList->ResourceBarrier(1, &barrier);
  440. }
  441. D3D12_TEXTURE_COPY_LOCATION srcLocation = {};
  442. D3D12_TEXTURE_COPY_LOCATION dstLocation = {};
  443. {
  444. srcLocation.pResource = uploadBuffer;
  445. srcLocation.Type = D3D12_TEXTURE_COPY_TYPE_PLACED_FOOTPRINT;
  446. srcLocation.PlacedFootprint.Footprint.Format = DXGI_FORMAT_R8G8B8A8_UNORM;
  447. srcLocation.PlacedFootprint.Footprint.Width = upload_w;
  448. srcLocation.PlacedFootprint.Footprint.Height = upload_h;
  449. srcLocation.PlacedFootprint.Footprint.Depth = 1;
  450. srcLocation.PlacedFootprint.Footprint.RowPitch = upload_pitch_dst;
  451. dstLocation.pResource = backend_tex->pTextureResource;
  452. dstLocation.Type = D3D12_TEXTURE_COPY_TYPE_SUBRESOURCE_INDEX;
  453. dstLocation.SubresourceIndex = 0;
  454. }
  455. cmdList->CopyTextureRegion(&dstLocation, upload_x, upload_y, 0, &srcLocation, nullptr);
  456. {
  457. D3D12_RESOURCE_BARRIER barrier = {};
  458. barrier.Type = D3D12_RESOURCE_BARRIER_TYPE_TRANSITION;
  459. barrier.Flags = D3D12_RESOURCE_BARRIER_FLAG_NONE;
  460. barrier.Transition.pResource = backend_tex->pTextureResource;
  461. barrier.Transition.Subresource = D3D12_RESOURCE_BARRIER_ALL_SUBRESOURCES;
  462. barrier.Transition.StateBefore = D3D12_RESOURCE_STATE_COPY_DEST;
  463. barrier.Transition.StateAfter = D3D12_RESOURCE_STATE_PIXEL_SHADER_RESOURCE;
  464. cmdList->ResourceBarrier(1, &barrier);
  465. }
  466. hr = cmdList->Close();
  467. IM_ASSERT(SUCCEEDED(hr));
  468. ID3D12CommandQueue* cmdQueue = bd->pCommandQueue;
  469. cmdQueue->ExecuteCommandLists(1, (ID3D12CommandList* const*)&cmdList);
  470. hr = cmdQueue->Signal(fence, 1);
  471. IM_ASSERT(SUCCEEDED(hr));
  472. // FIXME-OPT: Suboptimal?
  473. // - To remove this may need to create NumFramesInFlight x ImGui_ImplDX12_FrameContext in backend data (mimick docking version)
  474. // - Store per-frame in flight: upload buffer?
  475. // - Where do cmdList and cmdAlloc fit?
  476. fence->SetEventOnCompletion(1, event);
  477. ::WaitForSingleObject(event, INFINITE);
  478. cmdList->Release();
  479. cmdAlloc->Release();
  480. ::CloseHandle(event);
  481. fence->Release();
  482. uploadBuffer->Release();
  483. tex->SetStatus(ImTextureStatus_OK);
  484. }
  485. if (tex->Status == ImTextureStatus_WantDestroy && tex->UnusedFrames >= (int)bd->numFramesInFlight)
  486. ImGui_ImplDX12_DestroyTexture(tex);
  487. }
  488. bool ImGui_ImplDX12_CreateDeviceObjects()
  489. {
  490. ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
  491. if (!bd || !bd->pd3dDevice)
  492. return false;
  493. if (bd->pPipelineState)
  494. ImGui_ImplDX12_InvalidateDeviceObjects();
  495. // Create the root signature
  496. {
  497. D3D12_DESCRIPTOR_RANGE descRange = {};
  498. descRange.RangeType = D3D12_DESCRIPTOR_RANGE_TYPE_SRV;
  499. descRange.NumDescriptors = 1;
  500. descRange.BaseShaderRegister = 0;
  501. descRange.RegisterSpace = 0;
  502. descRange.OffsetInDescriptorsFromTableStart = 0;
  503. D3D12_ROOT_PARAMETER param[2] = {};
  504. param[0].ParameterType = D3D12_ROOT_PARAMETER_TYPE_32BIT_CONSTANTS;
  505. param[0].Constants.ShaderRegister = 0;
  506. param[0].Constants.RegisterSpace = 0;
  507. param[0].Constants.Num32BitValues = 16;
  508. param[0].ShaderVisibility = D3D12_SHADER_VISIBILITY_VERTEX;
  509. param[1].ParameterType = D3D12_ROOT_PARAMETER_TYPE_DESCRIPTOR_TABLE;
  510. param[1].DescriptorTable.NumDescriptorRanges = 1;
  511. param[1].DescriptorTable.pDescriptorRanges = &descRange;
  512. param[1].ShaderVisibility = D3D12_SHADER_VISIBILITY_PIXEL;
  513. // Bilinear sampling is required by default. Set 'io.Fonts->Flags |= ImFontAtlasFlags_NoBakedLines' or 'style.AntiAliasedLinesUseTex = false' to allow point/nearest sampling.
  514. D3D12_STATIC_SAMPLER_DESC staticSampler = {};
  515. staticSampler.Filter = D3D12_FILTER_MIN_MAG_MIP_LINEAR;
  516. staticSampler.AddressU = D3D12_TEXTURE_ADDRESS_MODE_CLAMP;
  517. staticSampler.AddressV = D3D12_TEXTURE_ADDRESS_MODE_CLAMP;
  518. staticSampler.AddressW = D3D12_TEXTURE_ADDRESS_MODE_CLAMP;
  519. staticSampler.MipLODBias = 0.f;
  520. staticSampler.MaxAnisotropy = 0;
  521. staticSampler.ComparisonFunc = D3D12_COMPARISON_FUNC_ALWAYS;
  522. staticSampler.BorderColor = D3D12_STATIC_BORDER_COLOR_TRANSPARENT_BLACK;
  523. staticSampler.MinLOD = 0.f;
  524. staticSampler.MaxLOD = D3D12_FLOAT32_MAX;
  525. staticSampler.ShaderRegister = 0;
  526. staticSampler.RegisterSpace = 0;
  527. staticSampler.ShaderVisibility = D3D12_SHADER_VISIBILITY_PIXEL;
  528. D3D12_ROOT_SIGNATURE_DESC desc = {};
  529. desc.NumParameters = _countof(param);
  530. desc.pParameters = param;
  531. desc.NumStaticSamplers = 1;
  532. desc.pStaticSamplers = &staticSampler;
  533. desc.Flags =
  534. D3D12_ROOT_SIGNATURE_FLAG_ALLOW_INPUT_ASSEMBLER_INPUT_LAYOUT |
  535. D3D12_ROOT_SIGNATURE_FLAG_DENY_HULL_SHADER_ROOT_ACCESS |
  536. D3D12_ROOT_SIGNATURE_FLAG_DENY_DOMAIN_SHADER_ROOT_ACCESS |
  537. D3D12_ROOT_SIGNATURE_FLAG_DENY_GEOMETRY_SHADER_ROOT_ACCESS;
  538. // Load d3d12.dll and D3D12SerializeRootSignature() function address dynamically to facilitate using with D3D12On7.
  539. // See if any version of d3d12.dll is already loaded in the process. If so, give preference to that.
  540. static HINSTANCE d3d12_dll = ::GetModuleHandleA("d3d12.dll");
  541. if (d3d12_dll == nullptr)
  542. {
  543. // Attempt to load d3d12.dll from local directories. This will only succeed if
  544. // (1) the current OS is Windows 7, and
  545. // (2) there exists a version of d3d12.dll for Windows 7 (D3D12On7) in one of the following directories.
  546. // See https://github.com/ocornut/imgui/pull/3696 for details.
  547. const char* localD3d12Paths[] = { ".\\d3d12.dll", ".\\d3d12on7\\d3d12.dll", ".\\12on7\\d3d12.dll" }; // A. current directory, B. used by some games, C. used in Microsoft D3D12On7 sample
  548. for (int i = 0; i < IM_ARRAYSIZE(localD3d12Paths); i++)
  549. if ((d3d12_dll = ::LoadLibraryA(localD3d12Paths[i])) != nullptr)
  550. break;
  551. // If failed, we are on Windows >= 10.
  552. if (d3d12_dll == nullptr)
  553. d3d12_dll = ::LoadLibraryA("d3d12.dll");
  554. if (d3d12_dll == nullptr)
  555. return false;
  556. }
  557. _PFN_D3D12_SERIALIZE_ROOT_SIGNATURE D3D12SerializeRootSignatureFn = (_PFN_D3D12_SERIALIZE_ROOT_SIGNATURE)(void*)::GetProcAddress(d3d12_dll, "D3D12SerializeRootSignature");
  558. if (D3D12SerializeRootSignatureFn == nullptr)
  559. return false;
  560. ID3DBlob* blob = nullptr;
  561. if (D3D12SerializeRootSignatureFn(&desc, D3D_ROOT_SIGNATURE_VERSION_1, &blob, nullptr) != S_OK)
  562. return false;
  563. bd->pd3dDevice->CreateRootSignature(0, blob->GetBufferPointer(), blob->GetBufferSize(), IID_PPV_ARGS(&bd->pRootSignature));
  564. blob->Release();
  565. }
  566. // By using D3DCompile() from <d3dcompiler.h> / d3dcompiler.lib, we introduce a dependency to a given version of d3dcompiler_XX.dll (see D3DCOMPILER_DLL_A)
  567. // If you would like to use this DX12 sample code but remove this dependency you can:
  568. // 1) compile once, save the compiled shader blobs into a file or source code and assign them to psoDesc.VS/PS [preferred solution]
  569. // 2) use code to detect any version of the DLL and grab a pointer to D3DCompile from the DLL.
  570. // See https://github.com/ocornut/imgui/pull/638 for sources and details.
  571. D3D12_GRAPHICS_PIPELINE_STATE_DESC psoDesc = {};
  572. psoDesc.NodeMask = 1;
  573. psoDesc.PrimitiveTopologyType = D3D12_PRIMITIVE_TOPOLOGY_TYPE_TRIANGLE;
  574. psoDesc.pRootSignature = bd->pRootSignature;
  575. psoDesc.SampleMask = UINT_MAX;
  576. psoDesc.NumRenderTargets = 1;
  577. psoDesc.RTVFormats[0] = bd->RTVFormat;
  578. psoDesc.DSVFormat = bd->DSVFormat;
  579. psoDesc.SampleDesc.Count = 1;
  580. psoDesc.Flags = D3D12_PIPELINE_STATE_FLAG_NONE;
  581. ID3DBlob* vertexShaderBlob;
  582. ID3DBlob* pixelShaderBlob;
  583. // Create the vertex shader
  584. {
  585. static const char* vertexShader =
  586. "cbuffer vertexBuffer : register(b0) \
  587. {\
  588. float4x4 ProjectionMatrix; \
  589. };\
  590. struct VS_INPUT\
  591. {\
  592. float2 pos : POSITION;\
  593. float4 col : COLOR0;\
  594. float2 uv : TEXCOORD0;\
  595. };\
  596. \
  597. struct PS_INPUT\
  598. {\
  599. float4 pos : SV_POSITION;\
  600. float4 col : COLOR0;\
  601. float2 uv : TEXCOORD0;\
  602. };\
  603. \
  604. PS_INPUT main(VS_INPUT input)\
  605. {\
  606. PS_INPUT output;\
  607. output.pos = mul( ProjectionMatrix, float4(input.pos.xy, 0.f, 1.f));\
  608. output.col = input.col;\
  609. output.uv = input.uv;\
  610. return output;\
  611. }";
  612. if (FAILED(D3DCompile(vertexShader, strlen(vertexShader), nullptr, nullptr, nullptr, "main", "vs_5_0", 0, 0, &vertexShaderBlob, nullptr)))
  613. return false; // NB: Pass ID3DBlob* pErrorBlob to D3DCompile() to get error showing in (const char*)pErrorBlob->GetBufferPointer(). Make sure to Release() the blob!
  614. psoDesc.VS = { vertexShaderBlob->GetBufferPointer(), vertexShaderBlob->GetBufferSize() };
  615. // Create the input layout
  616. static D3D12_INPUT_ELEMENT_DESC local_layout[] =
  617. {
  618. { "POSITION", 0, DXGI_FORMAT_R32G32_FLOAT, 0, (UINT)offsetof(ImDrawVert, pos), D3D12_INPUT_CLASSIFICATION_PER_VERTEX_DATA, 0 },
  619. { "TEXCOORD", 0, DXGI_FORMAT_R32G32_FLOAT, 0, (UINT)offsetof(ImDrawVert, uv), D3D12_INPUT_CLASSIFICATION_PER_VERTEX_DATA, 0 },
  620. { "COLOR", 0, DXGI_FORMAT_R8G8B8A8_UNORM, 0, (UINT)offsetof(ImDrawVert, col), D3D12_INPUT_CLASSIFICATION_PER_VERTEX_DATA, 0 },
  621. };
  622. psoDesc.InputLayout = { local_layout, 3 };
  623. }
  624. // Create the pixel shader
  625. {
  626. static const char* pixelShader =
  627. "struct PS_INPUT\
  628. {\
  629. float4 pos : SV_POSITION;\
  630. float4 col : COLOR0;\
  631. float2 uv : TEXCOORD0;\
  632. };\
  633. SamplerState sampler0 : register(s0);\
  634. Texture2D texture0 : register(t0);\
  635. \
  636. float4 main(PS_INPUT input) : SV_Target\
  637. {\
  638. float4 out_col = input.col * texture0.Sample(sampler0, input.uv); \
  639. return out_col; \
  640. }";
  641. if (FAILED(D3DCompile(pixelShader, strlen(pixelShader), nullptr, nullptr, nullptr, "main", "ps_5_0", 0, 0, &pixelShaderBlob, nullptr)))
  642. {
  643. vertexShaderBlob->Release();
  644. return false; // NB: Pass ID3DBlob* pErrorBlob to D3DCompile() to get error showing in (const char*)pErrorBlob->GetBufferPointer(). Make sure to Release() the blob!
  645. }
  646. psoDesc.PS = { pixelShaderBlob->GetBufferPointer(), pixelShaderBlob->GetBufferSize() };
  647. }
  648. // Create the blending setup
  649. {
  650. D3D12_BLEND_DESC& desc = psoDesc.BlendState;
  651. desc.AlphaToCoverageEnable = false;
  652. desc.RenderTarget[0].BlendEnable = true;
  653. desc.RenderTarget[0].SrcBlend = D3D12_BLEND_SRC_ALPHA;
  654. desc.RenderTarget[0].DestBlend = D3D12_BLEND_INV_SRC_ALPHA;
  655. desc.RenderTarget[0].BlendOp = D3D12_BLEND_OP_ADD;
  656. desc.RenderTarget[0].SrcBlendAlpha = D3D12_BLEND_ONE;
  657. desc.RenderTarget[0].DestBlendAlpha = D3D12_BLEND_INV_SRC_ALPHA;
  658. desc.RenderTarget[0].BlendOpAlpha = D3D12_BLEND_OP_ADD;
  659. desc.RenderTarget[0].RenderTargetWriteMask = D3D12_COLOR_WRITE_ENABLE_ALL;
  660. }
  661. // Create the rasterizer state
  662. {
  663. D3D12_RASTERIZER_DESC& desc = psoDesc.RasterizerState;
  664. desc.FillMode = D3D12_FILL_MODE_SOLID;
  665. desc.CullMode = D3D12_CULL_MODE_NONE;
  666. desc.FrontCounterClockwise = FALSE;
  667. desc.DepthBias = D3D12_DEFAULT_DEPTH_BIAS;
  668. desc.DepthBiasClamp = D3D12_DEFAULT_DEPTH_BIAS_CLAMP;
  669. desc.SlopeScaledDepthBias = D3D12_DEFAULT_SLOPE_SCALED_DEPTH_BIAS;
  670. desc.DepthClipEnable = true;
  671. desc.MultisampleEnable = FALSE;
  672. desc.AntialiasedLineEnable = FALSE;
  673. desc.ForcedSampleCount = 0;
  674. desc.ConservativeRaster = D3D12_CONSERVATIVE_RASTERIZATION_MODE_OFF;
  675. }
  676. // Create depth-stencil State
  677. {
  678. D3D12_DEPTH_STENCIL_DESC& desc = psoDesc.DepthStencilState;
  679. desc.DepthEnable = false;
  680. desc.DepthWriteMask = D3D12_DEPTH_WRITE_MASK_ALL;
  681. desc.DepthFunc = D3D12_COMPARISON_FUNC_ALWAYS;
  682. desc.StencilEnable = false;
  683. desc.FrontFace.StencilFailOp = desc.FrontFace.StencilDepthFailOp = desc.FrontFace.StencilPassOp = D3D12_STENCIL_OP_KEEP;
  684. desc.FrontFace.StencilFunc = D3D12_COMPARISON_FUNC_ALWAYS;
  685. desc.BackFace = desc.FrontFace;
  686. }
  687. HRESULT result_pipeline_state = bd->pd3dDevice->CreateGraphicsPipelineState(&psoDesc, IID_PPV_ARGS(&bd->pPipelineState));
  688. vertexShaderBlob->Release();
  689. pixelShaderBlob->Release();
  690. if (result_pipeline_state != S_OK)
  691. return false;
  692. return true;
  693. }
  694. void ImGui_ImplDX12_InvalidateDeviceObjects()
  695. {
  696. ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
  697. if (!bd || !bd->pd3dDevice)
  698. return;
  699. if (bd->commandQueueOwned)
  700. SafeRelease(bd->pCommandQueue);
  701. bd->commandQueueOwned = false;
  702. SafeRelease(bd->pRootSignature);
  703. SafeRelease(bd->pPipelineState);
  704. // Destroy all textures
  705. for (ImTextureData* tex : ImGui::GetPlatformIO().Textures)
  706. if (tex->RefCount == 1)
  707. ImGui_ImplDX12_DestroyTexture(tex);
  708. for (UINT i = 0; i < bd->numFramesInFlight; i++)
  709. {
  710. ImGui_ImplDX12_RenderBuffers* fr = &bd->pFrameResources[i];
  711. SafeRelease(fr->IndexBuffer);
  712. SafeRelease(fr->VertexBuffer);
  713. }
  714. }
  715. #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
  716. static void ImGui_ImplDX12_InitLegacySingleDescriptorMode(ImGui_ImplDX12_InitInfo* init_info)
  717. {
  718. // Wrap legacy behavior of passing space for a single descriptor
  719. IM_ASSERT(init_info->LegacySingleSrvCpuDescriptor.ptr != 0 && init_info->LegacySingleSrvGpuDescriptor.ptr != 0);
  720. init_info->SrvDescriptorAllocFn = [](ImGui_ImplDX12_InitInfo*, D3D12_CPU_DESCRIPTOR_HANDLE* out_cpu_handle, D3D12_GPU_DESCRIPTOR_HANDLE* out_gpu_handle)
  721. {
  722. ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
  723. IM_ASSERT(bd->LegacySingleDescriptorUsed == false && "Only 1 simultaneous texture allowed with legacy ImGui_ImplDX12_Init() signature!");
  724. *out_cpu_handle = bd->InitInfo.LegacySingleSrvCpuDescriptor;
  725. *out_gpu_handle = bd->InitInfo.LegacySingleSrvGpuDescriptor;
  726. bd->LegacySingleDescriptorUsed = true;
  727. };
  728. init_info->SrvDescriptorFreeFn = [](ImGui_ImplDX12_InitInfo*, D3D12_CPU_DESCRIPTOR_HANDLE, D3D12_GPU_DESCRIPTOR_HANDLE)
  729. {
  730. ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
  731. IM_ASSERT(bd->LegacySingleDescriptorUsed == true);
  732. bd->LegacySingleDescriptorUsed = false;
  733. };
  734. }
  735. #endif
  736. bool ImGui_ImplDX12_Init(ImGui_ImplDX12_InitInfo* init_info)
  737. {
  738. ImGuiIO& io = ImGui::GetIO();
  739. IMGUI_CHECKVERSION();
  740. IM_ASSERT(io.BackendRendererUserData == nullptr && "Already initialized a renderer backend!");
  741. // Setup backend capabilities flags
  742. ImGui_ImplDX12_Data* bd = IM_NEW(ImGui_ImplDX12_Data)();
  743. bd->InitInfo = *init_info; // Deep copy
  744. init_info = &bd->InitInfo;
  745. bd->pd3dDevice = init_info->Device;
  746. IM_ASSERT(init_info->CommandQueue != NULL);
  747. bd->pCommandQueue = init_info->CommandQueue;
  748. bd->RTVFormat = init_info->RTVFormat;
  749. bd->DSVFormat = init_info->DSVFormat;
  750. bd->numFramesInFlight = init_info->NumFramesInFlight;
  751. bd->pd3dSrvDescHeap = init_info->SrvDescriptorHeap;
  752. io.BackendRendererUserData = (void*)bd;
  753. io.BackendRendererName = "imgui_impl_dx12";
  754. io.BackendFlags |= ImGuiBackendFlags_RendererHasVtxOffset; // We can honor the ImDrawCmd::VtxOffset field, allowing for large meshes.
  755. io.BackendFlags |= ImGuiBackendFlags_RendererHasTextures; // We can honor ImGuiPlatformIO::Textures[] requests during render.
  756. #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
  757. if (init_info->SrvDescriptorAllocFn == nullptr)
  758. ImGui_ImplDX12_InitLegacySingleDescriptorMode(init_info);
  759. #endif
  760. IM_ASSERT(init_info->SrvDescriptorAllocFn != nullptr && init_info->SrvDescriptorFreeFn != nullptr);
  761. // Create buffers with a default size (they will later be grown as needed)
  762. bd->frameIndex = UINT_MAX;
  763. bd->pFrameResources = new ImGui_ImplDX12_RenderBuffers[bd->numFramesInFlight];
  764. for (int i = 0; i < (int)bd->numFramesInFlight; i++)
  765. {
  766. ImGui_ImplDX12_RenderBuffers* fr = &bd->pFrameResources[i];
  767. fr->IndexBuffer = nullptr;
  768. fr->VertexBuffer = nullptr;
  769. fr->IndexBufferSize = 10000;
  770. fr->VertexBufferSize = 5000;
  771. }
  772. return true;
  773. }
  774. #ifndef IMGUI_DISABLE_OBSOLETE_FUNCTIONS
  775. // Legacy initialization API Obsoleted in 1.91.5
  776. // 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, they must be in 'srv_descriptor_heap'
  777. bool ImGui_ImplDX12_Init(ID3D12Device* device, int num_frames_in_flight, DXGI_FORMAT rtv_format, ID3D12DescriptorHeap* srv_descriptor_heap, D3D12_CPU_DESCRIPTOR_HANDLE font_srv_cpu_desc_handle, D3D12_GPU_DESCRIPTOR_HANDLE font_srv_gpu_desc_handle)
  778. {
  779. ImGui_ImplDX12_InitInfo init_info;
  780. init_info.Device = device;
  781. init_info.NumFramesInFlight = num_frames_in_flight;
  782. init_info.RTVFormat = rtv_format;
  783. init_info.SrvDescriptorHeap = srv_descriptor_heap;
  784. init_info.LegacySingleSrvCpuDescriptor = font_srv_cpu_desc_handle;
  785. init_info.LegacySingleSrvGpuDescriptor = font_srv_gpu_desc_handle;
  786. D3D12_COMMAND_QUEUE_DESC queueDesc = {};
  787. queueDesc.Type = D3D12_COMMAND_LIST_TYPE_DIRECT;
  788. queueDesc.Flags = D3D12_COMMAND_QUEUE_FLAG_NONE;
  789. queueDesc.NodeMask = 1;
  790. HRESULT hr = device->CreateCommandQueue(&queueDesc, IID_PPV_ARGS(&init_info.CommandQueue));
  791. IM_ASSERT(SUCCEEDED(hr));
  792. bool ret = ImGui_ImplDX12_Init(&init_info);
  793. ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
  794. bd->commandQueueOwned = true;
  795. ImGuiIO& io = ImGui::GetIO();
  796. io.BackendFlags &= ~ImGuiBackendFlags_RendererHasTextures; // Using legacy ImGui_ImplDX12_Init() call with 1 SRV descriptor we cannot support multiple textures.
  797. return ret;
  798. }
  799. #endif
  800. void ImGui_ImplDX12_Shutdown()
  801. {
  802. ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
  803. IM_ASSERT(bd != nullptr && "No renderer backend to shutdown, or already shutdown?");
  804. ImGuiIO& io = ImGui::GetIO();
  805. // Clean up windows and device objects
  806. ImGui_ImplDX12_InvalidateDeviceObjects();
  807. delete[] bd->pFrameResources;
  808. io.BackendRendererName = nullptr;
  809. io.BackendRendererUserData = nullptr;
  810. io.BackendFlags &= ~(ImGuiBackendFlags_RendererHasVtxOffset | ImGuiBackendFlags_RendererHasTextures);
  811. IM_DELETE(bd);
  812. }
  813. void ImGui_ImplDX12_NewFrame()
  814. {
  815. ImGui_ImplDX12_Data* bd = ImGui_ImplDX12_GetBackendData();
  816. IM_ASSERT(bd != nullptr && "Context or backend not initialized! Did you call ImGui_ImplDX12_Init()?");
  817. if (!bd->pPipelineState)
  818. if (!ImGui_ImplDX12_CreateDeviceObjects())
  819. IM_ASSERT(0 && "ImGui_ImplDX12_CreateDeviceObjects() failed!");
  820. }
  821. //-----------------------------------------------------------------------------
  822. #endif // #ifndef IMGUI_DISABLE