imgui_impl_vulkan.cpp 82 KB

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