2
0

imgui_impl_vulkan.cpp 99 KB

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