imgui_impl_vulkan.cpp 52 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088
  1. // dear imgui: Renderer for Vulkan
  2. // This needs to be used along with a Platform Binding (e.g. GLFW, SDL, Win32, custom..)
  3. // Missing features:
  4. // [ ] Renderer: User texture binding. Changes of ImTextureID aren't supported by this binding! See https://github.com/ocornut/imgui/pull/914
  5. // You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
  6. // If you are new to dear imgui, read examples/README.txt and read the documentation at the top of imgui.cpp.
  7. // https://github.com/ocornut/imgui
  8. // The aim of imgui_impl_vulkan.h/.cpp is to be usable in your engine without any modification.
  9. // IF YOU FEEL YOU NEED TO MAKE ANY CHANGE TO THIS CODE, please share them and your feedback at https://github.com/ocornut/imgui/
  10. // CHANGELOG
  11. // (minor and older changes stripped away, please see git history for details)
  12. // 2019-02-16: Vulkan: Viewport and clipping rectangles correctly using draw_data->FramebufferScale to allow retina display.
  13. // 2018-11-30: Misc: Setting up io.BackendRendererName so it can be displayed in the About Window.
  14. // 2018-08-25: Vulkan: Fixed mishandled VkSurfaceCapabilitiesKHR::maxImageCount=0 case.
  15. // 2018-06-22: Inverted the parameters to ImGui_ImplVulkan_RenderDrawData() to be consistent with other bindings.
  16. // 2018-06-08: Misc: Extracted imgui_impl_vulkan.cpp/.h away from the old combined GLFW+Vulkan example.
  17. // 2018-06-08: Vulkan: Use draw_data->DisplayPos and draw_data->DisplaySize to setup projection matrix and clipping rectangle.
  18. // 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.
  19. // 2018-03-01: Vulkan: Renamed ImGui_ImplVulkan_Init_Info to ImGui_ImplVulkan_InitInfo and fields to match more closely Vulkan terminology.
  20. // 2018-02-16: Misc: Obsoleted the io.RenderDrawListsFn callback, ImGui_ImplVulkan_Render() calls ImGui_ImplVulkan_RenderDrawData() itself.
  21. // 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
  22. // 2017-05-15: Vulkan: Fix scissor offset being negative. Fix new Vulkan validation warnings. Set required depth member for buffer image copy.
  23. // 2016-11-13: Vulkan: Fix validation layer warnings and errors and redeclare gl_PerVertex.
  24. // 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.
  25. // 2016-08-27: Vulkan: Fix Vulkan example for use when a depth buffer is active.
  26. #include "imgui.h"
  27. #include "imgui_impl_vulkan.h"
  28. #include <stdio.h>
  29. // Vulkan data
  30. static const VkAllocationCallbacks* g_Allocator = NULL;
  31. static VkPhysicalDevice g_PhysicalDevice = VK_NULL_HANDLE;
  32. static VkInstance g_Instance = VK_NULL_HANDLE;
  33. static VkDevice g_Device = VK_NULL_HANDLE;
  34. static uint32_t g_QueueFamily = (uint32_t)-1;
  35. static VkQueue g_Queue = VK_NULL_HANDLE;
  36. static VkPipelineCache g_PipelineCache = VK_NULL_HANDLE;
  37. static VkDescriptorPool g_DescriptorPool = VK_NULL_HANDLE;
  38. static VkRenderPass g_RenderPass = VK_NULL_HANDLE;
  39. static void (*g_CheckVkResultFn)(VkResult err) = NULL;
  40. static VkDeviceSize g_BufferMemoryAlignment = 256;
  41. static VkPipelineCreateFlags g_PipelineCreateFlags = 0;
  42. static VkDescriptorSetLayout g_DescriptorSetLayout = VK_NULL_HANDLE;
  43. static VkPipelineLayout g_PipelineLayout = VK_NULL_HANDLE;
  44. static VkDescriptorSet g_DescriptorSet = VK_NULL_HANDLE;
  45. static VkPipeline g_Pipeline = VK_NULL_HANDLE;
  46. // Frame data
  47. struct FrameDataForRender
  48. {
  49. VkDeviceMemory VertexBufferMemory;
  50. VkDeviceMemory IndexBufferMemory;
  51. VkDeviceSize VertexBufferSize;
  52. VkDeviceSize IndexBufferSize;
  53. VkBuffer VertexBuffer;
  54. VkBuffer IndexBuffer;
  55. };
  56. static int g_FrameIndex = 0;
  57. static FrameDataForRender g_FramesDataBuffers[IMGUI_VK_QUEUED_FRAMES] = {};
  58. // Font data
  59. static VkSampler g_FontSampler = VK_NULL_HANDLE;
  60. static VkDeviceMemory g_FontMemory = VK_NULL_HANDLE;
  61. static VkImage g_FontImage = VK_NULL_HANDLE;
  62. static VkImageView g_FontView = VK_NULL_HANDLE;
  63. static VkDeviceMemory g_UploadBufferMemory = VK_NULL_HANDLE;
  64. static VkBuffer g_UploadBuffer = VK_NULL_HANDLE;
  65. // glsl_shader.vert, compiled with:
  66. // # glslangValidator -V -x -o glsl_shader.vert.u32 glsl_shader.vert
  67. static uint32_t __glsl_shader_vert_spv[] =
  68. {
  69. 0x07230203,0x00010000,0x00080001,0x0000002e,0x00000000,0x00020011,0x00000001,0x0006000b,
  70. 0x00000001,0x4c534c47,0x6474732e,0x3035342e,0x00000000,0x0003000e,0x00000000,0x00000001,
  71. 0x000a000f,0x00000000,0x00000004,0x6e69616d,0x00000000,0x0000000b,0x0000000f,0x00000015,
  72. 0x0000001b,0x0000001c,0x00030003,0x00000002,0x000001c2,0x00040005,0x00000004,0x6e69616d,
  73. 0x00000000,0x00030005,0x00000009,0x00000000,0x00050006,0x00000009,0x00000000,0x6f6c6f43,
  74. 0x00000072,0x00040006,0x00000009,0x00000001,0x00005655,0x00030005,0x0000000b,0x0074754f,
  75. 0x00040005,0x0000000f,0x6c6f4361,0x0000726f,0x00030005,0x00000015,0x00565561,0x00060005,
  76. 0x00000019,0x505f6c67,0x65567265,0x78657472,0x00000000,0x00060006,0x00000019,0x00000000,
  77. 0x505f6c67,0x7469736f,0x006e6f69,0x00030005,0x0000001b,0x00000000,0x00040005,0x0000001c,
  78. 0x736f5061,0x00000000,0x00060005,0x0000001e,0x73755075,0x6e6f4368,0x6e617473,0x00000074,
  79. 0x00050006,0x0000001e,0x00000000,0x61635375,0x0000656c,0x00060006,0x0000001e,0x00000001,
  80. 0x61725475,0x616c736e,0x00006574,0x00030005,0x00000020,0x00006370,0x00040047,0x0000000b,
  81. 0x0000001e,0x00000000,0x00040047,0x0000000f,0x0000001e,0x00000002,0x00040047,0x00000015,
  82. 0x0000001e,0x00000001,0x00050048,0x00000019,0x00000000,0x0000000b,0x00000000,0x00030047,
  83. 0x00000019,0x00000002,0x00040047,0x0000001c,0x0000001e,0x00000000,0x00050048,0x0000001e,
  84. 0x00000000,0x00000023,0x00000000,0x00050048,0x0000001e,0x00000001,0x00000023,0x00000008,
  85. 0x00030047,0x0000001e,0x00000002,0x00020013,0x00000002,0x00030021,0x00000003,0x00000002,
  86. 0x00030016,0x00000006,0x00000020,0x00040017,0x00000007,0x00000006,0x00000004,0x00040017,
  87. 0x00000008,0x00000006,0x00000002,0x0004001e,0x00000009,0x00000007,0x00000008,0x00040020,
  88. 0x0000000a,0x00000003,0x00000009,0x0004003b,0x0000000a,0x0000000b,0x00000003,0x00040015,
  89. 0x0000000c,0x00000020,0x00000001,0x0004002b,0x0000000c,0x0000000d,0x00000000,0x00040020,
  90. 0x0000000e,0x00000001,0x00000007,0x0004003b,0x0000000e,0x0000000f,0x00000001,0x00040020,
  91. 0x00000011,0x00000003,0x00000007,0x0004002b,0x0000000c,0x00000013,0x00000001,0x00040020,
  92. 0x00000014,0x00000001,0x00000008,0x0004003b,0x00000014,0x00000015,0x00000001,0x00040020,
  93. 0x00000017,0x00000003,0x00000008,0x0003001e,0x00000019,0x00000007,0x00040020,0x0000001a,
  94. 0x00000003,0x00000019,0x0004003b,0x0000001a,0x0000001b,0x00000003,0x0004003b,0x00000014,
  95. 0x0000001c,0x00000001,0x0004001e,0x0000001e,0x00000008,0x00000008,0x00040020,0x0000001f,
  96. 0x00000009,0x0000001e,0x0004003b,0x0000001f,0x00000020,0x00000009,0x00040020,0x00000021,
  97. 0x00000009,0x00000008,0x0004002b,0x00000006,0x00000028,0x00000000,0x0004002b,0x00000006,
  98. 0x00000029,0x3f800000,0x00050036,0x00000002,0x00000004,0x00000000,0x00000003,0x000200f8,
  99. 0x00000005,0x0004003d,0x00000007,0x00000010,0x0000000f,0x00050041,0x00000011,0x00000012,
  100. 0x0000000b,0x0000000d,0x0003003e,0x00000012,0x00000010,0x0004003d,0x00000008,0x00000016,
  101. 0x00000015,0x00050041,0x00000017,0x00000018,0x0000000b,0x00000013,0x0003003e,0x00000018,
  102. 0x00000016,0x0004003d,0x00000008,0x0000001d,0x0000001c,0x00050041,0x00000021,0x00000022,
  103. 0x00000020,0x0000000d,0x0004003d,0x00000008,0x00000023,0x00000022,0x00050085,0x00000008,
  104. 0x00000024,0x0000001d,0x00000023,0x00050041,0x00000021,0x00000025,0x00000020,0x00000013,
  105. 0x0004003d,0x00000008,0x00000026,0x00000025,0x00050081,0x00000008,0x00000027,0x00000024,
  106. 0x00000026,0x00050051,0x00000006,0x0000002a,0x00000027,0x00000000,0x00050051,0x00000006,
  107. 0x0000002b,0x00000027,0x00000001,0x00070050,0x00000007,0x0000002c,0x0000002a,0x0000002b,
  108. 0x00000028,0x00000029,0x00050041,0x00000011,0x0000002d,0x0000001b,0x0000000d,0x0003003e,
  109. 0x0000002d,0x0000002c,0x000100fd,0x00010038
  110. };
  111. // glsl_shader.frag, compiled with:
  112. // # glslangValidator -V -x -o glsl_shader.frag.u32 glsl_shader.frag
  113. static uint32_t __glsl_shader_frag_spv[] =
  114. {
  115. 0x07230203,0x00010000,0x00080001,0x0000001e,0x00000000,0x00020011,0x00000001,0x0006000b,
  116. 0x00000001,0x4c534c47,0x6474732e,0x3035342e,0x00000000,0x0003000e,0x00000000,0x00000001,
  117. 0x0007000f,0x00000004,0x00000004,0x6e69616d,0x00000000,0x00000009,0x0000000d,0x00030010,
  118. 0x00000004,0x00000007,0x00030003,0x00000002,0x000001c2,0x00040005,0x00000004,0x6e69616d,
  119. 0x00000000,0x00040005,0x00000009,0x6c6f4366,0x0000726f,0x00030005,0x0000000b,0x00000000,
  120. 0x00050006,0x0000000b,0x00000000,0x6f6c6f43,0x00000072,0x00040006,0x0000000b,0x00000001,
  121. 0x00005655,0x00030005,0x0000000d,0x00006e49,0x00050005,0x00000016,0x78655473,0x65727574,
  122. 0x00000000,0x00040047,0x00000009,0x0000001e,0x00000000,0x00040047,0x0000000d,0x0000001e,
  123. 0x00000000,0x00040047,0x00000016,0x00000022,0x00000000,0x00040047,0x00000016,0x00000021,
  124. 0x00000000,0x00020013,0x00000002,0x00030021,0x00000003,0x00000002,0x00030016,0x00000006,
  125. 0x00000020,0x00040017,0x00000007,0x00000006,0x00000004,0x00040020,0x00000008,0x00000003,
  126. 0x00000007,0x0004003b,0x00000008,0x00000009,0x00000003,0x00040017,0x0000000a,0x00000006,
  127. 0x00000002,0x0004001e,0x0000000b,0x00000007,0x0000000a,0x00040020,0x0000000c,0x00000001,
  128. 0x0000000b,0x0004003b,0x0000000c,0x0000000d,0x00000001,0x00040015,0x0000000e,0x00000020,
  129. 0x00000001,0x0004002b,0x0000000e,0x0000000f,0x00000000,0x00040020,0x00000010,0x00000001,
  130. 0x00000007,0x00090019,0x00000013,0x00000006,0x00000001,0x00000000,0x00000000,0x00000000,
  131. 0x00000001,0x00000000,0x0003001b,0x00000014,0x00000013,0x00040020,0x00000015,0x00000000,
  132. 0x00000014,0x0004003b,0x00000015,0x00000016,0x00000000,0x0004002b,0x0000000e,0x00000018,
  133. 0x00000001,0x00040020,0x00000019,0x00000001,0x0000000a,0x00050036,0x00000002,0x00000004,
  134. 0x00000000,0x00000003,0x000200f8,0x00000005,0x00050041,0x00000010,0x00000011,0x0000000d,
  135. 0x0000000f,0x0004003d,0x00000007,0x00000012,0x00000011,0x0004003d,0x00000014,0x00000017,
  136. 0x00000016,0x00050041,0x00000019,0x0000001a,0x0000000d,0x00000018,0x0004003d,0x0000000a,
  137. 0x0000001b,0x0000001a,0x00050057,0x00000007,0x0000001c,0x00000017,0x0000001b,0x00050085,
  138. 0x00000007,0x0000001d,0x00000012,0x0000001c,0x0003003e,0x00000009,0x0000001d,0x000100fd,
  139. 0x00010038
  140. };
  141. static uint32_t ImGui_ImplVulkan_MemoryType(VkMemoryPropertyFlags properties, uint32_t type_bits)
  142. {
  143. VkPhysicalDeviceMemoryProperties prop;
  144. vkGetPhysicalDeviceMemoryProperties(g_PhysicalDevice, &prop);
  145. for (uint32_t i = 0; i < prop.memoryTypeCount; i++)
  146. if ((prop.memoryTypes[i].propertyFlags & properties) == properties && type_bits & (1<<i))
  147. return i;
  148. return 0xFFFFFFFF; // Unable to find memoryType
  149. }
  150. static void check_vk_result(VkResult err)
  151. {
  152. if (g_CheckVkResultFn)
  153. g_CheckVkResultFn(err);
  154. }
  155. static void CreateOrResizeBuffer(VkBuffer& buffer, VkDeviceMemory& buffer_memory, VkDeviceSize& p_buffer_size, size_t new_size, VkBufferUsageFlagBits usage)
  156. {
  157. VkResult err;
  158. if (buffer != VK_NULL_HANDLE)
  159. vkDestroyBuffer(g_Device, buffer, g_Allocator);
  160. if (buffer_memory)
  161. vkFreeMemory(g_Device, buffer_memory, g_Allocator);
  162. VkDeviceSize vertex_buffer_size_aligned = ((new_size - 1) / g_BufferMemoryAlignment + 1) * g_BufferMemoryAlignment;
  163. VkBufferCreateInfo buffer_info = {};
  164. buffer_info.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO;
  165. buffer_info.size = vertex_buffer_size_aligned;
  166. buffer_info.usage = usage;
  167. buffer_info.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
  168. err = vkCreateBuffer(g_Device, &buffer_info, g_Allocator, &buffer);
  169. check_vk_result(err);
  170. VkMemoryRequirements req;
  171. vkGetBufferMemoryRequirements(g_Device, buffer, &req);
  172. g_BufferMemoryAlignment = (g_BufferMemoryAlignment > req.alignment) ? g_BufferMemoryAlignment : req.alignment;
  173. VkMemoryAllocateInfo alloc_info = {};
  174. alloc_info.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
  175. alloc_info.allocationSize = req.size;
  176. alloc_info.memoryTypeIndex = ImGui_ImplVulkan_MemoryType(VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT, req.memoryTypeBits);
  177. err = vkAllocateMemory(g_Device, &alloc_info, g_Allocator, &buffer_memory);
  178. check_vk_result(err);
  179. err = vkBindBufferMemory(g_Device, buffer, buffer_memory, 0);
  180. check_vk_result(err);
  181. p_buffer_size = new_size;
  182. }
  183. // Render function
  184. // (this used to be set in io.RenderDrawListsFn and called by ImGui::Render(), but you can now call this directly from your main loop)
  185. void ImGui_ImplVulkan_RenderDrawData(ImDrawData* draw_data, VkCommandBuffer command_buffer)
  186. {
  187. // Avoid rendering when minimized, scale coordinates for retina displays (screen coordinates != framebuffer coordinates)
  188. int fb_width = (int)(draw_data->DisplaySize.x * draw_data->FramebufferScale.x);
  189. int fb_height = (int)(draw_data->DisplaySize.y * draw_data->FramebufferScale.y);
  190. if (fb_width <= 0 || fb_height <= 0 || draw_data->TotalVtxCount == 0)
  191. return;
  192. VkResult err;
  193. FrameDataForRender* fd = &g_FramesDataBuffers[g_FrameIndex];
  194. g_FrameIndex = (g_FrameIndex + 1) % IMGUI_VK_QUEUED_FRAMES;
  195. // Create the Vertex and Index buffers:
  196. size_t vertex_size = draw_data->TotalVtxCount * sizeof(ImDrawVert);
  197. size_t index_size = draw_data->TotalIdxCount * sizeof(ImDrawIdx);
  198. if (!fd->VertexBuffer || fd->VertexBufferSize < vertex_size)
  199. CreateOrResizeBuffer(fd->VertexBuffer, fd->VertexBufferMemory, fd->VertexBufferSize, vertex_size, VK_BUFFER_USAGE_VERTEX_BUFFER_BIT);
  200. if (!fd->IndexBuffer || fd->IndexBufferSize < index_size)
  201. CreateOrResizeBuffer(fd->IndexBuffer, fd->IndexBufferMemory, fd->IndexBufferSize, index_size, VK_BUFFER_USAGE_INDEX_BUFFER_BIT);
  202. // Upload vertex/index data into a single contiguous GPU buffer
  203. {
  204. ImDrawVert* vtx_dst = NULL;
  205. ImDrawIdx* idx_dst = NULL;
  206. err = vkMapMemory(g_Device, fd->VertexBufferMemory, 0, vertex_size, 0, (void**)(&vtx_dst));
  207. check_vk_result(err);
  208. err = vkMapMemory(g_Device, fd->IndexBufferMemory, 0, index_size, 0, (void**)(&idx_dst));
  209. check_vk_result(err);
  210. for (int n = 0; n < draw_data->CmdListsCount; n++)
  211. {
  212. const ImDrawList* cmd_list = draw_data->CmdLists[n];
  213. memcpy(vtx_dst, cmd_list->VtxBuffer.Data, cmd_list->VtxBuffer.Size * sizeof(ImDrawVert));
  214. memcpy(idx_dst, cmd_list->IdxBuffer.Data, cmd_list->IdxBuffer.Size * sizeof(ImDrawIdx));
  215. vtx_dst += cmd_list->VtxBuffer.Size;
  216. idx_dst += cmd_list->IdxBuffer.Size;
  217. }
  218. VkMappedMemoryRange range[2] = {};
  219. range[0].sType = VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE;
  220. range[0].memory = fd->VertexBufferMemory;
  221. range[0].size = VK_WHOLE_SIZE;
  222. range[1].sType = VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE;
  223. range[1].memory = fd->IndexBufferMemory;
  224. range[1].size = VK_WHOLE_SIZE;
  225. err = vkFlushMappedMemoryRanges(g_Device, 2, range);
  226. check_vk_result(err);
  227. vkUnmapMemory(g_Device, fd->VertexBufferMemory);
  228. vkUnmapMemory(g_Device, fd->IndexBufferMemory);
  229. }
  230. // Bind pipeline and descriptor sets:
  231. {
  232. vkCmdBindPipeline(command_buffer, VK_PIPELINE_BIND_POINT_GRAPHICS, g_Pipeline);
  233. VkDescriptorSet desc_set[1] = { g_DescriptorSet };
  234. vkCmdBindDescriptorSets(command_buffer, VK_PIPELINE_BIND_POINT_GRAPHICS, g_PipelineLayout, 0, 1, desc_set, 0, NULL);
  235. }
  236. // Bind Vertex And Index Buffer:
  237. {
  238. VkBuffer vertex_buffers[1] = { fd->VertexBuffer };
  239. VkDeviceSize vertex_offset[1] = { 0 };
  240. vkCmdBindVertexBuffers(command_buffer, 0, 1, vertex_buffers, vertex_offset);
  241. vkCmdBindIndexBuffer(command_buffer, fd->IndexBuffer, 0, VK_INDEX_TYPE_UINT16);
  242. }
  243. // Setup viewport:
  244. {
  245. VkViewport viewport;
  246. viewport.x = 0;
  247. viewport.y = 0;
  248. viewport.width = (float)fb_width;
  249. viewport.height = (float)fb_height;
  250. viewport.minDepth = 0.0f;
  251. viewport.maxDepth = 1.0f;
  252. vkCmdSetViewport(command_buffer, 0, 1, &viewport);
  253. }
  254. // Setup scale and translation:
  255. // Our visible imgui space lies from draw_data->DisplayPos (top left) to draw_data->DisplayPos+data_data->DisplaySize (bottom right). DisplayMin is typically (0,0) for single viewport apps.
  256. {
  257. float scale[2];
  258. scale[0] = 2.0f / draw_data->DisplaySize.x;
  259. scale[1] = 2.0f / draw_data->DisplaySize.y;
  260. float translate[2];
  261. translate[0] = -1.0f - draw_data->DisplayPos.x * scale[0];
  262. translate[1] = -1.0f - draw_data->DisplayPos.y * scale[1];
  263. vkCmdPushConstants(command_buffer, g_PipelineLayout, VK_SHADER_STAGE_VERTEX_BIT, sizeof(float) * 0, sizeof(float) * 2, scale);
  264. vkCmdPushConstants(command_buffer, g_PipelineLayout, VK_SHADER_STAGE_VERTEX_BIT, sizeof(float) * 2, sizeof(float) * 2, translate);
  265. }
  266. // Will project scissor/clipping rectangles into framebuffer space
  267. ImVec2 clip_off = draw_data->DisplayPos; // (0,0) unless using multi-viewports
  268. ImVec2 clip_scale = draw_data->FramebufferScale; // (1,1) unless using retina display which are often (2,2)
  269. // Render command lists
  270. int vtx_offset = 0;
  271. int idx_offset = 0;
  272. for (int n = 0; n < draw_data->CmdListsCount; n++)
  273. {
  274. const ImDrawList* cmd_list = draw_data->CmdLists[n];
  275. for (int cmd_i = 0; cmd_i < cmd_list->CmdBuffer.Size; cmd_i++)
  276. {
  277. const ImDrawCmd* pcmd = &cmd_list->CmdBuffer[cmd_i];
  278. if (pcmd->UserCallback)
  279. {
  280. // User callback (registered via ImDrawList::AddCallback)
  281. pcmd->UserCallback(cmd_list, pcmd);
  282. }
  283. else
  284. {
  285. // Project scissor/clipping rectangles into framebuffer space
  286. ImVec4 clip_rect;
  287. clip_rect.x = (pcmd->ClipRect.x - clip_off.x) * clip_scale.x;
  288. clip_rect.y = (pcmd->ClipRect.y - clip_off.y) * clip_scale.y;
  289. clip_rect.z = (pcmd->ClipRect.z - clip_off.x) * clip_scale.x;
  290. clip_rect.w = (pcmd->ClipRect.w - clip_off.y) * clip_scale.y;
  291. if (clip_rect.x < fb_width && clip_rect.y < fb_height && clip_rect.z >= 0.0f && clip_rect.w >= 0.0f)
  292. {
  293. // Apply scissor/clipping rectangle
  294. VkRect2D scissor;
  295. scissor.offset.x = (int32_t)(clip_rect.x);
  296. scissor.offset.y = (int32_t)(clip_rect.y);
  297. scissor.extent.width = (uint32_t)(clip_rect.z - clip_rect.x);
  298. scissor.extent.height = (uint32_t)(clip_rect.w - clip_rect.y);
  299. vkCmdSetScissor(command_buffer, 0, 1, &scissor);
  300. // Draw
  301. vkCmdDrawIndexed(command_buffer, pcmd->ElemCount, 1, idx_offset, vtx_offset, 0);
  302. }
  303. }
  304. idx_offset += pcmd->ElemCount;
  305. }
  306. vtx_offset += cmd_list->VtxBuffer.Size;
  307. }
  308. }
  309. bool ImGui_ImplVulkan_CreateFontsTexture(VkCommandBuffer command_buffer)
  310. {
  311. ImGuiIO& io = ImGui::GetIO();
  312. unsigned char* pixels;
  313. int width, height;
  314. io.Fonts->GetTexDataAsRGBA32(&pixels, &width, &height);
  315. size_t upload_size = width*height*4*sizeof(char);
  316. VkResult err;
  317. // Create the Image:
  318. {
  319. VkImageCreateInfo info = {};
  320. info.sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO;
  321. info.imageType = VK_IMAGE_TYPE_2D;
  322. info.format = VK_FORMAT_R8G8B8A8_UNORM;
  323. info.extent.width = width;
  324. info.extent.height = height;
  325. info.extent.depth = 1;
  326. info.mipLevels = 1;
  327. info.arrayLayers = 1;
  328. info.samples = VK_SAMPLE_COUNT_1_BIT;
  329. info.tiling = VK_IMAGE_TILING_OPTIMAL;
  330. info.usage = VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_TRANSFER_DST_BIT;
  331. info.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
  332. info.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
  333. err = vkCreateImage(g_Device, &info, g_Allocator, &g_FontImage);
  334. check_vk_result(err);
  335. VkMemoryRequirements req;
  336. vkGetImageMemoryRequirements(g_Device, g_FontImage, &req);
  337. VkMemoryAllocateInfo alloc_info = {};
  338. alloc_info.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
  339. alloc_info.allocationSize = req.size;
  340. alloc_info.memoryTypeIndex = ImGui_ImplVulkan_MemoryType(VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT, req.memoryTypeBits);
  341. err = vkAllocateMemory(g_Device, &alloc_info, g_Allocator, &g_FontMemory);
  342. check_vk_result(err);
  343. err = vkBindImageMemory(g_Device, g_FontImage, g_FontMemory, 0);
  344. check_vk_result(err);
  345. }
  346. // Create the Image View:
  347. {
  348. VkImageViewCreateInfo info = {};
  349. info.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO;
  350. info.image = g_FontImage;
  351. info.viewType = VK_IMAGE_VIEW_TYPE_2D;
  352. info.format = VK_FORMAT_R8G8B8A8_UNORM;
  353. info.subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
  354. info.subresourceRange.levelCount = 1;
  355. info.subresourceRange.layerCount = 1;
  356. err = vkCreateImageView(g_Device, &info, g_Allocator, &g_FontView);
  357. check_vk_result(err);
  358. }
  359. // Update the Descriptor Set:
  360. {
  361. VkDescriptorImageInfo desc_image[1] = {};
  362. desc_image[0].sampler = g_FontSampler;
  363. desc_image[0].imageView = g_FontView;
  364. desc_image[0].imageLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
  365. VkWriteDescriptorSet write_desc[1] = {};
  366. write_desc[0].sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET;
  367. write_desc[0].dstSet = g_DescriptorSet;
  368. write_desc[0].descriptorCount = 1;
  369. write_desc[0].descriptorType = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
  370. write_desc[0].pImageInfo = desc_image;
  371. vkUpdateDescriptorSets(g_Device, 1, write_desc, 0, NULL);
  372. }
  373. // Create the Upload Buffer:
  374. {
  375. VkBufferCreateInfo buffer_info = {};
  376. buffer_info.sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO;
  377. buffer_info.size = upload_size;
  378. buffer_info.usage = VK_BUFFER_USAGE_TRANSFER_SRC_BIT;
  379. buffer_info.sharingMode = VK_SHARING_MODE_EXCLUSIVE;
  380. err = vkCreateBuffer(g_Device, &buffer_info, g_Allocator, &g_UploadBuffer);
  381. check_vk_result(err);
  382. VkMemoryRequirements req;
  383. vkGetBufferMemoryRequirements(g_Device, g_UploadBuffer, &req);
  384. g_BufferMemoryAlignment = (g_BufferMemoryAlignment > req.alignment) ? g_BufferMemoryAlignment : req.alignment;
  385. VkMemoryAllocateInfo alloc_info = {};
  386. alloc_info.sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO;
  387. alloc_info.allocationSize = req.size;
  388. alloc_info.memoryTypeIndex = ImGui_ImplVulkan_MemoryType(VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT, req.memoryTypeBits);
  389. err = vkAllocateMemory(g_Device, &alloc_info, g_Allocator, &g_UploadBufferMemory);
  390. check_vk_result(err);
  391. err = vkBindBufferMemory(g_Device, g_UploadBuffer, g_UploadBufferMemory, 0);
  392. check_vk_result(err);
  393. }
  394. // Upload to Buffer:
  395. {
  396. char* map = NULL;
  397. err = vkMapMemory(g_Device, g_UploadBufferMemory, 0, upload_size, 0, (void**)(&map));
  398. check_vk_result(err);
  399. memcpy(map, pixels, upload_size);
  400. VkMappedMemoryRange range[1] = {};
  401. range[0].sType = VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE;
  402. range[0].memory = g_UploadBufferMemory;
  403. range[0].size = upload_size;
  404. err = vkFlushMappedMemoryRanges(g_Device, 1, range);
  405. check_vk_result(err);
  406. vkUnmapMemory(g_Device, g_UploadBufferMemory);
  407. }
  408. // Copy to Image:
  409. {
  410. VkImageMemoryBarrier copy_barrier[1] = {};
  411. copy_barrier[0].sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER;
  412. copy_barrier[0].dstAccessMask = VK_ACCESS_TRANSFER_WRITE_BIT;
  413. copy_barrier[0].oldLayout = VK_IMAGE_LAYOUT_UNDEFINED;
  414. copy_barrier[0].newLayout = VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL;
  415. copy_barrier[0].srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  416. copy_barrier[0].dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  417. copy_barrier[0].image = g_FontImage;
  418. copy_barrier[0].subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
  419. copy_barrier[0].subresourceRange.levelCount = 1;
  420. copy_barrier[0].subresourceRange.layerCount = 1;
  421. vkCmdPipelineBarrier(command_buffer, VK_PIPELINE_STAGE_HOST_BIT, VK_PIPELINE_STAGE_TRANSFER_BIT, 0, 0, NULL, 0, NULL, 1, copy_barrier);
  422. VkBufferImageCopy region = {};
  423. region.imageSubresource.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
  424. region.imageSubresource.layerCount = 1;
  425. region.imageExtent.width = width;
  426. region.imageExtent.height = height;
  427. region.imageExtent.depth = 1;
  428. vkCmdCopyBufferToImage(command_buffer, g_UploadBuffer, g_FontImage, VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL, 1, &region);
  429. VkImageMemoryBarrier use_barrier[1] = {};
  430. use_barrier[0].sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER;
  431. use_barrier[0].srcAccessMask = VK_ACCESS_TRANSFER_WRITE_BIT;
  432. use_barrier[0].dstAccessMask = VK_ACCESS_SHADER_READ_BIT;
  433. use_barrier[0].oldLayout = VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL;
  434. use_barrier[0].newLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL;
  435. use_barrier[0].srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  436. use_barrier[0].dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED;
  437. use_barrier[0].image = g_FontImage;
  438. use_barrier[0].subresourceRange.aspectMask = VK_IMAGE_ASPECT_COLOR_BIT;
  439. use_barrier[0].subresourceRange.levelCount = 1;
  440. use_barrier[0].subresourceRange.layerCount = 1;
  441. vkCmdPipelineBarrier(command_buffer, VK_PIPELINE_STAGE_TRANSFER_BIT, VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT, 0, 0, NULL, 0, NULL, 1, use_barrier);
  442. }
  443. // Store our identifier
  444. io.Fonts->TexID = (ImTextureID)(intptr_t)g_FontImage;
  445. return true;
  446. }
  447. bool ImGui_ImplVulkan_CreateDeviceObjects()
  448. {
  449. VkResult err;
  450. VkShaderModule vert_module;
  451. VkShaderModule frag_module;
  452. // Create The Shader Modules:
  453. {
  454. VkShaderModuleCreateInfo vert_info = {};
  455. vert_info.sType = VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO;
  456. vert_info.codeSize = sizeof(__glsl_shader_vert_spv);
  457. vert_info.pCode = (uint32_t*)__glsl_shader_vert_spv;
  458. err = vkCreateShaderModule(g_Device, &vert_info, g_Allocator, &vert_module);
  459. check_vk_result(err);
  460. VkShaderModuleCreateInfo frag_info = {};
  461. frag_info.sType = VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO;
  462. frag_info.codeSize = sizeof(__glsl_shader_frag_spv);
  463. frag_info.pCode = (uint32_t*)__glsl_shader_frag_spv;
  464. err = vkCreateShaderModule(g_Device, &frag_info, g_Allocator, &frag_module);
  465. check_vk_result(err);
  466. }
  467. if (!g_FontSampler)
  468. {
  469. VkSamplerCreateInfo info = {};
  470. info.sType = VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO;
  471. info.magFilter = VK_FILTER_LINEAR;
  472. info.minFilter = VK_FILTER_LINEAR;
  473. info.mipmapMode = VK_SAMPLER_MIPMAP_MODE_LINEAR;
  474. info.addressModeU = VK_SAMPLER_ADDRESS_MODE_REPEAT;
  475. info.addressModeV = VK_SAMPLER_ADDRESS_MODE_REPEAT;
  476. info.addressModeW = VK_SAMPLER_ADDRESS_MODE_REPEAT;
  477. info.minLod = -1000;
  478. info.maxLod = 1000;
  479. info.maxAnisotropy = 1.0f;
  480. err = vkCreateSampler(g_Device, &info, g_Allocator, &g_FontSampler);
  481. check_vk_result(err);
  482. }
  483. if (!g_DescriptorSetLayout)
  484. {
  485. VkSampler sampler[1] = {g_FontSampler};
  486. VkDescriptorSetLayoutBinding binding[1] = {};
  487. binding[0].descriptorType = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER;
  488. binding[0].descriptorCount = 1;
  489. binding[0].stageFlags = VK_SHADER_STAGE_FRAGMENT_BIT;
  490. binding[0].pImmutableSamplers = sampler;
  491. VkDescriptorSetLayoutCreateInfo info = {};
  492. info.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO;
  493. info.bindingCount = 1;
  494. info.pBindings = binding;
  495. err = vkCreateDescriptorSetLayout(g_Device, &info, g_Allocator, &g_DescriptorSetLayout);
  496. check_vk_result(err);
  497. }
  498. // Create Descriptor Set:
  499. {
  500. VkDescriptorSetAllocateInfo alloc_info = {};
  501. alloc_info.sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO;
  502. alloc_info.descriptorPool = g_DescriptorPool;
  503. alloc_info.descriptorSetCount = 1;
  504. alloc_info.pSetLayouts = &g_DescriptorSetLayout;
  505. err = vkAllocateDescriptorSets(g_Device, &alloc_info, &g_DescriptorSet);
  506. check_vk_result(err);
  507. }
  508. if (!g_PipelineLayout)
  509. {
  510. // Constants: we are using 'vec2 offset' and 'vec2 scale' instead of a full 3d projection matrix
  511. VkPushConstantRange push_constants[1] = {};
  512. push_constants[0].stageFlags = VK_SHADER_STAGE_VERTEX_BIT;
  513. push_constants[0].offset = sizeof(float) * 0;
  514. push_constants[0].size = sizeof(float) * 4;
  515. VkDescriptorSetLayout set_layout[1] = { g_DescriptorSetLayout };
  516. VkPipelineLayoutCreateInfo layout_info = {};
  517. layout_info.sType = VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO;
  518. layout_info.setLayoutCount = 1;
  519. layout_info.pSetLayouts = set_layout;
  520. layout_info.pushConstantRangeCount = 1;
  521. layout_info.pPushConstantRanges = push_constants;
  522. err = vkCreatePipelineLayout(g_Device, &layout_info, g_Allocator, &g_PipelineLayout);
  523. check_vk_result(err);
  524. }
  525. VkPipelineShaderStageCreateInfo stage[2] = {};
  526. stage[0].sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO;
  527. stage[0].stage = VK_SHADER_STAGE_VERTEX_BIT;
  528. stage[0].module = vert_module;
  529. stage[0].pName = "main";
  530. stage[1].sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO;
  531. stage[1].stage = VK_SHADER_STAGE_FRAGMENT_BIT;
  532. stage[1].module = frag_module;
  533. stage[1].pName = "main";
  534. VkVertexInputBindingDescription binding_desc[1] = {};
  535. binding_desc[0].stride = sizeof(ImDrawVert);
  536. binding_desc[0].inputRate = VK_VERTEX_INPUT_RATE_VERTEX;
  537. VkVertexInputAttributeDescription attribute_desc[3] = {};
  538. attribute_desc[0].location = 0;
  539. attribute_desc[0].binding = binding_desc[0].binding;
  540. attribute_desc[0].format = VK_FORMAT_R32G32_SFLOAT;
  541. attribute_desc[0].offset = IM_OFFSETOF(ImDrawVert, pos);
  542. attribute_desc[1].location = 1;
  543. attribute_desc[1].binding = binding_desc[0].binding;
  544. attribute_desc[1].format = VK_FORMAT_R32G32_SFLOAT;
  545. attribute_desc[1].offset = IM_OFFSETOF(ImDrawVert, uv);
  546. attribute_desc[2].location = 2;
  547. attribute_desc[2].binding = binding_desc[0].binding;
  548. attribute_desc[2].format = VK_FORMAT_R8G8B8A8_UNORM;
  549. attribute_desc[2].offset = IM_OFFSETOF(ImDrawVert, col);
  550. VkPipelineVertexInputStateCreateInfo vertex_info = {};
  551. vertex_info.sType = VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO;
  552. vertex_info.vertexBindingDescriptionCount = 1;
  553. vertex_info.pVertexBindingDescriptions = binding_desc;
  554. vertex_info.vertexAttributeDescriptionCount = 3;
  555. vertex_info.pVertexAttributeDescriptions = attribute_desc;
  556. VkPipelineInputAssemblyStateCreateInfo ia_info = {};
  557. ia_info.sType = VK_STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO;
  558. ia_info.topology = VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST;
  559. VkPipelineViewportStateCreateInfo viewport_info = {};
  560. viewport_info.sType = VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO;
  561. viewport_info.viewportCount = 1;
  562. viewport_info.scissorCount = 1;
  563. VkPipelineRasterizationStateCreateInfo raster_info = {};
  564. raster_info.sType = VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO;
  565. raster_info.polygonMode = VK_POLYGON_MODE_FILL;
  566. raster_info.cullMode = VK_CULL_MODE_NONE;
  567. raster_info.frontFace = VK_FRONT_FACE_COUNTER_CLOCKWISE;
  568. raster_info.lineWidth = 1.0f;
  569. VkPipelineMultisampleStateCreateInfo ms_info = {};
  570. ms_info.sType = VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO;
  571. ms_info.rasterizationSamples = VK_SAMPLE_COUNT_1_BIT;
  572. VkPipelineColorBlendAttachmentState color_attachment[1] = {};
  573. color_attachment[0].blendEnable = VK_TRUE;
  574. color_attachment[0].srcColorBlendFactor = VK_BLEND_FACTOR_SRC_ALPHA;
  575. color_attachment[0].dstColorBlendFactor = VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;
  576. color_attachment[0].colorBlendOp = VK_BLEND_OP_ADD;
  577. color_attachment[0].srcAlphaBlendFactor = VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA;
  578. color_attachment[0].dstAlphaBlendFactor = VK_BLEND_FACTOR_ZERO;
  579. color_attachment[0].alphaBlendOp = VK_BLEND_OP_ADD;
  580. color_attachment[0].colorWriteMask = VK_COLOR_COMPONENT_R_BIT | VK_COLOR_COMPONENT_G_BIT | VK_COLOR_COMPONENT_B_BIT | VK_COLOR_COMPONENT_A_BIT;
  581. VkPipelineDepthStencilStateCreateInfo depth_info = {};
  582. depth_info.sType = VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO;
  583. VkPipelineColorBlendStateCreateInfo blend_info = {};
  584. blend_info.sType = VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO;
  585. blend_info.attachmentCount = 1;
  586. blend_info.pAttachments = color_attachment;
  587. VkDynamicState dynamic_states[2] = { VK_DYNAMIC_STATE_VIEWPORT, VK_DYNAMIC_STATE_SCISSOR };
  588. VkPipelineDynamicStateCreateInfo dynamic_state = {};
  589. dynamic_state.sType = VK_STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO;
  590. dynamic_state.dynamicStateCount = (uint32_t)IM_ARRAYSIZE(dynamic_states);
  591. dynamic_state.pDynamicStates = dynamic_states;
  592. VkGraphicsPipelineCreateInfo info = {};
  593. info.sType = VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO;
  594. info.flags = g_PipelineCreateFlags;
  595. info.stageCount = 2;
  596. info.pStages = stage;
  597. info.pVertexInputState = &vertex_info;
  598. info.pInputAssemblyState = &ia_info;
  599. info.pViewportState = &viewport_info;
  600. info.pRasterizationState = &raster_info;
  601. info.pMultisampleState = &ms_info;
  602. info.pDepthStencilState = &depth_info;
  603. info.pColorBlendState = &blend_info;
  604. info.pDynamicState = &dynamic_state;
  605. info.layout = g_PipelineLayout;
  606. info.renderPass = g_RenderPass;
  607. err = vkCreateGraphicsPipelines(g_Device, g_PipelineCache, 1, &info, g_Allocator, &g_Pipeline);
  608. check_vk_result(err);
  609. vkDestroyShaderModule(g_Device, vert_module, g_Allocator);
  610. vkDestroyShaderModule(g_Device, frag_module, g_Allocator);
  611. return true;
  612. }
  613. void ImGui_ImplVulkan_InvalidateFontUploadObjects()
  614. {
  615. if (g_UploadBuffer)
  616. {
  617. vkDestroyBuffer(g_Device, g_UploadBuffer, g_Allocator);
  618. g_UploadBuffer = VK_NULL_HANDLE;
  619. }
  620. if (g_UploadBufferMemory)
  621. {
  622. vkFreeMemory(g_Device, g_UploadBufferMemory, g_Allocator);
  623. g_UploadBufferMemory = VK_NULL_HANDLE;
  624. }
  625. }
  626. void ImGui_ImplVulkan_InvalidateDeviceObjects()
  627. {
  628. ImGui_ImplVulkan_InvalidateFontUploadObjects();
  629. for (int i = 0; i < IMGUI_VK_QUEUED_FRAMES; i++)
  630. {
  631. FrameDataForRender* fd = &g_FramesDataBuffers[i];
  632. if (fd->VertexBuffer) { vkDestroyBuffer (g_Device, fd->VertexBuffer, g_Allocator); fd->VertexBuffer = VK_NULL_HANDLE; }
  633. if (fd->VertexBufferMemory) { vkFreeMemory (g_Device, fd->VertexBufferMemory, g_Allocator); fd->VertexBufferMemory = VK_NULL_HANDLE; }
  634. if (fd->IndexBuffer) { vkDestroyBuffer (g_Device, fd->IndexBuffer, g_Allocator); fd->IndexBuffer = VK_NULL_HANDLE; }
  635. if (fd->IndexBufferMemory) { vkFreeMemory (g_Device, fd->IndexBufferMemory, g_Allocator); fd->IndexBufferMemory = VK_NULL_HANDLE; }
  636. }
  637. if (g_FontView) { vkDestroyImageView(g_Device, g_FontView, g_Allocator); g_FontView = VK_NULL_HANDLE; }
  638. if (g_FontImage) { vkDestroyImage(g_Device, g_FontImage, g_Allocator); g_FontImage = VK_NULL_HANDLE; }
  639. if (g_FontMemory) { vkFreeMemory(g_Device, g_FontMemory, g_Allocator); g_FontMemory = VK_NULL_HANDLE; }
  640. if (g_FontSampler) { vkDestroySampler(g_Device, g_FontSampler, g_Allocator); g_FontSampler = VK_NULL_HANDLE; }
  641. if (g_DescriptorSetLayout) { vkDestroyDescriptorSetLayout(g_Device, g_DescriptorSetLayout, g_Allocator); g_DescriptorSetLayout = VK_NULL_HANDLE; }
  642. if (g_PipelineLayout) { vkDestroyPipelineLayout(g_Device, g_PipelineLayout, g_Allocator); g_PipelineLayout = VK_NULL_HANDLE; }
  643. if (g_Pipeline) { vkDestroyPipeline(g_Device, g_Pipeline, g_Allocator); g_Pipeline = VK_NULL_HANDLE; }
  644. }
  645. bool ImGui_ImplVulkan_Init(ImGui_ImplVulkan_InitInfo* info, VkRenderPass render_pass)
  646. {
  647. ImGuiIO& io = ImGui::GetIO();
  648. io.BackendRendererName = "imgui_impl_vulkan";
  649. IM_ASSERT(info->Instance != VK_NULL_HANDLE);
  650. IM_ASSERT(info->PhysicalDevice != VK_NULL_HANDLE);
  651. IM_ASSERT(info->Device != VK_NULL_HANDLE);
  652. IM_ASSERT(info->Queue != VK_NULL_HANDLE);
  653. IM_ASSERT(info->DescriptorPool != VK_NULL_HANDLE);
  654. IM_ASSERT(render_pass != VK_NULL_HANDLE);
  655. g_Instance = info->Instance;
  656. g_PhysicalDevice = info->PhysicalDevice;
  657. g_Device = info->Device;
  658. g_QueueFamily = info->QueueFamily;
  659. g_Queue = info->Queue;
  660. g_RenderPass = render_pass;
  661. g_PipelineCache = info->PipelineCache;
  662. g_DescriptorPool = info->DescriptorPool;
  663. g_Allocator = info->Allocator;
  664. g_CheckVkResultFn = info->CheckVkResultFn;
  665. ImGui_ImplVulkan_CreateDeviceObjects();
  666. return true;
  667. }
  668. void ImGui_ImplVulkan_Shutdown()
  669. {
  670. ImGui_ImplVulkan_InvalidateDeviceObjects();
  671. }
  672. void ImGui_ImplVulkan_NewFrame()
  673. {
  674. }
  675. //-------------------------------------------------------------------------
  676. // Internal / Miscellaneous Vulkan Helpers
  677. //-------------------------------------------------------------------------
  678. // You probably do NOT need to use or care about those functions.
  679. // Those functions only exist because:
  680. // 1) they facilitate the readability and maintenance of the multiple main.cpp examples files.
  681. // 2) the upcoming multi-viewport feature will need them internally.
  682. // Generally we avoid exposing any kind of superfluous high-level helpers in the bindings,
  683. // but it is too much code to duplicate everywhere so we exceptionally expose them.
  684. // Your application/engine will likely already have code to setup all that stuff (swap chain, render pass, frame buffers, etc.).
  685. // You may read this code to learn about Vulkan, but it is recommended you use you own custom tailored code to do equivalent work.
  686. // (those functions do not interact with any of the state used by the regular ImGui_ImplVulkan_XXX functions)
  687. //-------------------------------------------------------------------------
  688. #include <stdlib.h> // malloc
  689. ImGui_ImplVulkanH_FrameData::ImGui_ImplVulkanH_FrameData()
  690. {
  691. BackbufferIndex = 0;
  692. CommandPool = VK_NULL_HANDLE;
  693. CommandBuffer = VK_NULL_HANDLE;
  694. Fence = VK_NULL_HANDLE;
  695. ImageAcquiredSemaphore = VK_NULL_HANDLE;
  696. RenderCompleteSemaphore = VK_NULL_HANDLE;
  697. }
  698. ImGui_ImplVulkanH_WindowData::ImGui_ImplVulkanH_WindowData()
  699. {
  700. Width = Height = 0;
  701. Swapchain = VK_NULL_HANDLE;
  702. Surface = VK_NULL_HANDLE;
  703. memset(&SurfaceFormat, 0, sizeof(SurfaceFormat));
  704. PresentMode = VK_PRESENT_MODE_MAX_ENUM_KHR;
  705. RenderPass = VK_NULL_HANDLE;
  706. ClearEnable = true;
  707. memset(&ClearValue, 0, sizeof(ClearValue));
  708. BackBufferCount = 0;
  709. memset(&BackBuffer, 0, sizeof(BackBuffer));
  710. memset(&BackBufferView, 0, sizeof(BackBufferView));
  711. memset(&Framebuffer, 0, sizeof(Framebuffer));
  712. FrameIndex = 0;
  713. }
  714. VkSurfaceFormatKHR ImGui_ImplVulkanH_SelectSurfaceFormat(VkPhysicalDevice physical_device, VkSurfaceKHR surface, const VkFormat* request_formats, int request_formats_count, VkColorSpaceKHR request_color_space)
  715. {
  716. IM_ASSERT(request_formats != NULL);
  717. IM_ASSERT(request_formats_count > 0);
  718. // Per Spec Format and View Format are expected to be the same unless VK_IMAGE_CREATE_MUTABLE_BIT was set at image creation
  719. // Assuming that the default behavior is without setting this bit, there is no need for separate Swapchain image and image view format
  720. // Additionally several new color spaces were introduced with Vulkan Spec v1.0.40,
  721. // hence we must make sure that a format with the mostly available color space, VK_COLOR_SPACE_SRGB_NONLINEAR_KHR, is found and used.
  722. uint32_t avail_count;
  723. vkGetPhysicalDeviceSurfaceFormatsKHR(physical_device, surface, &avail_count, NULL);
  724. ImVector<VkSurfaceFormatKHR> avail_format;
  725. avail_format.resize((int)avail_count);
  726. vkGetPhysicalDeviceSurfaceFormatsKHR(physical_device, surface, &avail_count, avail_format.Data);
  727. // First check if only one format, VK_FORMAT_UNDEFINED, is available, which would imply that any format is available
  728. if (avail_count == 1)
  729. {
  730. if (avail_format[0].format == VK_FORMAT_UNDEFINED)
  731. {
  732. VkSurfaceFormatKHR ret;
  733. ret.format = request_formats[0];
  734. ret.colorSpace = request_color_space;
  735. return ret;
  736. }
  737. else
  738. {
  739. // No point in searching another format
  740. return avail_format[0];
  741. }
  742. }
  743. else
  744. {
  745. // Request several formats, the first found will be used
  746. for (int request_i = 0; request_i < request_formats_count; request_i++)
  747. for (uint32_t avail_i = 0; avail_i < avail_count; avail_i++)
  748. if (avail_format[avail_i].format == request_formats[request_i] && avail_format[avail_i].colorSpace == request_color_space)
  749. return avail_format[avail_i];
  750. // If none of the requested image formats could be found, use the first available
  751. return avail_format[0];
  752. }
  753. }
  754. VkPresentModeKHR ImGui_ImplVulkanH_SelectPresentMode(VkPhysicalDevice physical_device, VkSurfaceKHR surface, const VkPresentModeKHR* request_modes, int request_modes_count)
  755. {
  756. IM_ASSERT(request_modes != NULL);
  757. IM_ASSERT(request_modes_count > 0);
  758. // Request a certain mode and confirm that it is available. If not use VK_PRESENT_MODE_FIFO_KHR which is mandatory
  759. uint32_t avail_count = 0;
  760. vkGetPhysicalDeviceSurfacePresentModesKHR(physical_device, surface, &avail_count, NULL);
  761. ImVector<VkPresentModeKHR> avail_modes;
  762. avail_modes.resize((int)avail_count);
  763. vkGetPhysicalDeviceSurfacePresentModesKHR(physical_device, surface, &avail_count, avail_modes.Data);
  764. //for (uint32_t avail_i = 0; avail_i < avail_count; avail_i++)
  765. // printf("[vulkan] avail_modes[%d] = %d\n", avail_i, avail_modes[avail_i]);
  766. for (int request_i = 0; request_i < request_modes_count; request_i++)
  767. for (uint32_t avail_i = 0; avail_i < avail_count; avail_i++)
  768. if (request_modes[request_i] == avail_modes[avail_i])
  769. return request_modes[request_i];
  770. return VK_PRESENT_MODE_FIFO_KHR; // Always available
  771. }
  772. void ImGui_ImplVulkanH_CreateWindowDataCommandBuffers(VkPhysicalDevice physical_device, VkDevice device, uint32_t queue_family, ImGui_ImplVulkanH_WindowData* wd, const VkAllocationCallbacks* allocator)
  773. {
  774. IM_ASSERT(physical_device != VK_NULL_HANDLE && device != VK_NULL_HANDLE);
  775. (void)physical_device;
  776. (void)allocator;
  777. // Create Command Buffers
  778. VkResult err;
  779. for (int i = 0; i < IMGUI_VK_QUEUED_FRAMES; i++)
  780. {
  781. ImGui_ImplVulkanH_FrameData* fd = &wd->Frames[i];
  782. {
  783. VkCommandPoolCreateInfo info = {};
  784. info.sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO;
  785. info.flags = VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT;
  786. info.queueFamilyIndex = queue_family;
  787. err = vkCreateCommandPool(device, &info, allocator, &fd->CommandPool);
  788. check_vk_result(err);
  789. }
  790. {
  791. VkCommandBufferAllocateInfo info = {};
  792. info.sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO;
  793. info.commandPool = fd->CommandPool;
  794. info.level = VK_COMMAND_BUFFER_LEVEL_PRIMARY;
  795. info.commandBufferCount = 1;
  796. err = vkAllocateCommandBuffers(device, &info, &fd->CommandBuffer);
  797. check_vk_result(err);
  798. }
  799. {
  800. VkFenceCreateInfo info = {};
  801. info.sType = VK_STRUCTURE_TYPE_FENCE_CREATE_INFO;
  802. info.flags = VK_FENCE_CREATE_SIGNALED_BIT;
  803. err = vkCreateFence(device, &info, allocator, &fd->Fence);
  804. check_vk_result(err);
  805. }
  806. {
  807. VkSemaphoreCreateInfo info = {};
  808. info.sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO;
  809. err = vkCreateSemaphore(device, &info, allocator, &fd->ImageAcquiredSemaphore);
  810. check_vk_result(err);
  811. err = vkCreateSemaphore(device, &info, allocator, &fd->RenderCompleteSemaphore);
  812. check_vk_result(err);
  813. }
  814. }
  815. }
  816. int ImGui_ImplVulkanH_GetMinImageCountFromPresentMode(VkPresentModeKHR present_mode)
  817. {
  818. if (present_mode == VK_PRESENT_MODE_MAILBOX_KHR)
  819. return 3;
  820. if (present_mode == VK_PRESENT_MODE_FIFO_KHR || present_mode == VK_PRESENT_MODE_FIFO_RELAXED_KHR)
  821. return 2;
  822. if (present_mode == VK_PRESENT_MODE_IMMEDIATE_KHR)
  823. return 1;
  824. IM_ASSERT(0);
  825. return 1;
  826. }
  827. void ImGui_ImplVulkanH_CreateWindowDataSwapChainAndFramebuffer(VkPhysicalDevice physical_device, VkDevice device, ImGui_ImplVulkanH_WindowData* wd, const VkAllocationCallbacks* allocator, int w, int h)
  828. {
  829. uint32_t min_image_count = 2; // FIXME: this should become a function parameter
  830. VkResult err;
  831. VkSwapchainKHR old_swapchain = wd->Swapchain;
  832. err = vkDeviceWaitIdle(device);
  833. check_vk_result(err);
  834. // Destroy old Framebuffer
  835. for (uint32_t i = 0; i < wd->BackBufferCount; i++)
  836. {
  837. if (wd->BackBufferView[i])
  838. vkDestroyImageView(device, wd->BackBufferView[i], allocator);
  839. if (wd->Framebuffer[i])
  840. vkDestroyFramebuffer(device, wd->Framebuffer[i], allocator);
  841. }
  842. wd->BackBufferCount = 0;
  843. if (wd->RenderPass)
  844. vkDestroyRenderPass(device, wd->RenderPass, allocator);
  845. // If min image count was not specified, request different count of images dependent on selected present mode
  846. if (min_image_count == 0)
  847. min_image_count = ImGui_ImplVulkanH_GetMinImageCountFromPresentMode(wd->PresentMode);
  848. // Create Swapchain
  849. {
  850. VkSwapchainCreateInfoKHR info = {};
  851. info.sType = VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR;
  852. info.surface = wd->Surface;
  853. info.minImageCount = min_image_count;
  854. info.imageFormat = wd->SurfaceFormat.format;
  855. info.imageColorSpace = wd->SurfaceFormat.colorSpace;
  856. info.imageArrayLayers = 1;
  857. info.imageUsage = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT;
  858. info.imageSharingMode = VK_SHARING_MODE_EXCLUSIVE; // Assume that graphics family == present family
  859. info.preTransform = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR;
  860. info.compositeAlpha = VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR;
  861. info.presentMode = wd->PresentMode;
  862. info.clipped = VK_TRUE;
  863. info.oldSwapchain = old_swapchain;
  864. VkSurfaceCapabilitiesKHR cap;
  865. err = vkGetPhysicalDeviceSurfaceCapabilitiesKHR(physical_device, wd->Surface, &cap);
  866. check_vk_result(err);
  867. if (info.minImageCount < cap.minImageCount)
  868. info.minImageCount = cap.minImageCount;
  869. else if (cap.maxImageCount != 0 && info.minImageCount > cap.maxImageCount)
  870. info.minImageCount = cap.maxImageCount;
  871. if (cap.currentExtent.width == 0xffffffff)
  872. {
  873. info.imageExtent.width = wd->Width = w;
  874. info.imageExtent.height = wd->Height = h;
  875. }
  876. else
  877. {
  878. info.imageExtent.width = wd->Width = cap.currentExtent.width;
  879. info.imageExtent.height = wd->Height = cap.currentExtent.height;
  880. }
  881. err = vkCreateSwapchainKHR(device, &info, allocator, &wd->Swapchain);
  882. check_vk_result(err);
  883. err = vkGetSwapchainImagesKHR(device, wd->Swapchain, &wd->BackBufferCount, NULL);
  884. check_vk_result(err);
  885. err = vkGetSwapchainImagesKHR(device, wd->Swapchain, &wd->BackBufferCount, wd->BackBuffer);
  886. check_vk_result(err);
  887. }
  888. if (old_swapchain)
  889. vkDestroySwapchainKHR(device, old_swapchain, allocator);
  890. // Create the Render Pass
  891. {
  892. VkAttachmentDescription attachment = {};
  893. attachment.format = wd->SurfaceFormat.format;
  894. attachment.samples = VK_SAMPLE_COUNT_1_BIT;
  895. attachment.loadOp = wd->ClearEnable ? VK_ATTACHMENT_LOAD_OP_CLEAR : VK_ATTACHMENT_LOAD_OP_DONT_CARE;
  896. attachment.storeOp = VK_ATTACHMENT_STORE_OP_STORE;
  897. attachment.stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE;
  898. attachment.stencilStoreOp = VK_ATTACHMENT_STORE_OP_DONT_CARE;
  899. attachment.initialLayout = VK_IMAGE_LAYOUT_UNDEFINED;
  900. attachment.finalLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR;
  901. VkAttachmentReference color_attachment = {};
  902. color_attachment.attachment = 0;
  903. color_attachment.layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL;
  904. VkSubpassDescription subpass = {};
  905. subpass.pipelineBindPoint = VK_PIPELINE_BIND_POINT_GRAPHICS;
  906. subpass.colorAttachmentCount = 1;
  907. subpass.pColorAttachments = &color_attachment;
  908. VkSubpassDependency dependency = {};
  909. dependency.srcSubpass = VK_SUBPASS_EXTERNAL;
  910. dependency.dstSubpass = 0;
  911. dependency.srcStageMask = VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT;
  912. dependency.dstStageMask = VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT;
  913. dependency.srcAccessMask = 0;
  914. dependency.dstAccessMask = VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT;
  915. VkRenderPassCreateInfo info = {};
  916. info.sType = VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO;
  917. info.attachmentCount = 1;
  918. info.pAttachments = &attachment;
  919. info.subpassCount = 1;
  920. info.pSubpasses = &subpass;
  921. info.dependencyCount = 1;
  922. info.pDependencies = &dependency;
  923. err = vkCreateRenderPass(device, &info, allocator, &wd->RenderPass);
  924. check_vk_result(err);
  925. }
  926. // Create The Image Views
  927. {
  928. VkImageViewCreateInfo info = {};
  929. info.sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO;
  930. info.viewType = VK_IMAGE_VIEW_TYPE_2D;
  931. info.format = wd->SurfaceFormat.format;
  932. info.components.r = VK_COMPONENT_SWIZZLE_R;
  933. info.components.g = VK_COMPONENT_SWIZZLE_G;
  934. info.components.b = VK_COMPONENT_SWIZZLE_B;
  935. info.components.a = VK_COMPONENT_SWIZZLE_A;
  936. VkImageSubresourceRange image_range = { VK_IMAGE_ASPECT_COLOR_BIT, 0, 1, 0, 1 };
  937. info.subresourceRange = image_range;
  938. for (uint32_t i = 0; i < wd->BackBufferCount; i++)
  939. {
  940. info.image = wd->BackBuffer[i];
  941. err = vkCreateImageView(device, &info, allocator, &wd->BackBufferView[i]);
  942. check_vk_result(err);
  943. }
  944. }
  945. // Create Framebuffer
  946. {
  947. VkImageView attachment[1];
  948. VkFramebufferCreateInfo info = {};
  949. info.sType = VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO;
  950. info.renderPass = wd->RenderPass;
  951. info.attachmentCount = 1;
  952. info.pAttachments = attachment;
  953. info.width = wd->Width;
  954. info.height = wd->Height;
  955. info.layers = 1;
  956. for (uint32_t i = 0; i < wd->BackBufferCount; i++)
  957. {
  958. attachment[0] = wd->BackBufferView[i];
  959. err = vkCreateFramebuffer(device, &info, allocator, &wd->Framebuffer[i]);
  960. check_vk_result(err);
  961. }
  962. }
  963. }
  964. void ImGui_ImplVulkanH_DestroyWindowData(VkInstance instance, VkDevice device, ImGui_ImplVulkanH_WindowData* wd, const VkAllocationCallbacks* allocator)
  965. {
  966. vkDeviceWaitIdle(device); // FIXME: We could wait on the Queue if we had the queue in wd-> (otherwise VulkanH functions can't use globals)
  967. //vkQueueWaitIdle(g_Queue);
  968. for (int i = 0; i < IMGUI_VK_QUEUED_FRAMES; i++)
  969. {
  970. ImGui_ImplVulkanH_FrameData* fd = &wd->Frames[i];
  971. vkDestroyFence(device, fd->Fence, allocator);
  972. vkFreeCommandBuffers(device, fd->CommandPool, 1, &fd->CommandBuffer);
  973. vkDestroyCommandPool(device, fd->CommandPool, allocator);
  974. vkDestroySemaphore(device, fd->ImageAcquiredSemaphore, allocator);
  975. vkDestroySemaphore(device, fd->RenderCompleteSemaphore, allocator);
  976. }
  977. for (uint32_t i = 0; i < wd->BackBufferCount; i++)
  978. {
  979. vkDestroyImageView(device, wd->BackBufferView[i], allocator);
  980. vkDestroyFramebuffer(device, wd->Framebuffer[i], allocator);
  981. }
  982. vkDestroyRenderPass(device, wd->RenderPass, allocator);
  983. vkDestroySwapchainKHR(device, wd->Swapchain, allocator);
  984. vkDestroySurfaceKHR(instance, wd->Surface, allocator);
  985. *wd = ImGui_ImplVulkanH_WindowData();
  986. }