imgui_impl_vulkan.cpp 113 KB

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