imgui_impl_vulkan.cpp 100 KB

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