imgui_impl_vulkan.cpp 114 KB

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