imgui_impl_vulkan.cpp 98 KB

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