imgui_impl_dx9.cpp 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637
  1. // dear imgui: Renderer Backend for DirectX9
  2. // This needs to be used along with a Platform Backend (e.g. Win32)
  3. // Implemented features:
  4. // [X] Renderer: User texture binding. Use 'LPDIRECT3DTEXTURE9' 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: IMGUI_USE_BGRA_PACKED_COLOR support, as this is the optimal color encoding for DirectX9.
  8. // [X] Renderer: Multi-viewport support (multiple windows). Enable with 'io.ConfigFlags |= ImGuiConfigFlags_ViewportsEnable'.
  9. // You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
  10. // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
  11. // Learn about Dear ImGui:
  12. // - FAQ https://dearimgui.com/faq
  13. // - Getting Started https://dearimgui.com/getting-started
  14. // - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
  15. // - Introduction, links and more at the top of imgui.cpp
  16. // CHANGELOG
  17. // (minor and older changes stripped away, please see git history for details)
  18. // 2025-XX-XX: Platform: Added support for multiple windows via the ImGuiPlatformIO interface.
  19. // 2025-06-11: DirectX9: Added support for ImGuiBackendFlags_RendererHasTextures, for dynamic font atlas.
  20. // 2024-10-07: DirectX9: Changed default texture sampler to Clamp instead of Repeat/Wrap.
  21. // 2024-02-12: DirectX9: Using RGBA format when supported by the driver to avoid CPU side conversion. (#6575)
  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-06-25: DirectX9: Explicitly disable texture state stages after >= 1.
  25. // 2021-05-19: DirectX9: Replaced direct access to ImDrawCmd::TextureId with a call to ImDrawCmd::GetTexID(). (will become a requirement)
  26. // 2021-04-23: DirectX9: Explicitly setting up more graphics states to increase compatibility with unusual non-default states.
  27. // 2021-03-18: DirectX9: Calling IDirect3DStateBlock9::Capture() after CreateStateBlock() as a workaround for state restoring issues (see #3857).
  28. // 2021-03-03: DirectX9: Added support for IMGUI_USE_BGRA_PACKED_COLOR in user's imconfig file.
  29. // 2021-02-18: DirectX9: Change blending equation to preserve alpha in output buffer.
  30. // 2019-05-29: DirectX9: Added support for large mesh (64K+ vertices), enable ImGuiBackendFlags_RendererHasVtxOffset flag.
  31. // 2019-04-30: DirectX9: Added support for special ImDrawCallback_ResetRenderState callback to reset render state.
  32. // 2019-03-29: Misc: Fixed erroneous assert in ImGui_ImplDX9_InvalidateDeviceObjects().
  33. // 2019-01-16: Misc: Disabled fog before drawing UI's. Fixes issue #2288.
  34. // 2018-11-30: Misc: Setting up io.BackendRendererName so it can be displayed in the About Window.
  35. // 2018-06-08: Misc: Extracted imgui_impl_dx9.cpp/.h away from the old combined DX9+Win32 example.
  36. // 2018-06-08: DirectX9: Use draw_data->DisplayPos and draw_data->DisplaySize to setup projection matrix and clipping rectangle.
  37. // 2018-05-07: Render: Saving/restoring Transform because they don't seem to be included in the StateBlock. Setting shading mode to Gouraud.
  38. // 2018-02-16: Misc: Obsoleted the io.RenderDrawListsFn callback and exposed ImGui_ImplDX9_RenderDrawData() in the .h file so you can call it yourself.
  39. // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
  40. #include "imgui.h"
  41. #ifndef IMGUI_DISABLE
  42. #include "imgui_impl_dx9.h"
  43. // DirectX
  44. #include <d3d9.h>
  45. // Clang/GCC warnings with -Weverything
  46. #if defined(__clang__)
  47. #pragma clang diagnostic ignored "-Wold-style-cast" // warning: use of old-style cast // yes, they are more terse.
  48. #pragma clang diagnostic ignored "-Wsign-conversion" // warning: implicit conversion changes signedness
  49. #endif
  50. // DirectX data
  51. struct ImGui_ImplDX9_Data
  52. {
  53. LPDIRECT3DDEVICE9 pd3dDevice;
  54. LPDIRECT3DVERTEXBUFFER9 pVB;
  55. LPDIRECT3DINDEXBUFFER9 pIB;
  56. int VertexBufferSize;
  57. int IndexBufferSize;
  58. bool HasRgbaSupport;
  59. ImGui_ImplDX9_Data() { memset((void*)this, 0, sizeof(*this)); VertexBufferSize = 5000; IndexBufferSize = 10000; }
  60. };
  61. struct CUSTOMVERTEX
  62. {
  63. float pos[3];
  64. D3DCOLOR col;
  65. float uv[2];
  66. };
  67. #define D3DFVF_CUSTOMVERTEX (D3DFVF_XYZ|D3DFVF_DIFFUSE|D3DFVF_TEX1)
  68. #ifdef IMGUI_USE_BGRA_PACKED_COLOR
  69. #define IMGUI_COL_TO_DX9_ARGB(_COL) (_COL)
  70. #else
  71. #define IMGUI_COL_TO_DX9_ARGB(_COL) (((_COL) & 0xFF00FF00) | (((_COL) & 0xFF0000) >> 16) | (((_COL) & 0xFF) << 16))
  72. #endif
  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_ImplDX9_Data* ImGui_ImplDX9_GetBackendData()
  76. {
  77. return ImGui::GetCurrentContext() ? (ImGui_ImplDX9_Data*)ImGui::GetIO().BackendRendererUserData : nullptr;
  78. }
  79. // Forward Declarations
  80. static void ImGui_ImplDX9_InitMultiViewportSupport();
  81. static void ImGui_ImplDX9_ShutdownMultiViewportSupport();
  82. static void ImGui_ImplDX9_CreateDeviceObjectsForPlatformWindows();
  83. static void ImGui_ImplDX9_InvalidateDeviceObjectsForPlatformWindows();
  84. // Functions
  85. static void ImGui_ImplDX9_SetupRenderState(ImDrawData* draw_data)
  86. {
  87. ImGui_ImplDX9_Data* bd = ImGui_ImplDX9_GetBackendData();
  88. // Setup viewport
  89. D3DVIEWPORT9 vp;
  90. vp.X = vp.Y = 0;
  91. vp.Width = (DWORD)draw_data->DisplaySize.x;
  92. vp.Height = (DWORD)draw_data->DisplaySize.y;
  93. vp.MinZ = 0.0f;
  94. vp.MaxZ = 1.0f;
  95. LPDIRECT3DDEVICE9 device = bd->pd3dDevice;
  96. device->SetViewport(&vp);
  97. // Setup render state: fixed-pipeline, alpha-blending, no face culling, no depth testing, shade mode (for gradient), bilinear sampling.
  98. device->SetPixelShader(nullptr);
  99. device->SetVertexShader(nullptr);
  100. device->SetRenderState(D3DRS_FILLMODE, D3DFILL_SOLID);
  101. device->SetRenderState(D3DRS_SHADEMODE, D3DSHADE_GOURAUD);
  102. device->SetRenderState(D3DRS_ZWRITEENABLE, FALSE);
  103. device->SetRenderState(D3DRS_ALPHATESTENABLE, FALSE);
  104. device->SetRenderState(D3DRS_CULLMODE, D3DCULL_NONE);
  105. device->SetRenderState(D3DRS_ZENABLE, FALSE);
  106. device->SetRenderState(D3DRS_ALPHABLENDENABLE, TRUE);
  107. device->SetRenderState(D3DRS_BLENDOP, D3DBLENDOP_ADD);
  108. device->SetRenderState(D3DRS_SRCBLEND, D3DBLEND_SRCALPHA);
  109. device->SetRenderState(D3DRS_DESTBLEND, D3DBLEND_INVSRCALPHA);
  110. device->SetRenderState(D3DRS_SEPARATEALPHABLENDENABLE, TRUE);
  111. device->SetRenderState(D3DRS_SRCBLENDALPHA, D3DBLEND_ONE);
  112. device->SetRenderState(D3DRS_DESTBLENDALPHA, D3DBLEND_INVSRCALPHA);
  113. device->SetRenderState(D3DRS_SCISSORTESTENABLE, TRUE);
  114. device->SetRenderState(D3DRS_FOGENABLE, FALSE);
  115. device->SetRenderState(D3DRS_RANGEFOGENABLE, FALSE);
  116. device->SetRenderState(D3DRS_SPECULARENABLE, FALSE);
  117. device->SetRenderState(D3DRS_STENCILENABLE, FALSE);
  118. device->SetRenderState(D3DRS_CLIPPING, TRUE);
  119. device->SetRenderState(D3DRS_LIGHTING, FALSE);
  120. device->SetTextureStageState(0, D3DTSS_COLOROP, D3DTOP_MODULATE);
  121. device->SetTextureStageState(0, D3DTSS_COLORARG1, D3DTA_TEXTURE);
  122. device->SetTextureStageState(0, D3DTSS_COLORARG2, D3DTA_DIFFUSE);
  123. device->SetTextureStageState(0, D3DTSS_ALPHAOP, D3DTOP_MODULATE);
  124. device->SetTextureStageState(0, D3DTSS_ALPHAARG1, D3DTA_TEXTURE);
  125. device->SetTextureStageState(0, D3DTSS_ALPHAARG2, D3DTA_DIFFUSE);
  126. device->SetTextureStageState(1, D3DTSS_COLOROP, D3DTOP_DISABLE);
  127. device->SetTextureStageState(1, D3DTSS_ALPHAOP, D3DTOP_DISABLE);
  128. device->SetSamplerState(0, D3DSAMP_MINFILTER, D3DTEXF_LINEAR);
  129. device->SetSamplerState(0, D3DSAMP_MAGFILTER, D3DTEXF_LINEAR);
  130. device->SetSamplerState(0, D3DSAMP_ADDRESSU, D3DTADDRESS_CLAMP);
  131. device->SetSamplerState(0, D3DSAMP_ADDRESSV, D3DTADDRESS_CLAMP);
  132. // Setup orthographic projection matrix
  133. // 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.
  134. // Being agnostic of whether <d3dx9.h> or <DirectXMath.h> can be used, we aren't relying on D3DXMatrixIdentity()/D3DXMatrixOrthoOffCenterLH() or DirectX::XMMatrixIdentity()/DirectX::XMMatrixOrthographicOffCenterLH()
  135. {
  136. float L = draw_data->DisplayPos.x + 0.5f;
  137. float R = draw_data->DisplayPos.x + draw_data->DisplaySize.x + 0.5f;
  138. float T = draw_data->DisplayPos.y + 0.5f;
  139. float B = draw_data->DisplayPos.y + draw_data->DisplaySize.y + 0.5f;
  140. D3DMATRIX mat_identity = { { { 1.0f, 0.0f, 0.0f, 0.0f, 0.0f, 1.0f, 0.0f, 0.0f, 0.0f, 0.0f, 1.0f, 0.0f, 0.0f, 0.0f, 0.0f, 1.0f } } };
  141. D3DMATRIX mat_projection =
  142. { { {
  143. 2.0f/(R-L), 0.0f, 0.0f, 0.0f,
  144. 0.0f, 2.0f/(T-B), 0.0f, 0.0f,
  145. 0.0f, 0.0f, 0.5f, 0.0f,
  146. (L+R)/(L-R), (T+B)/(B-T), 0.5f, 1.0f
  147. } } };
  148. device->SetTransform(D3DTS_WORLD, &mat_identity);
  149. device->SetTransform(D3DTS_VIEW, &mat_identity);
  150. device->SetTransform(D3DTS_PROJECTION, &mat_projection);
  151. }
  152. }
  153. // Render function.
  154. void ImGui_ImplDX9_RenderDrawData(ImDrawData* draw_data)
  155. {
  156. // Avoid rendering when minimized
  157. if (draw_data->DisplaySize.x <= 0.0f || draw_data->DisplaySize.y <= 0.0f)
  158. return;
  159. ImGui_ImplDX9_Data* bd = ImGui_ImplDX9_GetBackendData();
  160. LPDIRECT3DDEVICE9 device = bd->pd3dDevice;
  161. // Catch up with texture updates. Most of the times, the list will have 1 element with an OK status, aka nothing to do.
  162. // (This almost always points to ImGui::GetPlatformIO().Textures[] but is part of ImDrawData to allow overriding or disabling texture updates).
  163. if (draw_data->Textures != nullptr)
  164. for (ImTextureData* tex : *draw_data->Textures)
  165. if (tex->Status != ImTextureStatus_OK)
  166. ImGui_ImplDX9_UpdateTexture(tex);
  167. // Create and grow buffers if needed
  168. if (!bd->pVB || bd->VertexBufferSize < draw_data->TotalVtxCount)
  169. {
  170. if (bd->pVB) { bd->pVB->Release(); bd->pVB = nullptr; }
  171. bd->VertexBufferSize = draw_data->TotalVtxCount + 5000;
  172. if (device->CreateVertexBuffer(bd->VertexBufferSize * sizeof(CUSTOMVERTEX), D3DUSAGE_DYNAMIC | D3DUSAGE_WRITEONLY, D3DFVF_CUSTOMVERTEX, D3DPOOL_DEFAULT, &bd->pVB, nullptr) < 0)
  173. return;
  174. }
  175. if (!bd->pIB || bd->IndexBufferSize < draw_data->TotalIdxCount)
  176. {
  177. if (bd->pIB) { bd->pIB->Release(); bd->pIB = nullptr; }
  178. bd->IndexBufferSize = draw_data->TotalIdxCount + 10000;
  179. if (device->CreateIndexBuffer(bd->IndexBufferSize * sizeof(ImDrawIdx), D3DUSAGE_DYNAMIC | D3DUSAGE_WRITEONLY, sizeof(ImDrawIdx) == 2 ? D3DFMT_INDEX16 : D3DFMT_INDEX32, D3DPOOL_DEFAULT, &bd->pIB, nullptr) < 0)
  180. return;
  181. }
  182. // Backup the DX9 state
  183. IDirect3DStateBlock9* state_block = nullptr;
  184. if (device->CreateStateBlock(D3DSBT_ALL, &state_block) < 0)
  185. return;
  186. if (state_block->Capture() < 0)
  187. {
  188. state_block->Release();
  189. return;
  190. }
  191. // Backup the DX9 transform (DX9 documentation suggests that it is included in the StateBlock but it doesn't appear to)
  192. D3DMATRIX last_world, last_view, last_projection;
  193. device->GetTransform(D3DTS_WORLD, &last_world);
  194. device->GetTransform(D3DTS_VIEW, &last_view);
  195. device->GetTransform(D3DTS_PROJECTION, &last_projection);
  196. // Allocate buffers
  197. CUSTOMVERTEX* vtx_dst;
  198. ImDrawIdx* idx_dst;
  199. if (bd->pVB->Lock(0, (UINT)(draw_data->TotalVtxCount * sizeof(CUSTOMVERTEX)), (void**)&vtx_dst, D3DLOCK_DISCARD) < 0)
  200. {
  201. state_block->Release();
  202. return;
  203. }
  204. if (bd->pIB->Lock(0, (UINT)(draw_data->TotalIdxCount * sizeof(ImDrawIdx)), (void**)&idx_dst, D3DLOCK_DISCARD) < 0)
  205. {
  206. bd->pVB->Unlock();
  207. state_block->Release();
  208. return;
  209. }
  210. // Copy and convert all vertices into a single contiguous buffer, convert colors to DX9 default format.
  211. // FIXME-OPT: This is a minor waste of resource, the ideal is to use imconfig.h and
  212. // 1) to avoid repacking colors: #define IMGUI_USE_BGRA_PACKED_COLOR
  213. // 2) to avoid repacking vertices: #define IMGUI_OVERRIDE_DRAWVERT_STRUCT_LAYOUT struct ImDrawVert { ImVec2 pos; float z; ImU32 col; ImVec2 uv; }
  214. for (const ImDrawList* draw_list : draw_data->CmdLists)
  215. {
  216. const ImDrawVert* vtx_src = draw_list->VtxBuffer.Data;
  217. for (int i = 0; i < draw_list->VtxBuffer.Size; i++)
  218. {
  219. vtx_dst->pos[0] = vtx_src->pos.x;
  220. vtx_dst->pos[1] = vtx_src->pos.y;
  221. vtx_dst->pos[2] = 0.0f;
  222. vtx_dst->col = IMGUI_COL_TO_DX9_ARGB(vtx_src->col);
  223. vtx_dst->uv[0] = vtx_src->uv.x;
  224. vtx_dst->uv[1] = vtx_src->uv.y;
  225. vtx_dst++;
  226. vtx_src++;
  227. }
  228. memcpy(idx_dst, draw_list->IdxBuffer.Data, draw_list->IdxBuffer.Size * sizeof(ImDrawIdx));
  229. idx_dst += draw_list->IdxBuffer.Size;
  230. }
  231. bd->pVB->Unlock();
  232. bd->pIB->Unlock();
  233. device->SetStreamSource(0, bd->pVB, 0, sizeof(CUSTOMVERTEX));
  234. device->SetIndices(bd->pIB);
  235. device->SetFVF(D3DFVF_CUSTOMVERTEX);
  236. // Setup desired DX state
  237. ImGui_ImplDX9_SetupRenderState(draw_data);
  238. // Render command lists
  239. // (Because we merged all buffers into a single one, we maintain our own offset into them)
  240. int global_vtx_offset = 0;
  241. int global_idx_offset = 0;
  242. ImVec2 clip_off = draw_data->DisplayPos;
  243. for (const ImDrawList* draw_list : draw_data->CmdLists)
  244. {
  245. for (int cmd_i = 0; cmd_i < draw_list->CmdBuffer.Size; cmd_i++)
  246. {
  247. const ImDrawCmd* pcmd = &draw_list->CmdBuffer[cmd_i];
  248. if (pcmd->UserCallback != nullptr)
  249. {
  250. // User callback, registered via ImDrawList::AddCallback()
  251. // (ImDrawCallback_ResetRenderState is a special callback value used by the user to request the renderer to reset render state.)
  252. if (pcmd->UserCallback == ImDrawCallback_ResetRenderState)
  253. ImGui_ImplDX9_SetupRenderState(draw_data);
  254. else
  255. pcmd->UserCallback(draw_list, pcmd);
  256. }
  257. else
  258. {
  259. // Project scissor/clipping rectangles into framebuffer space
  260. ImVec2 clip_min(pcmd->ClipRect.x - clip_off.x, pcmd->ClipRect.y - clip_off.y);
  261. ImVec2 clip_max(pcmd->ClipRect.z - clip_off.x, pcmd->ClipRect.w - clip_off.y);
  262. if (clip_max.x <= clip_min.x || clip_max.y <= clip_min.y)
  263. continue;
  264. // Apply scissor/clipping rectangle
  265. const RECT r = { (LONG)clip_min.x, (LONG)clip_min.y, (LONG)clip_max.x, (LONG)clip_max.y };
  266. device->SetScissorRect(&r);
  267. // Bind texture, Draw
  268. const LPDIRECT3DTEXTURE9 texture = (LPDIRECT3DTEXTURE9)pcmd->GetTexID();
  269. device->SetTexture(0, texture);
  270. device->DrawIndexedPrimitive(D3DPT_TRIANGLELIST, pcmd->VtxOffset + global_vtx_offset, 0, (UINT)draw_list->VtxBuffer.Size, pcmd->IdxOffset + global_idx_offset, pcmd->ElemCount / 3);
  271. }
  272. }
  273. global_idx_offset += draw_list->IdxBuffer.Size;
  274. global_vtx_offset += draw_list->VtxBuffer.Size;
  275. }
  276. // When using multi-viewports, it appears that there's an odd logic in DirectX9 which prevent subsequent windows
  277. // from rendering until the first window submits at least one draw call, even once. That's our workaround. (see #2560)
  278. if (global_vtx_offset == 0)
  279. bd->pd3dDevice->DrawIndexedPrimitive(D3DPT_TRIANGLELIST, 0, 0, 0, 0, 0);
  280. // Restore the DX9 transform
  281. device->SetTransform(D3DTS_WORLD, &last_world);
  282. device->SetTransform(D3DTS_VIEW, &last_view);
  283. device->SetTransform(D3DTS_PROJECTION, &last_projection);
  284. // Restore the DX9 state
  285. state_block->Apply();
  286. state_block->Release();
  287. }
  288. static bool ImGui_ImplDX9_CheckFormatSupport(LPDIRECT3DDEVICE9 pDevice, D3DFORMAT format)
  289. {
  290. LPDIRECT3D9 pd3d = nullptr;
  291. if (pDevice->GetDirect3D(&pd3d) != D3D_OK)
  292. return false;
  293. D3DDEVICE_CREATION_PARAMETERS param = {};
  294. D3DDISPLAYMODE mode = {};
  295. if (pDevice->GetCreationParameters(&param) != D3D_OK || pDevice->GetDisplayMode(0, &mode) != D3D_OK)
  296. {
  297. pd3d->Release();
  298. return false;
  299. }
  300. // Font texture should support linear filter, color blend and write to render-target
  301. bool support = (pd3d->CheckDeviceFormat(param.AdapterOrdinal, param.DeviceType, mode.Format, D3DUSAGE_DYNAMIC | D3DUSAGE_QUERY_FILTER | D3DUSAGE_QUERY_POSTPIXELSHADER_BLENDING, D3DRTYPE_TEXTURE, format)) == D3D_OK;
  302. pd3d->Release();
  303. return support;
  304. }
  305. bool ImGui_ImplDX9_Init(IDirect3DDevice9* device)
  306. {
  307. ImGuiIO& io = ImGui::GetIO();
  308. IMGUI_CHECKVERSION();
  309. IM_ASSERT(io.BackendRendererUserData == nullptr && "Already initialized a renderer backend!");
  310. // Setup backend capabilities flags
  311. ImGui_ImplDX9_Data* bd = IM_NEW(ImGui_ImplDX9_Data)();
  312. io.BackendRendererUserData = (void*)bd;
  313. io.BackendRendererName = "imgui_impl_dx9";
  314. io.BackendFlags |= ImGuiBackendFlags_RendererHasVtxOffset; // We can honor the ImDrawCmd::VtxOffset field, allowing for large meshes.
  315. io.BackendFlags |= ImGuiBackendFlags_RendererHasTextures; // We can honor ImGuiPlatformIO::Textures[] requests during render.
  316. io.BackendFlags |= ImGuiBackendFlags_RendererHasViewports; // We can create multi-viewports on the Renderer side (optional)
  317. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  318. platform_io.Renderer_TextureMaxWidth = platform_io.Renderer_TextureMaxHeight = 4096;
  319. bd->pd3dDevice = device;
  320. bd->pd3dDevice->AddRef();
  321. bd->HasRgbaSupport = ImGui_ImplDX9_CheckFormatSupport(bd->pd3dDevice, D3DFMT_A8B8G8R8);
  322. ImGui_ImplDX9_InitMultiViewportSupport();
  323. return true;
  324. }
  325. void ImGui_ImplDX9_Shutdown()
  326. {
  327. ImGui_ImplDX9_Data* bd = ImGui_ImplDX9_GetBackendData();
  328. IM_ASSERT(bd != nullptr && "No renderer backend to shutdown, or already shutdown?");
  329. ImGuiIO& io = ImGui::GetIO();
  330. ImGui_ImplDX9_ShutdownMultiViewportSupport();
  331. ImGui_ImplDX9_InvalidateDeviceObjects();
  332. if (bd->pd3dDevice) { bd->pd3dDevice->Release(); }
  333. io.BackendRendererName = nullptr;
  334. io.BackendRendererUserData = nullptr;
  335. io.BackendFlags &= ~(ImGuiBackendFlags_RendererHasVtxOffset | ImGuiBackendFlags_RendererHasTextures | ImGuiBackendFlags_RendererHasViewports);
  336. IM_DELETE(bd);
  337. }
  338. // Convert RGBA32 to BGRA32 (because RGBA32 is not well supported by DX9 devices)
  339. static void ImGui_ImplDX9_CopyTextureRegion(bool tex_use_colors, const ImU32* src, int src_pitch, ImU32* dst, int dst_pitch, int w, int h)
  340. {
  341. #ifndef IMGUI_USE_BGRA_PACKED_COLOR
  342. ImGui_ImplDX9_Data* bd = ImGui_ImplDX9_GetBackendData();
  343. const bool convert_rgba_to_bgra = (!bd->HasRgbaSupport && tex_use_colors);
  344. #else
  345. const bool convert_rgba_to_bgra = false;
  346. IM_UNUSED(tex_use_colors);
  347. #endif
  348. for (int y = 0; y < h; y++)
  349. {
  350. const ImU32* src_p = (const ImU32*)(const void*)((const unsigned char*)src + src_pitch * y);
  351. ImU32* dst_p = (ImU32*)(void*)((unsigned char*)dst + dst_pitch * y);
  352. if (convert_rgba_to_bgra)
  353. for (int x = w; x > 0; x--, src_p++, dst_p++) // Convert copy
  354. *dst_p = IMGUI_COL_TO_DX9_ARGB(*src_p);
  355. else
  356. memcpy(dst_p, src_p, w * 4); // Raw copy
  357. }
  358. }
  359. void ImGui_ImplDX9_UpdateTexture(ImTextureData* tex)
  360. {
  361. ImGui_ImplDX9_Data* bd = ImGui_ImplDX9_GetBackendData();
  362. if (tex->Status == ImTextureStatus_WantCreate)
  363. {
  364. // Create and upload new texture to graphics system
  365. //IMGUI_DEBUG_LOG("UpdateTexture #%03d: WantCreate %dx%d\n", tex->UniqueID, tex->Width, tex->Height);
  366. IM_ASSERT(tex->TexID == ImTextureID_Invalid && tex->BackendUserData == nullptr);
  367. IM_ASSERT(tex->Format == ImTextureFormat_RGBA32);
  368. LPDIRECT3DTEXTURE9 dx_tex = nullptr;
  369. HRESULT hr = bd->pd3dDevice->CreateTexture(tex->Width, tex->Height, 1, D3DUSAGE_DYNAMIC, bd->HasRgbaSupport ? D3DFMT_A8B8G8R8 : D3DFMT_A8R8G8B8, D3DPOOL_DEFAULT, &dx_tex, nullptr);
  370. if (hr < 0)
  371. {
  372. IM_ASSERT(hr >= 0 && "Backend failed to create texture!");
  373. return;
  374. }
  375. D3DLOCKED_RECT locked_rect;
  376. if (dx_tex->LockRect(0, &locked_rect, nullptr, 0) == D3D_OK)
  377. {
  378. ImGui_ImplDX9_CopyTextureRegion(tex->UseColors, (ImU32*)tex->GetPixels(), tex->Width * 4, (ImU32*)locked_rect.pBits, (ImU32)locked_rect.Pitch, tex->Width, tex->Height);
  379. dx_tex->UnlockRect(0);
  380. }
  381. // Store identifiers
  382. tex->SetTexID((ImTextureID)(intptr_t)dx_tex);
  383. tex->SetStatus(ImTextureStatus_OK);
  384. }
  385. else if (tex->Status == ImTextureStatus_WantUpdates)
  386. {
  387. // Update selected blocks. We only ever write to textures regions which have never been used before!
  388. // This backend choose to use tex->Updates[] but you can use tex->UpdateRect to upload a single region.
  389. LPDIRECT3DTEXTURE9 backend_tex = (LPDIRECT3DTEXTURE9)(intptr_t)tex->TexID;
  390. RECT update_rect = { (LONG)tex->UpdateRect.x, (LONG)tex->UpdateRect.y, (LONG)(tex->UpdateRect.x + tex->UpdateRect.w), (LONG)(tex->UpdateRect.y + tex->UpdateRect.h) };
  391. D3DLOCKED_RECT locked_rect;
  392. if (backend_tex->LockRect(0, &locked_rect, &update_rect, 0) == D3D_OK)
  393. for (ImTextureRect& r : tex->Updates)
  394. ImGui_ImplDX9_CopyTextureRegion(tex->UseColors, (ImU32*)tex->GetPixelsAt(r.x, r.y), tex->Width * 4,
  395. (ImU32*)locked_rect.pBits + (r.x - update_rect.left) + (r.y - update_rect.top) * (locked_rect.Pitch / 4), (int)locked_rect.Pitch, r.w, r.h);
  396. backend_tex->UnlockRect(0);
  397. tex->SetStatus(ImTextureStatus_OK);
  398. }
  399. else if (tex->Status == ImTextureStatus_WantDestroy)
  400. {
  401. LPDIRECT3DTEXTURE9 backend_tex = (LPDIRECT3DTEXTURE9)tex->TexID;
  402. if (backend_tex == nullptr)
  403. return;
  404. IM_ASSERT(tex->TexID == (ImTextureID)(intptr_t)backend_tex);
  405. backend_tex->Release();
  406. // Clear identifiers and mark as destroyed (in order to allow e.g. calling InvalidateDeviceObjects while running)
  407. tex->SetTexID(ImTextureID_Invalid);
  408. tex->SetStatus(ImTextureStatus_Destroyed);
  409. }
  410. }
  411. bool ImGui_ImplDX9_CreateDeviceObjects()
  412. {
  413. ImGui_ImplDX9_Data* bd = ImGui_ImplDX9_GetBackendData();
  414. if (!bd || !bd->pd3dDevice)
  415. return false;
  416. ImGui_ImplDX9_CreateDeviceObjectsForPlatformWindows();
  417. return true;
  418. }
  419. void ImGui_ImplDX9_InvalidateDeviceObjects()
  420. {
  421. ImGui_ImplDX9_Data* bd = ImGui_ImplDX9_GetBackendData();
  422. if (!bd || !bd->pd3dDevice)
  423. return;
  424. // Destroy all textures
  425. for (ImTextureData* tex : ImGui::GetPlatformIO().Textures)
  426. if (tex->RefCount == 1)
  427. {
  428. tex->SetStatus(ImTextureStatus_WantDestroy);
  429. ImGui_ImplDX9_UpdateTexture(tex);
  430. }
  431. if (bd->pVB) { bd->pVB->Release(); bd->pVB = nullptr; }
  432. if (bd->pIB) { bd->pIB->Release(); bd->pIB = nullptr; }
  433. ImGui_ImplDX9_InvalidateDeviceObjectsForPlatformWindows();
  434. }
  435. void ImGui_ImplDX9_NewFrame()
  436. {
  437. ImGui_ImplDX9_Data* bd = ImGui_ImplDX9_GetBackendData();
  438. IM_ASSERT(bd != nullptr && "Context or backend not initialized! Did you call ImGui_ImplDX9_Init()?");
  439. IM_UNUSED(bd);
  440. }
  441. //--------------------------------------------------------------------------------------------------------
  442. // MULTI-VIEWPORT / PLATFORM INTERFACE SUPPORT
  443. // This is an _advanced_ and _optional_ feature, allowing the backend to create and handle multiple viewports simultaneously.
  444. // 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..
  445. //--------------------------------------------------------------------------------------------------------
  446. // Helper structure we store in the void* RendererUserData field of each ImGuiViewport to easily retrieve our backend data.
  447. struct ImGui_ImplDX9_ViewportData
  448. {
  449. IDirect3DSwapChain9* SwapChain;
  450. D3DPRESENT_PARAMETERS d3dpp;
  451. ImGui_ImplDX9_ViewportData() { SwapChain = nullptr; ZeroMemory(&d3dpp, sizeof(D3DPRESENT_PARAMETERS)); }
  452. ~ImGui_ImplDX9_ViewportData() { IM_ASSERT(SwapChain == nullptr); }
  453. };
  454. static void ImGui_ImplDX9_CreateWindow(ImGuiViewport* viewport)
  455. {
  456. ImGui_ImplDX9_Data* bd = ImGui_ImplDX9_GetBackendData();
  457. ImGui_ImplDX9_ViewportData* vd = IM_NEW(ImGui_ImplDX9_ViewportData)();
  458. viewport->RendererUserData = vd;
  459. // PlatformHandleRaw should always be a HWND, whereas PlatformHandle might be a higher-level handle (e.g. GLFWWindow*, SDL's WindowID).
  460. // Some backends will leave PlatformHandleRaw == 0, in which case we assume PlatformHandle will contain the HWND.
  461. HWND hwnd = viewport->PlatformHandleRaw ? (HWND)viewport->PlatformHandleRaw : (HWND)viewport->PlatformHandle;
  462. IM_ASSERT(hwnd != 0);
  463. ZeroMemory(&vd->d3dpp, sizeof(D3DPRESENT_PARAMETERS));
  464. vd->d3dpp.Windowed = TRUE;
  465. vd->d3dpp.SwapEffect = D3DSWAPEFFECT_DISCARD;
  466. vd->d3dpp.BackBufferWidth = (UINT)viewport->Size.x;
  467. vd->d3dpp.BackBufferHeight = (UINT)viewport->Size.y;
  468. vd->d3dpp.BackBufferFormat = D3DFMT_UNKNOWN;
  469. vd->d3dpp.hDeviceWindow = hwnd;
  470. vd->d3dpp.EnableAutoDepthStencil = FALSE;
  471. vd->d3dpp.AutoDepthStencilFormat = D3DFMT_D16;
  472. vd->d3dpp.PresentationInterval = D3DPRESENT_INTERVAL_IMMEDIATE; // Present without vsync
  473. HRESULT hr = bd->pd3dDevice->CreateAdditionalSwapChain(&vd->d3dpp, &vd->SwapChain); IM_UNUSED(hr);
  474. IM_ASSERT(hr == D3D_OK);
  475. IM_ASSERT(vd->SwapChain != nullptr);
  476. }
  477. static void ImGui_ImplDX9_DestroyWindow(ImGuiViewport* viewport)
  478. {
  479. // The main viewport (owned by the application) will always have RendererUserData == 0 since we didn't create the data for it.
  480. if (ImGui_ImplDX9_ViewportData* vd = (ImGui_ImplDX9_ViewportData*)viewport->RendererUserData)
  481. {
  482. if (vd->SwapChain)
  483. vd->SwapChain->Release();
  484. vd->SwapChain = nullptr;
  485. ZeroMemory(&vd->d3dpp, sizeof(D3DPRESENT_PARAMETERS));
  486. IM_DELETE(vd);
  487. }
  488. viewport->RendererUserData = nullptr;
  489. }
  490. static void ImGui_ImplDX9_SetWindowSize(ImGuiViewport* viewport, ImVec2 size)
  491. {
  492. ImGui_ImplDX9_Data* bd = ImGui_ImplDX9_GetBackendData();
  493. ImGui_ImplDX9_ViewportData* vd = (ImGui_ImplDX9_ViewportData*)viewport->RendererUserData;
  494. if (vd->SwapChain)
  495. {
  496. vd->SwapChain->Release();
  497. vd->SwapChain = nullptr;
  498. vd->d3dpp.BackBufferWidth = (UINT)size.x;
  499. vd->d3dpp.BackBufferHeight = (UINT)size.y;
  500. HRESULT hr = bd->pd3dDevice->CreateAdditionalSwapChain(&vd->d3dpp, &vd->SwapChain); IM_UNUSED(hr);
  501. IM_ASSERT(hr == D3D_OK);
  502. }
  503. }
  504. static void ImGui_ImplDX9_RenderWindow(ImGuiViewport* viewport, void*)
  505. {
  506. ImGui_ImplDX9_Data* bd = ImGui_ImplDX9_GetBackendData();
  507. ImGui_ImplDX9_ViewportData* vd = (ImGui_ImplDX9_ViewportData*)viewport->RendererUserData;
  508. ImVec4 clear_color = ImVec4(0.0f, 0.0f, 0.0f, 1.0f);
  509. LPDIRECT3DSURFACE9 render_target = nullptr;
  510. LPDIRECT3DSURFACE9 last_render_target = nullptr;
  511. LPDIRECT3DSURFACE9 last_depth_stencil = nullptr;
  512. vd->SwapChain->GetBackBuffer(0, D3DBACKBUFFER_TYPE_MONO, &render_target);
  513. bd->pd3dDevice->GetRenderTarget(0, &last_render_target);
  514. bd->pd3dDevice->GetDepthStencilSurface(&last_depth_stencil);
  515. bd->pd3dDevice->SetRenderTarget(0, render_target);
  516. bd->pd3dDevice->SetDepthStencilSurface(nullptr);
  517. if (!(viewport->Flags & ImGuiViewportFlags_NoRendererClear))
  518. {
  519. D3DCOLOR clear_col_dx = D3DCOLOR_RGBA((int)(clear_color.x*255.0f), (int)(clear_color.y*255.0f), (int)(clear_color.z*255.0f), (int)(clear_color.w*255.0f));
  520. bd->pd3dDevice->Clear(0, nullptr, D3DCLEAR_TARGET, clear_col_dx, 1.0f, 0);
  521. }
  522. ImGui_ImplDX9_RenderDrawData(viewport->DrawData);
  523. // Restore render target
  524. bd->pd3dDevice->SetRenderTarget(0, last_render_target);
  525. bd->pd3dDevice->SetDepthStencilSurface(last_depth_stencil);
  526. render_target->Release();
  527. last_render_target->Release();
  528. if (last_depth_stencil) last_depth_stencil->Release();
  529. }
  530. static void ImGui_ImplDX9_SwapBuffers(ImGuiViewport* viewport, void*)
  531. {
  532. ImGui_ImplDX9_ViewportData* vd = (ImGui_ImplDX9_ViewportData*)viewport->RendererUserData;
  533. HRESULT hr = vd->SwapChain->Present(nullptr, nullptr, vd->d3dpp.hDeviceWindow, nullptr, 0);
  534. // Let main application handle D3DERR_DEVICELOST by resetting the device.
  535. IM_ASSERT(SUCCEEDED(hr) || hr == D3DERR_DEVICELOST);
  536. }
  537. static void ImGui_ImplDX9_InitMultiViewportSupport()
  538. {
  539. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  540. platform_io.Renderer_CreateWindow = ImGui_ImplDX9_CreateWindow;
  541. platform_io.Renderer_DestroyWindow = ImGui_ImplDX9_DestroyWindow;
  542. platform_io.Renderer_SetWindowSize = ImGui_ImplDX9_SetWindowSize;
  543. platform_io.Renderer_RenderWindow = ImGui_ImplDX9_RenderWindow;
  544. platform_io.Renderer_SwapBuffers = ImGui_ImplDX9_SwapBuffers;
  545. }
  546. static void ImGui_ImplDX9_ShutdownMultiViewportSupport()
  547. {
  548. ImGui::DestroyPlatformWindows();
  549. }
  550. static void ImGui_ImplDX9_CreateDeviceObjectsForPlatformWindows()
  551. {
  552. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  553. for (int i = 1; i < platform_io.Viewports.Size; i++)
  554. if (!platform_io.Viewports[i]->RendererUserData)
  555. ImGui_ImplDX9_CreateWindow(platform_io.Viewports[i]);
  556. }
  557. static void ImGui_ImplDX9_InvalidateDeviceObjectsForPlatformWindows()
  558. {
  559. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  560. for (int i = 1; i < platform_io.Viewports.Size; i++)
  561. if (platform_io.Viewports[i]->RendererUserData)
  562. ImGui_ImplDX9_DestroyWindow(platform_io.Viewports[i]);
  563. }
  564. //-----------------------------------------------------------------------------
  565. #endif // #ifndef IMGUI_DISABLE