imgui_impl_vulkan.cpp 99 KB

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