imgui_impl_dx11.cpp 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764
  1. // dear imgui: Renderer Backend for DirectX11
  2. // This needs to be used along with a Platform Backend (e.g. Win32)
  3. // Implemented features:
  4. // [X] Renderer: User texture binding. Use 'ID3D11ShaderResourceView*' as ImTextureID. Read the FAQ about ImTextureID!
  5. // [X] Renderer: Large meshes support (64k+ vertices) even with 16-bit indices (ImGuiBackendFlags_RendererHasVtxOffset).
  6. // [X] Renderer: Expose selected render state for draw callbacks to use. Access in '(ImGui_ImplXXXX_RenderState*)GetPlatformIO().Renderer_RenderState'.
  7. // [X] Renderer: Multi-viewport support (multiple windows). Enable with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
  8. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
  9. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
  10. // Learn about Dear ImGui:
  11. // - FAQ https://dearimgui.com/faq
  12. // - Getting Started https://dearimgui.com/getting-started
  13. // - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
  14. // - Introduction, links and more at the top of imgui.cpp
  15. // CHANGELOG
  16. // (minor and older changes stripped away, please see git history for details)
  17. // 2025-XX-XX: Platform: Added support for multiple windows via the ImGuiPlatformIO interface.
  18. // 2025-01-06: DirectX11: Expose VertexConstantBuffer in ImGui_ImplDX11_RenderState. Reset projection matrix in ImDrawCallback_ResetRenderState handler.
  19. // 2024-10-07: DirectX11: Changed default texture sampler to Clamp instead of Repeat/Wrap.
  20. // 2024-10-07: DirectX11: Expose selected render state in ImGui_ImplDX11_RenderState, which you can access in 'void* platform_io.Renderer_RenderState' during draw callbacks.
  21. // 2022-10-11: Using 'nullptr' instead of 'NULL' as per our switch to C++11.
  22. // 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).
  23. // 2021-05-19: DirectX11: Replaced direct access to ImDrawCmd::TextureId with a call to ImDrawCmd::GetTexID(). (will become a requirement)
  24. // 2021-02-18: DirectX11: Change blending equation to preserve alpha in output buffer.
  25. // 2019-08-01: DirectX11: Fixed code querying the Geometry Shader state (would generally error with Debug layer enabled).
  26. // 2019-07-21: DirectX11: Backup, clear and restore Geometry Shader is any is bound when calling ImGui_ImplDX11_RenderDrawData. Clearing Hull/Domain/Compute shaders without backup/restore.
  27. // 2019-05-29: DirectX11: Added support for large mesh (64K+ vertices), enable ImGuiBackendFlags_RendererHasVtxOffset flag.
  28. // 2019-04-30: DirectX11: Added support for special ImDrawCallback_ResetRenderState callback to reset render state.
  29. // 2018-12-03: Misc: Added #pragma comment statement to automatically link with d3dcompiler.lib when using D3DCompile().
  30. // 2018-11-30: Misc: Setting up io.BackendRendererName so it can be displayed in the About Window.
  31. // 2018-08-01: DirectX11: Querying for IDXGIFactory instead of IDXGIFactory1 to increase compatibility.
  32. // 2018-07-13: DirectX11: Fixed unreleased resources in Init and Shutdown functions.
  33. // 2018-06-08: Misc: Extracted imgui_impl_dx11.cpp/.h away from the old combined DX11+Win32 example.
  34. // 2018-06-08: DirectX11: Use draw_data->DisplayPos and draw_data->DisplaySize to setup projection matrix and clipping rectangle.
  35. // 2018-02-16: Misc: Obsoleted the io.RenderDrawListsFn callback and exposed ImGui_ImplDX11_RenderDrawData() in the .h file so you can call it yourself.
  36. // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
  37. // 2016-05-07: DirectX11: Disabling depth-write.
  38. #include "imgui.h"
  39. #ifndef IMGUI_DISABLE
  40. #include "imgui_impl_dx11.h"
  41. // DirectX
  42. #include <stdio.h>
  43. #include <d3d11.h>
  44. #include <d3dcompiler.h>
  45. #ifdef _MSC_VER
  46. #pragma comment(lib, "d3dcompiler") // Automatically link with d3dcompiler.lib as we are using D3DCompile() below.
  47. #endif
  48. // DirectX11 data
  49. struct ImGui_ImplDX11_Data
  50. {
  51. ID3D11Device* pd3dDevice;
  52. ID3D11DeviceContext* pd3dDeviceContext;
  53. IDXGIFactory* pFactory;
  54. ID3D11Buffer* pVB;
  55. ID3D11Buffer* pIB;
  56. ID3D11VertexShader* pVertexShader;
  57. ID3D11InputLayout* pInputLayout;
  58. ID3D11Buffer* pVertexConstantBuffer;
  59. ID3D11PixelShader* pPixelShader;
  60. ID3D11SamplerState* pFontSampler;
  61. ID3D11ShaderResourceView* pFontTextureView;
  62. ID3D11RasterizerState* pRasterizerState;
  63. ID3D11BlendState* pBlendState;
  64. ID3D11DepthStencilState* pDepthStencilState;
  65. int VertexBufferSize;
  66. int IndexBufferSize;
  67. ImGui_ImplDX11_Data() { memset((void*)this, 0, sizeof(*this)); VertexBufferSize = 5000; IndexBufferSize = 10000; }
  68. };
  69. struct VERTEX_CONSTANT_BUFFER_DX11
  70. {
  71. float mvp[4][4];
  72. };
  73. // Backend data stored in io.BackendRendererUserData to allow support for multiple Dear ImGui contexts
  74. // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
  75. static ImGui_ImplDX11_Data* ImGui_ImplDX11_GetBackendData()
  76. {
  77. return ImGui::GetCurrentContext() ? (ImGui_ImplDX11_Data*)ImGui::GetIO().BackendRendererUserData : nullptr;
  78. }
  79. // Forward Declarations
  80. static void ImGui_ImplDX11_InitMultiViewportSupport();
  81. static void ImGui_ImplDX11_ShutdownMultiViewportSupport();
  82. // Functions
  83. static void ImGui_ImplDX11_SetupRenderState(ImDrawData* draw_data, ID3D11DeviceContext* device_ctx)
  84. {
  85. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  86. // Setup viewport
  87. D3D11_VIEWPORT vp;
  88. memset(&vp, 0, sizeof(D3D11_VIEWPORT));
  89. vp.Width = draw_data->DisplaySize.x;
  90. vp.Height = draw_data->DisplaySize.y;
  91. vp.MinDepth = 0.0f;
  92. vp.MaxDepth = 1.0f;
  93. vp.TopLeftX = vp.TopLeftY = 0;
  94. device_ctx->RSSetViewports(1, &vp);
  95. // Setup orthographic projection matrix into our constant buffer
  96. // Our visible imgui space lies from draw_data->DisplayPos (top left) to draw_data->DisplayPos+data_data->DisplaySize (bottom right). DisplayPos is (0,0) for single viewport apps.
  97. D3D11_MAPPED_SUBRESOURCE mapped_resource;
  98. if (device_ctx->Map(bd->pVertexConstantBuffer, 0, D3D11_MAP_WRITE_DISCARD, 0, &mapped_resource) == S_OK)
  99. {
  100. VERTEX_CONSTANT_BUFFER_DX11* constant_buffer = (VERTEX_CONSTANT_BUFFER_DX11*)mapped_resource.pData;
  101. float L = draw_data->DisplayPos.x;
  102. float R = draw_data->DisplayPos.x + draw_data->DisplaySize.x;
  103. float T = draw_data->DisplayPos.y;
  104. float B = draw_data->DisplayPos.y + draw_data->DisplaySize.y;
  105. float mvp[4][4] =
  106. {
  107. { 2.0f/(R-L), 0.0f, 0.0f, 0.0f },
  108. { 0.0f, 2.0f/(T-B), 0.0f, 0.0f },
  109. { 0.0f, 0.0f, 0.5f, 0.0f },
  110. { (R+L)/(L-R), (T+B)/(B-T), 0.5f, 1.0f },
  111. };
  112. memcpy(&constant_buffer->mvp, mvp, sizeof(mvp));
  113. device_ctx->Unmap(bd->pVertexConstantBuffer, 0);
  114. }
  115. // Setup shader and vertex buffers
  116. unsigned int stride = sizeof(ImDrawVert);
  117. unsigned int offset = 0;
  118. device_ctx->IASetInputLayout(bd->pInputLayout);
  119. device_ctx->IASetVertexBuffers(0, 1, &bd->pVB, &stride, &offset);
  120. device_ctx->IASetIndexBuffer(bd->pIB, sizeof(ImDrawIdx) == 2 ? DXGI_FORMAT_R16_UINT : DXGI_FORMAT_R32_UINT, 0);
  121. device_ctx->IASetPrimitiveTopology(D3D11_PRIMITIVE_TOPOLOGY_TRIANGLELIST);
  122. device_ctx->VSSetShader(bd->pVertexShader, nullptr, 0);
  123. device_ctx->VSSetConstantBuffers(0, 1, &bd->pVertexConstantBuffer);
  124. device_ctx->PSSetShader(bd->pPixelShader, nullptr, 0);
  125. device_ctx->PSSetSamplers(0, 1, &bd->pFontSampler);
  126. device_ctx->GSSetShader(nullptr, nullptr, 0);
  127. device_ctx->HSSetShader(nullptr, nullptr, 0); // In theory we should backup and restore this as well.. very infrequently used..
  128. device_ctx->DSSetShader(nullptr, nullptr, 0); // In theory we should backup and restore this as well.. very infrequently used..
  129. device_ctx->CSSetShader(nullptr, nullptr, 0); // In theory we should backup and restore this as well.. very infrequently used..
  130. // Setup render state
  131. const float blend_factor[4] = { 0.f, 0.f, 0.f, 0.f };
  132. device_ctx->OMSetBlendState(bd->pBlendState, blend_factor, 0xffffffff);
  133. device_ctx->OMSetDepthStencilState(bd->pDepthStencilState, 0);
  134. device_ctx->RSSetState(bd->pRasterizerState);
  135. }
  136. // Render function
  137. void ImGui_ImplDX11_RenderDrawData(ImDrawData* draw_data)
  138. {
  139. // Avoid rendering when minimized
  140. if (draw_data->DisplaySize.x <= 0.0f || draw_data->DisplaySize.y <= 0.0f)
  141. return;
  142. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  143. ID3D11DeviceContext* device = bd->pd3dDeviceContext;
  144. // Create and grow vertex/index buffers if needed
  145. if (!bd->pVB || bd->VertexBufferSize < draw_data->TotalVtxCount)
  146. {
  147. if (bd->pVB) { bd->pVB->Release(); bd->pVB = nullptr; }
  148. bd->VertexBufferSize = draw_data->TotalVtxCount + 5000;
  149. D3D11_BUFFER_DESC desc;
  150. memset(&desc, 0, sizeof(D3D11_BUFFER_DESC));
  151. desc.Usage = D3D11_USAGE_DYNAMIC;
  152. desc.ByteWidth = bd->VertexBufferSize * sizeof(ImDrawVert);
  153. desc.BindFlags = D3D11_BIND_VERTEX_BUFFER;
  154. desc.CPUAccessFlags = D3D11_CPU_ACCESS_WRITE;
  155. desc.MiscFlags = 0;
  156. if (bd->pd3dDevice->CreateBuffer(&desc, nullptr, &bd->pVB) < 0)
  157. return;
  158. }
  159. if (!bd->pIB || bd->IndexBufferSize < draw_data->TotalIdxCount)
  160. {
  161. if (bd->pIB) { bd->pIB->Release(); bd->pIB = nullptr; }
  162. bd->IndexBufferSize = draw_data->TotalIdxCount + 10000;
  163. D3D11_BUFFER_DESC desc;
  164. memset(&desc, 0, sizeof(D3D11_BUFFER_DESC));
  165. desc.Usage = D3D11_USAGE_DYNAMIC;
  166. desc.ByteWidth = bd->IndexBufferSize * sizeof(ImDrawIdx);
  167. desc.BindFlags = D3D11_BIND_INDEX_BUFFER;
  168. desc.CPUAccessFlags = D3D11_CPU_ACCESS_WRITE;
  169. if (bd->pd3dDevice->CreateBuffer(&desc, nullptr, &bd->pIB) < 0)
  170. return;
  171. }
  172. // Upload vertex/index data into a single contiguous GPU buffer
  173. D3D11_MAPPED_SUBRESOURCE vtx_resource, idx_resource;
  174. if (device->Map(bd->pVB, 0, D3D11_MAP_WRITE_DISCARD, 0, &vtx_resource) != S_OK)
  175. return;
  176. if (device->Map(bd->pIB, 0, D3D11_MAP_WRITE_DISCARD, 0, &idx_resource) != S_OK)
  177. return;
  178. ImDrawVert* vtx_dst = (ImDrawVert*)vtx_resource.pData;
  179. ImDrawIdx* idx_dst = (ImDrawIdx*)idx_resource.pData;
  180. for (int n = 0; n < draw_data->CmdListsCount; n++)
  181. {
  182. const ImDrawList* draw_list = draw_data->CmdLists[n];
  183. memcpy(vtx_dst, draw_list->VtxBuffer.Data, draw_list->VtxBuffer.Size * sizeof(ImDrawVert));
  184. memcpy(idx_dst, draw_list->IdxBuffer.Data, draw_list->IdxBuffer.Size * sizeof(ImDrawIdx));
  185. vtx_dst += draw_list->VtxBuffer.Size;
  186. idx_dst += draw_list->IdxBuffer.Size;
  187. }
  188. device->Unmap(bd->pVB, 0);
  189. device->Unmap(bd->pIB, 0);
  190. // Backup DX state that will be modified to restore it afterwards (unfortunately this is very ugly looking and verbose. Close your eyes!)
  191. struct BACKUP_DX11_STATE
  192. {
  193. UINT ScissorRectsCount, ViewportsCount;
  194. D3D11_RECT ScissorRects[D3D11_VIEWPORT_AND_SCISSORRECT_OBJECT_COUNT_PER_PIPELINE];
  195. D3D11_VIEWPORT Viewports[D3D11_VIEWPORT_AND_SCISSORRECT_OBJECT_COUNT_PER_PIPELINE];
  196. ID3D11RasterizerState* RS;
  197. ID3D11BlendState* BlendState;
  198. FLOAT BlendFactor[4];
  199. UINT SampleMask;
  200. UINT StencilRef;
  201. ID3D11DepthStencilState* DepthStencilState;
  202. ID3D11ShaderResourceView* PSShaderResource;
  203. ID3D11SamplerState* PSSampler;
  204. ID3D11PixelShader* PS;
  205. ID3D11VertexShader* VS;
  206. ID3D11GeometryShader* GS;
  207. UINT PSInstancesCount, VSInstancesCount, GSInstancesCount;
  208. ID3D11ClassInstance *PSInstances[256], *VSInstances[256], *GSInstances[256]; // 256 is max according to PSSetShader documentation
  209. D3D11_PRIMITIVE_TOPOLOGY PrimitiveTopology;
  210. ID3D11Buffer* IndexBuffer, *VertexBuffer, *VSConstantBuffer;
  211. UINT IndexBufferOffset, VertexBufferStride, VertexBufferOffset;
  212. DXGI_FORMAT IndexBufferFormat;
  213. ID3D11InputLayout* InputLayout;
  214. };
  215. BACKUP_DX11_STATE old = {};
  216. old.ScissorRectsCount = old.ViewportsCount = D3D11_VIEWPORT_AND_SCISSORRECT_OBJECT_COUNT_PER_PIPELINE;
  217. device->RSGetScissorRects(&old.ScissorRectsCount, old.ScissorRects);
  218. device->RSGetViewports(&old.ViewportsCount, old.Viewports);
  219. device->RSGetState(&old.RS);
  220. device->OMGetBlendState(&old.BlendState, old.BlendFactor, &old.SampleMask);
  221. device->OMGetDepthStencilState(&old.DepthStencilState, &old.StencilRef);
  222. device->PSGetShaderResources(0, 1, &old.PSShaderResource);
  223. device->PSGetSamplers(0, 1, &old.PSSampler);
  224. old.PSInstancesCount = old.VSInstancesCount = old.GSInstancesCount = 256;
  225. device->PSGetShader(&old.PS, old.PSInstances, &old.PSInstancesCount);
  226. device->VSGetShader(&old.VS, old.VSInstances, &old.VSInstancesCount);
  227. device->VSGetConstantBuffers(0, 1, &old.VSConstantBuffer);
  228. device->GSGetShader(&old.GS, old.GSInstances, &old.GSInstancesCount);
  229. device->IAGetPrimitiveTopology(&old.PrimitiveTopology);
  230. device->IAGetIndexBuffer(&old.IndexBuffer, &old.IndexBufferFormat, &old.IndexBufferOffset);
  231. device->IAGetVertexBuffers(0, 1, &old.VertexBuffer, &old.VertexBufferStride, &old.VertexBufferOffset);
  232. device->IAGetInputLayout(&old.InputLayout);
  233. // Setup desired DX state
  234. ImGui_ImplDX11_SetupRenderState(draw_data, device);
  235. // Setup render state structure (for callbacks and custom texture bindings)
  236. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  237. ImGui_ImplDX11_RenderState render_state;
  238. render_state.Device = bd->pd3dDevice;
  239. render_state.DeviceContext = bd->pd3dDeviceContext;
  240. render_state.SamplerDefault = bd->pFontSampler;
  241. render_state.VertexConstantBuffer = bd->pVertexConstantBuffer;
  242. platform_io.Renderer_RenderState = &render_state;
  243. // Render command lists
  244. // (Because we merged all buffers into a single one, we maintain our own offset into them)
  245. int global_idx_offset = 0;
  246. int global_vtx_offset = 0;
  247. ImVec2 clip_off = draw_data->DisplayPos;
  248. for (int n = 0; n < draw_data->CmdListsCount; n++)
  249. {
  250. const ImDrawList* draw_list = draw_data->CmdLists[n];
  251. for (int cmd_i = 0; cmd_i < draw_list->CmdBuffer.Size; cmd_i++)
  252. {
  253. const ImDrawCmd* pcmd = &draw_list->CmdBuffer[cmd_i];
  254. if (pcmd->UserCallback != nullptr)
  255. {
  256. // User callback, registered via ImDrawList::AddCallback()
  257. // (ImDrawCallback_ResetRenderState is a special callback value used by the user to request the renderer to reset render state.)
  258. if (pcmd->UserCallback == ImDrawCallback_ResetRenderState)
  259. ImGui_ImplDX11_SetupRenderState(draw_data, device);
  260. else
  261. pcmd->UserCallback(draw_list, pcmd);
  262. }
  263. else
  264. {
  265. // Project scissor/clipping rectangles into framebuffer space
  266. ImVec2 clip_min(pcmd->ClipRect.x - clip_off.x, pcmd->ClipRect.y - clip_off.y);
  267. ImVec2 clip_max(pcmd->ClipRect.z - clip_off.x, pcmd->ClipRect.w - clip_off.y);
  268. if (clip_max.x <= clip_min.x || clip_max.y <= clip_min.y)
  269. continue;
  270. // Apply scissor/clipping rectangle
  271. const D3D11_RECT r = { (LONG)clip_min.x, (LONG)clip_min.y, (LONG)clip_max.x, (LONG)clip_max.y };
  272. device->RSSetScissorRects(1, &r);
  273. // Bind texture, Draw
  274. ID3D11ShaderResourceView* texture_srv = (ID3D11ShaderResourceView*)pcmd->GetTexID();
  275. device->PSSetShaderResources(0, 1, &texture_srv);
  276. device->DrawIndexed(pcmd->ElemCount, pcmd->IdxOffset + global_idx_offset, pcmd->VtxOffset + global_vtx_offset);
  277. }
  278. }
  279. global_idx_offset += draw_list->IdxBuffer.Size;
  280. global_vtx_offset += draw_list->VtxBuffer.Size;
  281. }
  282. platform_io.Renderer_RenderState = nullptr;
  283. // Restore modified DX state
  284. device->RSSetScissorRects(old.ScissorRectsCount, old.ScissorRects);
  285. device->RSSetViewports(old.ViewportsCount, old.Viewports);
  286. device->RSSetState(old.RS); if (old.RS) old.RS->Release();
  287. device->OMSetBlendState(old.BlendState, old.BlendFactor, old.SampleMask); if (old.BlendState) old.BlendState->Release();
  288. device->OMSetDepthStencilState(old.DepthStencilState, old.StencilRef); if (old.DepthStencilState) old.DepthStencilState->Release();
  289. device->PSSetShaderResources(0, 1, &old.PSShaderResource); if (old.PSShaderResource) old.PSShaderResource->Release();
  290. device->PSSetSamplers(0, 1, &old.PSSampler); if (old.PSSampler) old.PSSampler->Release();
  291. device->PSSetShader(old.PS, old.PSInstances, old.PSInstancesCount); if (old.PS) old.PS->Release();
  292. for (UINT i = 0; i < old.PSInstancesCount; i++) if (old.PSInstances[i]) old.PSInstances[i]->Release();
  293. device->VSSetShader(old.VS, old.VSInstances, old.VSInstancesCount); if (old.VS) old.VS->Release();
  294. device->VSSetConstantBuffers(0, 1, &old.VSConstantBuffer); if (old.VSConstantBuffer) old.VSConstantBuffer->Release();
  295. device->GSSetShader(old.GS, old.GSInstances, old.GSInstancesCount); if (old.GS) old.GS->Release();
  296. for (UINT i = 0; i < old.VSInstancesCount; i++) if (old.VSInstances[i]) old.VSInstances[i]->Release();
  297. device->IASetPrimitiveTopology(old.PrimitiveTopology);
  298. device->IASetIndexBuffer(old.IndexBuffer, old.IndexBufferFormat, old.IndexBufferOffset); if (old.IndexBuffer) old.IndexBuffer->Release();
  299. device->IASetVertexBuffers(0, 1, &old.VertexBuffer, &old.VertexBufferStride, &old.VertexBufferOffset); if (old.VertexBuffer) old.VertexBuffer->Release();
  300. device->IASetInputLayout(old.InputLayout); if (old.InputLayout) old.InputLayout->Release();
  301. }
  302. static void ImGui_ImplDX11_CreateFontsTexture()
  303. {
  304. // Build texture atlas
  305. ImGuiIO& io = ImGui::GetIO();
  306. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  307. unsigned char* pixels;
  308. int width, height;
  309. io.Fonts->GetTexDataAsRGBA32(&pixels, &width, &height);
  310. // Upload texture to graphics system
  311. {
  312. D3D11_TEXTURE2D_DESC desc;
  313. ZeroMemory(&desc, sizeof(desc));
  314. desc.Width = width;
  315. desc.Height = height;
  316. desc.MipLevels = 1;
  317. desc.ArraySize = 1;
  318. desc.Format = DXGI_FORMAT_R8G8B8A8_UNORM;
  319. desc.SampleDesc.Count = 1;
  320. desc.Usage = D3D11_USAGE_DEFAULT;
  321. desc.BindFlags = D3D11_BIND_SHADER_RESOURCE;
  322. desc.CPUAccessFlags = 0;
  323. ID3D11Texture2D* pTexture = nullptr;
  324. D3D11_SUBRESOURCE_DATA subResource;
  325. subResource.pSysMem = pixels;
  326. subResource.SysMemPitch = desc.Width * 4;
  327. subResource.SysMemSlicePitch = 0;
  328. bd->pd3dDevice->CreateTexture2D(&desc, &subResource, &pTexture);
  329. IM_ASSERT(pTexture != nullptr);
  330. // Create texture view
  331. D3D11_SHADER_RESOURCE_VIEW_DESC srvDesc;
  332. ZeroMemory(&srvDesc, sizeof(srvDesc));
  333. srvDesc.Format = DXGI_FORMAT_R8G8B8A8_UNORM;
  334. srvDesc.ViewDimension = D3D11_SRV_DIMENSION_TEXTURE2D;
  335. srvDesc.Texture2D.MipLevels = desc.MipLevels;
  336. srvDesc.Texture2D.MostDetailedMip = 0;
  337. bd->pd3dDevice->CreateShaderResourceView(pTexture, &srvDesc, &bd->pFontTextureView);
  338. pTexture->Release();
  339. }
  340. // Store our identifier
  341. io.Fonts->SetTexID((ImTextureID)bd->pFontTextureView);
  342. }
  343. static void ImGui_ImplDX11_DestroyFontsTexture()
  344. {
  345. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  346. if (bd->pFontTextureView)
  347. {
  348. bd->pFontTextureView->Release();
  349. bd->pFontTextureView = nullptr;
  350. ImGui::GetIO().Fonts->SetTexID(0); // We copied data->pFontTextureView to io.Fonts->TexID so let's clear that as well.
  351. }
  352. }
  353. bool ImGui_ImplDX11_CreateDeviceObjects()
  354. {
  355. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  356. if (!bd->pd3dDevice)
  357. return false;
  358. if (bd->pFontSampler)
  359. ImGui_ImplDX11_InvalidateDeviceObjects();
  360. // By using D3DCompile() from <d3dcompiler.h> / d3dcompiler.lib, we introduce a dependency to a given version of d3dcompiler_XX.dll (see D3DCOMPILER_DLL_A)
  361. // If you would like to use this DX11 sample code but remove this dependency you can:
  362. // 1) compile once, save the compiled shader blobs into a file or source code and pass them to CreateVertexShader()/CreatePixelShader() [preferred solution]
  363. // 2) use code to detect any version of the DLL and grab a pointer to D3DCompile from the DLL.
  364. // See https://github.com/ocornut/imgui/pull/638 for sources and details.
  365. // Create the vertex shader
  366. {
  367. static const char* vertexShader =
  368. "cbuffer vertexBuffer : register(b0) \
  369. {\
  370. float4x4 ProjectionMatrix; \
  371. };\
  372. struct VS_INPUT\
  373. {\
  374. float2 pos : POSITION;\
  375. float4 col : COLOR0;\
  376. float2 uv : TEXCOORD0;\
  377. };\
  378. \
  379. struct PS_INPUT\
  380. {\
  381. float4 pos : SV_POSITION;\
  382. float4 col : COLOR0;\
  383. float2 uv : TEXCOORD0;\
  384. };\
  385. \
  386. PS_INPUT main(VS_INPUT input)\
  387. {\
  388. PS_INPUT output;\
  389. output.pos = mul( ProjectionMatrix, float4(input.pos.xy, 0.f, 1.f));\
  390. output.col = input.col;\
  391. output.uv = input.uv;\
  392. return output;\
  393. }";
  394. ID3DBlob* vertexShaderBlob;
  395. if (FAILED(D3DCompile(vertexShader, strlen(vertexShader), nullptr, nullptr, nullptr, "main", "vs_4_0", 0, 0, &vertexShaderBlob, nullptr)))
  396. return false; // NB: Pass ID3DBlob* pErrorBlob to D3DCompile() to get error showing in (const char*)pErrorBlob->GetBufferPointer(). Make sure to Release() the blob!
  397. if (bd->pd3dDevice->CreateVertexShader(vertexShaderBlob->GetBufferPointer(), vertexShaderBlob->GetBufferSize(), nullptr, &bd->pVertexShader) != S_OK)
  398. {
  399. vertexShaderBlob->Release();
  400. return false;
  401. }
  402. // Create the input layout
  403. D3D11_INPUT_ELEMENT_DESC local_layout[] =
  404. {
  405. { "POSITION", 0, DXGI_FORMAT_R32G32_FLOAT, 0, (UINT)offsetof(ImDrawVert, pos), D3D11_INPUT_PER_VERTEX_DATA, 0 },
  406. { "TEXCOORD", 0, DXGI_FORMAT_R32G32_FLOAT, 0, (UINT)offsetof(ImDrawVert, uv), D3D11_INPUT_PER_VERTEX_DATA, 0 },
  407. { "COLOR", 0, DXGI_FORMAT_R8G8B8A8_UNORM, 0, (UINT)offsetof(ImDrawVert, col), D3D11_INPUT_PER_VERTEX_DATA, 0 },
  408. };
  409. if (bd->pd3dDevice->CreateInputLayout(local_layout, 3, vertexShaderBlob->GetBufferPointer(), vertexShaderBlob->GetBufferSize(), &bd->pInputLayout) != S_OK)
  410. {
  411. vertexShaderBlob->Release();
  412. return false;
  413. }
  414. vertexShaderBlob->Release();
  415. // Create the constant buffer
  416. {
  417. D3D11_BUFFER_DESC desc;
  418. desc.ByteWidth = sizeof(VERTEX_CONSTANT_BUFFER_DX11);
  419. desc.Usage = D3D11_USAGE_DYNAMIC;
  420. desc.BindFlags = D3D11_BIND_CONSTANT_BUFFER;
  421. desc.CPUAccessFlags = D3D11_CPU_ACCESS_WRITE;
  422. desc.MiscFlags = 0;
  423. bd->pd3dDevice->CreateBuffer(&desc, nullptr, &bd->pVertexConstantBuffer);
  424. }
  425. }
  426. // Create the pixel shader
  427. {
  428. static const char* pixelShader =
  429. "struct PS_INPUT\
  430. {\
  431. float4 pos : SV_POSITION;\
  432. float4 col : COLOR0;\
  433. float2 uv : TEXCOORD0;\
  434. };\
  435. sampler sampler0;\
  436. Texture2D texture0;\
  437. \
  438. float4 main(PS_INPUT input) : SV_Target\
  439. {\
  440. float4 out_col = input.col * texture0.Sample(sampler0, input.uv); \
  441. return out_col; \
  442. }";
  443. ID3DBlob* pixelShaderBlob;
  444. if (FAILED(D3DCompile(pixelShader, strlen(pixelShader), nullptr, nullptr, nullptr, "main", "ps_4_0", 0, 0, &pixelShaderBlob, nullptr)))
  445. return false; // NB: Pass ID3DBlob* pErrorBlob to D3DCompile() to get error showing in (const char*)pErrorBlob->GetBufferPointer(). Make sure to Release() the blob!
  446. if (bd->pd3dDevice->CreatePixelShader(pixelShaderBlob->GetBufferPointer(), pixelShaderBlob->GetBufferSize(), nullptr, &bd->pPixelShader) != S_OK)
  447. {
  448. pixelShaderBlob->Release();
  449. return false;
  450. }
  451. pixelShaderBlob->Release();
  452. }
  453. // Create the blending setup
  454. {
  455. D3D11_BLEND_DESC desc;
  456. ZeroMemory(&desc, sizeof(desc));
  457. desc.AlphaToCoverageEnable = false;
  458. desc.RenderTarget[0].BlendEnable = true;
  459. desc.RenderTarget[0].SrcBlend = D3D11_BLEND_SRC_ALPHA;
  460. desc.RenderTarget[0].DestBlend = D3D11_BLEND_INV_SRC_ALPHA;
  461. desc.RenderTarget[0].BlendOp = D3D11_BLEND_OP_ADD;
  462. desc.RenderTarget[0].SrcBlendAlpha = D3D11_BLEND_ONE;
  463. desc.RenderTarget[0].DestBlendAlpha = D3D11_BLEND_INV_SRC_ALPHA;
  464. desc.RenderTarget[0].BlendOpAlpha = D3D11_BLEND_OP_ADD;
  465. desc.RenderTarget[0].RenderTargetWriteMask = D3D11_COLOR_WRITE_ENABLE_ALL;
  466. bd->pd3dDevice->CreateBlendState(&desc, &bd->pBlendState);
  467. }
  468. // Create the rasterizer state
  469. {
  470. D3D11_RASTERIZER_DESC desc;
  471. ZeroMemory(&desc, sizeof(desc));
  472. desc.FillMode = D3D11_FILL_SOLID;
  473. desc.CullMode = D3D11_CULL_NONE;
  474. desc.ScissorEnable = true;
  475. desc.DepthClipEnable = true;
  476. bd->pd3dDevice->CreateRasterizerState(&desc, &bd->pRasterizerState);
  477. }
  478. // Create depth-stencil State
  479. {
  480. D3D11_DEPTH_STENCIL_DESC desc;
  481. ZeroMemory(&desc, sizeof(desc));
  482. desc.DepthEnable = false;
  483. desc.DepthWriteMask = D3D11_DEPTH_WRITE_MASK_ALL;
  484. desc.DepthFunc = D3D11_COMPARISON_ALWAYS;
  485. desc.StencilEnable = false;
  486. desc.FrontFace.StencilFailOp = desc.FrontFace.StencilDepthFailOp = desc.FrontFace.StencilPassOp = D3D11_STENCIL_OP_KEEP;
  487. desc.FrontFace.StencilFunc = D3D11_COMPARISON_ALWAYS;
  488. desc.BackFace = desc.FrontFace;
  489. bd->pd3dDevice->CreateDepthStencilState(&desc, &bd->pDepthStencilState);
  490. }
  491. // Create texture sampler
  492. // (Bilinear sampling is required by default. Set 'io.Fonts->Flags |= ImFontAtlasFlags_NoBakedLines' or 'style.AntiAliasedLinesUseTex = false' to allow point/nearest sampling)
  493. {
  494. D3D11_SAMPLER_DESC desc;
  495. ZeroMemory(&desc, sizeof(desc));
  496. desc.Filter = D3D11_FILTER_MIN_MAG_MIP_LINEAR;
  497. desc.AddressU = D3D11_TEXTURE_ADDRESS_CLAMP;
  498. desc.AddressV = D3D11_TEXTURE_ADDRESS_CLAMP;
  499. desc.AddressW = D3D11_TEXTURE_ADDRESS_CLAMP;
  500. desc.MipLODBias = 0.f;
  501. desc.ComparisonFunc = D3D11_COMPARISON_ALWAYS;
  502. desc.MinLOD = 0.f;
  503. desc.MaxLOD = 0.f;
  504. bd->pd3dDevice->CreateSamplerState(&desc, &bd->pFontSampler);
  505. }
  506. ImGui_ImplDX11_CreateFontsTexture();
  507. return true;
  508. }
  509. void ImGui_ImplDX11_InvalidateDeviceObjects()
  510. {
  511. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  512. if (!bd->pd3dDevice)
  513. return;
  514. ImGui_ImplDX11_DestroyFontsTexture();
  515. if (bd->pFontSampler) { bd->pFontSampler->Release(); bd->pFontSampler = nullptr; }
  516. if (bd->pIB) { bd->pIB->Release(); bd->pIB = nullptr; }
  517. if (bd->pVB) { bd->pVB->Release(); bd->pVB = nullptr; }
  518. if (bd->pBlendState) { bd->pBlendState->Release(); bd->pBlendState = nullptr; }
  519. if (bd->pDepthStencilState) { bd->pDepthStencilState->Release(); bd->pDepthStencilState = nullptr; }
  520. if (bd->pRasterizerState) { bd->pRasterizerState->Release(); bd->pRasterizerState = nullptr; }
  521. if (bd->pPixelShader) { bd->pPixelShader->Release(); bd->pPixelShader = nullptr; }
  522. if (bd->pVertexConstantBuffer) { bd->pVertexConstantBuffer->Release(); bd->pVertexConstantBuffer = nullptr; }
  523. if (bd->pInputLayout) { bd->pInputLayout->Release(); bd->pInputLayout = nullptr; }
  524. if (bd->pVertexShader) { bd->pVertexShader->Release(); bd->pVertexShader = nullptr; }
  525. }
  526. bool ImGui_ImplDX11_Init(ID3D11Device* device, ID3D11DeviceContext* device_context)
  527. {
  528. ImGuiIO& io = ImGui::GetIO();
  529. IMGUI_CHECKVERSION();
  530. IM_ASSERT(io.BackendRendererUserData == nullptr && "Already initialized a renderer backend!");
  531. // Setup backend capabilities flags
  532. ImGui_ImplDX11_Data* bd = IM_NEW(ImGui_ImplDX11_Data)();
  533. io.BackendRendererUserData = (void*)bd;
  534. io.BackendRendererName = "imgui_impl_dx11";
  535. io.BackendFlags |= ImGuiBackendFlags_RendererHasVtxOffset; // We can honor the ImDrawCmd::VtxOffset field, allowing for large meshes.
  536. io.BackendFlags |= ImGuiBackendFlags_RendererHasViewports; // We can create multi-viewports on the Renderer side (optional)
  537. // Get factory from device
  538. IDXGIDevice* pDXGIDevice = nullptr;
  539. IDXGIAdapter* pDXGIAdapter = nullptr;
  540. IDXGIFactory* pFactory = nullptr;
  541. if (device->QueryInterface(IID_PPV_ARGS(&pDXGIDevice)) == S_OK)
  542. if (pDXGIDevice->GetParent(IID_PPV_ARGS(&pDXGIAdapter)) == S_OK)
  543. if (pDXGIAdapter->GetParent(IID_PPV_ARGS(&pFactory)) == S_OK)
  544. {
  545. bd->pd3dDevice = device;
  546. bd->pd3dDeviceContext = device_context;
  547. bd->pFactory = pFactory;
  548. }
  549. if (pDXGIDevice) pDXGIDevice->Release();
  550. if (pDXGIAdapter) pDXGIAdapter->Release();
  551. bd->pd3dDevice->AddRef();
  552. bd->pd3dDeviceContext->AddRef();
  553. ImGui_ImplDX11_InitMultiViewportSupport();
  554. return true;
  555. }
  556. void ImGui_ImplDX11_Shutdown()
  557. {
  558. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  559. IM_ASSERT(bd != nullptr && "No renderer backend to shutdown, or already shutdown?");
  560. ImGuiIO& io = ImGui::GetIO();
  561. ImGui_ImplDX11_ShutdownMultiViewportSupport();
  562. ImGui_ImplDX11_InvalidateDeviceObjects();
  563. if (bd->pFactory) { bd->pFactory->Release(); }
  564. if (bd->pd3dDevice) { bd->pd3dDevice->Release(); }
  565. if (bd->pd3dDeviceContext) { bd->pd3dDeviceContext->Release(); }
  566. io.BackendRendererName = nullptr;
  567. io.BackendRendererUserData = nullptr;
  568. io.BackendFlags &= ~(ImGuiBackendFlags_RendererHasVtxOffset | ImGuiBackendFlags_RendererHasViewports);
  569. IM_DELETE(bd);
  570. }
  571. void ImGui_ImplDX11_NewFrame()
  572. {
  573. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  574. IM_ASSERT(bd != nullptr && "Context or backend not initialized! Did you call ImGui_ImplDX11_Init()?");
  575. if (!bd->pFontSampler)
  576. ImGui_ImplDX11_CreateDeviceObjects();
  577. }
  578. //--------------------------------------------------------------------------------------------------------
  579. // MULTI-VIEWPORT / PLATFORM INTERFACE SUPPORT
  580. // This is an _advanced_ and _optional_ feature, allowing the backend to create and handle multiple viewports simultaneously.
  581. // If you are new to dear imgui or creating a new binding for dear imgui, it is recommended that you completely ignore this section first..
  582. //--------------------------------------------------------------------------------------------------------
  583. // Helper structure we store in the void* RendererUserData field of each ImGuiViewport to easily retrieve our backend data.
  584. struct ImGui_ImplDX11_ViewportData
  585. {
  586. IDXGISwapChain* SwapChain;
  587. ID3D11RenderTargetView* RTView;
  588. ImGui_ImplDX11_ViewportData() { SwapChain = nullptr; RTView = nullptr; }
  589. ~ImGui_ImplDX11_ViewportData() { IM_ASSERT(SwapChain == nullptr && RTView == nullptr); }
  590. };
  591. static void ImGui_ImplDX11_CreateWindow(ImGuiViewport* viewport)
  592. {
  593. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  594. ImGui_ImplDX11_ViewportData* vd = IM_NEW(ImGui_ImplDX11_ViewportData)();
  595. viewport->RendererUserData = vd;
  596. // PlatformHandleRaw should always be a HWND, whereas PlatformHandle might be a higher-level handle (e.g. GLFWWindow*, SDL_Window*).
  597. // Some backends will leave PlatformHandleRaw == 0, in which case we assume PlatformHandle will contain the HWND.
  598. HWND hwnd = viewport->PlatformHandleRaw ? (HWND)viewport->PlatformHandleRaw : (HWND)viewport->PlatformHandle;
  599. IM_ASSERT(hwnd != 0);
  600. // Create swap chain
  601. DXGI_SWAP_CHAIN_DESC sd;
  602. ZeroMemory(&sd, sizeof(sd));
  603. sd.BufferDesc.Width = (UINT)viewport->Size.x;
  604. sd.BufferDesc.Height = (UINT)viewport->Size.y;
  605. sd.BufferDesc.Format = DXGI_FORMAT_R8G8B8A8_UNORM;
  606. sd.SampleDesc.Count = 1;
  607. sd.SampleDesc.Quality = 0;
  608. sd.BufferUsage = DXGI_USAGE_RENDER_TARGET_OUTPUT;
  609. sd.BufferCount = 1;
  610. sd.OutputWindow = hwnd;
  611. sd.Windowed = TRUE;
  612. sd.SwapEffect = DXGI_SWAP_EFFECT_DISCARD;
  613. sd.Flags = 0;
  614. IM_ASSERT(vd->SwapChain == nullptr && vd->RTView == nullptr);
  615. bd->pFactory->CreateSwapChain(bd->pd3dDevice, &sd, &vd->SwapChain);
  616. // Create the render target
  617. if (vd->SwapChain)
  618. {
  619. ID3D11Texture2D* pBackBuffer;
  620. vd->SwapChain->GetBuffer(0, IID_PPV_ARGS(&pBackBuffer));
  621. bd->pd3dDevice->CreateRenderTargetView(pBackBuffer, nullptr, &vd->RTView);
  622. pBackBuffer->Release();
  623. }
  624. }
  625. static void ImGui_ImplDX11_DestroyWindow(ImGuiViewport* viewport)
  626. {
  627. // The main viewport (owned by the application) will always have RendererUserData == nullptr since we didn't create the data for it.
  628. if (ImGui_ImplDX11_ViewportData* vd = (ImGui_ImplDX11_ViewportData*)viewport->RendererUserData)
  629. {
  630. if (vd->SwapChain)
  631. vd->SwapChain->Release();
  632. vd->SwapChain = nullptr;
  633. if (vd->RTView)
  634. vd->RTView->Release();
  635. vd->RTView = nullptr;
  636. IM_DELETE(vd);
  637. }
  638. viewport->RendererUserData = nullptr;
  639. }
  640. static void ImGui_ImplDX11_SetWindowSize(ImGuiViewport* viewport, ImVec2 size)
  641. {
  642. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  643. ImGui_ImplDX11_ViewportData* vd = (ImGui_ImplDX11_ViewportData*)viewport->RendererUserData;
  644. if (vd->RTView)
  645. {
  646. vd->RTView->Release();
  647. vd->RTView = nullptr;
  648. }
  649. if (vd->SwapChain)
  650. {
  651. ID3D11Texture2D* pBackBuffer = nullptr;
  652. vd->SwapChain->ResizeBuffers(0, (UINT)size.x, (UINT)size.y, DXGI_FORMAT_UNKNOWN, 0);
  653. vd->SwapChain->GetBuffer(0, IID_PPV_ARGS(&pBackBuffer));
  654. if (pBackBuffer == nullptr) { fprintf(stderr, "ImGui_ImplDX11_SetWindowSize() failed creating buffers.\n"); return; }
  655. bd->pd3dDevice->CreateRenderTargetView(pBackBuffer, nullptr, &vd->RTView);
  656. pBackBuffer->Release();
  657. }
  658. }
  659. static void ImGui_ImplDX11_RenderWindow(ImGuiViewport* viewport, void*)
  660. {
  661. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  662. ImGui_ImplDX11_ViewportData* vd = (ImGui_ImplDX11_ViewportData*)viewport->RendererUserData;
  663. ImVec4 clear_color = ImVec4(0.0f, 0.0f, 0.0f, 1.0f);
  664. bd->pd3dDeviceContext->OMSetRenderTargets(1, &vd->RTView, nullptr);
  665. if (!(viewport->Flags & ImGuiViewportFlags_NoRendererClear))
  666. bd->pd3dDeviceContext->ClearRenderTargetView(vd->RTView, (float*)&clear_color);
  667. ImGui_ImplDX11_RenderDrawData(viewport->DrawData);
  668. }
  669. static void ImGui_ImplDX11_SwapBuffers(ImGuiViewport* viewport, void*)
  670. {
  671. ImGui_ImplDX11_ViewportData* vd = (ImGui_ImplDX11_ViewportData*)viewport->RendererUserData;
  672. vd->SwapChain->Present(0, 0); // Present without vsync
  673. }
  674. static void ImGui_ImplDX11_InitMultiViewportSupport()
  675. {
  676. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  677. platform_io.Renderer_CreateWindow = ImGui_ImplDX11_CreateWindow;
  678. platform_io.Renderer_DestroyWindow = ImGui_ImplDX11_DestroyWindow;
  679. platform_io.Renderer_SetWindowSize = ImGui_ImplDX11_SetWindowSize;
  680. platform_io.Renderer_RenderWindow = ImGui_ImplDX11_RenderWindow;
  681. platform_io.Renderer_SwapBuffers = ImGui_ImplDX11_SwapBuffers;
  682. }
  683. static void ImGui_ImplDX11_ShutdownMultiViewportSupport()
  684. {
  685. ImGui::DestroyPlatformWindows();
  686. }
  687. //-----------------------------------------------------------------------------
  688. #endif // #ifndef IMGUI_DISABLE