imgui_impl_vulkan.cpp 109 KB

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