imgui_impl_vulkan.cpp 118 KB

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