imgui_impl_vulkan.cpp 103 KB

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