imgui_impl_vulkan.cpp 86 KB

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