imgui_impl_vulkan.cpp 81 KB

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