imgui_impl_vulkan.cpp 83 KB

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