imgui_impl_vulkan.cpp 97 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849
  1. // dear imgui: Renderer Backend for Vulkan
  2. // This needs to be used along with a Platform Backend (e.g. GLFW, SDL, Win32, custom..)
  3. // Implemented features:
  4. // [!] Renderer: User texture binding. Use 'VkDescriptorSet' as texture identifier. Call ImGui_ImplVulkan_AddTexture() to register one. Read the FAQ about ImTextureID/ImTextureRef + https://github.com/ocornut/imgui/pull/914 for discussions.
  5. // [X] Renderer: Large meshes support (64k+ vertices) even with 16-bit indices (ImGuiBackendFlags_RendererHasVtxOffset).
  6. // [X] Renderer: Texture updates support for dynamic font atlas (ImGuiBackendFlags_RendererHasTextures).
  7. // [X] Renderer: Expose selected render state for draw callbacks to use. Access in '(ImGui_ImplXXXX_RenderState*)GetPlatformIO().Renderer_RenderState'.
  8. // The aim of imgui_impl_vulkan.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_vulkan.cpp/.h in their own engine/app.
  18. // - Common ImGui_ImplVulkan_XXX functions and structures are used to interface with imgui_impl_vulkan.cpp/.h.
  19. // You will use those if you want to use this rendering backend in your engine/app.
  20. // - Helper ImGui_ImplVulkanH_XXX functions and structures are only used by this example (main.cpp) and by
  21. // the backend itself (imgui_impl_vulkan.cpp), but should PROBABLY NOT be used by your own engine/app code.
  22. // Read comments in imgui_impl_vulkan.h.
  23. // CHANGELOG
  24. // (minor and older changes stripped away, please see git history for details)
  25. // 2025-07-07: Vulkan: Fixed texture synchronization issue introduced on 2025-06-11. (#8772)
  26. // 2025-06-27: Vulkan: Fixed validation errors during texture upload/update by aligning upload size to 'nonCoherentAtomSize'. (#8743, #8744)
  27. // 2025-06-11: Vulkan: Added support for ImGuiBackendFlags_RendererHasTextures, for dynamic font atlas. Removed ImGui_ImplVulkan_CreateFontsTexture() and ImGui_ImplVulkan_DestroyFontsTexture().
  28. // 2025-05-07: Vulkan: Fixed validation errors during window detach in multi-viewport mode. (#8600, #8176)
  29. // 2025-05-07: Vulkan: Load dynamic rendering functions using vkGetDeviceProcAddr() + try both non-KHR and KHR versions. (#8600, #8326, #8365)
  30. // 2025-04-07: Vulkan: Deep-copy ImGui_ImplVulkan_InitInfo::PipelineRenderingCreateInfo's pColorAttachmentFormats buffer when set, in order to reduce common user-error of specifying a pointer to data that gets out of scope. (#8282)
  31. // 2025-02-14: *BREAKING CHANGE*: Added uint32_t api_version to ImGui_ImplVulkan_LoadFunctions().
  32. // 2025-02-13: Vulkan: Added ApiVersion field in ImGui_ImplVulkan_InitInfo. Default to header version if unspecified. Dynamic rendering path loads "vkCmdBeginRendering/vkCmdEndRendering" (without -KHR suffix) on API 1.3. (#8326)
  33. // 2025-01-09: Vulkan: Added IMGUI_IMPL_VULKAN_MINIMUM_IMAGE_SAMPLER_POOL_SIZE to clarify how many image sampler descriptors are expected to be available in descriptor pool. (#6642)
  34. // 2025-01-06: Vulkan: Added more ImGui_ImplVulkanH_XXXX helper functions to simplify our examples.
  35. // 2024-12-11: Vulkan: Fixed setting VkSwapchainCreateInfoKHR::preTransform for platforms not supporting VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR. (#8222)
  36. // 2024-11-27: Vulkan: Make user-provided descriptor pool optional. As a convenience, when setting init_info->DescriptorPoolSize the backend will create one itself. (#8172, #4867)
  37. // 2024-10-07: Vulkan: Changed default texture sampler to Clamp instead of Repeat/Wrap.
  38. // 2024-10-07: Vulkan: Expose selected render state in ImGui_ImplVulkan_RenderState, which you can access in 'void* platform_io.Renderer_RenderState' during draw callbacks.
  39. // 2024-10-07: Vulkan: Compiling with '#define ImTextureID=ImU64' is unnecessary now that dear imgui defaults ImTextureID to u64 instead of void*.
  40. // 2024-04-19: Vulkan: Added convenience support for Volk via IMGUI_IMPL_VULKAN_USE_VOLK define (you can also use IMGUI_IMPL_VULKAN_NO_PROTOTYPES + wrap Volk via ImGui_ImplVulkan_LoadFunctions().)
  41. // 2024-02-14: *BREAKING CHANGE*: Moved RenderPass parameter from ImGui_ImplVulkan_Init() function to ImGui_ImplVulkan_InitInfo structure. Not required when using dynamic rendering.
  42. // 2024-02-12: *BREAKING CHANGE*: Dynamic rendering now require filling PipelineRenderingCreateInfo structure.
  43. // 2024-01-19: Vulkan: Fixed vkAcquireNextImageKHR() validation errors in VulkanSDK 1.3.275 by allocating one extra semaphore than in-flight frames. (#7236)
  44. // 2024-01-11: Vulkan: Fixed vkMapMemory() calls unnecessarily using full buffer size (#3957). Fixed MinAllocationSize handing (#7189).
  45. // 2024-01-03: Vulkan: Added MinAllocationSize field in ImGui_ImplVulkan_InitInfo to workaround zealous "best practice" validation layer. (#7189, #4238)
  46. // 2024-01-03: Vulkan: Stopped creating command pools with VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT as we don't reset them.
  47. // 2023-11-29: Vulkan: Fixed mismatching allocator passed to vkCreateCommandPool() vs vkDestroyCommandPool(). (#7075)
  48. // 2023-11-10: *BREAKING CHANGE*: Removed parameter from ImGui_ImplVulkan_CreateFontsTexture(): backend now creates its own command-buffer to upload fonts.
  49. // *BREAKING CHANGE*: Removed ImGui_ImplVulkan_DestroyFontUploadObjects() which is now unnecessary as we create and destroy those objects in the backend.
  50. // ImGui_ImplVulkan_CreateFontsTexture() is automatically called by NewFrame() the first time.
  51. // You can call ImGui_ImplVulkan_CreateFontsTexture() again to recreate the font atlas texture.
  52. // Added ImGui_ImplVulkan_DestroyFontsTexture() but you probably never need to call this.
  53. // 2023-07-04: Vulkan: Added optional support for VK_KHR_dynamic_rendering. User needs to set init_info->UseDynamicRendering = true and init_info->ColorAttachmentFormat.
  54. // 2023-01-02: Vulkan: Fixed sampler passed to ImGui_ImplVulkan_AddTexture() not being honored + removed a bunch of duplicate code.
  55. // 2022-10-11: Using 'nullptr' instead of 'NULL' as per our switch to C++11.
  56. // 2022-10-04: Vulkan: Added experimental ImGui_ImplVulkan_RemoveTexture() for api symmetry. (#914, #5738).
  57. // 2022-01-20: Vulkan: Added support for ImTextureID as VkDescriptorSet. User need to call ImGui_ImplVulkan_AddTexture(). Building for 32-bit targets requires '#define ImTextureID ImU64'. (#914).
  58. // 2021-10-15: Vulkan: Call vkCmdSetScissor() at the end of render a full-viewport to reduce likelihood of issues with people using VK_DYNAMIC_STATE_SCISSOR in their app without calling vkCmdSetScissor() explicitly every frame.
  59. // 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).
  60. // 2021-03-22: Vulkan: Fix mapped memory validation error when buffer sizes are not multiple of VkPhysicalDeviceLimits::nonCoherentAtomSize.
  61. // 2021-02-18: Vulkan: Change blending equation to preserve alpha in output buffer.
  62. // 2021-01-27: Vulkan: Added support for custom function load and IMGUI_IMPL_VULKAN_NO_PROTOTYPES by using ImGui_ImplVulkan_LoadFunctions().
  63. // 2020-11-11: Vulkan: Added support for specifying which subpass to reference during VkPipeline creation.
  64. // 2020-09-07: Vulkan: Added VkPipeline parameter to ImGui_ImplVulkan_RenderDrawData (default to one passed to ImGui_ImplVulkan_Init).
  65. // 2020-05-04: Vulkan: Fixed crash if initial frame has no vertices.
  66. // 2020-04-26: Vulkan: Fixed edge case where render callbacks wouldn't be called if the ImDrawData didn't have vertices.
  67. // 2019-08-01: Vulkan: Added support for specifying multisample count. Set ImGui_ImplVulkan_InitInfo::MSAASamples to one of the VkSampleCountFlagBits values to use, default is non-multisampled as before.
  68. // 2019-05-29: Vulkan: Added support for large mesh (64K+ vertices), enable ImGuiBackendFlags_RendererHasVtxOffset flag.
  69. // 2019-04-30: Vulkan: Added support for special ImDrawCallback_ResetRenderState callback to reset render state.
  70. // 2019-04-04: *BREAKING CHANGE*: Vulkan: Added ImageCount/MinImageCount fields in ImGui_ImplVulkan_InitInfo, required for initialization (was previously a hard #define IMGUI_VK_QUEUED_FRAMES 2). Added ImGui_ImplVulkan_SetMinImageCount().
  71. // 2019-04-04: Vulkan: Added VkInstance argument to ImGui_ImplVulkanH_CreateWindow() optional helper.
  72. // 2019-04-04: Vulkan: Avoid passing negative coordinates to vkCmdSetScissor, which debug validation layers do not like.
  73. // 2019-04-01: Vulkan: Support for 32-bit index buffer (#define ImDrawIdx unsigned int).
  74. // 2019-02-16: Vulkan: Viewport and clipping rectangles correctly using draw_data->FramebufferScale to allow retina display.
  75. // 2018-11-30: Misc: Setting up io.BackendRendererName so it can be displayed in the About Window.
  76. // 2018-08-25: Vulkan: Fixed mishandled VkSurfaceCapabilitiesKHR::maxImageCount=0 case.
  77. // 2018-06-22: Inverted the parameters to ImGui_ImplVulkan_RenderDrawData() to be consistent with other backends.
  78. // 2018-06-08: Misc: Extracted imgui_impl_vulkan.cpp/.h away from the old combined GLFW+Vulkan example.
  79. // 2018-06-08: Vulkan: Use draw_data->DisplayPos and draw_data->DisplaySize to setup projection matrix and clipping rectangle.
  80. // 2018-03-03: Vulkan: Various refactor, created a couple of ImGui_ImplVulkanH_XXX helper that the example can use and that viewport support will use.
  81. // 2018-03-01: Vulkan: Renamed ImGui_ImplVulkan_Init_Info to ImGui_ImplVulkan_InitInfo and fields to match more closely Vulkan terminology.
  82. // 2018-02-16: Misc: Obsoleted the io.RenderDrawListsFn callback, ImGui_ImplVulkan_Render() calls ImGui_ImplVulkan_RenderDrawData() itself.
  83. // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
  84. // 2017-05-15: Vulkan: Fix scissor offset being negative. Fix new Vulkan validation warnings. Set required depth member for buffer image copy.
  85. // 2016-11-13: Vulkan: Fix validation layer warnings and errors and redeclare gl_PerVertex.
  86. // 2016-10-18: Vulkan: Add location decorators & change to use structs as in/out in glsl, update embedded spv (produced with glslangValidator -x). Null the released resources.
  87. // 2016-08-27: Vulkan: Fix Vulkan example for use when a depth buffer is active.
  88. #include "imgui.h"
  89. #ifndef IMGUI_DISABLE
  90. #include "imgui_impl_vulkan.h"
  91. #include <stdio.h>
  92. #ifndef IM_MAX
  93. #define IM_MAX(A, B) (((A) >= (B)) ? (A) : (B))
  94. #endif
  95. #undef Status // X11 headers are leaking this.
  96. // Visual Studio warnings
  97. #ifdef _MSC_VER
  98. #pragma warning (disable: 4127) // condition expression is constant
  99. #endif
  100. // Forward Declarations
  101. struct ImGui_ImplVulkan_FrameRenderBuffers;
  102. struct ImGui_ImplVulkan_WindowRenderBuffers;
  103. bool ImGui_ImplVulkan_CreateDeviceObjects();
  104. void ImGui_ImplVulkan_DestroyDeviceObjects();
  105. void ImGui_ImplVulkan_DestroyFrameRenderBuffers(VkDevice device, ImGui_ImplVulkan_FrameRenderBuffers* buffers, const VkAllocationCallbacks* allocator);
  106. void ImGui_ImplVulkan_DestroyWindowRenderBuffers(VkDevice device, ImGui_ImplVulkan_WindowRenderBuffers* buffers, const VkAllocationCallbacks* allocator);
  107. void ImGui_ImplVulkanH_DestroyFrame(VkDevice device, ImGui_ImplVulkanH_Frame* fd, const VkAllocationCallbacks* allocator);
  108. void ImGui_ImplVulkanH_DestroyFrameSemaphores(VkDevice device, ImGui_ImplVulkanH_FrameSemaphores* fsd, const VkAllocationCallbacks* allocator);
  109. void ImGui_ImplVulkanH_CreateWindowSwapChain(VkPhysicalDevice physical_device, VkDevice device, ImGui_ImplVulkanH_Window* wd, const VkAllocationCallbacks* allocator, int w, int h, uint32_t min_image_count);
  110. void ImGui_ImplVulkanH_CreateWindowCommandBuffers(VkPhysicalDevice physical_device, VkDevice device, ImGui_ImplVulkanH_Window* wd, uint32_t queue_family, const VkAllocationCallbacks* allocator);
  111. // Vulkan prototypes for use with custom loaders
  112. // (see description of IMGUI_IMPL_VULKAN_NO_PROTOTYPES in imgui_impl_vulkan.h
  113. #if defined(VK_NO_PROTOTYPES) && !defined(VOLK_H_)
  114. #define IMGUI_IMPL_VULKAN_USE_LOADER
  115. static bool g_FunctionsLoaded = false;
  116. #else
  117. static bool g_FunctionsLoaded = true;
  118. #endif
  119. #ifdef IMGUI_IMPL_VULKAN_USE_LOADER
  120. #define IMGUI_VULKAN_FUNC_MAP(IMGUI_VULKAN_FUNC_MAP_MACRO) \
  121. IMGUI_VULKAN_FUNC_MAP_MACRO(vkAllocateCommandBuffers) \
  122. IMGUI_VULKAN_FUNC_MAP_MACRO(vkAllocateDescriptorSets) \
  123. IMGUI_VULKAN_FUNC_MAP_MACRO(vkAllocateMemory) \
  124. IMGUI_VULKAN_FUNC_MAP_MACRO(vkBeginCommandBuffer) \
  125. IMGUI_VULKAN_FUNC_MAP_MACRO(vkBindBufferMemory) \
  126. IMGUI_VULKAN_FUNC_MAP_MACRO(vkBindImageMemory) \
  127. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCmdBindDescriptorSets) \
  128. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCmdBindIndexBuffer) \
  129. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCmdBindPipeline) \
  130. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCmdBindVertexBuffers) \
  131. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCmdCopyBufferToImage) \
  132. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCmdDrawIndexed) \
  133. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCmdPipelineBarrier) \
  134. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCmdPushConstants) \
  135. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCmdSetScissor) \
  136. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCmdSetViewport) \
  137. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCreateBuffer) \
  138. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCreateCommandPool) \
  139. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCreateDescriptorPool) \
  140. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCreateDescriptorSetLayout) \
  141. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCreateFence) \
  142. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCreateFramebuffer) \
  143. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCreateGraphicsPipelines) \
  144. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCreateImage) \
  145. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCreateImageView) \
  146. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCreatePipelineLayout) \
  147. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCreateRenderPass) \
  148. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCreateSampler) \
  149. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCreateSemaphore) \
  150. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCreateShaderModule) \
  151. IMGUI_VULKAN_FUNC_MAP_MACRO(vkCreateSwapchainKHR) \
  152. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroyBuffer) \
  153. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroyCommandPool) \
  154. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroyDescriptorPool) \
  155. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroyDescriptorSetLayout) \
  156. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroyFence) \
  157. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroyFramebuffer) \
  158. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroyImage) \
  159. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroyImageView) \
  160. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroyPipeline) \
  161. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroyPipelineLayout) \
  162. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroyRenderPass) \
  163. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroySampler) \
  164. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroySemaphore) \
  165. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroyShaderModule) \
  166. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroySurfaceKHR) \
  167. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDestroySwapchainKHR) \
  168. IMGUI_VULKAN_FUNC_MAP_MACRO(vkDeviceWaitIdle) \
  169. IMGUI_VULKAN_FUNC_MAP_MACRO(vkEnumeratePhysicalDevices) \
  170. IMGUI_VULKAN_FUNC_MAP_MACRO(vkEndCommandBuffer) \
  171. IMGUI_VULKAN_FUNC_MAP_MACRO(vkFlushMappedMemoryRanges) \
  172. IMGUI_VULKAN_FUNC_MAP_MACRO(vkFreeCommandBuffers) \
  173. IMGUI_VULKAN_FUNC_MAP_MACRO(vkFreeDescriptorSets) \
  174. IMGUI_VULKAN_FUNC_MAP_MACRO(vkFreeMemory) \
  175. IMGUI_VULKAN_FUNC_MAP_MACRO(vkGetBufferMemoryRequirements) \
  176. IMGUI_VULKAN_FUNC_MAP_MACRO(vkGetDeviceQueue) \
  177. IMGUI_VULKAN_FUNC_MAP_MACRO(vkGetImageMemoryRequirements) \
  178. IMGUI_VULKAN_FUNC_MAP_MACRO(vkGetPhysicalDeviceProperties) \
  179. IMGUI_VULKAN_FUNC_MAP_MACRO(vkGetPhysicalDeviceMemoryProperties) \
  180. IMGUI_VULKAN_FUNC_MAP_MACRO(vkGetPhysicalDeviceQueueFamilyProperties) \
  181. IMGUI_VULKAN_FUNC_MAP_MACRO(vkGetPhysicalDeviceSurfaceCapabilitiesKHR) \
  182. IMGUI_VULKAN_FUNC_MAP_MACRO(vkGetPhysicalDeviceSurfaceFormatsKHR) \
  183. IMGUI_VULKAN_FUNC_MAP_MACRO(vkGetPhysicalDeviceSurfacePresentModesKHR) \
  184. IMGUI_VULKAN_FUNC_MAP_MACRO(vkGetSwapchainImagesKHR) \
  185. IMGUI_VULKAN_FUNC_MAP_MACRO(vkMapMemory) \
  186. IMGUI_VULKAN_FUNC_MAP_MACRO(vkQueueSubmit) \
  187. IMGUI_VULKAN_FUNC_MAP_MACRO(vkQueueWaitIdle) \
  188. IMGUI_VULKAN_FUNC_MAP_MACRO(vkResetCommandPool) \
  189. IMGUI_VULKAN_FUNC_MAP_MACRO(vkResetFences) \
  190. IMGUI_VULKAN_FUNC_MAP_MACRO(vkUnmapMemory) \
  191. IMGUI_VULKAN_FUNC_MAP_MACRO(vkUpdateDescriptorSets) \
  192. IMGUI_VULKAN_FUNC_MAP_MACRO(vkWaitForFences)
  193. // Define function pointers
  194. #define IMGUI_VULKAN_FUNC_DEF(func) static PFN_##func func;
  195. IMGUI_VULKAN_FUNC_MAP(IMGUI_VULKAN_FUNC_DEF)
  196. #undef IMGUI_VULKAN_FUNC_DEF
  197. #endif // IMGUI_IMPL_VULKAN_USE_LOADER
  198. #ifdef IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
  199. static PFN_vkCmdBeginRenderingKHR ImGuiImplVulkanFuncs_vkCmdBeginRenderingKHR;
  200. static PFN_vkCmdEndRenderingKHR ImGuiImplVulkanFuncs_vkCmdEndRenderingKHR;
  201. #endif
  202. // Reusable buffers used for rendering 1 current in-flight frame, for ImGui_ImplVulkan_RenderDrawData()
  203. // [Please zero-clear before use!]
  204. struct ImGui_ImplVulkan_FrameRenderBuffers
  205. {
  206. VkDeviceMemory VertexBufferMemory;
  207. VkDeviceMemory IndexBufferMemory;
  208. VkDeviceSize VertexBufferSize;
  209. VkDeviceSize IndexBufferSize;
  210. VkBuffer VertexBuffer;
  211. VkBuffer IndexBuffer;
  212. };
  213. // Each viewport will hold 1 ImGui_ImplVulkanH_WindowRenderBuffers
  214. // [Please zero-clear before use!]
  215. struct ImGui_ImplVulkan_WindowRenderBuffers
  216. {
  217. uint32_t Index;
  218. uint32_t Count;
  219. ImVector<ImGui_ImplVulkan_FrameRenderBuffers> FrameRenderBuffers;
  220. };
  221. struct ImGui_ImplVulkan_Texture
  222. {
  223. VkDeviceMemory Memory;
  224. VkImage Image;
  225. VkImageView ImageView;
  226. VkDescriptorSet DescriptorSet;
  227. ImGui_ImplVulkan_Texture() { memset((void*)this, 0, sizeof(*this)); }
  228. };
  229. // Vulkan data
  230. struct ImGui_ImplVulkan_Data
  231. {
  232. ImGui_ImplVulkan_InitInfo VulkanInitInfo;
  233. VkDeviceSize BufferMemoryAlignment;
  234. VkDeviceSize NonCoherentAtomSize;
  235. VkPipelineCreateFlags PipelineCreateFlags;
  236. VkDescriptorSetLayout DescriptorSetLayout;
  237. VkPipelineLayout PipelineLayout;
  238. VkPipeline Pipeline;
  239. VkShaderModule ShaderModuleVert;
  240. VkShaderModule ShaderModuleFrag;
  241. VkDescriptorPool DescriptorPool;
  242. // Texture management
  243. VkSampler TexSampler;
  244. VkCommandPool TexCommandPool;
  245. VkCommandBuffer TexCommandBuffer;
  246. // Render buffers for main window
  247. ImGui_ImplVulkan_WindowRenderBuffers MainWindowRenderBuffers;
  248. ImGui_ImplVulkan_Data()
  249. {
  250. memset((void*)this, 0, sizeof(*this));
  251. BufferMemoryAlignment = 256;
  252. NonCoherentAtomSize = 64;
  253. }
  254. };
  255. //-----------------------------------------------------------------------------
  256. // SHADERS
  257. //-----------------------------------------------------------------------------
  258. // backends/vulkan/glsl_shader.vert, compiled with:
  259. // # glslangValidator -V -x -o glsl_shader.vert.u32 glsl_shader.vert
  260. /*
  261. #version 450 core
  262. layout(location = 0) in vec2 aPos;
  263. layout(location = 1) in vec2 aUV;
  264. layout(location = 2) in vec4 aColor;
  265. layout(push_constant) uniform uPushConstant { vec2 uScale; vec2 uTranslate; } pc;
  266. out gl_PerVertex { vec4 gl_Position; };
  267. layout(location = 0) out struct { vec4 Color; vec2 UV; } Out;
  268. void main()
  269. {
  270. Out.Color = aColor;
  271. Out.UV = aUV;
  272. gl_Position = vec4(aPos * pc.uScale + pc.uTranslate, 0, 1);
  273. }
  274. */
  275. static uint32_t __glsl_shader_vert_spv[] =
  276. {
  277. 0x07230203,0x00010000,0x00080001,0x0000002e,0x00000000,0x00020011,0x00000001,0x0006000b,
  278. 0x00000001,0x4c534c47,0x6474732e,0x3035342e,0x00000000,0x0003000e,0x00000000,0x00000001,
  279. 0x000a000f,0x00000000,0x00000004,0x6e69616d,0x00000000,0x0000000b,0x0000000f,0x00000015,
  280. 0x0000001b,0x0000001c,0x00030003,0x00000002,0x000001c2,0x00040005,0x00000004,0x6e69616d,
  281. 0x00000000,0x00030005,0x00000009,0x00000000,0x00050006,0x00000009,0x00000000,0x6f6c6f43,
  282. 0x00000072,0x00040006,0x00000009,0x00000001,0x00005655,0x00030005,0x0000000b,0x0074754f,
  283. 0x00040005,0x0000000f,0x6c6f4361,0x0000726f,0x00030005,0x00000015,0x00565561,0x00060005,
  284. 0x00000019,0x505f6c67,0x65567265,0x78657472,0x00000000,0x00060006,0x00000019,0x00000000,
  285. 0x505f6c67,0x7469736f,0x006e6f69,0x00030005,0x0000001b,0x00000000,0x00040005,0x0000001c,
  286. 0x736f5061,0x00000000,0x00060005,0x0000001e,0x73755075,0x6e6f4368,0x6e617473,0x00000074,
  287. 0x00050006,0x0000001e,0x00000000,0x61635375,0x0000656c,0x00060006,0x0000001e,0x00000001,
  288. 0x61725475,0x616c736e,0x00006574,0x00030005,0x00000020,0x00006370,0x00040047,0x0000000b,
  289. 0x0000001e,0x00000000,0x00040047,0x0000000f,0x0000001e,0x00000002,0x00040047,0x00000015,
  290. 0x0000001e,0x00000001,0x00050048,0x00000019,0x00000000,0x0000000b,0x00000000,0x00030047,
  291. 0x00000019,0x00000002,0x00040047,0x0000001c,0x0000001e,0x00000000,0x00050048,0x0000001e,
  292. 0x00000000,0x00000023,0x00000000,0x00050048,0x0000001e,0x00000001,0x00000023,0x00000008,
  293. 0x00030047,0x0000001e,0x00000002,0x00020013,0x00000002,0x00030021,0x00000003,0x00000002,
  294. 0x00030016,0x00000006,0x00000020,0x00040017,0x00000007,0x00000006,0x00000004,0x00040017,
  295. 0x00000008,0x00000006,0x00000002,0x0004001e,0x00000009,0x00000007,0x00000008,0x00040020,
  296. 0x0000000a,0x00000003,0x00000009,0x0004003b,0x0000000a,0x0000000b,0x00000003,0x00040015,
  297. 0x0000000c,0x00000020,0x00000001,0x0004002b,0x0000000c,0x0000000d,0x00000000,0x00040020,
  298. 0x0000000e,0x00000001,0x00000007,0x0004003b,0x0000000e,0x0000000f,0x00000001,0x00040020,
  299. 0x00000011,0x00000003,0x00000007,0x0004002b,0x0000000c,0x00000013,0x00000001,0x00040020,
  300. 0x00000014,0x00000001,0x00000008,0x0004003b,0x00000014,0x00000015,0x00000001,0x00040020,
  301. 0x00000017,0x00000003,0x00000008,0x0003001e,0x00000019,0x00000007,0x00040020,0x0000001a,
  302. 0x00000003,0x00000019,0x0004003b,0x0000001a,0x0000001b,0x00000003,0x0004003b,0x00000014,
  303. 0x0000001c,0x00000001,0x0004001e,0x0000001e,0x00000008,0x00000008,0x00040020,0x0000001f,
  304. 0x00000009,0x0000001e,0x0004003b,0x0000001f,0x00000020,0x00000009,0x00040020,0x00000021,
  305. 0x00000009,0x00000008,0x0004002b,0x00000006,0x00000028,0x00000000,0x0004002b,0x00000006,
  306. 0x00000029,0x3f800000,0x00050036,0x00000002,0x00000004,0x00000000,0x00000003,0x000200f8,
  307. 0x00000005,0x0004003d,0x00000007,0x00000010,0x0000000f,0x00050041,0x00000011,0x00000012,
  308. 0x0000000b,0x0000000d,0x0003003e,0x00000012,0x00000010,0x0004003d,0x00000008,0x00000016,
  309. 0x00000015,0x00050041,0x00000017,0x00000018,0x0000000b,0x00000013,0x0003003e,0x00000018,
  310. 0x00000016,0x0004003d,0x00000008,0x0000001d,0x0000001c,0x00050041,0x00000021,0x00000022,
  311. 0x00000020,0x0000000d,0x0004003d,0x00000008,0x00000023,0x00000022,0x00050085,0x00000008,
  312. 0x00000024,0x0000001d,0x00000023,0x00050041,0x00000021,0x00000025,0x00000020,0x00000013,
  313. 0x0004003d,0x00000008,0x00000026,0x00000025,0x00050081,0x00000008,0x00000027,0x00000024,
  314. 0x00000026,0x00050051,0x00000006,0x0000002a,0x00000027,0x00000000,0x00050051,0x00000006,
  315. 0x0000002b,0x00000027,0x00000001,0x00070050,0x00000007,0x0000002c,0x0000002a,0x0000002b,
  316. 0x00000028,0x00000029,0x00050041,0x00000011,0x0000002d,0x0000001b,0x0000000d,0x0003003e,
  317. 0x0000002d,0x0000002c,0x000100fd,0x00010038
  318. };
  319. // backends/vulkan/glsl_shader.frag, compiled with:
  320. // # glslangValidator -V -x -o glsl_shader.frag.u32 glsl_shader.frag
  321. /*
  322. #version 450 core
  323. layout(location = 0) out vec4 fColor;
  324. layout(set=0, binding=0) uniform sampler2D sTexture;
  325. layout(location = 0) in struct { vec4 Color; vec2 UV; } In;
  326. void main()
  327. {
  328. fColor = In.Color * texture(sTexture, In.UV.st);
  329. }
  330. */
  331. static uint32_t __glsl_shader_frag_spv[] =
  332. {
  333. 0x07230203,0x00010000,0x00080001,0x0000001e,0x00000000,0x00020011,0x00000001,0x0006000b,
  334. 0x00000001,0x4c534c47,0x6474732e,0x3035342e,0x00000000,0x0003000e,0x00000000,0x00000001,
  335. 0x0007000f,0x00000004,0x00000004,0x6e69616d,0x00000000,0x00000009,0x0000000d,0x00030010,
  336. 0x00000004,0x00000007,0x00030003,0x00000002,0x000001c2,0x00040005,0x00000004,0x6e69616d,
  337. 0x00000000,0x00040005,0x00000009,0x6c6f4366,0x0000726f,0x00030005,0x0000000b,0x00000000,
  338. 0x00050006,0x0000000b,0x00000000,0x6f6c6f43,0x00000072,0x00040006,0x0000000b,0x00000001,
  339. 0x00005655,0x00030005,0x0000000d,0x00006e49,0x00050005,0x00000016,0x78655473,0x65727574,
  340. 0x00000000,0x00040047,0x00000009,0x0000001e,0x00000000,0x00040047,0x0000000d,0x0000001e,
  341. 0x00000000,0x00040047,0x00000016,0x00000022,0x00000000,0x00040047,0x00000016,0x00000021,
  342. 0x00000000,0x00020013,0x00000002,0x00030021,0x00000003,0x00000002,0x00030016,0x00000006,
  343. 0x00000020,0x00040017,0x00000007,0x00000006,0x00000004,0x00040020,0x00000008,0x00000003,
  344. 0x00000007,0x0004003b,0x00000008,0x00000009,0x00000003,0x00040017,0x0000000a,0x00000006,
  345. 0x00000002,0x0004001e,0x0000000b,0x00000007,0x0000000a,0x00040020,0x0000000c,0x00000001,
  346. 0x0000000b,0x0004003b,0x0000000c,0x0000000d,0x00000001,0x00040015,0x0000000e,0x00000020,
  347. 0x00000001,0x0004002b,0x0000000e,0x0000000f,0x00000000,0x00040020,0x00000010,0x00000001,
  348. 0x00000007,0x00090019,0x00000013,0x00000006,0x00000001,0x00000000,0x00000000,0x00000000,
  349. 0x00000001,0x00000000,0x0003001b,0x00000014,0x00000013,0x00040020,0x00000015,0x00000000,
  350. 0x00000014,0x0004003b,0x00000015,0x00000016,0x00000000,0x0004002b,0x0000000e,0x00000018,
  351. 0x00000001,0x00040020,0x00000019,0x00000001,0x0000000a,0x00050036,0x00000002,0x00000004,
  352. 0x00000000,0x00000003,0x000200f8,0x00000005,0x00050041,0x00000010,0x00000011,0x0000000d,
  353. 0x0000000f,0x0004003d,0x00000007,0x00000012,0x00000011,0x0004003d,0x00000014,0x00000017,
  354. 0x00000016,0x00050041,0x00000019,0x0000001a,0x0000000d,0x00000018,0x0004003d,0x0000000a,
  355. 0x0000001b,0x0000001a,0x00050057,0x00000007,0x0000001c,0x00000017,0x0000001b,0x00050085,
  356. 0x00000007,0x0000001d,0x00000012,0x0000001c,0x0003003e,0x00000009,0x0000001d,0x000100fd,
  357. 0x00010038
  358. };
  359. //-----------------------------------------------------------------------------
  360. // FUNCTIONS
  361. //-----------------------------------------------------------------------------
  362. // Backend data stored in io.BackendRendererUserData to allow support for multiple Dear ImGui contexts
  363. // It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
  364. // FIXME: multi-context support is not tested and probably dysfunctional in this backend.
  365. static ImGui_ImplVulkan_Data* ImGui_ImplVulkan_GetBackendData()
  366. {
  367. return ImGui::GetCurrentContext() ? (ImGui_ImplVulkan_Data*)ImGui::GetIO().BackendRendererUserData : nullptr;
  368. }
  369. static uint32_t ImGui_ImplVulkan_MemoryType(VkMemoryPropertyFlags properties, uint32_t type_bits)
  370. {
  371. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  372. ImGui_ImplVulkan_InitInfo* v = &bd->VulkanInitInfo;
  373. VkPhysicalDeviceMemoryProperties prop;
  374. vkGetPhysicalDeviceMemoryProperties(v->PhysicalDevice, &prop);
  375. for (uint32_t i = 0; i < prop.memoryTypeCount; i++)
  376. if ((prop.memoryTypes[i].propertyFlags & properties) == properties && type_bits & (1 << i))
  377. return i;
  378. return 0xFFFFFFFF; // Unable to find memoryType
  379. }
  380. static void check_vk_result(VkResult err)
  381. {
  382. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  383. if (!bd)
  384. return;
  385. ImGui_ImplVulkan_InitInfo* v = &bd->VulkanInitInfo;
  386. if (v->CheckVkResultFn)
  387. v->CheckVkResultFn(err);
  388. }
  389. // Same as IM_MEMALIGN(). 'alignment' must be a power of two.
  390. static inline VkDeviceSize AlignBufferSize(VkDeviceSize size, VkDeviceSize alignment)
  391. {
  392. return (size + alignment - 1) & ~(alignment - 1);
  393. }
  394. static void CreateOrResizeBuffer(VkBuffer& buffer, VkDeviceMemory& buffer_memory, VkDeviceSize& buffer_size, VkDeviceSize new_size, VkBufferUsageFlagBits usage)
  395. {
  396. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  397. ImGui_ImplVulkan_InitInfo* v = &bd->VulkanInitInfo;
  398. VkResult err;
  399. if (buffer != VK_NULL_HANDLE)
  400. vkDestroyBuffer(v->Device, buffer, v->Allocator);
  401. if (buffer_memory != VK_NULL_HANDLE)
  402. vkFreeMemory(v->Device, buffer_memory, v->Allocator);
  403. VkDeviceSize buffer_size_aligned = AlignBufferSize(IM_MAX(v->MinAllocationSize, new_size), bd->BufferMemoryAlignment);
  404. VkBufferCreateInfo buffer_info = {};
  405. buffer_info.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO;
  406. buffer_info.size = buffer_size_aligned;
  407. buffer_info.usage = usage;
  408. buffer_info.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
  409. err = vkCreateBuffer(v->Device, &buffer_info, v->Allocator, &buffer);
  410. check_vk_result(err);
  411. VkMemoryRequirements req;
  412. vkGetBufferMemoryRequirements(v->Device, buffer, &req);
  413. bd->BufferMemoryAlignment = (bd->BufferMemoryAlignment > req.alignment) ? bd->BufferMemoryAlignment : req.alignment;
  414. VkMemoryAllocateInfo alloc_info = {};
  415. alloc_info.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
  416. alloc_info.allocationSize = req.size;
  417. alloc_info.memoryTypeIndex = ImGui_ImplVulkan_MemoryType(VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT, req.memoryTypeBits);
  418. err = vkAllocateMemory(v->Device, &alloc_info, v->Allocator, &buffer_memory);
  419. check_vk_result(err);
  420. err = vkBindBufferMemory(v->Device, buffer, buffer_memory, 0);
  421. check_vk_result(err);
  422. buffer_size = buffer_size_aligned;
  423. }
  424. static void ImGui_ImplVulkan_SetupRenderState(ImDrawData* draw_data, VkPipeline pipeline, VkCommandBuffer command_buffer, ImGui_ImplVulkan_FrameRenderBuffers* rb, int fb_width, int fb_height)
  425. {
  426. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  427. // Bind pipeline:
  428. {
  429. vkCmdBindPipeline(command_buffer, VK_PIPELINE_BIND_POINT_GRAPHICS, pipeline);
  430. }
  431. // Bind Vertex And Index Buffer:
  432. if (draw_data->TotalVtxCount > 0)
  433. {
  434. VkBuffer vertex_buffers[1] = { rb->VertexBuffer };
  435. VkDeviceSize vertex_offset[1] = { 0 };
  436. vkCmdBindVertexBuffers(command_buffer, 0, 1, vertex_buffers, vertex_offset);
  437. vkCmdBindIndexBuffer(command_buffer, rb->IndexBuffer, 0, sizeof(ImDrawIdx) == 2 ? VK_INDEX_TYPE_UINT16 : VK_INDEX_TYPE_UINT32);
  438. }
  439. // Setup viewport:
  440. {
  441. VkViewport viewport;
  442. viewport.x = 0;
  443. viewport.y = 0;
  444. viewport.width = (float)fb_width;
  445. viewport.height = (float)fb_height;
  446. viewport.minDepth = 0.0f;
  447. viewport.maxDepth = 1.0f;
  448. vkCmdSetViewport(command_buffer, 0, 1, &viewport);
  449. }
  450. // Setup scale and translation:
  451. // 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.
  452. {
  453. float scale[2];
  454. scale[0] = 2.0f / draw_data->DisplaySize.x;
  455. scale[1] = 2.0f / draw_data->DisplaySize.y;
  456. float translate[2];
  457. translate[0] = -1.0f - draw_data->DisplayPos.x * scale[0];
  458. translate[1] = -1.0f - draw_data->DisplayPos.y * scale[1];
  459. vkCmdPushConstants(command_buffer, bd->PipelineLayout, VK_SHADER_STAGE_VERTEX_BIT, sizeof(float) * 0, sizeof(float) * 2, scale);
  460. vkCmdPushConstants(command_buffer, bd->PipelineLayout, VK_SHADER_STAGE_VERTEX_BIT, sizeof(float) * 2, sizeof(float) * 2, translate);
  461. }
  462. }
  463. // Render function
  464. void ImGui_ImplVulkan_RenderDrawData(ImDrawData* draw_data, VkCommandBuffer command_buffer, VkPipeline pipeline)
  465. {
  466. // Avoid rendering when minimized, scale coordinates for retina displays (screen coordinates != framebuffer coordinates)
  467. int fb_width = (int)(draw_data->DisplaySize.x * draw_data->FramebufferScale.x);
  468. int fb_height = (int)(draw_data->DisplaySize.y * draw_data->FramebufferScale.y);
  469. if (fb_width <= 0 || fb_height <= 0)
  470. return;
  471. // Catch up with texture updates. Most of the times, the list will have 1 element with an OK status, aka nothing to do.
  472. // (This almost always points to ImGui::GetPlatformIO().Textures[] but is part of ImDrawData to allow overriding or disabling texture updates).
  473. if (draw_data->Textures != nullptr)
  474. for (ImTextureData* tex : *draw_data->Textures)
  475. if (tex->Status != ImTextureStatus_OK)
  476. ImGui_ImplVulkan_UpdateTexture(tex);
  477. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  478. ImGui_ImplVulkan_InitInfo* v = &bd->VulkanInitInfo;
  479. if (pipeline == VK_NULL_HANDLE)
  480. pipeline = bd->Pipeline;
  481. // Allocate array to store enough vertex/index buffers
  482. ImGui_ImplVulkan_WindowRenderBuffers* wrb = &bd->MainWindowRenderBuffers;
  483. if (wrb->FrameRenderBuffers.Size == 0)
  484. {
  485. wrb->Index = 0;
  486. wrb->Count = v->ImageCount;
  487. wrb->FrameRenderBuffers.resize(wrb->Count);
  488. memset((void*)wrb->FrameRenderBuffers.Data, 0, wrb->FrameRenderBuffers.size_in_bytes());
  489. }
  490. IM_ASSERT(wrb->Count == v->ImageCount);
  491. wrb->Index = (wrb->Index + 1) % wrb->Count;
  492. ImGui_ImplVulkan_FrameRenderBuffers* rb = &wrb->FrameRenderBuffers[wrb->Index];
  493. if (draw_data->TotalVtxCount > 0)
  494. {
  495. // Create or resize the vertex/index buffers
  496. VkDeviceSize vertex_size = AlignBufferSize(draw_data->TotalVtxCount * sizeof(ImDrawVert), bd->BufferMemoryAlignment);
  497. VkDeviceSize index_size = AlignBufferSize(draw_data->TotalIdxCount * sizeof(ImDrawIdx), bd->BufferMemoryAlignment);
  498. if (rb->VertexBuffer == VK_NULL_HANDLE || rb->VertexBufferSize < vertex_size)
  499. CreateOrResizeBuffer(rb->VertexBuffer, rb->VertexBufferMemory, rb->VertexBufferSize, vertex_size, VK_BUFFER_USAGE_VERTEX_BUFFER_BIT);
  500. if (rb->IndexBuffer == VK_NULL_HANDLE || rb->IndexBufferSize < index_size)
  501. CreateOrResizeBuffer(rb->IndexBuffer, rb->IndexBufferMemory, rb->IndexBufferSize, index_size, VK_BUFFER_USAGE_INDEX_BUFFER_BIT);
  502. // Upload vertex/index data into a single contiguous GPU buffer
  503. ImDrawVert* vtx_dst = nullptr;
  504. ImDrawIdx* idx_dst = nullptr;
  505. VkResult err = vkMapMemory(v->Device, rb->VertexBufferMemory, 0, vertex_size, 0, (void**)&vtx_dst);
  506. check_vk_result(err);
  507. err = vkMapMemory(v->Device, rb->IndexBufferMemory, 0, index_size, 0, (void**)&idx_dst);
  508. check_vk_result(err);
  509. for (int n = 0; n < draw_data->CmdListsCount; n++)
  510. {
  511. const ImDrawList* draw_list = draw_data->CmdLists[n];
  512. memcpy(vtx_dst, draw_list->VtxBuffer.Data, draw_list->VtxBuffer.Size * sizeof(ImDrawVert));
  513. memcpy(idx_dst, draw_list->IdxBuffer.Data, draw_list->IdxBuffer.Size * sizeof(ImDrawIdx));
  514. vtx_dst += draw_list->VtxBuffer.Size;
  515. idx_dst += draw_list->IdxBuffer.Size;
  516. }
  517. VkMappedMemoryRange range[2] = {};
  518. range[0].sType = VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE;
  519. range[0].memory = rb->VertexBufferMemory;
  520. range[0].size = VK_WHOLE_SIZE;
  521. range[1].sType = VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE;
  522. range[1].memory = rb->IndexBufferMemory;
  523. range[1].size = VK_WHOLE_SIZE;
  524. err = vkFlushMappedMemoryRanges(v->Device, 2, range);
  525. check_vk_result(err);
  526. vkUnmapMemory(v->Device, rb->VertexBufferMemory);
  527. vkUnmapMemory(v->Device, rb->IndexBufferMemory);
  528. }
  529. // Setup desired Vulkan state
  530. ImGui_ImplVulkan_SetupRenderState(draw_data, pipeline, command_buffer, rb, fb_width, fb_height);
  531. // Setup render state structure (for callbacks and custom texture bindings)
  532. ImGuiPlatformIO& platform_io = ImGui::GetPlatformIO();
  533. ImGui_ImplVulkan_RenderState render_state;
  534. render_state.CommandBuffer = command_buffer;
  535. render_state.Pipeline = pipeline;
  536. render_state.PipelineLayout = bd->PipelineLayout;
  537. platform_io.Renderer_RenderState = &render_state;
  538. // Will project scissor/clipping rectangles into framebuffer space
  539. ImVec2 clip_off = draw_data->DisplayPos; // (0,0) unless using multi-viewports
  540. ImVec2 clip_scale = draw_data->FramebufferScale; // (1,1) unless using retina display which are often (2,2)
  541. // Render command lists
  542. // (Because we merged all buffers into a single one, we maintain our own offset into them)
  543. int global_vtx_offset = 0;
  544. int global_idx_offset = 0;
  545. for (int n = 0; n < draw_data->CmdListsCount; n++)
  546. {
  547. const ImDrawList* draw_list = draw_data->CmdLists[n];
  548. for (int cmd_i = 0; cmd_i < draw_list->CmdBuffer.Size; cmd_i++)
  549. {
  550. const ImDrawCmd* pcmd = &draw_list->CmdBuffer[cmd_i];
  551. if (pcmd->UserCallback != nullptr)
  552. {
  553. // User callback, registered via ImDrawList::AddCallback()
  554. // (ImDrawCallback_ResetRenderState is a special callback value used by the user to request the renderer to reset render state.)
  555. if (pcmd->UserCallback == ImDrawCallback_ResetRenderState)
  556. ImGui_ImplVulkan_SetupRenderState(draw_data, pipeline, command_buffer, rb, fb_width, fb_height);
  557. else
  558. pcmd->UserCallback(draw_list, pcmd);
  559. }
  560. else
  561. {
  562. // Project scissor/clipping rectangles into framebuffer space
  563. ImVec2 clip_min((pcmd->ClipRect.x - clip_off.x) * clip_scale.x, (pcmd->ClipRect.y - clip_off.y) * clip_scale.y);
  564. ImVec2 clip_max((pcmd->ClipRect.z - clip_off.x) * clip_scale.x, (pcmd->ClipRect.w - clip_off.y) * clip_scale.y);
  565. // Clamp to viewport as vkCmdSetScissor() won't accept values that are off bounds
  566. if (clip_min.x < 0.0f) { clip_min.x = 0.0f; }
  567. if (clip_min.y < 0.0f) { clip_min.y = 0.0f; }
  568. if (clip_max.x > fb_width) { clip_max.x = (float)fb_width; }
  569. if (clip_max.y > fb_height) { clip_max.y = (float)fb_height; }
  570. if (clip_max.x <= clip_min.x || clip_max.y <= clip_min.y)
  571. continue;
  572. // Apply scissor/clipping rectangle
  573. VkRect2D scissor;
  574. scissor.offset.x = (int32_t)(clip_min.x);
  575. scissor.offset.y = (int32_t)(clip_min.y);
  576. scissor.extent.width = (uint32_t)(clip_max.x - clip_min.x);
  577. scissor.extent.height = (uint32_t)(clip_max.y - clip_min.y);
  578. vkCmdSetScissor(command_buffer, 0, 1, &scissor);
  579. // Bind DescriptorSet with font or user texture
  580. VkDescriptorSet desc_set = (VkDescriptorSet)pcmd->GetTexID();
  581. vkCmdBindDescriptorSets(command_buffer, VK_PIPELINE_BIND_POINT_GRAPHICS, bd->PipelineLayout, 0, 1, &desc_set, 0, nullptr);
  582. // Draw
  583. vkCmdDrawIndexed(command_buffer, pcmd->ElemCount, 1, pcmd->IdxOffset + global_idx_offset, pcmd->VtxOffset + global_vtx_offset, 0);
  584. }
  585. }
  586. global_idx_offset += draw_list->IdxBuffer.Size;
  587. global_vtx_offset += draw_list->VtxBuffer.Size;
  588. }
  589. platform_io.Renderer_RenderState = nullptr;
  590. // Note: at this point both vkCmdSetViewport() and vkCmdSetScissor() have been called.
  591. // Our last values will leak into user/application rendering IF:
  592. // - Your app uses a pipeline with VK_DYNAMIC_STATE_VIEWPORT or VK_DYNAMIC_STATE_SCISSOR dynamic state
  593. // - And you forgot to call vkCmdSetViewport() and vkCmdSetScissor() yourself to explicitly set that state.
  594. // If you use VK_DYNAMIC_STATE_VIEWPORT or VK_DYNAMIC_STATE_SCISSOR you are responsible for setting the values before rendering.
  595. // In theory we should aim to backup/restore those values but I am not sure this is possible.
  596. // We perform a call to vkCmdSetScissor() to set back a full viewport which is likely to fix things for 99% users but technically this is not perfect. (See github #4644)
  597. VkRect2D scissor = { { 0, 0 }, { (uint32_t)fb_width, (uint32_t)fb_height } };
  598. vkCmdSetScissor(command_buffer, 0, 1, &scissor);
  599. }
  600. static void ImGui_ImplVulkan_DestroyTexture(ImTextureData* tex)
  601. {
  602. ImGui_ImplVulkan_Texture* backend_tex = (ImGui_ImplVulkan_Texture*)tex->BackendUserData;
  603. if (backend_tex == nullptr)
  604. return;
  605. IM_ASSERT(backend_tex->DescriptorSet == (VkDescriptorSet)tex->TexID);
  606. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  607. ImGui_ImplVulkan_InitInfo* v = &bd->VulkanInitInfo;
  608. ImGui_ImplVulkan_RemoveTexture(backend_tex->DescriptorSet);
  609. vkDestroyImageView(v->Device, backend_tex->ImageView, v->Allocator);
  610. vkDestroyImage(v->Device, backend_tex->Image, v->Allocator);
  611. vkFreeMemory(v->Device, backend_tex->Memory, v->Allocator);
  612. IM_DELETE(backend_tex);
  613. // Clear identifiers and mark as destroyed (in order to allow e.g. calling InvalidateDeviceObjects while running)
  614. tex->SetTexID(ImTextureID_Invalid);
  615. tex->SetStatus(ImTextureStatus_Destroyed);
  616. tex->BackendUserData = nullptr;
  617. }
  618. void ImGui_ImplVulkan_UpdateTexture(ImTextureData* tex)
  619. {
  620. if (tex->Status == ImTextureStatus_OK)
  621. return;
  622. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  623. ImGui_ImplVulkan_InitInfo* v = &bd->VulkanInitInfo;
  624. VkResult err;
  625. if (tex->Status == ImTextureStatus_WantCreate)
  626. {
  627. // Create and upload new texture to graphics system
  628. //IMGUI_DEBUG_LOG("UpdateTexture #%03d: WantCreate %dx%d\n", tex->UniqueID, tex->Width, tex->Height);
  629. IM_ASSERT(tex->TexID == ImTextureID_Invalid && tex->BackendUserData == nullptr);
  630. IM_ASSERT(tex->Format == ImTextureFormat_RGBA32);
  631. ImGui_ImplVulkan_Texture* backend_tex = IM_NEW(ImGui_ImplVulkan_Texture)();
  632. // Create the Image:
  633. {
  634. VkImageCreateInfo info = {};
  635. info.sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO;
  636. info.imageType = VK_IMAGE_TYPE_2D;
  637. info.format = VK_FORMAT_R8G8B8A8_UNORM;
  638. info.extent.width = tex->Width;
  639. info.extent.height = tex->Height;
  640. info.extent.depth = 1;
  641. info.mipLevels = 1;
  642. info.arrayLayers = 1;
  643. info.samples = VK_SAMPLE_COUNT_1_BIT;
  644. info.tiling = VK_IMAGE_TILING_OPTIMAL;
  645. info.usage = VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_TRANSFER_DST_BIT;
  646. info.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
  647. info.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
  648. err = vkCreateImage(v->Device, &info, v->Allocator, &backend_tex->Image);
  649. check_vk_result(err);
  650. VkMemoryRequirements req;
  651. vkGetImageMemoryRequirements(v->Device, backend_tex->Image, &req);
  652. VkMemoryAllocateInfo alloc_info = {};
  653. alloc_info.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
  654. alloc_info.allocationSize = IM_MAX(v->MinAllocationSize, req.size);
  655. alloc_info.memoryTypeIndex = ImGui_ImplVulkan_MemoryType(VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT, req.memoryTypeBits);
  656. err = vkAllocateMemory(v->Device, &alloc_info, v->Allocator, &backend_tex->Memory);
  657. check_vk_result(err);
  658. err = vkBindImageMemory(v->Device, backend_tex->Image, backend_tex->Memory, 0);
  659. check_vk_result(err);
  660. }
  661. // Create the Image View:
  662. {
  663. VkImageViewCreateInfo info = {};
  664. info.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO;
  665. info.image = backend_tex->Image;
  666. info.viewType = VK_IMAGE_VIEW_TYPE_2D;
  667. info.format = VK_FORMAT_R8G8B8A8_UNORM;
  668. info.subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
  669. info.subresourceRange.levelCount = 1;
  670. info.subresourceRange.layerCount = 1;
  671. err = vkCreateImageView(v->Device, &info, v->Allocator, &backend_tex->ImageView);
  672. check_vk_result(err);
  673. }
  674. // Create the Descriptor Set
  675. backend_tex->DescriptorSet = ImGui_ImplVulkan_AddTexture(bd->TexSampler, backend_tex->ImageView, VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL);
  676. // Store identifiers
  677. tex->SetTexID((ImTextureID)backend_tex->DescriptorSet);
  678. tex->BackendUserData = backend_tex;
  679. }
  680. if (tex->Status == ImTextureStatus_WantCreate || tex->Status == ImTextureStatus_WantUpdates)
  681. {
  682. ImGui_ImplVulkan_Texture* backend_tex = (ImGui_ImplVulkan_Texture*)tex->BackendUserData;
  683. // Update full texture or selected blocks. We only ever write to textures regions which have never been used before!
  684. // This backend choose to use tex->UpdateRect but you can use tex->Updates[] to upload individual regions.
  685. // We could use the smaller rect on _WantCreate but using the full rect allows us to clear the texture.
  686. const int upload_x = (tex->Status == ImTextureStatus_WantCreate) ? 0 : tex->UpdateRect.x;
  687. const int upload_y = (tex->Status == ImTextureStatus_WantCreate) ? 0 : tex->UpdateRect.y;
  688. const int upload_w = (tex->Status == ImTextureStatus_WantCreate) ? tex->Width : tex->UpdateRect.w;
  689. const int upload_h = (tex->Status == ImTextureStatus_WantCreate) ? tex->Height : tex->UpdateRect.h;
  690. // Create the Upload Buffer:
  691. VkDeviceMemory upload_buffer_memory;
  692. VkBuffer upload_buffer;
  693. VkDeviceSize upload_pitch = upload_w * tex->BytesPerPixel;
  694. VkDeviceSize upload_size = AlignBufferSize(upload_h * upload_pitch, bd->NonCoherentAtomSize);
  695. {
  696. VkBufferCreateInfo buffer_info = {};
  697. buffer_info.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO;
  698. buffer_info.size = upload_size;
  699. buffer_info.usage = VK_BUFFER_USAGE_TRANSFER_SRC_BIT;
  700. buffer_info.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
  701. err = vkCreateBuffer(v->Device, &buffer_info, v->Allocator, &upload_buffer);
  702. check_vk_result(err);
  703. VkMemoryRequirements req;
  704. vkGetBufferMemoryRequirements(v->Device, upload_buffer, &req);
  705. bd->BufferMemoryAlignment = (bd->BufferMemoryAlignment > req.alignment) ? bd->BufferMemoryAlignment : req.alignment;
  706. VkMemoryAllocateInfo alloc_info = {};
  707. alloc_info.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
  708. alloc_info.allocationSize = IM_MAX(v->MinAllocationSize, req.size);
  709. alloc_info.memoryTypeIndex = ImGui_ImplVulkan_MemoryType(VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT, req.memoryTypeBits);
  710. err = vkAllocateMemory(v->Device, &alloc_info, v->Allocator, &upload_buffer_memory);
  711. check_vk_result(err);
  712. err = vkBindBufferMemory(v->Device, upload_buffer, upload_buffer_memory, 0);
  713. check_vk_result(err);
  714. }
  715. // Upload to Buffer:
  716. {
  717. char* map = nullptr;
  718. err = vkMapMemory(v->Device, upload_buffer_memory, 0, upload_size, 0, (void**)(&map));
  719. check_vk_result(err);
  720. for (int y = 0; y < upload_h; y++)
  721. memcpy(map + upload_pitch * y, tex->GetPixelsAt(upload_x, upload_y + y), (size_t)upload_pitch);
  722. VkMappedMemoryRange range[1] = {};
  723. range[0].sType = VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE;
  724. range[0].memory = upload_buffer_memory;
  725. range[0].size = upload_size;
  726. err = vkFlushMappedMemoryRanges(v->Device, 1, range);
  727. check_vk_result(err);
  728. vkUnmapMemory(v->Device, upload_buffer_memory);
  729. }
  730. // Start command buffer
  731. {
  732. err = vkResetCommandPool(v->Device, bd->TexCommandPool, 0);
  733. check_vk_result(err);
  734. VkCommandBufferBeginInfo begin_info = {};
  735. begin_info.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO;
  736. begin_info.flags |= VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT;
  737. err = vkBeginCommandBuffer(bd->TexCommandBuffer, &begin_info);
  738. check_vk_result(err);
  739. }
  740. // Copy to Image:
  741. {
  742. VkBufferMemoryBarrier upload_barrier[1] = {};
  743. upload_barrier[0].sType = VK_STRUCTURE_TYPE_BUFFER_MEMORY_BARRIER;
  744. upload_barrier[0].srcAccessMask = VK_ACCESS_HOST_WRITE_BIT;
  745. upload_barrier[0].dstAccessMask = VK_ACCESS_TRANSFER_READ_BIT;
  746. upload_barrier[0].srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  747. upload_barrier[0].dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  748. upload_barrier[0].buffer = upload_buffer;
  749. upload_barrier[0].offset = 0;
  750. upload_barrier[0].size = upload_size;
  751. VkImageMemoryBarrier copy_barrier[1] = {};
  752. copy_barrier[0].sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER;
  753. copy_barrier[0].dstAccessMask = VK_ACCESS_TRANSFER_WRITE_BIT;
  754. copy_barrier[0].oldLayout = VK_IMAGE_LAYOUT_UNDEFINED;
  755. copy_barrier[0].newLayout = VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL;
  756. copy_barrier[0].srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  757. copy_barrier[0].dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  758. copy_barrier[0].image = backend_tex->Image;
  759. copy_barrier[0].subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
  760. copy_barrier[0].subresourceRange.levelCount = 1;
  761. copy_barrier[0].subresourceRange.layerCount = 1;
  762. vkCmdPipelineBarrier(bd->TexCommandBuffer, VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT | VK_PIPELINE_STAGE_HOST_BIT, VK_PIPELINE_STAGE_TRANSFER_BIT, 0, 0, nullptr, 1, upload_barrier, 1, copy_barrier);
  763. VkBufferImageCopy region = {};
  764. region.imageSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
  765. region.imageSubresource.layerCount = 1;
  766. region.imageExtent.width = upload_w;
  767. region.imageExtent.height = upload_h;
  768. region.imageExtent.depth = 1;
  769. region.imageOffset.x = upload_x;
  770. region.imageOffset.y = upload_y;
  771. vkCmdCopyBufferToImage(bd->TexCommandBuffer, upload_buffer, backend_tex->Image, VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, 1, &region);
  772. VkImageMemoryBarrier use_barrier[1] = {};
  773. use_barrier[0].sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER;
  774. use_barrier[0].srcAccessMask = VK_ACCESS_TRANSFER_WRITE_BIT;
  775. use_barrier[0].dstAccessMask = VK_ACCESS_SHADER_READ_BIT;
  776. use_barrier[0].oldLayout = VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL;
  777. use_barrier[0].newLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
  778. use_barrier[0].srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  779. use_barrier[0].dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  780. use_barrier[0].image = backend_tex->Image;
  781. use_barrier[0].subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
  782. use_barrier[0].subresourceRange.levelCount = 1;
  783. use_barrier[0].subresourceRange.layerCount = 1;
  784. vkCmdPipelineBarrier(bd->TexCommandBuffer, VK_PIPELINE_STAGE_TRANSFER_BIT, VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT, 0, 0, nullptr, 0, nullptr, 1, use_barrier);
  785. }
  786. // End command buffer
  787. {
  788. VkSubmitInfo end_info = {};
  789. end_info.sType = VK_STRUCTURE_TYPE_SUBMIT_INFO;
  790. end_info.commandBufferCount = 1;
  791. end_info.pCommandBuffers = &bd->TexCommandBuffer;
  792. err = vkEndCommandBuffer(bd->TexCommandBuffer);
  793. check_vk_result(err);
  794. err = vkQueueSubmit(v->Queue, 1, &end_info, VK_NULL_HANDLE);
  795. check_vk_result(err);
  796. }
  797. err = vkQueueWaitIdle(v->Queue); // FIXME-OPT: Suboptimal!
  798. check_vk_result(err);
  799. vkDestroyBuffer(v->Device, upload_buffer, v->Allocator);
  800. vkFreeMemory(v->Device, upload_buffer_memory, v->Allocator);
  801. tex->SetStatus(ImTextureStatus_OK);
  802. }
  803. if (tex->Status == ImTextureStatus_WantDestroy && tex->UnusedFrames >= (int)bd->VulkanInitInfo.ImageCount)
  804. ImGui_ImplVulkan_DestroyTexture(tex);
  805. }
  806. static void ImGui_ImplVulkan_CreateShaderModules(VkDevice device, const VkAllocationCallbacks* allocator)
  807. {
  808. // Create the shader modules
  809. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  810. if (bd->ShaderModuleVert == VK_NULL_HANDLE)
  811. {
  812. VkShaderModuleCreateInfo vert_info = {};
  813. vert_info.sType = VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO;
  814. vert_info.codeSize = sizeof(__glsl_shader_vert_spv);
  815. vert_info.pCode = (uint32_t*)__glsl_shader_vert_spv;
  816. VkResult err = vkCreateShaderModule(device, &vert_info, allocator, &bd->ShaderModuleVert);
  817. check_vk_result(err);
  818. }
  819. if (bd->ShaderModuleFrag == VK_NULL_HANDLE)
  820. {
  821. VkShaderModuleCreateInfo frag_info = {};
  822. frag_info.sType = VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO;
  823. frag_info.codeSize = sizeof(__glsl_shader_frag_spv);
  824. frag_info.pCode = (uint32_t*)__glsl_shader_frag_spv;
  825. VkResult err = vkCreateShaderModule(device, &frag_info, allocator, &bd->ShaderModuleFrag);
  826. check_vk_result(err);
  827. }
  828. }
  829. static void ImGui_ImplVulkan_CreatePipeline(VkDevice device, const VkAllocationCallbacks* allocator, VkPipelineCache pipelineCache, VkRenderPass renderPass, VkSampleCountFlagBits MSAASamples, VkPipeline* pipeline, uint32_t subpass)
  830. {
  831. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  832. ImGui_ImplVulkan_CreateShaderModules(device, allocator);
  833. VkPipelineShaderStageCreateInfo stage[2] = {};
  834. stage[0].sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO;
  835. stage[0].stage = VK_SHADER_STAGE_VERTEX_BIT;
  836. stage[0].module = bd->ShaderModuleVert;
  837. stage[0].pName = "main";
  838. stage[1].sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO;
  839. stage[1].stage = VK_SHADER_STAGE_FRAGMENT_BIT;
  840. stage[1].module = bd->ShaderModuleFrag;
  841. stage[1].pName = "main";
  842. VkVertexInputBindingDescription binding_desc[1] = {};
  843. binding_desc[0].stride = sizeof(ImDrawVert);
  844. binding_desc[0].inputRate = VK_VERTEX_INPUT_RATE_VERTEX;
  845. VkVertexInputAttributeDescription attribute_desc[3] = {};
  846. attribute_desc[0].location = 0;
  847. attribute_desc[0].binding = binding_desc[0].binding;
  848. attribute_desc[0].format = VK_FORMAT_R32G32_SFLOAT;
  849. attribute_desc[0].offset = offsetof(ImDrawVert, pos);
  850. attribute_desc[1].location = 1;
  851. attribute_desc[1].binding = binding_desc[0].binding;
  852. attribute_desc[1].format = VK_FORMAT_R32G32_SFLOAT;
  853. attribute_desc[1].offset = offsetof(ImDrawVert, uv);
  854. attribute_desc[2].location = 2;
  855. attribute_desc[2].binding = binding_desc[0].binding;
  856. attribute_desc[2].format = VK_FORMAT_R8G8B8A8_UNORM;
  857. attribute_desc[2].offset = offsetof(ImDrawVert, col);
  858. VkPipelineVertexInputStateCreateInfo vertex_info = {};
  859. vertex_info.sType = VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO;
  860. vertex_info.vertexBindingDescriptionCount = 1;
  861. vertex_info.pVertexBindingDescriptions = binding_desc;
  862. vertex_info.vertexAttributeDescriptionCount = 3;
  863. vertex_info.pVertexAttributeDescriptions = attribute_desc;
  864. VkPipelineInputAssemblyStateCreateInfo ia_info = {};
  865. ia_info.sType = VK_STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO;
  866. ia_info.topology = VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST;
  867. VkPipelineViewportStateCreateInfo viewport_info = {};
  868. viewport_info.sType = VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO;
  869. viewport_info.viewportCount = 1;
  870. viewport_info.scissorCount = 1;
  871. VkPipelineRasterizationStateCreateInfo raster_info = {};
  872. raster_info.sType = VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO;
  873. raster_info.polygonMode = VK_POLYGON_MODE_FILL;
  874. raster_info.cullMode = VK_CULL_MODE_NONE;
  875. raster_info.frontFace = VK_FRONT_FACE_COUNTER_CLOCKWISE;
  876. raster_info.lineWidth = 1.0f;
  877. VkPipelineMultisampleStateCreateInfo ms_info = {};
  878. ms_info.sType = VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO;
  879. ms_info.rasterizationSamples = (MSAASamples != 0) ? MSAASamples : VK_SAMPLE_COUNT_1_BIT;
  880. VkPipelineColorBlendAttachmentState color_attachment[1] = {};
  881. color_attachment[0].blendEnable = VK_TRUE;
  882. color_attachment[0].srcColorBlendFactor = VK_BLEND_FACTOR_SRC_ALPHA;
  883. color_attachment[0].dstColorBlendFactor = VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;
  884. color_attachment[0].colorBlendOp = VK_BLEND_OP_ADD;
  885. color_attachment[0].srcAlphaBlendFactor = VK_BLEND_FACTOR_ONE;
  886. color_attachment[0].dstAlphaBlendFactor = VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;
  887. color_attachment[0].alphaBlendOp = VK_BLEND_OP_ADD;
  888. color_attachment[0].colorWriteMask = VK_COLOR_COMPONENT_R_BIT | VK_COLOR_COMPONENT_G_BIT | VK_COLOR_COMPONENT_B_BIT | VK_COLOR_COMPONENT_A_BIT;
  889. VkPipelineDepthStencilStateCreateInfo depth_info = {};
  890. depth_info.sType = VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO;
  891. VkPipelineColorBlendStateCreateInfo blend_info = {};
  892. blend_info.sType = VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO;
  893. blend_info.attachmentCount = 1;
  894. blend_info.pAttachments = color_attachment;
  895. VkDynamicState dynamic_states[2] = { VK_DYNAMIC_STATE_VIEWPORT, VK_DYNAMIC_STATE_SCISSOR };
  896. VkPipelineDynamicStateCreateInfo dynamic_state = {};
  897. dynamic_state.sType = VK_STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO;
  898. dynamic_state.dynamicStateCount = (uint32_t)IM_ARRAYSIZE(dynamic_states);
  899. dynamic_state.pDynamicStates = dynamic_states;
  900. VkGraphicsPipelineCreateInfo info = {};
  901. info.sType = VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO;
  902. info.flags = bd->PipelineCreateFlags;
  903. info.stageCount = 2;
  904. info.pStages = stage;
  905. info.pVertexInputState = &vertex_info;
  906. info.pInputAssemblyState = &ia_info;
  907. info.pViewportState = &viewport_info;
  908. info.pRasterizationState = &raster_info;
  909. info.pMultisampleState = &ms_info;
  910. info.pDepthStencilState = &depth_info;
  911. info.pColorBlendState = &blend_info;
  912. info.pDynamicState = &dynamic_state;
  913. info.layout = bd->PipelineLayout;
  914. info.renderPass = renderPass;
  915. info.subpass = subpass;
  916. #ifdef IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
  917. if (bd->VulkanInitInfo.UseDynamicRendering)
  918. {
  919. IM_ASSERT(bd->VulkanInitInfo.PipelineRenderingCreateInfo.sType == VK_STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO_KHR && "PipelineRenderingCreateInfo sType must be VK_STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO_KHR");
  920. IM_ASSERT(bd->VulkanInitInfo.PipelineRenderingCreateInfo.pNext == nullptr && "PipelineRenderingCreateInfo pNext must be nullptr");
  921. info.pNext = &bd->VulkanInitInfo.PipelineRenderingCreateInfo;
  922. info.renderPass = VK_NULL_HANDLE; // Just make sure it's actually nullptr.
  923. }
  924. #endif
  925. VkResult err = vkCreateGraphicsPipelines(device, pipelineCache, 1, &info, allocator, pipeline);
  926. check_vk_result(err);
  927. }
  928. bool ImGui_ImplVulkan_CreateDeviceObjects()
  929. {
  930. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  931. ImGui_ImplVulkan_InitInfo* v = &bd->VulkanInitInfo;
  932. VkResult err;
  933. if (!bd->TexSampler)
  934. {
  935. // Bilinear sampling is required by default. Set 'io.Fonts->Flags |= ImFontAtlasFlags_NoBakedLines' or 'style.AntiAliasedLinesUseTex = false' to allow point/nearest sampling.
  936. VkSamplerCreateInfo info = {};
  937. info.sType = VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO;
  938. info.magFilter = VK_FILTER_LINEAR;
  939. info.minFilter = VK_FILTER_LINEAR;
  940. info.mipmapMode = VK_SAMPLER_MIPMAP_MODE_LINEAR;
  941. info.addressModeU = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE;
  942. info.addressModeV = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE;
  943. info.addressModeW = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE;
  944. info.minLod = -1000;
  945. info.maxLod = 1000;
  946. info.maxAnisotropy = 1.0f;
  947. err = vkCreateSampler(v->Device, &info, v->Allocator, &bd->TexSampler);
  948. check_vk_result(err);
  949. }
  950. if (!bd->DescriptorSetLayout)
  951. {
  952. VkDescriptorSetLayoutBinding binding[1] = {};
  953. binding[0].descriptorType = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
  954. binding[0].descriptorCount = 1;
  955. binding[0].stageFlags = VK_SHADER_STAGE_FRAGMENT_BIT;
  956. VkDescriptorSetLayoutCreateInfo info = {};
  957. info.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO;
  958. info.bindingCount = 1;
  959. info.pBindings = binding;
  960. err = vkCreateDescriptorSetLayout(v->Device, &info, v->Allocator, &bd->DescriptorSetLayout);
  961. check_vk_result(err);
  962. }
  963. if (v->DescriptorPoolSize != 0)
  964. {
  965. IM_ASSERT(v->DescriptorPoolSize >= IMGUI_IMPL_VULKAN_MINIMUM_IMAGE_SAMPLER_POOL_SIZE);
  966. VkDescriptorPoolSize pool_size = { VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER, v->DescriptorPoolSize };
  967. VkDescriptorPoolCreateInfo pool_info = {};
  968. pool_info.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_POOL_CREATE_INFO;
  969. pool_info.flags = VK_DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT;
  970. pool_info.maxSets = v->DescriptorPoolSize;
  971. pool_info.poolSizeCount = 1;
  972. pool_info.pPoolSizes = &pool_size;
  973. err = vkCreateDescriptorPool(v->Device, &pool_info, v->Allocator, &bd->DescriptorPool);
  974. check_vk_result(err);
  975. }
  976. if (!bd->PipelineLayout)
  977. {
  978. // Constants: we are using 'vec2 offset' and 'vec2 scale' instead of a full 3d projection matrix
  979. VkPushConstantRange push_constants[1] = {};
  980. push_constants[0].stageFlags = VK_SHADER_STAGE_VERTEX_BIT;
  981. push_constants[0].offset = sizeof(float) * 0;
  982. push_constants[0].size = sizeof(float) * 4;
  983. VkDescriptorSetLayout set_layout[1] = { bd->DescriptorSetLayout };
  984. VkPipelineLayoutCreateInfo layout_info = {};
  985. layout_info.sType = VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO;
  986. layout_info.setLayoutCount = 1;
  987. layout_info.pSetLayouts = set_layout;
  988. layout_info.pushConstantRangeCount = 1;
  989. layout_info.pPushConstantRanges = push_constants;
  990. err = vkCreatePipelineLayout(v->Device, &layout_info, v->Allocator, &bd->PipelineLayout);
  991. check_vk_result(err);
  992. }
  993. ImGui_ImplVulkan_CreatePipeline(v->Device, v->Allocator, v->PipelineCache, v->RenderPass, v->MSAASamples, &bd->Pipeline, v->Subpass);
  994. // Create command pool/buffer for texture upload
  995. if (!bd->TexCommandPool)
  996. {
  997. VkCommandPoolCreateInfo info = {};
  998. info.sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO;
  999. info.flags = 0;
  1000. info.queueFamilyIndex = v->QueueFamily;
  1001. err = vkCreateCommandPool(v->Device, &info, v->Allocator, &bd->TexCommandPool);
  1002. check_vk_result(err);
  1003. }
  1004. if (!bd->TexCommandBuffer)
  1005. {
  1006. VkCommandBufferAllocateInfo info = {};
  1007. info.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO;
  1008. info.commandPool = bd->TexCommandPool;
  1009. info.commandBufferCount = 1;
  1010. err = vkAllocateCommandBuffers(v->Device, &info, &bd->TexCommandBuffer);
  1011. check_vk_result(err);
  1012. }
  1013. return true;
  1014. }
  1015. void ImGui_ImplVulkan_DestroyDeviceObjects()
  1016. {
  1017. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  1018. ImGui_ImplVulkan_InitInfo* v = &bd->VulkanInitInfo;
  1019. ImGui_ImplVulkan_DestroyWindowRenderBuffers(v->Device, &bd->MainWindowRenderBuffers, v->Allocator);
  1020. // Destroy all textures
  1021. for (ImTextureData* tex : ImGui::GetPlatformIO().Textures)
  1022. if (tex->RefCount == 1)
  1023. ImGui_ImplVulkan_DestroyTexture(tex);
  1024. if (bd->TexCommandBuffer) { vkFreeCommandBuffers(v->Device, bd->TexCommandPool, 1, &bd->TexCommandBuffer); bd->TexCommandBuffer = VK_NULL_HANDLE; }
  1025. if (bd->TexCommandPool) { vkDestroyCommandPool(v->Device, bd->TexCommandPool, v->Allocator); bd->TexCommandPool = VK_NULL_HANDLE; }
  1026. if (bd->TexSampler) { vkDestroySampler(v->Device, bd->TexSampler, v->Allocator); bd->TexSampler = VK_NULL_HANDLE; }
  1027. if (bd->ShaderModuleVert) { vkDestroyShaderModule(v->Device, bd->ShaderModuleVert, v->Allocator); bd->ShaderModuleVert = VK_NULL_HANDLE; }
  1028. if (bd->ShaderModuleFrag) { vkDestroyShaderModule(v->Device, bd->ShaderModuleFrag, v->Allocator); bd->ShaderModuleFrag = VK_NULL_HANDLE; }
  1029. if (bd->DescriptorSetLayout) { vkDestroyDescriptorSetLayout(v->Device, bd->DescriptorSetLayout, v->Allocator); bd->DescriptorSetLayout = VK_NULL_HANDLE; }
  1030. if (bd->PipelineLayout) { vkDestroyPipelineLayout(v->Device, bd->PipelineLayout, v->Allocator); bd->PipelineLayout = VK_NULL_HANDLE; }
  1031. if (bd->Pipeline) { vkDestroyPipeline(v->Device, bd->Pipeline, v->Allocator); bd->Pipeline = VK_NULL_HANDLE; }
  1032. if (bd->DescriptorPool) { vkDestroyDescriptorPool(v->Device, bd->DescriptorPool, v->Allocator); bd->DescriptorPool = VK_NULL_HANDLE; }
  1033. }
  1034. #ifdef IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
  1035. static void ImGui_ImplVulkan_LoadDynamicRenderingFunctions(uint32_t api_version, PFN_vkVoidFunction(*loader_func)(const char* function_name, void* user_data), void* user_data)
  1036. {
  1037. IM_UNUSED(api_version);
  1038. // Manually load those two (see #5446, #8326, #8365, #8600)
  1039. // - Try loading core (non-KHR) versions first (this will work for Vulkan 1.3+ and the device supports dynamic rendering)
  1040. ImGuiImplVulkanFuncs_vkCmdBeginRenderingKHR = reinterpret_cast<PFN_vkCmdBeginRenderingKHR>(loader_func("vkCmdBeginRendering", user_data));
  1041. ImGuiImplVulkanFuncs_vkCmdEndRenderingKHR = reinterpret_cast<PFN_vkCmdEndRenderingKHR>(loader_func("vkCmdEndRendering", user_data));
  1042. // - Fallback to KHR versions if core not available (this will work if KHR extension is available and enabled and also the device supports dynamic rendering)
  1043. if (ImGuiImplVulkanFuncs_vkCmdBeginRenderingKHR == nullptr || ImGuiImplVulkanFuncs_vkCmdEndRenderingKHR == nullptr)
  1044. {
  1045. ImGuiImplVulkanFuncs_vkCmdBeginRenderingKHR = reinterpret_cast<PFN_vkCmdBeginRenderingKHR>(loader_func("vkCmdBeginRenderingKHR", user_data));
  1046. ImGuiImplVulkanFuncs_vkCmdEndRenderingKHR = reinterpret_cast<PFN_vkCmdEndRenderingKHR>(loader_func("vkCmdEndRenderingKHR", user_data));
  1047. }
  1048. }
  1049. #endif
  1050. // If unspecified by user, assume that ApiVersion == HeaderVersion
  1051. // We don't care about other versions than 1.3 for our checks, so don't need to make this exhaustive (e.g. with all #ifdef VK_VERSION_1_X checks)
  1052. static uint32_t ImGui_ImplVulkan_GetDefaultApiVersion()
  1053. {
  1054. #ifdef VK_HEADER_VERSION_COMPLETE
  1055. return VK_HEADER_VERSION_COMPLETE;
  1056. #else
  1057. return VK_API_VERSION_1_0;
  1058. #endif
  1059. }
  1060. bool ImGui_ImplVulkan_LoadFunctions(uint32_t api_version, PFN_vkVoidFunction(*loader_func)(const char* function_name, void* user_data), void* user_data)
  1061. {
  1062. // Load function pointers
  1063. // You can use the default Vulkan loader using:
  1064. // ImGui_ImplVulkan_LoadFunctions(VK_API_VERSION_1_3, [](const char* function_name, void*) { return vkGetInstanceProcAddr(your_vk_isntance, function_name); });
  1065. // But this would be roughly equivalent to not setting VK_NO_PROTOTYPES.
  1066. if (api_version == 0)
  1067. api_version = ImGui_ImplVulkan_GetDefaultApiVersion();
  1068. #ifdef IMGUI_IMPL_VULKAN_USE_LOADER
  1069. #define IMGUI_VULKAN_FUNC_LOAD(func) \
  1070. func = reinterpret_cast<decltype(func)>(loader_func(#func, user_data)); \
  1071. if (func == nullptr) \
  1072. return false;
  1073. IMGUI_VULKAN_FUNC_MAP(IMGUI_VULKAN_FUNC_LOAD)
  1074. #undef IMGUI_VULKAN_FUNC_LOAD
  1075. #ifdef IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
  1076. ImGui_ImplVulkan_LoadDynamicRenderingFunctions(api_version, loader_func, user_data);
  1077. #endif
  1078. #else
  1079. IM_UNUSED(loader_func);
  1080. IM_UNUSED(user_data);
  1081. #endif
  1082. g_FunctionsLoaded = true;
  1083. return true;
  1084. }
  1085. bool ImGui_ImplVulkan_Init(ImGui_ImplVulkan_InitInfo* info)
  1086. {
  1087. IM_ASSERT(g_FunctionsLoaded && "Need to call ImGui_ImplVulkan_LoadFunctions() if IMGUI_IMPL_VULKAN_NO_PROTOTYPES or VK_NO_PROTOTYPES are set!");
  1088. if (info->ApiVersion == 0)
  1089. info->ApiVersion = ImGui_ImplVulkan_GetDefaultApiVersion();
  1090. if (info->UseDynamicRendering)
  1091. {
  1092. #ifdef IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
  1093. #ifndef IMGUI_IMPL_VULKAN_USE_LOADER
  1094. ImGui_ImplVulkan_LoadDynamicRenderingFunctions(info->ApiVersion, [](const char* function_name, void* user_data) { return vkGetDeviceProcAddr((VkDevice)user_data, function_name); }, (void*)info->Device);
  1095. #endif
  1096. IM_ASSERT(ImGuiImplVulkanFuncs_vkCmdBeginRenderingKHR != nullptr);
  1097. IM_ASSERT(ImGuiImplVulkanFuncs_vkCmdEndRenderingKHR != nullptr);
  1098. #else
  1099. IM_ASSERT(0 && "Can't use dynamic rendering when neither VK_VERSION_1_3 or VK_KHR_dynamic_rendering is defined.");
  1100. #endif
  1101. }
  1102. ImGuiIO& io = ImGui::GetIO();
  1103. IMGUI_CHECKVERSION();
  1104. IM_ASSERT(io.BackendRendererUserData == nullptr && "Already initialized a renderer backend!");
  1105. // Setup backend capabilities flags
  1106. ImGui_ImplVulkan_Data* bd = IM_NEW(ImGui_ImplVulkan_Data)();
  1107. io.BackendRendererUserData = (void*)bd;
  1108. io.BackendRendererName = "imgui_impl_vulkan";
  1109. io.BackendFlags |= ImGuiBackendFlags_RendererHasVtxOffset; // We can honor the ImDrawCmd::VtxOffset field, allowing for large meshes.
  1110. io.BackendFlags |= ImGuiBackendFlags_RendererHasTextures; // We can honor ImGuiPlatformIO::Textures[] requests during render.
  1111. IM_ASSERT(info->Instance != VK_NULL_HANDLE);
  1112. IM_ASSERT(info->PhysicalDevice != VK_NULL_HANDLE);
  1113. IM_ASSERT(info->Device != VK_NULL_HANDLE);
  1114. IM_ASSERT(info->Queue != VK_NULL_HANDLE);
  1115. if (info->DescriptorPool != VK_NULL_HANDLE) // Either DescriptorPool or DescriptorPoolSize must be set, not both!
  1116. IM_ASSERT(info->DescriptorPoolSize == 0);
  1117. else
  1118. IM_ASSERT(info->DescriptorPoolSize > 0);
  1119. IM_ASSERT(info->MinImageCount >= 2);
  1120. IM_ASSERT(info->ImageCount >= info->MinImageCount);
  1121. if (info->UseDynamicRendering == false)
  1122. IM_ASSERT(info->RenderPass != VK_NULL_HANDLE);
  1123. bd->VulkanInitInfo = *info;
  1124. VkPhysicalDeviceProperties properties;
  1125. vkGetPhysicalDeviceProperties(info->PhysicalDevice, &properties);
  1126. bd->NonCoherentAtomSize = properties.limits.nonCoherentAtomSize;
  1127. #ifdef IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
  1128. ImGui_ImplVulkan_InitInfo* v = &bd->VulkanInitInfo;
  1129. if (v->PipelineRenderingCreateInfo.pColorAttachmentFormats != NULL)
  1130. {
  1131. // Deep copy buffer to reduce error-rate for end user (#8282)
  1132. VkFormat* formats_copy = (VkFormat*)IM_ALLOC(sizeof(VkFormat) * v->PipelineRenderingCreateInfo.colorAttachmentCount);
  1133. memcpy(formats_copy, v->PipelineRenderingCreateInfo.pColorAttachmentFormats, sizeof(VkFormat) * v->PipelineRenderingCreateInfo.colorAttachmentCount);
  1134. v->PipelineRenderingCreateInfo.pColorAttachmentFormats = formats_copy;
  1135. }
  1136. #endif
  1137. if (!ImGui_ImplVulkan_CreateDeviceObjects())
  1138. IM_ASSERT(0 && "ImGui_ImplVulkan_CreateDeviceObjects() failed!"); // <- Can't be hit yet.
  1139. return true;
  1140. }
  1141. void ImGui_ImplVulkan_Shutdown()
  1142. {
  1143. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  1144. IM_ASSERT(bd != nullptr && "No renderer backend to shutdown, or already shutdown?");
  1145. ImGuiIO& io = ImGui::GetIO();
  1146. ImGui_ImplVulkan_DestroyDeviceObjects();
  1147. #ifdef IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
  1148. IM_FREE((void*)const_cast<VkFormat*>(bd->VulkanInitInfo.PipelineRenderingCreateInfo.pColorAttachmentFormats));
  1149. #endif
  1150. io.BackendRendererName = nullptr;
  1151. io.BackendRendererUserData = nullptr;
  1152. io.BackendFlags &= ~(ImGuiBackendFlags_RendererHasVtxOffset | ImGuiBackendFlags_RendererHasTextures);
  1153. IM_DELETE(bd);
  1154. }
  1155. void ImGui_ImplVulkan_NewFrame()
  1156. {
  1157. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  1158. IM_ASSERT(bd != nullptr && "Context or backend not initialized! Did you call ImGui_ImplVulkan_Init()?");
  1159. IM_UNUSED(bd);
  1160. }
  1161. void ImGui_ImplVulkan_SetMinImageCount(uint32_t min_image_count)
  1162. {
  1163. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  1164. IM_ASSERT(min_image_count >= 2);
  1165. if (bd->VulkanInitInfo.MinImageCount == min_image_count)
  1166. return;
  1167. ImGui_ImplVulkan_InitInfo* v = &bd->VulkanInitInfo;
  1168. VkResult err = vkDeviceWaitIdle(v->Device);
  1169. check_vk_result(err);
  1170. ImGui_ImplVulkan_DestroyWindowRenderBuffers(v->Device, &bd->MainWindowRenderBuffers, v->Allocator);
  1171. bd->VulkanInitInfo.MinImageCount = min_image_count;
  1172. }
  1173. // Register a texture by creating a descriptor
  1174. // FIXME: This is experimental in the sense that we are unsure how to best design/tackle this problem, please post to https://github.com/ocornut/imgui/pull/914 if you have suggestions.
  1175. VkDescriptorSet ImGui_ImplVulkan_AddTexture(VkSampler sampler, VkImageView image_view, VkImageLayout image_layout)
  1176. {
  1177. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  1178. ImGui_ImplVulkan_InitInfo* v = &bd->VulkanInitInfo;
  1179. VkDescriptorPool pool = bd->DescriptorPool ? bd->DescriptorPool : v->DescriptorPool;
  1180. // Create Descriptor Set:
  1181. VkDescriptorSet descriptor_set;
  1182. {
  1183. VkDescriptorSetAllocateInfo alloc_info = {};
  1184. alloc_info.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO;
  1185. alloc_info.descriptorPool = pool;
  1186. alloc_info.descriptorSetCount = 1;
  1187. alloc_info.pSetLayouts = &bd->DescriptorSetLayout;
  1188. VkResult err = vkAllocateDescriptorSets(v->Device, &alloc_info, &descriptor_set);
  1189. check_vk_result(err);
  1190. }
  1191. // Update the Descriptor Set:
  1192. {
  1193. VkDescriptorImageInfo desc_image[1] = {};
  1194. desc_image[0].sampler = sampler;
  1195. desc_image[0].imageView = image_view;
  1196. desc_image[0].imageLayout = image_layout;
  1197. VkWriteDescriptorSet write_desc[1] = {};
  1198. write_desc[0].sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
  1199. write_desc[0].dstSet = descriptor_set;
  1200. write_desc[0].descriptorCount = 1;
  1201. write_desc[0].descriptorType = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
  1202. write_desc[0].pImageInfo = desc_image;
  1203. vkUpdateDescriptorSets(v->Device, 1, write_desc, 0, nullptr);
  1204. }
  1205. return descriptor_set;
  1206. }
  1207. void ImGui_ImplVulkan_RemoveTexture(VkDescriptorSet descriptor_set)
  1208. {
  1209. ImGui_ImplVulkan_Data* bd = ImGui_ImplVulkan_GetBackendData();
  1210. ImGui_ImplVulkan_InitInfo* v = &bd->VulkanInitInfo;
  1211. VkDescriptorPool pool = bd->DescriptorPool ? bd->DescriptorPool : v->DescriptorPool;
  1212. vkFreeDescriptorSets(v->Device, pool, 1, &descriptor_set);
  1213. }
  1214. void ImGui_ImplVulkan_DestroyFrameRenderBuffers(VkDevice device, ImGui_ImplVulkan_FrameRenderBuffers* buffers, const VkAllocationCallbacks* allocator)
  1215. {
  1216. if (buffers->VertexBuffer) { vkDestroyBuffer(device, buffers->VertexBuffer, allocator); buffers->VertexBuffer = VK_NULL_HANDLE; }
  1217. if (buffers->VertexBufferMemory) { vkFreeMemory(device, buffers->VertexBufferMemory, allocator); buffers->VertexBufferMemory = VK_NULL_HANDLE; }
  1218. if (buffers->IndexBuffer) { vkDestroyBuffer(device, buffers->IndexBuffer, allocator); buffers->IndexBuffer = VK_NULL_HANDLE; }
  1219. if (buffers->IndexBufferMemory) { vkFreeMemory(device, buffers->IndexBufferMemory, allocator); buffers->IndexBufferMemory = VK_NULL_HANDLE; }
  1220. buffers->VertexBufferSize = 0;
  1221. buffers->IndexBufferSize = 0;
  1222. }
  1223. void ImGui_ImplVulkan_DestroyWindowRenderBuffers(VkDevice device, ImGui_ImplVulkan_WindowRenderBuffers* buffers, const VkAllocationCallbacks* allocator)
  1224. {
  1225. for (uint32_t n = 0; n < buffers->Count; n++)
  1226. ImGui_ImplVulkan_DestroyFrameRenderBuffers(device, &buffers->FrameRenderBuffers[n], allocator);
  1227. buffers->FrameRenderBuffers.clear();
  1228. buffers->Index = 0;
  1229. buffers->Count = 0;
  1230. }
  1231. //-------------------------------------------------------------------------
  1232. // Internal / Miscellaneous Vulkan Helpers
  1233. // (Used by example's main.cpp. Used by multi-viewport features. PROBABLY NOT used by your own app.)
  1234. //-------------------------------------------------------------------------
  1235. // You probably do NOT need to use or care about those functions.
  1236. // Those functions only exist because:
  1237. // 1) they facilitate the readability and maintenance of the multiple main.cpp examples files.
  1238. // 2) the upcoming multi-viewport feature will need them internally.
  1239. // Generally we avoid exposing any kind of superfluous high-level helpers in the backends,
  1240. // but it is too much code to duplicate everywhere so we exceptionally expose them.
  1241. //
  1242. // Your engine/app will likely _already_ have code to setup all that stuff (swap chain, render pass, frame buffers, etc.).
  1243. // You may read this code to learn about Vulkan, but it is recommended you use you own custom tailored code to do equivalent work.
  1244. // (The ImGui_ImplVulkanH_XXX functions do not interact with any of the state used by the regular ImGui_ImplVulkan_XXX functions)
  1245. //-------------------------------------------------------------------------
  1246. VkSurfaceFormatKHR ImGui_ImplVulkanH_SelectSurfaceFormat(VkPhysicalDevice physical_device, VkSurfaceKHR surface, const VkFormat* request_formats, int request_formats_count, VkColorSpaceKHR request_color_space)
  1247. {
  1248. IM_ASSERT(g_FunctionsLoaded && "Need to call ImGui_ImplVulkan_LoadFunctions() if IMGUI_IMPL_VULKAN_NO_PROTOTYPES or VK_NO_PROTOTYPES are set!");
  1249. IM_ASSERT(request_formats != nullptr);
  1250. IM_ASSERT(request_formats_count > 0);
  1251. // Per Spec Format and View Format are expected to be the same unless VK_IMAGE_CREATE_MUTABLE_BIT was set at image creation
  1252. // Assuming that the default behavior is without setting this bit, there is no need for separate Swapchain image and image view format
  1253. // Additionally several new color spaces were introduced with Vulkan Spec v1.0.40,
  1254. // hence we must make sure that a format with the mostly available color space, VK_COLOR_SPACE_SRGB_NONLINEAR_KHR, is found and used.
  1255. uint32_t avail_count;
  1256. vkGetPhysicalDeviceSurfaceFormatsKHR(physical_device, surface, &avail_count, nullptr);
  1257. ImVector<VkSurfaceFormatKHR> avail_format;
  1258. avail_format.resize((int)avail_count);
  1259. vkGetPhysicalDeviceSurfaceFormatsKHR(physical_device, surface, &avail_count, avail_format.Data);
  1260. // First check if only one format, VK_FORMAT_UNDEFINED, is available, which would imply that any format is available
  1261. if (avail_count == 1)
  1262. {
  1263. if (avail_format[0].format == VK_FORMAT_UNDEFINED)
  1264. {
  1265. VkSurfaceFormatKHR ret;
  1266. ret.format = request_formats[0];
  1267. ret.colorSpace = request_color_space;
  1268. return ret;
  1269. }
  1270. else
  1271. {
  1272. // No point in searching another format
  1273. return avail_format[0];
  1274. }
  1275. }
  1276. else
  1277. {
  1278. // Request several formats, the first found will be used
  1279. for (int request_i = 0; request_i < request_formats_count; request_i++)
  1280. for (uint32_t avail_i = 0; avail_i < avail_count; avail_i++)
  1281. if (avail_format[avail_i].format == request_formats[request_i] && avail_format[avail_i].colorSpace == request_color_space)
  1282. return avail_format[avail_i];
  1283. // If none of the requested image formats could be found, use the first available
  1284. return avail_format[0];
  1285. }
  1286. }
  1287. VkPresentModeKHR ImGui_ImplVulkanH_SelectPresentMode(VkPhysicalDevice physical_device, VkSurfaceKHR surface, const VkPresentModeKHR* request_modes, int request_modes_count)
  1288. {
  1289. IM_ASSERT(g_FunctionsLoaded && "Need to call ImGui_ImplVulkan_LoadFunctions() if IMGUI_IMPL_VULKAN_NO_PROTOTYPES or VK_NO_PROTOTYPES are set!");
  1290. IM_ASSERT(request_modes != nullptr);
  1291. IM_ASSERT(request_modes_count > 0);
  1292. // Request a certain mode and confirm that it is available. If not use VK_PRESENT_MODE_FIFO_KHR which is mandatory
  1293. uint32_t avail_count = 0;
  1294. vkGetPhysicalDeviceSurfacePresentModesKHR(physical_device, surface, &avail_count, nullptr);
  1295. ImVector<VkPresentModeKHR> avail_modes;
  1296. avail_modes.resize((int)avail_count);
  1297. vkGetPhysicalDeviceSurfacePresentModesKHR(physical_device, surface, &avail_count, avail_modes.Data);
  1298. //for (uint32_t avail_i = 0; avail_i < avail_count; avail_i++)
  1299. // printf("[vulkan] avail_modes[%d] = %d\n", avail_i, avail_modes[avail_i]);
  1300. for (int request_i = 0; request_i < request_modes_count; request_i++)
  1301. for (uint32_t avail_i = 0; avail_i < avail_count; avail_i++)
  1302. if (request_modes[request_i] == avail_modes[avail_i])
  1303. return request_modes[request_i];
  1304. return VK_PRESENT_MODE_FIFO_KHR; // Always available
  1305. }
  1306. VkPhysicalDevice ImGui_ImplVulkanH_SelectPhysicalDevice(VkInstance instance)
  1307. {
  1308. uint32_t gpu_count;
  1309. VkResult err = vkEnumeratePhysicalDevices(instance, &gpu_count, nullptr);
  1310. check_vk_result(err);
  1311. IM_ASSERT(gpu_count > 0);
  1312. ImVector<VkPhysicalDevice> gpus;
  1313. gpus.resize(gpu_count);
  1314. err = vkEnumeratePhysicalDevices(instance, &gpu_count, gpus.Data);
  1315. check_vk_result(err);
  1316. // If a number >1 of GPUs got reported, find discrete GPU if present, or use first one available. This covers
  1317. // most common cases (multi-gpu/integrated+dedicated graphics). Handling more complicated setups (multiple
  1318. // dedicated GPUs) is out of scope of this sample.
  1319. for (VkPhysicalDevice& device : gpus)
  1320. {
  1321. VkPhysicalDeviceProperties properties;
  1322. vkGetPhysicalDeviceProperties(device, &properties);
  1323. if (properties.deviceType == VK_PHYSICAL_DEVICE_TYPE_DISCRETE_GPU)
  1324. return device;
  1325. }
  1326. // Use first GPU (Integrated) is a Discrete one is not available.
  1327. if (gpu_count > 0)
  1328. return gpus[0];
  1329. return VK_NULL_HANDLE;
  1330. }
  1331. uint32_t ImGui_ImplVulkanH_SelectQueueFamilyIndex(VkPhysicalDevice physical_device)
  1332. {
  1333. uint32_t count;
  1334. vkGetPhysicalDeviceQueueFamilyProperties(physical_device, &count, nullptr);
  1335. ImVector<VkQueueFamilyProperties> queues_properties;
  1336. queues_properties.resize((int)count);
  1337. vkGetPhysicalDeviceQueueFamilyProperties(physical_device, &count, queues_properties.Data);
  1338. for (uint32_t i = 0; i < count; i++)
  1339. if (queues_properties[i].queueFlags & VK_QUEUE_GRAPHICS_BIT)
  1340. return i;
  1341. return (uint32_t)-1;
  1342. }
  1343. void ImGui_ImplVulkanH_CreateWindowCommandBuffers(VkPhysicalDevice physical_device, VkDevice device, ImGui_ImplVulkanH_Window* wd, uint32_t queue_family, const VkAllocationCallbacks* allocator)
  1344. {
  1345. IM_ASSERT(physical_device != VK_NULL_HANDLE && device != VK_NULL_HANDLE);
  1346. IM_UNUSED(physical_device);
  1347. // Create Command Buffers
  1348. VkResult err;
  1349. for (uint32_t i = 0; i < wd->ImageCount; i++)
  1350. {
  1351. ImGui_ImplVulkanH_Frame* fd = &wd->Frames[i];
  1352. {
  1353. VkCommandPoolCreateInfo info = {};
  1354. info.sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO;
  1355. info.flags = 0;
  1356. info.queueFamilyIndex = queue_family;
  1357. err = vkCreateCommandPool(device, &info, allocator, &fd->CommandPool);
  1358. check_vk_result(err);
  1359. }
  1360. {
  1361. VkCommandBufferAllocateInfo info = {};
  1362. info.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO;
  1363. info.commandPool = fd->CommandPool;
  1364. info.level = VK_COMMAND_BUFFER_LEVEL_PRIMARY;
  1365. info.commandBufferCount = 1;
  1366. err = vkAllocateCommandBuffers(device, &info, &fd->CommandBuffer);
  1367. check_vk_result(err);
  1368. }
  1369. {
  1370. VkFenceCreateInfo info = {};
  1371. info.sType = VK_STRUCTURE_TYPE_FENCE_CREATE_INFO;
  1372. info.flags = VK_FENCE_CREATE_SIGNALED_BIT;
  1373. err = vkCreateFence(device, &info, allocator, &fd->Fence);
  1374. check_vk_result(err);
  1375. }
  1376. }
  1377. for (uint32_t i = 0; i < wd->SemaphoreCount; i++)
  1378. {
  1379. ImGui_ImplVulkanH_FrameSemaphores* fsd = &wd->FrameSemaphores[i];
  1380. {
  1381. VkSemaphoreCreateInfo info = {};
  1382. info.sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO;
  1383. err = vkCreateSemaphore(device, &info, allocator, &fsd->ImageAcquiredSemaphore);
  1384. check_vk_result(err);
  1385. err = vkCreateSemaphore(device, &info, allocator, &fsd->RenderCompleteSemaphore);
  1386. check_vk_result(err);
  1387. }
  1388. }
  1389. }
  1390. int ImGui_ImplVulkanH_GetMinImageCountFromPresentMode(VkPresentModeKHR present_mode)
  1391. {
  1392. if (present_mode == VK_PRESENT_MODE_MAILBOX_KHR)
  1393. return 3;
  1394. if (present_mode == VK_PRESENT_MODE_FIFO_KHR || present_mode == VK_PRESENT_MODE_FIFO_RELAXED_KHR)
  1395. return 2;
  1396. if (present_mode == VK_PRESENT_MODE_IMMEDIATE_KHR)
  1397. return 1;
  1398. IM_ASSERT(0);
  1399. return 1;
  1400. }
  1401. // Also destroy old swap chain and in-flight frames data, if any.
  1402. void ImGui_ImplVulkanH_CreateWindowSwapChain(VkPhysicalDevice physical_device, VkDevice device, ImGui_ImplVulkanH_Window* wd, const VkAllocationCallbacks* allocator, int w, int h, uint32_t min_image_count)
  1403. {
  1404. VkResult err;
  1405. VkSwapchainKHR old_swapchain = wd->Swapchain;
  1406. wd->Swapchain = VK_NULL_HANDLE;
  1407. err = vkDeviceWaitIdle(device);
  1408. check_vk_result(err);
  1409. // We don't use ImGui_ImplVulkanH_DestroyWindow() because we want to preserve the old swapchain to create the new one.
  1410. // Destroy old Framebuffer
  1411. for (uint32_t i = 0; i < wd->ImageCount; i++)
  1412. ImGui_ImplVulkanH_DestroyFrame(device, &wd->Frames[i], allocator);
  1413. for (uint32_t i = 0; i < wd->SemaphoreCount; i++)
  1414. ImGui_ImplVulkanH_DestroyFrameSemaphores(device, &wd->FrameSemaphores[i], allocator);
  1415. wd->Frames.clear();
  1416. wd->FrameSemaphores.clear();
  1417. wd->ImageCount = 0;
  1418. if (wd->RenderPass)
  1419. vkDestroyRenderPass(device, wd->RenderPass, allocator);
  1420. if (wd->Pipeline)
  1421. vkDestroyPipeline(device, wd->Pipeline, allocator);
  1422. // If min image count was not specified, request different count of images dependent on selected present mode
  1423. if (min_image_count == 0)
  1424. min_image_count = ImGui_ImplVulkanH_GetMinImageCountFromPresentMode(wd->PresentMode);
  1425. // Create Swapchain
  1426. {
  1427. VkSurfaceCapabilitiesKHR cap;
  1428. err = vkGetPhysicalDeviceSurfaceCapabilitiesKHR(physical_device, wd->Surface, &cap);
  1429. check_vk_result(err);
  1430. VkSwapchainCreateInfoKHR info = {};
  1431. info.sType = VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR;
  1432. info.surface = wd->Surface;
  1433. info.minImageCount = min_image_count;
  1434. info.imageFormat = wd->SurfaceFormat.format;
  1435. info.imageColorSpace = wd->SurfaceFormat.colorSpace;
  1436. info.imageArrayLayers = 1;
  1437. info.imageUsage = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
  1438. info.imageSharingMode = VK_SHARING_MODE_EXCLUSIVE; // Assume that graphics family == present family
  1439. info.preTransform = (cap.supportedTransforms & VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR) ? VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR : cap.currentTransform;
  1440. info.compositeAlpha = VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR;
  1441. info.presentMode = wd->PresentMode;
  1442. info.clipped = VK_TRUE;
  1443. info.oldSwapchain = old_swapchain;
  1444. if (info.minImageCount < cap.minImageCount)
  1445. info.minImageCount = cap.minImageCount;
  1446. else if (cap.maxImageCount != 0 && info.minImageCount > cap.maxImageCount)
  1447. info.minImageCount = cap.maxImageCount;
  1448. if (cap.currentExtent.width == 0xffffffff)
  1449. {
  1450. info.imageExtent.width = wd->Width = w;
  1451. info.imageExtent.height = wd->Height = h;
  1452. }
  1453. else
  1454. {
  1455. info.imageExtent.width = wd->Width = cap.currentExtent.width;
  1456. info.imageExtent.height = wd->Height = cap.currentExtent.height;
  1457. }
  1458. err = vkCreateSwapchainKHR(device, &info, allocator, &wd->Swapchain);
  1459. check_vk_result(err);
  1460. err = vkGetSwapchainImagesKHR(device, wd->Swapchain, &wd->ImageCount, nullptr);
  1461. check_vk_result(err);
  1462. VkImage backbuffers[16] = {};
  1463. IM_ASSERT(wd->ImageCount >= min_image_count);
  1464. IM_ASSERT(wd->ImageCount < IM_ARRAYSIZE(backbuffers));
  1465. err = vkGetSwapchainImagesKHR(device, wd->Swapchain, &wd->ImageCount, backbuffers);
  1466. check_vk_result(err);
  1467. wd->SemaphoreCount = wd->ImageCount + 1;
  1468. wd->Frames.resize(wd->ImageCount);
  1469. wd->FrameSemaphores.resize(wd->SemaphoreCount);
  1470. memset(wd->Frames.Data, 0, wd->Frames.size_in_bytes());
  1471. memset(wd->FrameSemaphores.Data, 0, wd->FrameSemaphores.size_in_bytes());
  1472. for (uint32_t i = 0; i < wd->ImageCount; i++)
  1473. wd->Frames[i].Backbuffer = backbuffers[i];
  1474. }
  1475. if (old_swapchain)
  1476. vkDestroySwapchainKHR(device, old_swapchain, allocator);
  1477. // Create the Render Pass
  1478. if (wd->UseDynamicRendering == false)
  1479. {
  1480. VkAttachmentDescription attachment = {};
  1481. attachment.format = wd->SurfaceFormat.format;
  1482. attachment.samples = VK_SAMPLE_COUNT_1_BIT;
  1483. attachment.loadOp = wd->ClearEnable ? VK_ATTACHMENT_LOAD_OP_CLEAR : VK_ATTACHMENT_LOAD_OP_DONT_CARE;
  1484. attachment.storeOp = VK_ATTACHMENT_STORE_OP_STORE;
  1485. attachment.stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE;
  1486. attachment.stencilStoreOp = VK_ATTACHMENT_STORE_OP_DONT_CARE;
  1487. attachment.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
  1488. attachment.finalLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR;
  1489. VkAttachmentReference color_attachment = {};
  1490. color_attachment.attachment = 0;
  1491. color_attachment.layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
  1492. VkSubpassDescription subpass = {};
  1493. subpass.pipelineBindPoint = VK_PIPELINE_BIND_POINT_GRAPHICS;
  1494. subpass.colorAttachmentCount = 1;
  1495. subpass.pColorAttachments = &color_attachment;
  1496. VkSubpassDependency dependency = {};
  1497. dependency.srcSubpass = VK_SUBPASS_EXTERNAL;
  1498. dependency.dstSubpass = 0;
  1499. dependency.srcStageMask = VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT;
  1500. dependency.dstStageMask = VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT;
  1501. dependency.srcAccessMask = 0;
  1502. dependency.dstAccessMask = VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT;
  1503. VkRenderPassCreateInfo info = {};
  1504. info.sType = VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO;
  1505. info.attachmentCount = 1;
  1506. info.pAttachments = &attachment;
  1507. info.subpassCount = 1;
  1508. info.pSubpasses = &subpass;
  1509. info.dependencyCount = 1;
  1510. info.pDependencies = &dependency;
  1511. err = vkCreateRenderPass(device, &info, allocator, &wd->RenderPass);
  1512. check_vk_result(err);
  1513. // We do not create a pipeline by default as this is also used by examples' main.cpp,
  1514. // but secondary viewport in multi-viewport mode may want to create one with:
  1515. //ImGui_ImplVulkan_CreatePipeline(device, allocator, VK_NULL_HANDLE, wd->RenderPass, VK_SAMPLE_COUNT_1_BIT, &wd->Pipeline, v->Subpass);
  1516. }
  1517. // Create The Image Views
  1518. {
  1519. VkImageViewCreateInfo info = {};
  1520. info.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO;
  1521. info.viewType = VK_IMAGE_VIEW_TYPE_2D;
  1522. info.format = wd->SurfaceFormat.format;
  1523. info.components.r = VK_COMPONENT_SWIZZLE_R;
  1524. info.components.g = VK_COMPONENT_SWIZZLE_G;
  1525. info.components.b = VK_COMPONENT_SWIZZLE_B;
  1526. info.components.a = VK_COMPONENT_SWIZZLE_A;
  1527. VkImageSubresourceRange image_range = { VK_IMAGE_ASPECT_COLOR_BIT, 0, 1, 0, 1 };
  1528. info.subresourceRange = image_range;
  1529. for (uint32_t i = 0; i < wd->ImageCount; i++)
  1530. {
  1531. ImGui_ImplVulkanH_Frame* fd = &wd->Frames[i];
  1532. info.image = fd->Backbuffer;
  1533. err = vkCreateImageView(device, &info, allocator, &fd->BackbufferView);
  1534. check_vk_result(err);
  1535. }
  1536. }
  1537. // Create Framebuffer
  1538. if (wd->UseDynamicRendering == false)
  1539. {
  1540. VkImageView attachment[1];
  1541. VkFramebufferCreateInfo info = {};
  1542. info.sType = VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO;
  1543. info.renderPass = wd->RenderPass;
  1544. info.attachmentCount = 1;
  1545. info.pAttachments = attachment;
  1546. info.width = wd->Width;
  1547. info.height = wd->Height;
  1548. info.layers = 1;
  1549. for (uint32_t i = 0; i < wd->ImageCount; i++)
  1550. {
  1551. ImGui_ImplVulkanH_Frame* fd = &wd->Frames[i];
  1552. attachment[0] = fd->BackbufferView;
  1553. err = vkCreateFramebuffer(device, &info, allocator, &fd->Framebuffer);
  1554. check_vk_result(err);
  1555. }
  1556. }
  1557. }
  1558. // Create or resize window
  1559. void ImGui_ImplVulkanH_CreateOrResizeWindow(VkInstance instance, VkPhysicalDevice physical_device, VkDevice device, ImGui_ImplVulkanH_Window* wd, uint32_t queue_family, const VkAllocationCallbacks* allocator, int width, int height, uint32_t min_image_count)
  1560. {
  1561. IM_ASSERT(g_FunctionsLoaded && "Need to call ImGui_ImplVulkan_LoadFunctions() if IMGUI_IMPL_VULKAN_NO_PROTOTYPES or VK_NO_PROTOTYPES are set!");
  1562. (void)instance;
  1563. ImGui_ImplVulkanH_CreateWindowSwapChain(physical_device, device, wd, allocator, width, height, min_image_count);
  1564. ImGui_ImplVulkanH_CreateWindowCommandBuffers(physical_device, device, wd, queue_family, allocator);
  1565. // FIXME: to submit the command buffer, we need a queue. In the examples folder, the ImGui_ImplVulkanH_CreateOrResizeWindow function is called
  1566. // before the ImGui_ImplVulkan_Init function, so we don't have access to the queue yet. Here we have the queue_family that we can use to grab
  1567. // a queue from the device and submit the command buffer. It would be better to have access to the queue as suggested in the FIXME below.
  1568. VkCommandPool command_pool;
  1569. VkCommandPoolCreateInfo pool_info = {};
  1570. pool_info.sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO;
  1571. pool_info.queueFamilyIndex = queue_family;
  1572. pool_info.flags = VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT;
  1573. VkResult err = vkCreateCommandPool(device, &pool_info, allocator, &command_pool);
  1574. check_vk_result(err);
  1575. VkFenceCreateInfo fence_info = {};
  1576. fence_info.sType = VK_STRUCTURE_TYPE_FENCE_CREATE_INFO;
  1577. VkFence fence;
  1578. err = vkCreateFence(device, &fence_info, allocator, &fence);
  1579. check_vk_result(err);
  1580. VkCommandBufferAllocateInfo alloc_info = {};
  1581. alloc_info.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO;
  1582. alloc_info.commandPool = command_pool;
  1583. alloc_info.level = VK_COMMAND_BUFFER_LEVEL_PRIMARY;
  1584. alloc_info.commandBufferCount = 1;
  1585. VkCommandBuffer command_buffer;
  1586. err = vkAllocateCommandBuffers(device, &alloc_info, &command_buffer);
  1587. check_vk_result(err);
  1588. VkCommandBufferBeginInfo begin_info = {};
  1589. begin_info.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO;
  1590. begin_info.flags = VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT;
  1591. err = vkBeginCommandBuffer(command_buffer, &begin_info);
  1592. check_vk_result(err);
  1593. // Transition the images to the correct layout for rendering
  1594. for (uint32_t i = 0; i < wd->ImageCount; i++)
  1595. {
  1596. VkImageMemoryBarrier barrier = {};
  1597. barrier.sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER;
  1598. barrier.image = wd->Frames[i].Backbuffer;
  1599. barrier.oldLayout = VK_IMAGE_LAYOUT_UNDEFINED;
  1600. barrier.newLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR;
  1601. barrier.srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  1602. barrier.dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  1603. barrier.subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
  1604. barrier.subresourceRange.levelCount = 1;
  1605. barrier.subresourceRange.layerCount = 1;
  1606. vkCmdPipelineBarrier(command_buffer, VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT, VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT, 0, 0, nullptr, 0, nullptr, 1, &barrier);
  1607. }
  1608. err = vkEndCommandBuffer(command_buffer);
  1609. check_vk_result(err);
  1610. VkSubmitInfo submit_info = {};
  1611. submit_info.sType = VK_STRUCTURE_TYPE_SUBMIT_INFO;
  1612. submit_info.commandBufferCount = 1;
  1613. submit_info.pCommandBuffers = &command_buffer;
  1614. VkQueue queue;
  1615. vkGetDeviceQueue(device, queue_family, 0, &queue);
  1616. err = vkQueueSubmit(queue, 1, &submit_info, fence);
  1617. check_vk_result(err);
  1618. err = vkWaitForFences(device, 1, &fence, VK_TRUE, UINT64_MAX);
  1619. check_vk_result(err);
  1620. err = vkResetFences(device, 1, &fence);
  1621. check_vk_result(err);
  1622. err = vkResetCommandPool(device, command_pool, 0);
  1623. check_vk_result(err);
  1624. // Destroy command buffer and fence and command pool
  1625. vkFreeCommandBuffers(device, command_pool, 1, &command_buffer);
  1626. vkDestroyCommandPool(device, command_pool, allocator);
  1627. vkDestroyFence(device, fence, allocator);
  1628. command_pool = VK_NULL_HANDLE;
  1629. command_buffer = VK_NULL_HANDLE;
  1630. fence = VK_NULL_HANDLE;
  1631. queue = VK_NULL_HANDLE;
  1632. }
  1633. void ImGui_ImplVulkanH_DestroyWindow(VkInstance instance, VkDevice device, ImGui_ImplVulkanH_Window* wd, const VkAllocationCallbacks* allocator)
  1634. {
  1635. vkDeviceWaitIdle(device); // FIXME: We could wait on the Queue if we had the queue in wd-> (otherwise VulkanH functions can't use globals)
  1636. //vkQueueWaitIdle(bd->Queue);
  1637. for (uint32_t i = 0; i < wd->ImageCount; i++)
  1638. ImGui_ImplVulkanH_DestroyFrame(device, &wd->Frames[i], allocator);
  1639. for (uint32_t i = 0; i < wd->SemaphoreCount; i++)
  1640. ImGui_ImplVulkanH_DestroyFrameSemaphores(device, &wd->FrameSemaphores[i], allocator);
  1641. wd->Frames.clear();
  1642. wd->FrameSemaphores.clear();
  1643. vkDestroyPipeline(device, wd->Pipeline, allocator);
  1644. vkDestroyRenderPass(device, wd->RenderPass, allocator);
  1645. vkDestroySwapchainKHR(device, wd->Swapchain, allocator);
  1646. vkDestroySurfaceKHR(instance, wd->Surface, allocator);
  1647. *wd = ImGui_ImplVulkanH_Window();
  1648. }
  1649. void ImGui_ImplVulkanH_DestroyFrame(VkDevice device, ImGui_ImplVulkanH_Frame* fd, const VkAllocationCallbacks* allocator)
  1650. {
  1651. vkDestroyFence(device, fd->Fence, allocator);
  1652. vkFreeCommandBuffers(device, fd->CommandPool, 1, &fd->CommandBuffer);
  1653. vkDestroyCommandPool(device, fd->CommandPool, allocator);
  1654. fd->Fence = VK_NULL_HANDLE;
  1655. fd->CommandBuffer = VK_NULL_HANDLE;
  1656. fd->CommandPool = VK_NULL_HANDLE;
  1657. vkDestroyImageView(device, fd->BackbufferView, allocator);
  1658. vkDestroyFramebuffer(device, fd->Framebuffer, allocator);
  1659. }
  1660. void ImGui_ImplVulkanH_DestroyFrameSemaphores(VkDevice device, ImGui_ImplVulkanH_FrameSemaphores* fsd, const VkAllocationCallbacks* allocator)
  1661. {
  1662. vkDestroySemaphore(device, fsd->ImageAcquiredSemaphore, allocator);
  1663. vkDestroySemaphore(device, fsd->RenderCompleteSemaphore, allocator);
  1664. fsd->ImageAcquiredSemaphore = fsd->RenderCompleteSemaphore = VK_NULL_HANDLE;
  1665. }
  1666. //-----------------------------------------------------------------------------
  1667. #endif // #ifndef IMGUI_DISABLE