imgui_impl_dx11.cpp 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671
  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 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. // 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-06-11: DirectX11: Added support for ImGuiBackendFlags_RendererHasTextures, for dynamic font atlas.
  18. // 2025-05-07: DirectX11: 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).
  19. // 2025-01-06: DirectX11: Expose VertexConstantBuffer in ImGui_ImplDX11_RenderState. Reset projection matrix in ImDrawCallback_ResetRenderState handler.
  20. // 2024-10-07: DirectX11: Changed default texture sampler to Clamp instead of Repeat/Wrap.
  21. // 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.
  22. // 2022-10-11: Using 'nullptr' instead of 'NULL' as per our switch to C++11.
  23. // 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).
  24. // 2021-05-19: DirectX11: Replaced direct access to ImDrawCmd::TextureId with a call to ImDrawCmd::GetTexID(). (will become a requirement)
  25. // 2021-02-18: DirectX11: Change blending equation to preserve alpha in output buffer.
  26. // 2019-08-01: DirectX11: Fixed code querying the Geometry Shader state (would generally error with Debug layer enabled).
  27. // 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.
  28. // 2019-05-29: DirectX11: Added support for large mesh (64K+ vertices), enable ImGuiBackendFlags_RendererHasVtxOffset flag.
  29. // 2019-04-30: DirectX11: Added support for special ImDrawCallback_ResetRenderState callback to reset render state.
  30. // 2018-12-03: Misc: Added #pragma comment statement to automatically link with d3dcompiler.lib when using D3DCompile().
  31. // 2018-11-30: Misc: Setting up io.BackendRendererName so it can be displayed in the About Window.
  32. // 2018-08-01: DirectX11: Querying for IDXGIFactory instead of IDXGIFactory1 to increase compatibility.
  33. // 2018-07-13: DirectX11: Fixed unreleased resources in Init and Shutdown functions.
  34. // 2018-06-08: Misc: Extracted imgui_impl_dx11.cpp/.h away from the old combined DX11+Win32 example.
  35. // 2018-06-08: DirectX11: Use draw_data->DisplayPos and draw_data->DisplaySize to setup projection matrix and clipping rectangle.
  36. // 2018-02-16: Misc: Obsoleted the io.RenderDrawListsFn callback and exposed ImGui_ImplDX11_RenderDrawData() in the .h file so you can call it yourself.
  37. // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
  38. // 2016-05-07: DirectX11: Disabling depth-write.
  39. #include "imgui.h"
  40. #ifndef IMGUI_DISABLE
  41. #include "imgui_impl_dx11.h"
  42. // DirectX
  43. #include <stdio.h>
  44. #include <d3d11.h>
  45. #include <d3dcompiler.h>
  46. #ifdef _MSC_VER
  47. #pragma comment(lib, "d3dcompiler") // Automatically link with d3dcompiler.lib as we are using D3DCompile() below.
  48. #endif
  49. // DirectX11 data
  50. struct ImGui_ImplDX11_Texture
  51. {
  52. ID3D11Texture2D* pTexture;
  53. ID3D11ShaderResourceView* pTextureView;
  54. };
  55. struct ImGui_ImplDX11_Data
  56. {
  57. ID3D11Device* pd3dDevice;
  58. ID3D11DeviceContext* pd3dDeviceContext;
  59. IDXGIFactory* pFactory;
  60. ID3D11Buffer* pVB;
  61. ID3D11Buffer* pIB;
  62. ID3D11VertexShader* pVertexShader;
  63. ID3D11InputLayout* pInputLayout;
  64. ID3D11Buffer* pVertexConstantBuffer;
  65. ID3D11PixelShader* pPixelShader;
  66. ID3D11SamplerState* pFontSampler;
  67. ID3D11RasterizerState* pRasterizerState;
  68. ID3D11BlendState* pBlendState;
  69. ID3D11DepthStencilState* pDepthStencilState;
  70. int VertexBufferSize;
  71. int IndexBufferSize;
  72. ImGui_ImplDX11_Data() { memset((void*)this, 0, sizeof(*this)); VertexBufferSize = 5000; IndexBufferSize = 10000; }
  73. };
  74. struct VERTEX_CONSTANT_BUFFER_DX11
  75. {
  76. float mvp[4][4];
  77. };
  78. // Backend data stored in io.BackendRendererUserData to allow support for multiple Dear ImGui contexts
  79. // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
  80. static ImGui_ImplDX11_Data* ImGui_ImplDX11_GetBackendData()
  81. {
  82. return ImGui::GetCurrentContext() ? (ImGui_ImplDX11_Data*)ImGui::GetIO().BackendRendererUserData : nullptr;
  83. }
  84. // Functions
  85. static void ImGui_ImplDX11_SetupRenderState(ImDrawData* draw_data, ID3D11DeviceContext* device_ctx)
  86. {
  87. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  88. // Setup viewport
  89. D3D11_VIEWPORT vp = {};
  90. vp.Width = draw_data->DisplaySize.x * draw_data->FramebufferScale.x;
  91. vp.Height = draw_data->DisplaySize.y * draw_data->FramebufferScale.y;
  92. vp.MinDepth = 0.0f;
  93. vp.MaxDepth = 1.0f;
  94. vp.TopLeftX = vp.TopLeftY = 0;
  95. device_ctx->RSSetViewports(1, &vp);
  96. // Setup orthographic projection matrix into our constant buffer
  97. // 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.
  98. D3D11_MAPPED_SUBRESOURCE mapped_resource;
  99. if (device_ctx->Map(bd->pVertexConstantBuffer, 0, D3D11_MAP_WRITE_DISCARD, 0, &mapped_resource) == S_OK)
  100. {
  101. VERTEX_CONSTANT_BUFFER_DX11* constant_buffer = (VERTEX_CONSTANT_BUFFER_DX11*)mapped_resource.pData;
  102. float L = draw_data->DisplayPos.x;
  103. float R = draw_data->DisplayPos.x + draw_data->DisplaySize.x;
  104. float T = draw_data->DisplayPos.y;
  105. float B = draw_data->DisplayPos.y + draw_data->DisplaySize.y;
  106. float mvp[4][4] =
  107. {
  108. { 2.0f/(R-L), 0.0f, 0.0f, 0.0f },
  109. { 0.0f, 2.0f/(T-B), 0.0f, 0.0f },
  110. { 0.0f, 0.0f, 0.5f, 0.0f },
  111. { (R+L)/(L-R), (T+B)/(B-T), 0.5f, 1.0f },
  112. };
  113. memcpy(&constant_buffer->mvp, mvp, sizeof(mvp));
  114. device_ctx->Unmap(bd->pVertexConstantBuffer, 0);
  115. }
  116. // Setup shader and vertex buffers
  117. unsigned int stride = sizeof(ImDrawVert);
  118. unsigned int offset = 0;
  119. device_ctx->IASetInputLayout(bd->pInputLayout);
  120. device_ctx->IASetVertexBuffers(0, 1, &bd->pVB, &stride, &offset);
  121. device_ctx->IASetIndexBuffer(bd->pIB, sizeof(ImDrawIdx) == 2 ? DXGI_FORMAT_R16_UINT : DXGI_FORMAT_R32_UINT, 0);
  122. device_ctx->IASetPrimitiveTopology(D3D11_PRIMITIVE_TOPOLOGY_TRIANGLELIST);
  123. device_ctx->VSSetShader(bd->pVertexShader, nullptr, 0);
  124. device_ctx->VSSetConstantBuffers(0, 1, &bd->pVertexConstantBuffer);
  125. device_ctx->PSSetShader(bd->pPixelShader, nullptr, 0);
  126. device_ctx->PSSetSamplers(0, 1, &bd->pFontSampler);
  127. device_ctx->GSSetShader(nullptr, nullptr, 0);
  128. device_ctx->HSSetShader(nullptr, nullptr, 0); // In theory we should backup and restore this as well.. very infrequently used..
  129. device_ctx->DSSetShader(nullptr, nullptr, 0); // In theory we should backup and restore this as well.. very infrequently used..
  130. device_ctx->CSSetShader(nullptr, nullptr, 0); // In theory we should backup and restore this as well.. very infrequently used..
  131. // Setup render state
  132. const float blend_factor[4] = { 0.f, 0.f, 0.f, 0.f };
  133. device_ctx->OMSetBlendState(bd->pBlendState, blend_factor, 0xffffffff);
  134. device_ctx->OMSetDepthStencilState(bd->pDepthStencilState, 0);
  135. device_ctx->RSSetState(bd->pRasterizerState);
  136. }
  137. // Render function
  138. void ImGui_ImplDX11_RenderDrawData(ImDrawData* draw_data)
  139. {
  140. // Avoid rendering when minimized
  141. if (draw_data->DisplaySize.x <= 0.0f || draw_data->DisplaySize.y <= 0.0f)
  142. return;
  143. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  144. ID3D11DeviceContext* device = bd->pd3dDeviceContext;
  145. // Catch up with texture updates. Most of the times, the list will have 1 element with an OK status, aka nothing to do.
  146. // (This almost always points to ImGui::GetPlatformIO().Textures[] but is part of ImDrawData to allow overriding or disabling texture updates).
  147. if (draw_data->Textures != nullptr)
  148. for (ImTextureData* tex : *draw_data->Textures)
  149. if (tex->Status != ImTextureStatus_OK)
  150. ImGui_ImplDX11_UpdateTexture(tex);
  151. // Create and grow vertex/index buffers if needed
  152. if (!bd->pVB || bd->VertexBufferSize < draw_data->TotalVtxCount)
  153. {
  154. if (bd->pVB) { bd->pVB->Release(); bd->pVB = nullptr; }
  155. bd->VertexBufferSize = draw_data->TotalVtxCount + 5000;
  156. D3D11_BUFFER_DESC desc = {};
  157. desc.Usage = D3D11_USAGE_DYNAMIC;
  158. desc.ByteWidth = bd->VertexBufferSize * sizeof(ImDrawVert);
  159. desc.BindFlags = D3D11_BIND_VERTEX_BUFFER;
  160. desc.CPUAccessFlags = D3D11_CPU_ACCESS_WRITE;
  161. desc.MiscFlags = 0;
  162. if (bd->pd3dDevice->CreateBuffer(&desc, nullptr, &bd->pVB) < 0)
  163. return;
  164. }
  165. if (!bd->pIB || bd->IndexBufferSize < draw_data->TotalIdxCount)
  166. {
  167. if (bd->pIB) { bd->pIB->Release(); bd->pIB = nullptr; }
  168. bd->IndexBufferSize = draw_data->TotalIdxCount + 10000;
  169. D3D11_BUFFER_DESC desc = {};
  170. desc.Usage = D3D11_USAGE_DYNAMIC;
  171. desc.ByteWidth = bd->IndexBufferSize * sizeof(ImDrawIdx);
  172. desc.BindFlags = D3D11_BIND_INDEX_BUFFER;
  173. desc.CPUAccessFlags = D3D11_CPU_ACCESS_WRITE;
  174. if (bd->pd3dDevice->CreateBuffer(&desc, nullptr, &bd->pIB) < 0)
  175. return;
  176. }
  177. // Upload vertex/index data into a single contiguous GPU buffer
  178. D3D11_MAPPED_SUBRESOURCE vtx_resource, idx_resource;
  179. if (device->Map(bd->pVB, 0, D3D11_MAP_WRITE_DISCARD, 0, &vtx_resource) != S_OK)
  180. return;
  181. if (device->Map(bd->pIB, 0, D3D11_MAP_WRITE_DISCARD, 0, &idx_resource) != S_OK)
  182. return;
  183. ImDrawVert* vtx_dst = (ImDrawVert*)vtx_resource.pData;
  184. ImDrawIdx* idx_dst = (ImDrawIdx*)idx_resource.pData;
  185. for (int n = 0; n < draw_data->CmdListsCount; n++)
  186. {
  187. const ImDrawList* draw_list = draw_data->CmdLists[n];
  188. memcpy(vtx_dst, draw_list->VtxBuffer.Data, draw_list->VtxBuffer.Size * sizeof(ImDrawVert));
  189. memcpy(idx_dst, draw_list->IdxBuffer.Data, draw_list->IdxBuffer.Size * sizeof(ImDrawIdx));
  190. vtx_dst += draw_list->VtxBuffer.Size;
  191. idx_dst += draw_list->IdxBuffer.Size;
  192. }
  193. device->Unmap(bd->pVB, 0);
  194. device->Unmap(bd->pIB, 0);
  195. // Backup DX state that will be modified to restore it afterwards (unfortunately this is very ugly looking and verbose. Close your eyes!)
  196. struct BACKUP_DX11_STATE
  197. {
  198. UINT ScissorRectsCount, ViewportsCount;
  199. D3D11_RECT ScissorRects[D3D11_VIEWPORT_AND_SCISSORRECT_OBJECT_COUNT_PER_PIPELINE];
  200. D3D11_VIEWPORT Viewports[D3D11_VIEWPORT_AND_SCISSORRECT_OBJECT_COUNT_PER_PIPELINE];
  201. ID3D11RasterizerState* RS;
  202. ID3D11BlendState* BlendState;
  203. FLOAT BlendFactor[4];
  204. UINT SampleMask;
  205. UINT StencilRef;
  206. ID3D11DepthStencilState* DepthStencilState;
  207. ID3D11ShaderResourceView* PSShaderResource;
  208. ID3D11SamplerState* PSSampler;
  209. ID3D11PixelShader* PS;
  210. ID3D11VertexShader* VS;
  211. ID3D11GeometryShader* GS;
  212. UINT PSInstancesCount, VSInstancesCount, GSInstancesCount;
  213. ID3D11ClassInstance *PSInstances[256], *VSInstances[256], *GSInstances[256]; // 256 is max according to PSSetShader documentation
  214. D3D11_PRIMITIVE_TOPOLOGY PrimitiveTopology;
  215. ID3D11Buffer* IndexBuffer, *VertexBuffer, *VSConstantBuffer;
  216. UINT IndexBufferOffset, VertexBufferStride, VertexBufferOffset;
  217. DXGI_FORMAT IndexBufferFormat;
  218. ID3D11InputLayout* InputLayout;
  219. };
  220. BACKUP_DX11_STATE old = {};
  221. old.ScissorRectsCount = old.ViewportsCount = D3D11_VIEWPORT_AND_SCISSORRECT_OBJECT_COUNT_PER_PIPELINE;
  222. device->RSGetScissorRects(&old.ScissorRectsCount, old.ScissorRects);
  223. device->RSGetViewports(&old.ViewportsCount, old.Viewports);
  224. device->RSGetState(&old.RS);
  225. device->OMGetBlendState(&old.BlendState, old.BlendFactor, &old.SampleMask);
  226. device->OMGetDepthStencilState(&old.DepthStencilState, &old.StencilRef);
  227. device->PSGetShaderResources(0, 1, &old.PSShaderResource);
  228. device->PSGetSamplers(0, 1, &old.PSSampler);
  229. old.PSInstancesCount = old.VSInstancesCount = old.GSInstancesCount = 256;
  230. device->PSGetShader(&old.PS, old.PSInstances, &old.PSInstancesCount);
  231. device->VSGetShader(&old.VS, old.VSInstances, &old.VSInstancesCount);
  232. device->VSGetConstantBuffers(0, 1, &old.VSConstantBuffer);
  233. device->GSGetShader(&old.GS, old.GSInstances, &old.GSInstancesCount);
  234. device->IAGetPrimitiveTopology(&old.PrimitiveTopology);
  235. device->IAGetIndexBuffer(&old.IndexBuffer, &old.IndexBufferFormat, &old.IndexBufferOffset);
  236. device->IAGetVertexBuffers(0, 1, &old.VertexBuffer, &old.VertexBufferStride, &old.VertexBufferOffset);
  237. device->IAGetInputLayout(&old.InputLayout);
  238. // Setup desired DX state
  239. ImGui_ImplDX11_SetupRenderState(draw_data, device);
  240. // Setup render state structure (for callbacks and custom texture bindings)
  241. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  242. ImGui_ImplDX11_RenderState render_state;
  243. render_state.Device = bd->pd3dDevice;
  244. render_state.DeviceContext = bd->pd3dDeviceContext;
  245. render_state.SamplerDefault = bd->pFontSampler;
  246. render_state.VertexConstantBuffer = bd->pVertexConstantBuffer;
  247. platform_io.Renderer_RenderState = &render_state;
  248. // Render command lists
  249. // (Because we merged all buffers into a single one, we maintain our own offset into them)
  250. int global_idx_offset = 0;
  251. int global_vtx_offset = 0;
  252. ImVec2 clip_off = draw_data->DisplayPos;
  253. ImVec2 clip_scale = draw_data->FramebufferScale;
  254. for (int n = 0; n < draw_data->CmdListsCount; n++)
  255. {
  256. const ImDrawList* draw_list = draw_data->CmdLists[n];
  257. for (int cmd_i = 0; cmd_i < draw_list->CmdBuffer.Size; cmd_i++)
  258. {
  259. const ImDrawCmd* pcmd = &draw_list->CmdBuffer[cmd_i];
  260. if (pcmd->UserCallback != nullptr)
  261. {
  262. // User callback, registered via ImDrawList::AddCallback()
  263. // (ImDrawCallback_ResetRenderState is a special callback value used by the user to request the renderer to reset render state.)
  264. if (pcmd->UserCallback == ImDrawCallback_ResetRenderState)
  265. ImGui_ImplDX11_SetupRenderState(draw_data, device);
  266. else
  267. pcmd->UserCallback(draw_list, pcmd);
  268. }
  269. else
  270. {
  271. // Project scissor/clipping rectangles into framebuffer space
  272. ImVec2 clip_min((pcmd->ClipRect.x - clip_off.x) * clip_scale.x, (pcmd->ClipRect.y - clip_off.y) * clip_scale.y);
  273. ImVec2 clip_max((pcmd->ClipRect.z - clip_off.x) * clip_scale.x, (pcmd->ClipRect.w - clip_off.y) * clip_scale.y);
  274. if (clip_max.x <= clip_min.x || clip_max.y <= clip_min.y)
  275. continue;
  276. // Apply scissor/clipping rectangle
  277. const D3D11_RECT r = { (LONG)clip_min.x, (LONG)clip_min.y, (LONG)clip_max.x, (LONG)clip_max.y };
  278. device->RSSetScissorRects(1, &r);
  279. // Bind texture, Draw
  280. ID3D11ShaderResourceView* texture_srv = (ID3D11ShaderResourceView*)pcmd->GetTexID();
  281. device->PSSetShaderResources(0, 1, &texture_srv);
  282. device->DrawIndexed(pcmd->ElemCount, pcmd->IdxOffset + global_idx_offset, pcmd->VtxOffset + global_vtx_offset);
  283. }
  284. }
  285. global_idx_offset += draw_list->IdxBuffer.Size;
  286. global_vtx_offset += draw_list->VtxBuffer.Size;
  287. }
  288. platform_io.Renderer_RenderState = nullptr;
  289. // Restore modified DX state
  290. device->RSSetScissorRects(old.ScissorRectsCount, old.ScissorRects);
  291. device->RSSetViewports(old.ViewportsCount, old.Viewports);
  292. device->RSSetState(old.RS); if (old.RS) old.RS->Release();
  293. device->OMSetBlendState(old.BlendState, old.BlendFactor, old.SampleMask); if (old.BlendState) old.BlendState->Release();
  294. device->OMSetDepthStencilState(old.DepthStencilState, old.StencilRef); if (old.DepthStencilState) old.DepthStencilState->Release();
  295. device->PSSetShaderResources(0, 1, &old.PSShaderResource); if (old.PSShaderResource) old.PSShaderResource->Release();
  296. device->PSSetSamplers(0, 1, &old.PSSampler); if (old.PSSampler) old.PSSampler->Release();
  297. device->PSSetShader(old.PS, old.PSInstances, old.PSInstancesCount); if (old.PS) old.PS->Release();
  298. for (UINT i = 0; i < old.PSInstancesCount; i++) if (old.PSInstances[i]) old.PSInstances[i]->Release();
  299. device->VSSetShader(old.VS, old.VSInstances, old.VSInstancesCount); if (old.VS) old.VS->Release();
  300. device->VSSetConstantBuffers(0, 1, &old.VSConstantBuffer); if (old.VSConstantBuffer) old.VSConstantBuffer->Release();
  301. device->GSSetShader(old.GS, old.GSInstances, old.GSInstancesCount); if (old.GS) old.GS->Release();
  302. for (UINT i = 0; i < old.VSInstancesCount; i++) if (old.VSInstances[i]) old.VSInstances[i]->Release();
  303. device->IASetPrimitiveTopology(old.PrimitiveTopology);
  304. device->IASetIndexBuffer(old.IndexBuffer, old.IndexBufferFormat, old.IndexBufferOffset); if (old.IndexBuffer) old.IndexBuffer->Release();
  305. device->IASetVertexBuffers(0, 1, &old.VertexBuffer, &old.VertexBufferStride, &old.VertexBufferOffset); if (old.VertexBuffer) old.VertexBuffer->Release();
  306. device->IASetInputLayout(old.InputLayout); if (old.InputLayout) old.InputLayout->Release();
  307. }
  308. static void ImGui_ImplDX11_DestroyTexture(ImTextureData* tex)
  309. {
  310. ImGui_ImplDX11_Texture* backend_tex = (ImGui_ImplDX11_Texture*)tex->BackendUserData;
  311. if (backend_tex == nullptr)
  312. return;
  313. IM_ASSERT(backend_tex->pTextureView == (ID3D11ShaderResourceView*)(intptr_t)tex->TexID);
  314. backend_tex->pTextureView->Release();
  315. backend_tex->pTexture->Release();
  316. IM_DELETE(backend_tex);
  317. // Clear identifiers and mark as destroyed (in order to allow e.g. calling InvalidateDeviceObjects while running)
  318. tex->SetTexID(ImTextureID_Invalid);
  319. tex->SetStatus(ImTextureStatus_Destroyed);
  320. tex->BackendUserData = nullptr;
  321. }
  322. void ImGui_ImplDX11_UpdateTexture(ImTextureData* tex)
  323. {
  324. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  325. if (tex->Status == ImTextureStatus_WantCreate)
  326. {
  327. // Create and upload new texture to graphics system
  328. //IMGUI_DEBUG_LOG("UpdateTexture #%03d: WantCreate %dx%d\n", tex->UniqueID, tex->Width, tex->Height);
  329. IM_ASSERT(tex->TexID == ImTextureID_Invalid && tex->BackendUserData == nullptr);
  330. IM_ASSERT(tex->Format == ImTextureFormat_RGBA32);
  331. unsigned int* pixels = (unsigned int*)tex->GetPixels();
  332. ImGui_ImplDX11_Texture* backend_tex = IM_NEW(ImGui_ImplDX11_Texture)();
  333. // Create texture
  334. D3D11_TEXTURE2D_DESC desc;
  335. ZeroMemory(&desc, sizeof(desc));
  336. desc.Width = (UINT)tex->Width;
  337. desc.Height = (UINT)tex->Height;
  338. desc.MipLevels = 1;
  339. desc.ArraySize = 1;
  340. desc.Format = DXGI_FORMAT_R8G8B8A8_UNORM;
  341. desc.SampleDesc.Count = 1;
  342. desc.Usage = D3D11_USAGE_DEFAULT;
  343. desc.BindFlags = D3D11_BIND_SHADER_RESOURCE;
  344. desc.CPUAccessFlags = 0;
  345. D3D11_SUBRESOURCE_DATA subResource;
  346. subResource.pSysMem = pixels;
  347. subResource.SysMemPitch = desc.Width * 4;
  348. subResource.SysMemSlicePitch = 0;
  349. bd->pd3dDevice->CreateTexture2D(&desc, &subResource, &backend_tex->pTexture);
  350. IM_ASSERT(backend_tex->pTexture != nullptr && "Backend failed to create texture!");
  351. // Create texture view
  352. D3D11_SHADER_RESOURCE_VIEW_DESC srvDesc;
  353. ZeroMemory(&srvDesc, sizeof(srvDesc));
  354. srvDesc.Format = DXGI_FORMAT_R8G8B8A8_UNORM;
  355. srvDesc.ViewDimension = D3D11_SRV_DIMENSION_TEXTURE2D;
  356. srvDesc.Texture2D.MipLevels = desc.MipLevels;
  357. srvDesc.Texture2D.MostDetailedMip = 0;
  358. bd->pd3dDevice->CreateShaderResourceView(backend_tex->pTexture, &srvDesc, &backend_tex->pTextureView);
  359. IM_ASSERT(backend_tex->pTextureView != nullptr && "Backend failed to create texture!");
  360. // Store identifiers
  361. tex->SetTexID((ImTextureID)(intptr_t)backend_tex->pTextureView);
  362. tex->SetStatus(ImTextureStatus_OK);
  363. tex->BackendUserData = backend_tex;
  364. }
  365. else if (tex->Status == ImTextureStatus_WantUpdates)
  366. {
  367. // Update selected blocks. We only ever write to textures regions which have never been used before!
  368. // This backend choose to use tex->Updates[] but you can use tex->UpdateRect to upload a single region.
  369. ImGui_ImplDX11_Texture* backend_tex = (ImGui_ImplDX11_Texture*)tex->BackendUserData;
  370. IM_ASSERT(backend_tex->pTextureView == (ID3D11ShaderResourceView*)(intptr_t)tex->TexID);
  371. for (ImTextureRect& r : tex->Updates)
  372. {
  373. D3D11_BOX box = { (UINT)r.x, (UINT)r.y, (UINT)0, (UINT)(r.x + r.w), (UINT)(r.y + r .h), (UINT)1 };
  374. bd->pd3dDeviceContext->UpdateSubresource(backend_tex->pTexture, 0, &box, tex->GetPixelsAt(r.x, r.y), (UINT)tex->GetPitch(), 0);
  375. }
  376. tex->SetStatus(ImTextureStatus_OK);
  377. }
  378. if (tex->Status == ImTextureStatus_WantDestroy && tex->UnusedFrames > 0)
  379. ImGui_ImplDX11_DestroyTexture(tex);
  380. }
  381. bool ImGui_ImplDX11_CreateDeviceObjects()
  382. {
  383. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  384. if (!bd->pd3dDevice)
  385. return false;
  386. ImGui_ImplDX11_InvalidateDeviceObjects();
  387. // By using D3DCompile() from <d3dcompiler.h> / d3dcompiler.lib, we introduce a dependency to a given version of d3dcompiler_XX.dll (see D3DCOMPILER_DLL_A)
  388. // If you would like to use this DX11 sample code but remove this dependency you can:
  389. // 1) compile once, save the compiled shader blobs into a file or source code and pass them to CreateVertexShader()/CreatePixelShader() [preferred solution]
  390. // 2) use code to detect any version of the DLL and grab a pointer to D3DCompile from the DLL.
  391. // See https://github.com/ocornut/imgui/pull/638 for sources and details.
  392. // Create the vertex shader
  393. {
  394. static const char* vertexShader =
  395. "cbuffer vertexBuffer : register(b0) \
  396. {\
  397. float4x4 ProjectionMatrix; \
  398. };\
  399. struct VS_INPUT\
  400. {\
  401. float2 pos : POSITION;\
  402. float4 col : COLOR0;\
  403. float2 uv : TEXCOORD0;\
  404. };\
  405. \
  406. struct PS_INPUT\
  407. {\
  408. float4 pos : SV_POSITION;\
  409. float4 col : COLOR0;\
  410. float2 uv : TEXCOORD0;\
  411. };\
  412. \
  413. PS_INPUT main(VS_INPUT input)\
  414. {\
  415. PS_INPUT output;\
  416. output.pos = mul( ProjectionMatrix, float4(input.pos.xy, 0.f, 1.f));\
  417. output.col = input.col;\
  418. output.uv = input.uv;\
  419. return output;\
  420. }";
  421. ID3DBlob* vertexShaderBlob;
  422. if (FAILED(D3DCompile(vertexShader, strlen(vertexShader), nullptr, nullptr, nullptr, "main", "vs_4_0", 0, 0, &vertexShaderBlob, nullptr)))
  423. return false; // NB: Pass ID3DBlob* pErrorBlob to D3DCompile() to get error showing in (const char*)pErrorBlob->GetBufferPointer(). Make sure to Release() the blob!
  424. if (bd->pd3dDevice->CreateVertexShader(vertexShaderBlob->GetBufferPointer(), vertexShaderBlob->GetBufferSize(), nullptr, &bd->pVertexShader) != S_OK)
  425. {
  426. vertexShaderBlob->Release();
  427. return false;
  428. }
  429. // Create the input layout
  430. D3D11_INPUT_ELEMENT_DESC local_layout[] =
  431. {
  432. { "POSITION", 0, DXGI_FORMAT_R32G32_FLOAT, 0, (UINT)offsetof(ImDrawVert, pos), D3D11_INPUT_PER_VERTEX_DATA, 0 },
  433. { "TEXCOORD", 0, DXGI_FORMAT_R32G32_FLOAT, 0, (UINT)offsetof(ImDrawVert, uv), D3D11_INPUT_PER_VERTEX_DATA, 0 },
  434. { "COLOR", 0, DXGI_FORMAT_R8G8B8A8_UNORM, 0, (UINT)offsetof(ImDrawVert, col), D3D11_INPUT_PER_VERTEX_DATA, 0 },
  435. };
  436. if (bd->pd3dDevice->CreateInputLayout(local_layout, 3, vertexShaderBlob->GetBufferPointer(), vertexShaderBlob->GetBufferSize(), &bd->pInputLayout) != S_OK)
  437. {
  438. vertexShaderBlob->Release();
  439. return false;
  440. }
  441. vertexShaderBlob->Release();
  442. // Create the constant buffer
  443. {
  444. D3D11_BUFFER_DESC desc = {};
  445. desc.ByteWidth = sizeof(VERTEX_CONSTANT_BUFFER_DX11);
  446. desc.Usage = D3D11_USAGE_DYNAMIC;
  447. desc.BindFlags = D3D11_BIND_CONSTANT_BUFFER;
  448. desc.CPUAccessFlags = D3D11_CPU_ACCESS_WRITE;
  449. desc.MiscFlags = 0;
  450. bd->pd3dDevice->CreateBuffer(&desc, nullptr, &bd->pVertexConstantBuffer);
  451. }
  452. }
  453. // Create the pixel shader
  454. {
  455. static const char* pixelShader =
  456. "struct PS_INPUT\
  457. {\
  458. float4 pos : SV_POSITION;\
  459. float4 col : COLOR0;\
  460. float2 uv : TEXCOORD0;\
  461. };\
  462. sampler sampler0;\
  463. Texture2D texture0;\
  464. \
  465. float4 main(PS_INPUT input) : SV_Target\
  466. {\
  467. float4 out_col = input.col * texture0.Sample(sampler0, input.uv); \
  468. return out_col; \
  469. }";
  470. ID3DBlob* pixelShaderBlob;
  471. if (FAILED(D3DCompile(pixelShader, strlen(pixelShader), nullptr, nullptr, nullptr, "main", "ps_4_0", 0, 0, &pixelShaderBlob, nullptr)))
  472. return false; // NB: Pass ID3DBlob* pErrorBlob to D3DCompile() to get error showing in (const char*)pErrorBlob->GetBufferPointer(). Make sure to Release() the blob!
  473. if (bd->pd3dDevice->CreatePixelShader(pixelShaderBlob->GetBufferPointer(), pixelShaderBlob->GetBufferSize(), nullptr, &bd->pPixelShader) != S_OK)
  474. {
  475. pixelShaderBlob->Release();
  476. return false;
  477. }
  478. pixelShaderBlob->Release();
  479. }
  480. // Create the blending setup
  481. {
  482. D3D11_BLEND_DESC desc;
  483. ZeroMemory(&desc, sizeof(desc));
  484. desc.AlphaToCoverageEnable = false;
  485. desc.RenderTarget[0].BlendEnable = true;
  486. desc.RenderTarget[0].SrcBlend = D3D11_BLEND_SRC_ALPHA;
  487. desc.RenderTarget[0].DestBlend = D3D11_BLEND_INV_SRC_ALPHA;
  488. desc.RenderTarget[0].BlendOp = D3D11_BLEND_OP_ADD;
  489. desc.RenderTarget[0].SrcBlendAlpha = D3D11_BLEND_ONE;
  490. desc.RenderTarget[0].DestBlendAlpha = D3D11_BLEND_INV_SRC_ALPHA;
  491. desc.RenderTarget[0].BlendOpAlpha = D3D11_BLEND_OP_ADD;
  492. desc.RenderTarget[0].RenderTargetWriteMask = D3D11_COLOR_WRITE_ENABLE_ALL;
  493. bd->pd3dDevice->CreateBlendState(&desc, &bd->pBlendState);
  494. }
  495. // Create the rasterizer state
  496. {
  497. D3D11_RASTERIZER_DESC desc;
  498. ZeroMemory(&desc, sizeof(desc));
  499. desc.FillMode = D3D11_FILL_SOLID;
  500. desc.CullMode = D3D11_CULL_NONE;
  501. desc.ScissorEnable = true;
  502. desc.DepthClipEnable = true;
  503. bd->pd3dDevice->CreateRasterizerState(&desc, &bd->pRasterizerState);
  504. }
  505. // Create depth-stencil State
  506. {
  507. D3D11_DEPTH_STENCIL_DESC desc;
  508. ZeroMemory(&desc, sizeof(desc));
  509. desc.DepthEnable = false;
  510. desc.DepthWriteMask = D3D11_DEPTH_WRITE_MASK_ALL;
  511. desc.DepthFunc = D3D11_COMPARISON_ALWAYS;
  512. desc.StencilEnable = false;
  513. desc.FrontFace.StencilFailOp = desc.FrontFace.StencilDepthFailOp = desc.FrontFace.StencilPassOp = D3D11_STENCIL_OP_KEEP;
  514. desc.FrontFace.StencilFunc = D3D11_COMPARISON_ALWAYS;
  515. desc.BackFace = desc.FrontFace;
  516. bd->pd3dDevice->CreateDepthStencilState(&desc, &bd->pDepthStencilState);
  517. }
  518. // Create texture sampler
  519. // (Bilinear sampling is required by default. Set 'io.Fonts->Flags |= ImFontAtlasFlags_NoBakedLines' or 'style.AntiAliasedLinesUseTex = false' to allow point/nearest sampling)
  520. {
  521. D3D11_SAMPLER_DESC desc;
  522. ZeroMemory(&desc, sizeof(desc));
  523. desc.Filter = D3D11_FILTER_MIN_MAG_MIP_LINEAR;
  524. desc.AddressU = D3D11_TEXTURE_ADDRESS_CLAMP;
  525. desc.AddressV = D3D11_TEXTURE_ADDRESS_CLAMP;
  526. desc.AddressW = D3D11_TEXTURE_ADDRESS_CLAMP;
  527. desc.MipLODBias = 0.f;
  528. desc.ComparisonFunc = D3D11_COMPARISON_ALWAYS;
  529. desc.MinLOD = 0.f;
  530. desc.MaxLOD = 0.f;
  531. bd->pd3dDevice->CreateSamplerState(&desc, &bd->pFontSampler);
  532. }
  533. return true;
  534. }
  535. void ImGui_ImplDX11_InvalidateDeviceObjects()
  536. {
  537. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  538. if (!bd->pd3dDevice)
  539. return;
  540. // Destroy all textures
  541. for (ImTextureData* tex : ImGui::GetPlatformIO().Textures)
  542. if (tex->RefCount == 1)
  543. ImGui_ImplDX11_DestroyTexture(tex);
  544. if (bd->pFontSampler) { bd->pFontSampler->Release(); bd->pFontSampler = nullptr; }
  545. if (bd->pIB) { bd->pIB->Release(); bd->pIB = nullptr; }
  546. if (bd->pVB) { bd->pVB->Release(); bd->pVB = nullptr; }
  547. if (bd->pBlendState) { bd->pBlendState->Release(); bd->pBlendState = nullptr; }
  548. if (bd->pDepthStencilState) { bd->pDepthStencilState->Release(); bd->pDepthStencilState = nullptr; }
  549. if (bd->pRasterizerState) { bd->pRasterizerState->Release(); bd->pRasterizerState = nullptr; }
  550. if (bd->pPixelShader) { bd->pPixelShader->Release(); bd->pPixelShader = nullptr; }
  551. if (bd->pVertexConstantBuffer) { bd->pVertexConstantBuffer->Release(); bd->pVertexConstantBuffer = nullptr; }
  552. if (bd->pInputLayout) { bd->pInputLayout->Release(); bd->pInputLayout = nullptr; }
  553. if (bd->pVertexShader) { bd->pVertexShader->Release(); bd->pVertexShader = nullptr; }
  554. }
  555. bool ImGui_ImplDX11_Init(ID3D11Device* device, ID3D11DeviceContext* device_context)
  556. {
  557. ImGuiIO& io = ImGui::GetIO();
  558. IMGUI_CHECKVERSION();
  559. IM_ASSERT(io.BackendRendererUserData == nullptr && "Already initialized a renderer backend!");
  560. // Setup backend capabilities flags
  561. ImGui_ImplDX11_Data* bd = IM_NEW(ImGui_ImplDX11_Data)();
  562. io.BackendRendererUserData = (void*)bd;
  563. io.BackendRendererName = "imgui_impl_dx11";
  564. io.BackendFlags |= ImGuiBackendFlags_RendererHasVtxOffset; // We can honor the ImDrawCmd::VtxOffset field, allowing for large meshes.
  565. io.BackendFlags |= ImGuiBackendFlags_RendererHasTextures; // We can honor ImGuiPlatformIO::Textures[] requests during render.
  566. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  567. platform_io.Renderer_TextureMaxWidth = platform_io.Renderer_TextureMaxHeight = D3D11_REQ_TEXTURE2D_U_OR_V_DIMENSION;
  568. // Get factory from device
  569. IDXGIDevice* pDXGIDevice = nullptr;
  570. IDXGIAdapter* pDXGIAdapter = nullptr;
  571. IDXGIFactory* pFactory = nullptr;
  572. if (device->QueryInterface(IID_PPV_ARGS(&pDXGIDevice)) == S_OK)
  573. if (pDXGIDevice->GetParent(IID_PPV_ARGS(&pDXGIAdapter)) == S_OK)
  574. if (pDXGIAdapter->GetParent(IID_PPV_ARGS(&pFactory)) == S_OK)
  575. {
  576. bd->pd3dDevice = device;
  577. bd->pd3dDeviceContext = device_context;
  578. bd->pFactory = pFactory;
  579. }
  580. if (pDXGIDevice) pDXGIDevice->Release();
  581. if (pDXGIAdapter) pDXGIAdapter->Release();
  582. bd->pd3dDevice->AddRef();
  583. bd->pd3dDeviceContext->AddRef();
  584. return true;
  585. }
  586. void ImGui_ImplDX11_Shutdown()
  587. {
  588. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  589. IM_ASSERT(bd != nullptr && "No renderer backend to shutdown, or already shutdown?");
  590. ImGuiIO& io = ImGui::GetIO();
  591. ImGui_ImplDX11_InvalidateDeviceObjects();
  592. if (bd->pFactory) { bd->pFactory->Release(); }
  593. if (bd->pd3dDevice) { bd->pd3dDevice->Release(); }
  594. if (bd->pd3dDeviceContext) { bd->pd3dDeviceContext->Release(); }
  595. io.BackendRendererName = nullptr;
  596. io.BackendRendererUserData = nullptr;
  597. io.BackendFlags &= ~(ImGuiBackendFlags_RendererHasVtxOffset | ImGuiBackendFlags_RendererHasTextures);
  598. IM_DELETE(bd);
  599. }
  600. void ImGui_ImplDX11_NewFrame()
  601. {
  602. ImGui_ImplDX11_Data* bd = ImGui_ImplDX11_GetBackendData();
  603. IM_ASSERT(bd != nullptr && "Context or backend not initialized! Did you call ImGui_ImplDX11_Init()?");
  604. if (!bd->pVertexShader)
  605. if (!ImGui_ImplDX11_CreateDeviceObjects())
  606. IM_ASSERT(0 && "ImGui_ImplDX11_CreateDeviceObjects() failed!");
  607. }
  608. //-----------------------------------------------------------------------------
  609. #endif // #ifndef IMGUI_DISABLE