imgui_impl_vulkan.cpp 51 KB

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