imgui_impl_vulkan.cpp 99 KB

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