imgui_impl_vulkan.cpp 114 KB

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