imgui_impl_sdlgpu3.cpp 28 KB

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