imgui_impl_vulkan.cpp 96 KB

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