imgui_impl_sdlgpu3.cpp 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693
  1. // dear imgui: Renderer Backend for SDL_GPU
  2. // This needs to be used along with the SDL3 Platform Backend
  3. // Implemented features:
  4. // [X] Renderer: User texture binding. Use simply cast a reference to your SDL_GPUTextureSamplerBinding to ImTextureID.
  5. // [X] Renderer: Large meshes support (64k+ vertices) with 16-bit indices.
  6. // [X] Renderer: Multi-viewport support (multiple windows).
  7. // The aim of imgui_impl_sdlgpu3.h/.cpp is to be usable in your engine without any modification.
  8. // IF YOU FEEL YOU NEED TO MAKE ANY CHANGE TO THIS CODE, please share them and your feedback at https://github.com/ocornut/imgui/
  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. // Important note to the reader who wish to integrate imgui_impl_sdlgpu3.cpp/.h in their own engine/app.
  17. // - Unlike other backends, the user must call the function ImGui_ImplSDLGPU3_PrepareDrawData() BEFORE issuing a SDL_GPURenderPass containing ImGui_ImplSDLGPU3_RenderDrawData.
  18. // Calling the function is MANDATORY, otherwise the ImGui will not upload neither the vertex nor the index buffer for the GPU. See imgui_impl_sdlgpu3.cpp for more info.
  19. // CHANGELOG
  20. // 2025-03-30: Made ImGui_ImplSDLGPU3_PrepareDrawData() reuse GPU Transfer Buffers which were unusually slow to recreate every frame. Much faster now.
  21. // 2025-03-21: Fixed typo in function name Imgui_ImplSDLGPU3_PrepareDrawData() -> ImGui_ImplSDLGPU3_PrepareDrawData().
  22. // 2025-01-16: Renamed ImGui_ImplSDLGPU3_InitInfo::GpuDevice to Device.
  23. // 2025-01-09: SDL_GPU: Added the SDL_GPU3 backend.
  24. #include "imgui.h"
  25. #ifndef IMGUI_DISABLE
  26. #include "imgui_impl_sdlgpu3.h"
  27. #include "imgui_impl_sdlgpu3_shaders.h"
  28. // SDL_GPU Data
  29. // Reusable buffers used for rendering 1 current in-flight frame, for ImGui_ImplSDLGPU3_RenderDrawData()
  30. struct ImGui_ImplSDLGPU3_FrameData
  31. {
  32. SDL_GPUBuffer* VertexBuffer = nullptr;
  33. SDL_GPUTransferBuffer* VertexTransferBuffer = nullptr;
  34. uint32_t VertexBufferSize = 0;
  35. SDL_GPUBuffer* IndexBuffer = nullptr;
  36. SDL_GPUTransferBuffer* IndexTransferBuffer = nullptr;
  37. uint32_t IndexBufferSize = 0;
  38. };
  39. struct ImGui_ImplSDLGPU3_Data
  40. {
  41. ImGui_ImplSDLGPU3_InitInfo InitInfo;
  42. // Graphics pipeline & shaders
  43. SDL_GPUShader* VertexShader = nullptr;
  44. SDL_GPUShader* FragmentShader = nullptr;
  45. SDL_GPUGraphicsPipeline* Pipeline = nullptr;
  46. // Font data
  47. SDL_GPUSampler* FontSampler = nullptr;
  48. SDL_GPUTexture* FontTexture = nullptr;
  49. SDL_GPUTextureSamplerBinding FontBinding = { nullptr, nullptr };
  50. // Frame data for main window
  51. ImGui_ImplSDLGPU3_FrameData MainWindowFrameData;
  52. };
  53. // Forward Declarations
  54. static void ImGui_ImplSDLGPU3_DestroyFrameData();
  55. //-----------------------------------------------------------------------------
  56. // FUNCTIONS
  57. //-----------------------------------------------------------------------------
  58. // Backend data stored in io.BackendRendererUserData to allow support for multiple Dear ImGui contexts
  59. // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
  60. // FIXME: multi-context support has never been tested.
  61. static ImGui_ImplSDLGPU3_Data* ImGui_ImplSDLGPU3_GetBackendData()
  62. {
  63. return ImGui::GetCurrentContext() ? (ImGui_ImplSDLGPU3_Data*)ImGui::GetIO().BackendRendererUserData : nullptr;
  64. }
  65. static void ImGui_ImplSDLGPU3_SetupRenderState(ImDrawData* draw_data, SDL_GPUGraphicsPipeline* pipeline, SDL_GPUCommandBuffer* command_buffer, SDL_GPURenderPass * render_pass, ImGui_ImplSDLGPU3_FrameData* fd, uint32_t fb_width, uint32_t fb_height)
  66. {
  67. //ImGui_ImplSDLGPU3_Data* bd = ImGui_ImplSDLGPU3_GetBackendData();
  68. // Bind graphics pipeline
  69. SDL_BindGPUGraphicsPipeline(render_pass,pipeline);
  70. // Bind Vertex And Index Buffers
  71. if (draw_data->TotalVtxCount > 0)
  72. {
  73. SDL_GPUBufferBinding vertex_buffer_binding = {};
  74. vertex_buffer_binding.buffer = fd->VertexBuffer;
  75. vertex_buffer_binding.offset = 0;
  76. SDL_GPUBufferBinding index_buffer_binding = {};
  77. index_buffer_binding.buffer = fd->IndexBuffer;
  78. index_buffer_binding.offset = 0;
  79. SDL_BindGPUVertexBuffers(render_pass,0, &vertex_buffer_binding, 1);
  80. SDL_BindGPUIndexBuffer(render_pass, &index_buffer_binding, sizeof(ImDrawIdx) == 2 ? SDL_GPU_INDEXELEMENTSIZE_16BIT : SDL_GPU_INDEXELEMENTSIZE_32BIT);
  81. }
  82. // Setup viewport
  83. SDL_GPUViewport viewport = {};
  84. viewport.x = 0;
  85. viewport.y = 0;
  86. viewport.w = (float)fb_width;
  87. viewport.h = (float)fb_height;
  88. viewport.min_depth = 0.0f;
  89. viewport.max_depth = 1.0f;
  90. SDL_SetGPUViewport(render_pass, &viewport);
  91. // Setup scale and translation
  92. // Our visible imgui space lies from draw_data->DisplayPps (top left) to draw_data->DisplayPos+data_data->DisplaySize (bottom right). DisplayPos is (0,0) for single viewport apps.
  93. struct UBO { float scale[2]; float translation[2]; } ubo;
  94. ubo.scale[0] = 2.0f / draw_data->DisplaySize.x;
  95. ubo.scale[1] = 2.0f / draw_data->DisplaySize.y;
  96. ubo.translation[0] = -1.0f - draw_data->DisplayPos.x * ubo.scale[0];
  97. ubo.translation[1] = -1.0f - draw_data->DisplayPos.y * ubo.scale[1];
  98. SDL_PushGPUVertexUniformData(command_buffer, 0, &ubo, sizeof(UBO));
  99. }
  100. static void CreateOrResizeBuffers(SDL_GPUBuffer** buffer, SDL_GPUTransferBuffer** transferbuffer, uint32_t* old_size, uint32_t new_size, SDL_GPUBufferUsageFlags usage)
  101. {
  102. ImGui_ImplSDLGPU3_Data* bd = ImGui_ImplSDLGPU3_GetBackendData();
  103. ImGui_ImplSDLGPU3_InitInfo* v = &bd->InitInfo;
  104. // FIXME-OPT: Not optimal, but this is fairly rarely called.
  105. SDL_WaitForGPUIdle(v->Device);
  106. SDL_ReleaseGPUBuffer(v->Device, *buffer);
  107. SDL_ReleaseGPUTransferBuffer(v->Device, *transferbuffer);
  108. SDL_GPUBufferCreateInfo buffer_info = {};
  109. buffer_info.usage = usage;
  110. buffer_info.size = new_size;
  111. buffer_info.props = 0;
  112. *buffer = SDL_CreateGPUBuffer(v->Device, &buffer_info);
  113. *old_size = new_size;
  114. IM_ASSERT(*buffer != nullptr && "Failed to create GPU Buffer, call SDL_GetError() for more information");
  115. SDL_GPUTransferBufferCreateInfo transferbuffer_info = {};
  116. transferbuffer_info.usage = SDL_GPU_TRANSFERBUFFERUSAGE_UPLOAD;
  117. transferbuffer_info.size = new_size;
  118. *transferbuffer = SDL_CreateGPUTransferBuffer(v->Device, &transferbuffer_info);
  119. IM_ASSERT(*transferbuffer != nullptr && "Failed to create GPU Transfer Buffer, call SDL_GetError() for more information");
  120. }
  121. // SDL_GPU doesn't allow copy passes to occur while a render or compute pass is bound!
  122. // The only way to allow a user to supply their own RenderPass (to render to a texture instead of the window for example),
  123. // is to split the upload part of ImGui_ImplSDLGPU3_RenderDrawData() to another function that needs to be called by the user before rendering.
  124. void ImGui_ImplSDLGPU3_PrepareDrawData(ImDrawData* draw_data, SDL_GPUCommandBuffer* command_buffer)
  125. {
  126. // Avoid rendering when minimized, scale coordinates for retina displays (screen coordinates != framebuffer coordinates)
  127. int fb_width = (int)(draw_data->DisplaySize.x * draw_data->FramebufferScale.x);
  128. int fb_height = (int)(draw_data->DisplaySize.y * draw_data->FramebufferScale.y);
  129. if (fb_width <= 0 || fb_height <= 0 || draw_data->TotalVtxCount <= 0)
  130. return;
  131. ImGui_ImplSDLGPU3_Data* bd = ImGui_ImplSDLGPU3_GetBackendData();
  132. ImGui_ImplSDLGPU3_InitInfo* v = &bd->InitInfo;
  133. ImGui_ImplSDLGPU3_FrameData* fd = &bd->MainWindowFrameData;
  134. uint32_t vertex_size = draw_data->TotalVtxCount * sizeof(ImDrawVert);
  135. uint32_t index_size = draw_data->TotalIdxCount * sizeof(ImDrawIdx);
  136. if (fd->VertexBuffer == nullptr || fd->VertexBufferSize < vertex_size)
  137. CreateOrResizeBuffers(&fd->VertexBuffer, &fd->VertexTransferBuffer, &fd->VertexBufferSize, vertex_size, SDL_GPU_BUFFERUSAGE_VERTEX);
  138. if (fd->IndexBuffer == nullptr || fd->IndexBufferSize < index_size)
  139. CreateOrResizeBuffers(&fd->IndexBuffer, &fd->IndexTransferBuffer, &fd->IndexBufferSize, index_size, SDL_GPU_BUFFERUSAGE_INDEX);
  140. ImDrawVert* vtx_dst = (ImDrawVert*)SDL_MapGPUTransferBuffer(v->Device, fd->VertexTransferBuffer, true);
  141. ImDrawIdx* idx_dst = (ImDrawIdx*)SDL_MapGPUTransferBuffer(v->Device, fd->IndexTransferBuffer, true);
  142. for (int n = 0; n < draw_data->CmdListsCount; n++)
  143. {
  144. const ImDrawList* draw_list = draw_data->CmdLists[n];
  145. memcpy(vtx_dst, draw_list->VtxBuffer.Data, draw_list->VtxBuffer.Size * sizeof(ImDrawVert));
  146. memcpy(idx_dst, draw_list->IdxBuffer.Data, draw_list->IdxBuffer.Size * sizeof(ImDrawIdx));
  147. vtx_dst += draw_list->VtxBuffer.Size;
  148. idx_dst += draw_list->IdxBuffer.Size;
  149. }
  150. SDL_UnmapGPUTransferBuffer(v->Device, fd->VertexTransferBuffer);
  151. SDL_UnmapGPUTransferBuffer(v->Device, fd->IndexTransferBuffer);
  152. SDL_GPUTransferBufferLocation vertex_buffer_location = {};
  153. vertex_buffer_location.offset = 0;
  154. vertex_buffer_location.transfer_buffer = fd->VertexTransferBuffer;
  155. SDL_GPUTransferBufferLocation index_buffer_location = {};
  156. index_buffer_location.offset = 0;
  157. index_buffer_location.transfer_buffer = fd->IndexTransferBuffer;
  158. SDL_GPUBufferRegion vertex_buffer_region = {};
  159. vertex_buffer_region.buffer = fd->VertexBuffer;
  160. vertex_buffer_region.offset = 0;
  161. vertex_buffer_region.size = vertex_size;
  162. SDL_GPUBufferRegion index_buffer_region = {};
  163. index_buffer_region.buffer = fd->IndexBuffer;
  164. index_buffer_region.offset = 0;
  165. index_buffer_region.size = index_size;
  166. SDL_GPUCopyPass* copy_pass = SDL_BeginGPUCopyPass(command_buffer);
  167. SDL_UploadToGPUBuffer(copy_pass, &vertex_buffer_location, &vertex_buffer_region, true);
  168. SDL_UploadToGPUBuffer(copy_pass, &index_buffer_location, &index_buffer_region, true);
  169. SDL_EndGPUCopyPass(copy_pass);
  170. }
  171. void ImGui_ImplSDLGPU3_RenderDrawData(ImDrawData* draw_data, SDL_GPUCommandBuffer* command_buffer, SDL_GPURenderPass* render_pass, SDL_GPUGraphicsPipeline* pipeline)
  172. {
  173. // Avoid rendering when minimized, scale coordinates for retina displays (screen coordinates != framebuffer coordinates)
  174. int fb_width = (int)(draw_data->DisplaySize.x * draw_data->FramebufferScale.x);
  175. int fb_height = (int)(draw_data->DisplaySize.y * draw_data->FramebufferScale.y);
  176. if (fb_width <= 0 || fb_height <= 0)
  177. return;
  178. ImGui_ImplSDLGPU3_Data* bd = ImGui_ImplSDLGPU3_GetBackendData();
  179. ImGui_ImplSDLGPU3_FrameData* fd = &bd->MainWindowFrameData;
  180. if (pipeline == nullptr)
  181. pipeline = bd->Pipeline;
  182. ImGui_ImplSDLGPU3_SetupRenderState(draw_data, pipeline, command_buffer, render_pass, fd, fb_width, fb_height);
  183. // Will project scissor/clipping rectangles into framebuffer space
  184. ImVec2 clip_off = draw_data->DisplayPos; // (0,0) unless using multi-viewports
  185. ImVec2 clip_scale = draw_data->FramebufferScale; // (1,1) unless using retina display which are often (2,2)
  186. // Render command lists
  187. // (Because we merged all buffers into a single one, we maintain our own offset into them)
  188. int global_vtx_offset = 0;
  189. int global_idx_offset = 0;
  190. for (int n = 0; n < draw_data->CmdListsCount; n++)
  191. {
  192. const ImDrawList* draw_list = draw_data->CmdLists[n];
  193. for (int cmd_i = 0; cmd_i < draw_list->CmdBuffer.Size; cmd_i++)
  194. {
  195. const ImDrawCmd* pcmd = &draw_list->CmdBuffer[cmd_i];
  196. if (pcmd->UserCallback != nullptr)
  197. {
  198. pcmd->UserCallback(draw_list, pcmd);
  199. }
  200. else
  201. {
  202. // Project scissor/clipping rectangles into framebuffer space
  203. ImVec2 clip_min((pcmd->ClipRect.x - clip_off.x) * clip_scale.x, (pcmd->ClipRect.y - clip_off.y) * clip_scale.y);
  204. ImVec2 clip_max((pcmd->ClipRect.z - clip_off.x) * clip_scale.x, (pcmd->ClipRect.w - clip_off.y) * clip_scale.y);
  205. // Clamp to viewport as SDL_SetGPUScissor() won't accept values that are off bounds
  206. if (clip_min.x < 0.0f) { clip_min.x = 0.0f; }
  207. if (clip_min.y < 0.0f) { clip_min.y = 0.0f; }
  208. if (clip_max.x > fb_width) { clip_max.x = (float)fb_width; }
  209. if (clip_max.y > fb_height) { clip_max.y = (float)fb_height; }
  210. if (clip_max.x <= clip_min.x || clip_max.y <= clip_min.y)
  211. continue;
  212. // Apply scissor/clipping rectangle
  213. SDL_Rect scissor_rect = {};
  214. scissor_rect.x = (int)clip_min.x;
  215. scissor_rect.y = (int)clip_min.y;
  216. scissor_rect.w = (int)(clip_max.x - clip_min.x);
  217. scissor_rect.h = (int)(clip_max.y - clip_min.y);
  218. SDL_SetGPUScissor(render_pass,&scissor_rect);
  219. // Bind DescriptorSet with font or user texture
  220. SDL_BindGPUFragmentSamplers(render_pass, 0, (SDL_GPUTextureSamplerBinding*)pcmd->GetTexID(), 1);
  221. // Draw
  222. SDL_DrawGPUIndexedPrimitives(render_pass, pcmd->ElemCount, 1, pcmd->IdxOffset + global_idx_offset, pcmd->VtxOffset + global_vtx_offset, 0);
  223. }
  224. }
  225. global_idx_offset += draw_list->IdxBuffer.Size;
  226. global_vtx_offset += draw_list->VtxBuffer.Size;
  227. }
  228. // Note: at this point both SDL_SetGPUViewport() and SDL_SetGPUScissor() have been called.
  229. // Our last values will leak into user/application rendering if you forgot to call SDL_SetGPUViewport() and SDL_SetGPUScissor() yourself to explicitly set that state
  230. // In theory we should aim to backup/restore those values but I am not sure this is possible.
  231. // We perform a call to SDL_SetGPUScissor() to set back a full viewport which is likely to fix things for 99% users but technically this is not perfect. (See github #4644)
  232. SDL_Rect scissor_rect { 0, 0, fb_width, fb_height };
  233. SDL_SetGPUScissor(render_pass, &scissor_rect);
  234. }
  235. void ImGui_ImplSDLGPU3_CreateFontsTexture()
  236. {
  237. ImGuiIO& io = ImGui::GetIO();
  238. ImGui_ImplSDLGPU3_Data* bd = ImGui_ImplSDLGPU3_GetBackendData();
  239. ImGui_ImplSDLGPU3_InitInfo* v = &bd->InitInfo;
  240. // Destroy existing texture (if any)
  241. if (bd->FontTexture)
  242. {
  243. SDL_WaitForGPUIdle(v->Device);
  244. ImGui_ImplSDLGPU3_DestroyFontsTexture();
  245. }
  246. unsigned char* pixels;
  247. int width, height;
  248. io.Fonts->GetTexDataAsRGBA32(&pixels, &width, &height);
  249. uint32_t upload_size = width * height * 4 * sizeof(char);
  250. // Create the Image:
  251. {
  252. SDL_GPUTextureCreateInfo texture_info = {};
  253. texture_info.type = SDL_GPU_TEXTURETYPE_2D;
  254. texture_info.format = SDL_GPU_TEXTUREFORMAT_R8G8B8A8_UNORM;
  255. texture_info.usage = SDL_GPU_TEXTUREUSAGE_SAMPLER;
  256. texture_info.width = width;
  257. texture_info.height = height;
  258. texture_info.layer_count_or_depth = 1;
  259. texture_info.num_levels = 1;
  260. texture_info.sample_count = SDL_GPU_SAMPLECOUNT_1;
  261. bd->FontTexture = SDL_CreateGPUTexture(v->Device, &texture_info);
  262. IM_ASSERT(bd->FontTexture && "Failed to create font texture, call SDL_GetError() for more info");
  263. }
  264. // Assign the texture to the TextureSamplerBinding
  265. bd->FontBinding.texture = bd->FontTexture;
  266. // Create all the upload structures and upload:
  267. {
  268. SDL_GPUTransferBufferCreateInfo transferbuffer_info = {};
  269. transferbuffer_info.usage = SDL_GPU_TRANSFERBUFFERUSAGE_UPLOAD;
  270. transferbuffer_info.size = upload_size;
  271. SDL_GPUTransferBuffer* transferbuffer = SDL_CreateGPUTransferBuffer(v->Device, &transferbuffer_info);
  272. IM_ASSERT(transferbuffer != nullptr && "Failed to create font transfer buffer, call SDL_GetError() for more information");
  273. void* texture_ptr = SDL_MapGPUTransferBuffer(v->Device, transferbuffer, false);
  274. memcpy(texture_ptr, pixels, upload_size);
  275. SDL_UnmapGPUTransferBuffer(v->Device, transferbuffer);
  276. SDL_GPUTextureTransferInfo transfer_info = {};
  277. transfer_info.offset = 0;
  278. transfer_info.transfer_buffer = transferbuffer;
  279. SDL_GPUTextureRegion texture_region = {};
  280. texture_region.texture = bd->FontTexture;
  281. texture_region.w = width;
  282. texture_region.h = height;
  283. texture_region.d = 1;
  284. SDL_GPUCommandBuffer* cmd = SDL_AcquireGPUCommandBuffer(v->Device);
  285. SDL_GPUCopyPass* copy_pass = SDL_BeginGPUCopyPass(cmd);
  286. SDL_UploadToGPUTexture(copy_pass, &transfer_info, &texture_region, false);
  287. SDL_EndGPUCopyPass(copy_pass);
  288. SDL_SubmitGPUCommandBuffer(cmd);
  289. SDL_ReleaseGPUTransferBuffer(v->Device, transferbuffer);
  290. }
  291. // Store our identifier
  292. io.Fonts->SetTexID((ImTextureID)&bd->FontBinding);
  293. }
  294. // You probably never need to call this, as it is called by ImGui_ImplSDLGPU3_CreateFontsTexture() and ImGui_ImplSDLGPU3_Shutdown().
  295. void ImGui_ImplSDLGPU3_DestroyFontsTexture()
  296. {
  297. ImGuiIO& io = ImGui::GetIO();
  298. ImGui_ImplSDLGPU3_Data* bd = ImGui_ImplSDLGPU3_GetBackendData();
  299. ImGui_ImplSDLGPU3_InitInfo* v = &bd->InitInfo;
  300. if (bd->FontTexture)
  301. {
  302. SDL_ReleaseGPUTexture(v->Device, bd->FontTexture);
  303. bd->FontBinding.texture = nullptr;
  304. bd->FontTexture = nullptr;
  305. }
  306. io.Fonts->SetTexID(0);
  307. }
  308. static void ImGui_ImplSDLGPU3_CreateShaders()
  309. {
  310. // Create the shader modules
  311. ImGui_ImplSDLGPU3_Data* bd = ImGui_ImplSDLGPU3_GetBackendData();
  312. ImGui_ImplSDLGPU3_InitInfo* v = &bd->InitInfo;
  313. const char* driver = SDL_GetGPUDeviceDriver(v->Device);
  314. SDL_GPUShaderCreateInfo vertex_shader_info = {};
  315. vertex_shader_info.entrypoint = "main";
  316. vertex_shader_info.stage = SDL_GPU_SHADERSTAGE_VERTEX;
  317. vertex_shader_info.num_uniform_buffers = 1;
  318. vertex_shader_info.num_storage_buffers = 0;
  319. vertex_shader_info.num_storage_textures = 0;
  320. vertex_shader_info.num_samplers = 0;
  321. SDL_GPUShaderCreateInfo fragment_shader_info = {};
  322. fragment_shader_info.entrypoint = "main";
  323. fragment_shader_info.stage = SDL_GPU_SHADERSTAGE_FRAGMENT;
  324. fragment_shader_info.num_samplers = 1;
  325. fragment_shader_info.num_storage_buffers = 0;
  326. fragment_shader_info.num_storage_textures = 0;
  327. fragment_shader_info.num_uniform_buffers = 0;
  328. if (strcmp(driver, "vulkan") == 0)
  329. {
  330. vertex_shader_info.format = SDL_GPU_SHADERFORMAT_SPIRV;
  331. vertex_shader_info.code = spirv_vertex;
  332. vertex_shader_info.code_size = sizeof(spirv_vertex);
  333. fragment_shader_info.format = SDL_GPU_SHADERFORMAT_SPIRV;
  334. fragment_shader_info.code = spirv_fragment;
  335. fragment_shader_info.code_size = sizeof(spirv_fragment);
  336. }
  337. else if (strcmp(driver, "direct3d12") == 0)
  338. {
  339. vertex_shader_info.format = SDL_GPU_SHADERFORMAT_DXBC;
  340. vertex_shader_info.code = dxbc_vertex;
  341. vertex_shader_info.code_size = sizeof(dxbc_vertex);
  342. fragment_shader_info.format = SDL_GPU_SHADERFORMAT_DXBC;
  343. fragment_shader_info.code = dxbc_fragment;
  344. fragment_shader_info.code_size = sizeof(dxbc_fragment);
  345. }
  346. #ifdef __APPLE__
  347. else
  348. {
  349. vertex_shader_info.entrypoint = "main0";
  350. vertex_shader_info.format = SDL_GPU_SHADERFORMAT_METALLIB;
  351. vertex_shader_info.code = metallib_vertex;
  352. vertex_shader_info.code_size = sizeof(metallib_vertex);
  353. fragment_shader_info.entrypoint = "main0";
  354. fragment_shader_info.format = SDL_GPU_SHADERFORMAT_METALLIB;
  355. fragment_shader_info.code = metallib_fragment;
  356. fragment_shader_info.code_size = sizeof(metallib_fragment);
  357. }
  358. #endif
  359. bd->VertexShader = SDL_CreateGPUShader(v->Device, &vertex_shader_info);
  360. bd->FragmentShader = SDL_CreateGPUShader(v->Device, &fragment_shader_info);
  361. IM_ASSERT(bd->VertexShader != nullptr && "Failed to create vertex shader, call SDL_GetError() for more information");
  362. IM_ASSERT(bd->FragmentShader != nullptr && "Failed to create fragment shader, call SDL_GetError() for more information");
  363. }
  364. static void ImGui_ImplSDLGPU3_CreateGraphicsPipeline()
  365. {
  366. ImGui_ImplSDLGPU3_Data* bd = ImGui_ImplSDLGPU3_GetBackendData();
  367. ImGui_ImplSDLGPU3_InitInfo* v = &bd->InitInfo;
  368. ImGui_ImplSDLGPU3_CreateShaders();
  369. SDL_GPUVertexBufferDescription vertex_buffer_desc[1];
  370. vertex_buffer_desc[0].slot = 0;
  371. vertex_buffer_desc[0].input_rate = SDL_GPU_VERTEXINPUTRATE_VERTEX;
  372. vertex_buffer_desc[0].instance_step_rate = 0;
  373. vertex_buffer_desc[0].pitch = sizeof(ImDrawVert);
  374. SDL_GPUVertexAttribute vertex_attributes[3];
  375. vertex_attributes[0].buffer_slot = 0;
  376. vertex_attributes[0].format = SDL_GPU_VERTEXELEMENTFORMAT_FLOAT2;
  377. vertex_attributes[0].location = 0;
  378. vertex_attributes[0].offset = offsetof(ImDrawVert,pos);
  379. vertex_attributes[1].buffer_slot = 0;
  380. vertex_attributes[1].format = SDL_GPU_VERTEXELEMENTFORMAT_FLOAT2;
  381. vertex_attributes[1].location = 1;
  382. vertex_attributes[1].offset = offsetof(ImDrawVert, uv);
  383. vertex_attributes[2].buffer_slot = 0;
  384. vertex_attributes[2].format = SDL_GPU_VERTEXELEMENTFORMAT_UBYTE4_NORM;
  385. vertex_attributes[2].location = 2;
  386. vertex_attributes[2].offset = offsetof(ImDrawVert, col);
  387. SDL_GPUVertexInputState vertex_input_state = {};
  388. vertex_input_state.num_vertex_attributes = 3;
  389. vertex_input_state.vertex_attributes = vertex_attributes;
  390. vertex_input_state.num_vertex_buffers = 1;
  391. vertex_input_state.vertex_buffer_descriptions = vertex_buffer_desc;
  392. SDL_GPURasterizerState rasterizer_state = {};
  393. rasterizer_state.fill_mode = SDL_GPU_FILLMODE_FILL;
  394. rasterizer_state.cull_mode = SDL_GPU_CULLMODE_NONE;
  395. rasterizer_state.front_face = SDL_GPU_FRONTFACE_COUNTER_CLOCKWISE;
  396. rasterizer_state.enable_depth_bias = false;
  397. rasterizer_state.enable_depth_clip = false;
  398. SDL_GPUMultisampleState multisample_state = {};
  399. multisample_state.sample_count = v->MSAASamples;
  400. multisample_state.enable_mask = false;
  401. SDL_GPUDepthStencilState depth_stencil_state = {};
  402. depth_stencil_state.enable_depth_test = false;
  403. depth_stencil_state.enable_depth_write = false;
  404. depth_stencil_state.enable_stencil_test = false;
  405. SDL_GPUColorTargetBlendState blend_state = {};
  406. blend_state.enable_blend = true;
  407. blend_state.src_color_blendfactor = SDL_GPU_BLENDFACTOR_SRC_ALPHA;
  408. blend_state.dst_color_blendfactor = SDL_GPU_BLENDFACTOR_ONE_MINUS_SRC_ALPHA;
  409. blend_state.color_blend_op = SDL_GPU_BLENDOP_ADD;
  410. blend_state.src_alpha_blendfactor = SDL_GPU_BLENDFACTOR_ONE;
  411. blend_state.dst_alpha_blendfactor = SDL_GPU_BLENDFACTOR_ONE_MINUS_SRC_ALPHA;
  412. blend_state.alpha_blend_op = SDL_GPU_BLENDOP_ADD;
  413. blend_state.color_write_mask = SDL_GPU_COLORCOMPONENT_R | SDL_GPU_COLORCOMPONENT_G | SDL_GPU_COLORCOMPONENT_B | SDL_GPU_COLORCOMPONENT_A;
  414. SDL_GPUColorTargetDescription color_target_desc[1];
  415. color_target_desc[0].format = v->ColorTargetFormat;
  416. color_target_desc[0].blend_state = blend_state;
  417. SDL_GPUGraphicsPipelineTargetInfo target_info = {};
  418. target_info.num_color_targets = 1;
  419. target_info.color_target_descriptions = color_target_desc;
  420. target_info.has_depth_stencil_target = false;
  421. SDL_GPUGraphicsPipelineCreateInfo pipeline_info = {};
  422. pipeline_info.vertex_shader = bd->VertexShader;
  423. pipeline_info.fragment_shader = bd->FragmentShader;
  424. pipeline_info.vertex_input_state = vertex_input_state;
  425. pipeline_info.primitive_type = SDL_GPU_PRIMITIVETYPE_TRIANGLELIST;
  426. pipeline_info.rasterizer_state = rasterizer_state;
  427. pipeline_info.multisample_state = multisample_state;
  428. pipeline_info.depth_stencil_state = depth_stencil_state;
  429. pipeline_info.target_info = target_info;
  430. bd->Pipeline = SDL_CreateGPUGraphicsPipeline(v->Device, &pipeline_info);
  431. IM_ASSERT(bd->Pipeline != nullptr && "Failed to create graphics pipeline, call SDL_GetError() for more information");
  432. }
  433. void ImGui_ImplSDLGPU3_CreateDeviceObjects()
  434. {
  435. ImGui_ImplSDLGPU3_Data* bd = ImGui_ImplSDLGPU3_GetBackendData();
  436. ImGui_ImplSDLGPU3_InitInfo* v = &bd->InitInfo;
  437. if (!bd->FontSampler)
  438. {
  439. // Bilinear sampling is required by default. Set 'io.Fonts->Flags |= ImFontAtlasFlags_NoBakedLines' or 'style.AntiAliasedLinesUseTex = false' to allow point/nearest sampling.
  440. SDL_GPUSamplerCreateInfo sampler_info = {};
  441. sampler_info.min_filter = SDL_GPU_FILTER_LINEAR;
  442. sampler_info.mag_filter = SDL_GPU_FILTER_LINEAR;
  443. sampler_info.mipmap_mode = SDL_GPU_SAMPLERMIPMAPMODE_LINEAR;
  444. sampler_info.address_mode_u = SDL_GPU_SAMPLERADDRESSMODE_CLAMP_TO_EDGE;
  445. sampler_info.address_mode_v = SDL_GPU_SAMPLERADDRESSMODE_CLAMP_TO_EDGE;
  446. sampler_info.address_mode_w = SDL_GPU_SAMPLERADDRESSMODE_CLAMP_TO_EDGE;
  447. sampler_info.mip_lod_bias = 0.0f;
  448. sampler_info.min_lod = -1000.0f;
  449. sampler_info.max_lod = 1000.0f;
  450. sampler_info.enable_anisotropy = false;
  451. sampler_info.max_anisotropy = 1.0f;
  452. sampler_info.enable_compare = false;
  453. bd->FontSampler = SDL_CreateGPUSampler(v->Device, &sampler_info);
  454. bd->FontBinding.sampler = bd->FontSampler;
  455. IM_ASSERT(bd->FontSampler != nullptr && "Failed to create font sampler, call SDL_GetError() for more information");
  456. }
  457. ImGui_ImplSDLGPU3_CreateGraphicsPipeline();
  458. ImGui_ImplSDLGPU3_CreateFontsTexture();
  459. }
  460. void ImGui_ImplSDLGPU3_DestroyFrameData()
  461. {
  462. ImGui_ImplSDLGPU3_Data* bd = ImGui_ImplSDLGPU3_GetBackendData();
  463. ImGui_ImplSDLGPU3_InitInfo* v = &bd->InitInfo;
  464. ImGui_ImplSDLGPU3_FrameData* fd = &bd->MainWindowFrameData;
  465. SDL_ReleaseGPUBuffer(v->Device, fd->VertexBuffer);
  466. SDL_ReleaseGPUBuffer(v->Device, fd->IndexBuffer);
  467. SDL_ReleaseGPUTransferBuffer(v->Device, fd->VertexTransferBuffer);
  468. SDL_ReleaseGPUTransferBuffer(v->Device, fd->IndexTransferBuffer);
  469. fd->VertexBuffer = fd->IndexBuffer = nullptr;
  470. fd->VertexTransferBuffer = fd->IndexTransferBuffer = nullptr;
  471. fd->VertexBufferSize = fd->IndexBufferSize = 0;
  472. }
  473. void ImGui_ImplSDLGPU3_DestroyDeviceObjects()
  474. {
  475. ImGui_ImplSDLGPU3_Data* bd = ImGui_ImplSDLGPU3_GetBackendData();
  476. ImGui_ImplSDLGPU3_InitInfo* v = &bd->InitInfo;
  477. ImGui_ImplSDLGPU3_DestroyFrameData();
  478. ImGui_ImplSDLGPU3_DestroyFontsTexture();
  479. if (bd->VertexShader) { SDL_ReleaseGPUShader(v->Device, bd->VertexShader); bd->VertexShader = nullptr;}
  480. if (bd->FragmentShader) { SDL_ReleaseGPUShader(v->Device, bd->FragmentShader); bd->FragmentShader = nullptr;}
  481. if (bd->FontSampler) { SDL_ReleaseGPUSampler(v->Device, bd->FontSampler); bd->FontSampler = nullptr;}
  482. if (bd->Pipeline) { SDL_ReleaseGPUGraphicsPipeline(v->Device, bd->Pipeline); bd->Pipeline = nullptr;}
  483. }
  484. static void ImGui_ImplSDLGPU3_InitMultiViewportSupport();
  485. static void ImGui_ImplSDLGPU3_ShutdownMultiViewportSupport();
  486. bool ImGui_ImplSDLGPU3_Init(ImGui_ImplSDLGPU3_InitInfo* info)
  487. {
  488. ImGuiIO& io = ImGui::GetIO();
  489. IMGUI_CHECKVERSION();
  490. IM_ASSERT(io.BackendRendererUserData == nullptr && "Already initialized a renderer backend!");
  491. // Setup backend capabilities flags
  492. ImGui_ImplSDLGPU3_Data* bd = IM_NEW(ImGui_ImplSDLGPU3_Data)();
  493. io.BackendRendererUserData = (void*)bd;
  494. io.BackendRendererName = "imgui_impl_sdlgpu3";
  495. io.BackendFlags |= ImGuiBackendFlags_RendererHasVtxOffset; // We can honor the ImDrawCmd::VtxOffset field, allowing for large meshes.
  496. io.BackendFlags |= ImGuiBackendFlags_RendererHasViewports;
  497. IM_ASSERT(info->Device != nullptr);
  498. IM_ASSERT(info->ColorTargetFormat != SDL_GPU_TEXTUREFORMAT_INVALID);
  499. bd->InitInfo = *info;
  500. ImGui_ImplSDLGPU3_CreateDeviceObjects();
  501. ImGui_ImplSDLGPU3_InitMultiViewportSupport();
  502. return true;
  503. }
  504. void ImGui_ImplSDLGPU3_Shutdown()
  505. {
  506. ImGui_ImplSDLGPU3_Data* bd = ImGui_ImplSDLGPU3_GetBackendData();
  507. IM_ASSERT(bd != nullptr && "No renderer backend to shutdown, or already shutdown?");
  508. ImGuiIO& io = ImGui::GetIO();
  509. ImGui_ImplSDLGPU3_ShutdownMultiViewportSupport();
  510. ImGui_ImplSDLGPU3_DestroyDeviceObjects();
  511. io.BackendRendererName = nullptr;
  512. io.BackendRendererUserData = nullptr;
  513. io.BackendFlags &= ~ImGuiBackendFlags_RendererHasVtxOffset;
  514. IM_DELETE(bd);
  515. }
  516. void ImGui_ImplSDLGPU3_NewFrame()
  517. {
  518. ImGui_ImplSDLGPU3_Data* bd = ImGui_ImplSDLGPU3_GetBackendData();
  519. IM_ASSERT(bd != nullptr && "Context or backend not initialized! Did you call ImGui_ImplSDLGPU3_Init()?");
  520. if (!bd->FontTexture)
  521. ImGui_ImplSDLGPU3_CreateFontsTexture();
  522. }
  523. //--------------------------------------------------------------------------------------------------------
  524. // MULTI-VIEWPORT / PLATFORM INTERFACE SUPPORT
  525. // This is an _advanced_ and _optional_ feature, allowing the backend to create and handle multiple viewports simultaneously.
  526. // 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..
  527. //--------------------------------------------------------------------------------------------------------
  528. static void ImGui_ImplSDLGPU3_CreateWindow(ImGuiViewport* viewport) {
  529. ImGui_ImplSDLGPU3_Data* data = ImGui_ImplSDLGPU3_GetBackendData();
  530. SDL_Window* window = SDL_GetWindowFromID((SDL_WindowID)(intptr_t)viewport->PlatformHandle);
  531. SDL_ClaimWindowForGPUDevice(data->InitInfo.Device, window);
  532. viewport->RendererUserData = (void*)1;
  533. }
  534. static void ImGui_ImplSDLGPU3_RenderWindow(ImGuiViewport* viewport, void*)
  535. {
  536. ImGui_ImplSDLGPU3_Data* data = ImGui_ImplSDLGPU3_GetBackendData();
  537. SDL_Window* window = SDL_GetWindowFromID((SDL_WindowID)(intptr_t)viewport->PlatformHandle);
  538. ImDrawData* draw_data = viewport->DrawData;
  539. SDL_GPUCommandBuffer* command_buffer = SDL_AcquireGPUCommandBuffer(data->InitInfo.Device);
  540. SDL_GPUTexture* swapchain_texture;
  541. SDL_AcquireGPUSwapchainTexture(command_buffer, window, &swapchain_texture, nullptr, nullptr);
  542. if (swapchain_texture != nullptr)
  543. {
  544. ImGui_ImplSDLGPU3_PrepareDrawData(draw_data, command_buffer);
  545. SDL_GPUColorTargetInfo target_info = {};
  546. target_info.texture = swapchain_texture;
  547. target_info.clear_color = SDL_FColor{ 0.0f,0.0f,0.0f,1.0f };
  548. target_info.load_op = SDL_GPU_LOADOP_CLEAR;
  549. target_info.store_op = SDL_GPU_STOREOP_STORE;
  550. target_info.mip_level = 0;
  551. target_info.layer_or_depth_plane = 0;
  552. target_info.cycle = false;
  553. SDL_GPURenderPass* render_pass = SDL_BeginGPURenderPass(command_buffer, &target_info, 1, nullptr);
  554. ImGui_ImplSDLGPU3_RenderDrawData(draw_data, command_buffer, render_pass);
  555. SDL_EndGPURenderPass(render_pass);
  556. }
  557. SDL_SubmitGPUCommandBuffer(command_buffer);
  558. }
  559. static void ImGui_ImplSDLGPU3_DestroyWindow(ImGuiViewport* viewport) {
  560. ImGui_ImplSDLGPU3_Data* data = ImGui_ImplSDLGPU3_GetBackendData();
  561. if (viewport->RendererUserData) {
  562. SDL_Window* window = SDL_GetWindowFromID((SDL_WindowID)(intptr_t)viewport->PlatformHandle);
  563. SDL_ReleaseWindowFromGPUDevice(data->InitInfo.Device, window);
  564. }
  565. viewport->RendererUserData = nullptr;
  566. }
  567. static void ImGui_ImplSDLGPU3_InitMultiViewportSupport() {
  568. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  569. platform_io.Renderer_RenderWindow = ImGui_ImplSDLGPU3_RenderWindow;
  570. platform_io.Renderer_CreateWindow = ImGui_ImplSDLGPU3_CreateWindow;
  571. platform_io.Renderer_DestroyWindow = ImGui_ImplSDLGPU3_DestroyWindow;
  572. }
  573. static void ImGui_ImplSDLGPU3_ShutdownMultiViewportSupport()
  574. {
  575. ImGui::DestroyPlatformWindows();
  576. }
  577. #endif // #ifndef IMGUI_DISABLE