imgui_impl_vulkan.cpp 99 KB

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