2020-10-12 17:34:22 +02:00
// dear imgui: Renderer Backend for Vulkan
// This needs to be used along with a Platform Backend (e.g. GLFW, SDL, Win32, custom..)
2018-02-05 20:34:11 +01:00
2019-05-29 15:53:36 +02:00
// Implemented features:
2023-02-07 16:23:49 +01:00
// [x] Renderer: User texture binding. Use 'VkDescriptorSet' as ImTextureID. Read the FAQ about ImTextureID! See https://github.com/ocornut/imgui/pull/914 for discussions.
2022-05-03 17:53:47 +02:00
// [X] Renderer: Large meshes support (64k+ vertices) with 16-bit indices.
2024-10-07 22:12:09 +02:00
// [X] Renderer: Expose selected render state for draw callbacks to use. Access in '(ImGui_ImplXXXX_RenderState*)GetPlatformIO().Renderer_RenderState'.
2022-05-03 17:53:47 +02:00
// [x] Renderer: Multi-viewport / platform windows. With issues (flickering when creating a new viewport).
2022-01-20 15:53:28 +01:00
2019-01-20 17:56:17 +01:00
// The aim of imgui_impl_vulkan.h/.cpp is to be usable in your engine without any modification.
2018-08-22 16:43:29 +02:00
// IF YOU FEEL YOU NEED TO MAKE ANY CHANGE TO THIS CODE, please share them and your feedback at https://github.com/ocornut/imgui/
2023-09-11 13:47:08 +02:00
// You can use unmodified imgui_impl_* files in your project. See examples/ folder for examples of using this.
// Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need.
// Learn about Dear ImGui:
// - FAQ https://dearimgui.com/faq
// - Getting Started https://dearimgui.com/getting-started
// - Documentation https://dearimgui.com/docs (same as your local docs/ folder).
// - Introduction, links and more at the top of imgui.cpp
2019-04-03 19:21:06 +02:00
// Important note to the reader who wish to integrate imgui_impl_vulkan.cpp/.h in their own engine/app.
2019-04-05 20:27:46 +02:00
// - Common ImGui_ImplVulkan_XXX functions and structures are used to interface with imgui_impl_vulkan.cpp/.h.
2020-10-12 17:34:22 +02:00
// You will use those if you want to use this rendering backend in your engine/app.
2019-09-17 16:35:50 +02:00
// - Helper ImGui_ImplVulkanH_XXX functions and structures are only used by this example (main.cpp) and by
2020-10-12 17:34:22 +02:00
// the backend itself (imgui_impl_vulkan.cpp), but should PROBABLY NOT be used by your own engine/app code.
2019-04-03 19:21:06 +02:00
// Read comments in imgui_impl_vulkan.h.
2018-02-16 17:20:18 +01:00
// CHANGELOG
// (minor and older changes stripped away, please see git history for details)
2024-01-16 11:43:36 +01:00
// 2024-XX-XX: Platform: Added support for multiple windows via the ImGuiPlatformIO interface.
2024-10-07 22:02:55 +02:00
// 2024-10-07: Vulkan: Changed default texture sampler to Clamp instead of Repeat/Wrap.
2024-10-07 21:00:07 +02:00
// 2024-10-07: Vulkan: Expose selected render state in ImGui_ImplVulkan_RenderState, which you can access in 'void* platform_io.Renderer_RenderState' during draw callbacks.
2024-10-14 19:13:04 +02:00
// 2024-10-07: Vulkan: Compiling with '#define ImTextureID=ImU64' is unnecessary now that dear imgui defaults ImTextureID to u64 instead of void*.
2024-04-19 15:16:54 +02:00
// 2024-04-19: Vulkan: Added convenience support for Volk via IMGUI_IMPL_VULKAN_USE_VOLK define (you can also use IMGUI_IMPL_VULKAN_NO_PROTOTYPES + wrap Volk via ImGui_ImplVulkan_LoadFunctions().)
2024-02-12 20:51:24 +01:00
// 2024-02-14: *BREAKING CHANGE*: Moved RenderPass parameter from ImGui_ImplVulkan_Init() function to ImGui_ImplVulkan_InitInfo structure. Not required when using dynamic rendering.
2023-12-23 20:01:48 +01:00
// 2024-02-12: *BREAKING CHANGE*: Dynamic rendering now require filling PipelineRenderingCreateInfo structure.
2024-01-19 14:50:32 +01:00
// 2024-01-19: Vulkan: Fixed vkAcquireNextImageKHR() validation errors in VulkanSDK 1.3.275 by allocating one extra semaphore than in-flight frames. (#7236)
2024-01-11 14:57:38 +01:00
// 2024-01-11: Vulkan: Fixed vkMapMemory() calls unnecessarily using full buffer size (#3957). Fixed MinAllocationSize handing (#7189).
2024-01-02 17:06:21 +01:00
// 2024-01-03: Vulkan: Added MinAllocationSize field in ImGui_ImplVulkan_InitInfo to workaround zealous "best practice" validation layer. (#7189, #4238)
2023-12-23 20:01:48 +01:00
// 2024-01-03: Vulkan: Stopped creating command pools with VK_COMMAND_POOL_CREATE_RESET_COMMAND_BUFFER_BIT as we don't reset them.
2023-11-29 14:24:25 +01:00
// 2023-11-29: Vulkan: Fixed mismatching allocator passed to vkCreateCommandPool() vs vkDestroyCommandPool(). (#7075)
2023-11-10 14:35:33 +01:00
// 2023-11-10: *BREAKING CHANGE*: Removed parameter from ImGui_ImplVulkan_CreateFontsTexture(): backend now creates its own command-buffer to upload fonts.
2024-05-16 08:58:45 +02:00
// *BREAKING CHANGE*: Removed ImGui_ImplVulkan_DestroyFontUploadObjects() which is now unnecessary as we create and destroy those objects in the backend.
2023-11-10 14:35:33 +01:00
// ImGui_ImplVulkan_CreateFontsTexture() is automatically called by NewFrame() the first time.
// You can call ImGui_ImplVulkan_CreateFontsTexture() again to recreate the font atlas texture.
// Added ImGui_ImplVulkan_DestroyFontsTexture() but you probably never need to call this.
2023-07-03 17:48:28 +02:00
// 2023-07-04: Vulkan: Added optional support for VK_KHR_dynamic_rendering. User needs to set init_info->UseDynamicRendering = true and init_info->ColorAttachmentFormat.
2022-12-16 16:48:36 +01:00
// 2023-01-02: Vulkan: Fixed sampler passed to ImGui_ImplVulkan_AddTexture() not being honored + removed a bunch of duplicate code.
2022-10-11 12:22:29 +02:00
// 2022-10-11: Using 'nullptr' instead of 'NULL' as per our switch to C++11.
2024-05-16 08:58:45 +02:00
// 2022-10-04: Vulkan: Added experimental ImGui_ImplVulkan_RemoveTexture() for api symmetry. (#914, #5738).
2022-10-04 12:02:48 +02:00
// 2022-01-20: Vulkan: Added support for ImTextureID as VkDescriptorSet. User need to call ImGui_ImplVulkan_AddTexture(). Building for 32-bit targets requires '#define ImTextureID ImU64'. (#914).
2021-10-15 12:11:11 +02:00
// 2021-10-15: Vulkan: Call vkCmdSetScissor() at the end of render a full-viewport to reduce likehood of issues with people using VK_DYNAMIC_STATE_SCISSOR in their app without calling vkCmdSetScissor() explicitly every frame.
2021-06-28 16:52:10 +02:00
// 2021-06-29: Reorganized backend to pull data from a single structure to facilitate usage with multiple-contexts (all g_XXXX access changed to bd->XXXX).
2021-03-21 17:29:24 +01:00
// 2021-03-22: Vulkan: Fix mapped memory validation error when buffer sizes are not multiple of VkPhysicalDeviceLimits::nonCoherentAtomSize.
2021-02-17 19:29:07 +01:00
// 2021-02-18: Vulkan: Change blending equation to preserve alpha in output buffer.
2021-01-27 13:23:28 +01:00
// 2021-01-27: Vulkan: Added support for custom function load and IMGUI_IMPL_VULKAN_NO_PROTOTYPES by using ImGui_ImplVulkan_LoadFunctions().
2020-11-07 16:32:48 +01:00
// 2020-11-11: Vulkan: Added support for specifying which subpass to reference during VkPipeline creation.
2020-09-08 16:47:06 +02:00
// 2020-09-07: Vulkan: Added VkPipeline parameter to ImGui_ImplVulkan_RenderDrawData (default to one passed to ImGui_ImplVulkan_Init).
2020-05-04 11:03:05 +02:00
// 2020-05-04: Vulkan: Fixed crash if initial frame has no vertices.
2019-07-05 03:28:34 +02:00
// 2020-04-26: Vulkan: Fixed edge case where render callbacks wouldn't be called if the ImDrawData didn't have vertices.
2019-07-31 20:50:50 +02:00
// 2019-08-01: Vulkan: Added support for specifying multisample count. Set ImGui_ImplVulkan_InitInfo::MSAASamples to one of the VkSampleCountFlagBits values to use, default is non-multisampled as before.
2019-05-29 16:29:17 +02:00
// 2019-05-29: Vulkan: Added support for large mesh (64K+ vertices), enable ImGuiBackendFlags_RendererHasVtxOffset flag.
2019-04-30 22:28:29 +02:00
// 2019-04-30: Vulkan: Added support for special ImDrawCallback_ResetRenderState callback to reset render state.
// 2019-04-04: *BREAKING CHANGE*: Vulkan: Added ImageCount/MinImageCount fields in ImGui_ImplVulkan_InitInfo, required for initialization (was previously a hard #define IMGUI_VK_QUEUED_FRAMES 2). Added ImGui_ImplVulkan_SetMinImageCount().
// 2019-04-04: Vulkan: Added VkInstance argument to ImGui_ImplVulkanH_CreateWindow() optional helper.
2019-04-04 22:09:12 +02:00
// 2019-04-04: Vulkan: Avoid passing negative coordinates to vkCmdSetScissor, which debug validation layers do not like.
2019-04-01 17:32:14 +02:00
// 2019-04-01: Vulkan: Support for 32-bit index buffer (#define ImDrawIdx unsigned int).
2019-02-16 12:27:46 +01:00
// 2019-02-16: Vulkan: Viewport and clipping rectangles correctly using draw_data->FramebufferScale to allow retina display.
2018-11-30 18:18:15 +01:00
// 2018-11-30: Misc: Setting up io.BackendRendererName so it can be displayed in the About Window.
2018-08-25 21:15:37 +02:00
// 2018-08-25: Vulkan: Fixed mishandled VkSurfaceCapabilitiesKHR::maxImageCount=0 case.
2020-10-12 17:34:22 +02:00
// 2018-06-22: Inverted the parameters to ImGui_ImplVulkan_RenderDrawData() to be consistent with other backends.
2018-06-08 19:37:33 +02:00
// 2018-06-08: Misc: Extracted imgui_impl_vulkan.cpp/.h away from the old combined GLFW+Vulkan example.
// 2018-06-08: Vulkan: Use draw_data->DisplayPos and draw_data->DisplaySize to setup projection matrix and clipping rectangle.
2018-03-03 00:29:17 +01:00
// 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.
2018-03-01 21:11:22 +01:00
// 2018-03-01: Vulkan: Renamed ImGui_ImplVulkan_Init_Info to ImGui_ImplVulkan_InitInfo and fields to match more closely Vulkan terminology.
2018-02-16 22:50:19 +01:00
// 2018-02-16: Misc: Obsoleted the io.RenderDrawListsFn callback, ImGui_ImplVulkan_Render() calls ImGui_ImplVulkan_RenderDrawData() itself.
2018-02-16 17:20:18 +01:00
// 2018-02-06: Misc: Removed call to ImGui::Shutdown() which is not available from 1.60 WIP, user needs to call CreateContext/DestroyContext themselves.
// 2017-05-15: Vulkan: Fix scissor offset being negative. Fix new Vulkan validation warnings. Set required depth member for buffer image copy.
// 2016-11-13: Vulkan: Fix validation layer warnings and errors and redeclare gl_PerVertex.
// 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.
// 2016-08-27: Vulkan: Fix Vulkan example for use when a depth buffer is active.
2023-07-13 11:27:52 +02:00
# include "imgui.h"
# ifndef IMGUI_DISABLE
2018-02-16 22:50:19 +01:00
# include "imgui_impl_vulkan.h"
2018-03-18 18:44:57 +01:00
# include <stdio.h>
2024-01-02 17:06:21 +01:00
# ifndef IM_MAX
# define IM_MAX(A, B) (((A) >= (B)) ? (A) : (B))
# endif
2016-03-09 16:39:54 +01:00
2022-01-20 15:53:28 +01:00
// Visual Studio warnings
# ifdef _MSC_VER
# pragma warning (disable: 4127) // condition expression is constant
# endif
2019-04-03 18:33:13 +02:00
// Forward Declarations
2024-01-11 20:22:37 +01:00
struct ImGui_ImplVulkan_FrameRenderBuffers ;
struct ImGui_ImplVulkan_WindowRenderBuffers ;
2019-04-05 18:52:40 +02:00
bool ImGui_ImplVulkan_CreateDeviceObjects ( ) ;
void ImGui_ImplVulkan_DestroyDeviceObjects ( ) ;
2024-01-11 20:22:37 +01:00
void ImGui_ImplVulkan_DestroyFrameRenderBuffers ( VkDevice device , ImGui_ImplVulkan_FrameRenderBuffers * buffers , const VkAllocationCallbacks * allocator ) ;
void ImGui_ImplVulkan_DestroyWindowRenderBuffers ( VkDevice device , ImGui_ImplVulkan_WindowRenderBuffers * buffers , const VkAllocationCallbacks * allocator ) ;
2019-04-05 17:54:16 +02:00
void ImGui_ImplVulkanH_DestroyFrame ( VkDevice device , ImGui_ImplVulkanH_Frame * fd , const VkAllocationCallbacks * allocator ) ;
void ImGui_ImplVulkanH_DestroyFrameSemaphores ( VkDevice device , ImGui_ImplVulkanH_FrameSemaphores * fsd , const VkAllocationCallbacks * allocator ) ;
2019-04-05 18:52:40 +02:00
void ImGui_ImplVulkanH_DestroyAllViewportsRenderBuffers ( VkDevice device , const VkAllocationCallbacks * allocator ) ;
2019-04-05 17:54:16 +02:00
void ImGui_ImplVulkanH_CreateWindowSwapChain ( VkPhysicalDevice physical_device , VkDevice device , ImGui_ImplVulkanH_Window * wd , const VkAllocationCallbacks * allocator , int w , int h , uint32_t min_image_count ) ;
void ImGui_ImplVulkanH_CreateWindowCommandBuffers ( VkPhysicalDevice physical_device , VkDevice device , ImGui_ImplVulkanH_Window * wd , uint32_t queue_family , const VkAllocationCallbacks * allocator ) ;
2019-04-03 18:33:13 +02:00
2021-01-27 13:23:28 +01:00
// Vulkan prototypes for use with custom loaders
// (see description of IMGUI_IMPL_VULKAN_NO_PROTOTYPES in imgui_impl_vulkan.h
2024-04-19 15:16:54 +02:00
# if defined(VK_NO_PROTOTYPES) && !defined(VOLK_H_)
# define IMGUI_IMPL_VULKAN_USE_LOADER
2021-06-28 16:52:10 +02:00
static bool g_FunctionsLoaded = false ;
# else
static bool g_FunctionsLoaded = true ;
# endif
2024-04-19 15:16:54 +02:00
# ifdef IMGUI_IMPL_VULKAN_USE_LOADER
2021-01-27 13:23:28 +01:00
# define IMGUI_VULKAN_FUNC_MAP(IMGUI_VULKAN_FUNC_MAP_MACRO) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkAllocateCommandBuffers ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkAllocateDescriptorSets ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkAllocateMemory ) \
2023-11-10 15:10:27 +01:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkAcquireNextImageKHR ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkBeginCommandBuffer ) \
2021-01-27 13:23:28 +01:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkBindBufferMemory ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkBindImageMemory ) \
2023-11-10 15:10:27 +01:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCmdBeginRenderPass ) \
2021-01-27 13:23:28 +01:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCmdBindDescriptorSets ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCmdBindIndexBuffer ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCmdBindPipeline ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCmdBindVertexBuffers ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCmdCopyBufferToImage ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCmdDrawIndexed ) \
2023-11-10 15:10:27 +01:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCmdEndRenderPass ) \
2021-01-27 13:23:28 +01:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCmdPipelineBarrier ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCmdPushConstants ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCmdSetScissor ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCmdSetViewport ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCreateBuffer ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCreateCommandPool ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCreateDescriptorSetLayout ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCreateFence ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCreateFramebuffer ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCreateGraphicsPipelines ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCreateImage ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCreateImageView ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCreatePipelineLayout ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCreateRenderPass ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCreateSampler ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCreateSemaphore ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCreateShaderModule ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkCreateSwapchainKHR ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDestroyBuffer ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDestroyCommandPool ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDestroyDescriptorSetLayout ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDestroyFence ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDestroyFramebuffer ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDestroyImage ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDestroyImageView ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDestroyPipeline ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDestroyPipelineLayout ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDestroyRenderPass ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDestroySampler ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDestroySemaphore ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDestroyShaderModule ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDestroySurfaceKHR ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDestroySwapchainKHR ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkDeviceWaitIdle ) \
2023-11-10 15:10:27 +01:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkEndCommandBuffer ) \
2021-01-27 13:23:28 +01:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkFlushMappedMemoryRanges ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkFreeCommandBuffers ) \
2022-10-04 12:30:45 +02:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkFreeDescriptorSets ) \
2021-01-27 13:23:28 +01:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkFreeMemory ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkGetBufferMemoryRequirements ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkGetImageMemoryRequirements ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkGetPhysicalDeviceMemoryProperties ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkGetPhysicalDeviceSurfaceCapabilitiesKHR ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkGetPhysicalDeviceSurfaceFormatsKHR ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkGetPhysicalDeviceSurfacePresentModesKHR ) \
2023-11-10 15:10:27 +01:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkGetPhysicalDeviceSurfaceSupportKHR ) \
2021-01-27 13:23:28 +01:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkGetSwapchainImagesKHR ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkMapMemory ) \
2021-05-18 15:07:17 +02:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkQueuePresentKHR ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkQueueSubmit ) \
2023-11-10 15:10:27 +01:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkQueueWaitIdle ) \
2021-05-18 15:07:17 +02:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkResetCommandPool ) \
2023-11-10 15:10:27 +01:00
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkResetFences ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkUnmapMemory ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkUpdateDescriptorSets ) \
IMGUI_VULKAN_FUNC_MAP_MACRO ( vkWaitForFences )
2021-01-27 13:23:28 +01:00
// Define function pointers
# define IMGUI_VULKAN_FUNC_DEF(func) static PFN_##func func;
IMGUI_VULKAN_FUNC_MAP ( IMGUI_VULKAN_FUNC_DEF )
# undef IMGUI_VULKAN_FUNC_DEF
2024-04-19 15:16:54 +02:00
# endif // IMGUI_IMPL_VULKAN_USE_LOADER
2021-01-27 13:23:28 +01:00
2024-02-12 18:46:01 +01:00
# ifdef IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
2023-07-03 17:48:28 +02:00
static PFN_vkCmdBeginRenderingKHR ImGuiImplVulkanFuncs_vkCmdBeginRenderingKHR ;
static PFN_vkCmdEndRenderingKHR ImGuiImplVulkanFuncs_vkCmdEndRenderingKHR ;
2022-02-19 20:15:58 +01:00
# endif
2024-01-03 16:17:39 +01:00
// Reusable buffers used for rendering 1 current in-flight frame, for ImGui_ImplVulkan_RenderDrawData()
// [Please zero-clear before use!]
2024-01-11 20:22:37 +01:00
struct ImGui_ImplVulkan_FrameRenderBuffers
2024-01-03 16:17:39 +01:00
{
VkDeviceMemory VertexBufferMemory ;
VkDeviceMemory IndexBufferMemory ;
VkDeviceSize VertexBufferSize ;
VkDeviceSize IndexBufferSize ;
VkBuffer VertexBuffer ;
VkBuffer IndexBuffer ;
} ;
// Each viewport will hold 1 ImGui_ImplVulkanH_WindowRenderBuffers
// [Please zero-clear before use!]
2024-01-11 20:22:37 +01:00
struct ImGui_ImplVulkan_WindowRenderBuffers
2024-01-03 16:17:39 +01:00
{
uint32_t Index ;
uint32_t Count ;
2024-01-11 20:22:37 +01:00
ImGui_ImplVulkan_FrameRenderBuffers * FrameRenderBuffers ;
2024-01-03 18:33:44 +01:00
} ;
// For multi-viewport support:
// Helper structure we store in the void* RendererUserData field of each ImGuiViewport to easily retrieve our backend data.
struct ImGui_ImplVulkan_ViewportData
{
2024-05-07 16:11:54 +02:00
ImGui_ImplVulkanH_Window Window ; // Used by secondary viewports only
ImGui_ImplVulkan_WindowRenderBuffers RenderBuffers ; // Used by all viewports
2024-01-03 18:33:44 +01:00
bool WindowOwned ;
2024-05-07 16:11:54 +02:00
bool SwapChainNeedRebuild ; // Flag when viewport swapchain resized in the middle of processing a frame
2024-01-03 18:33:44 +01:00
2024-05-07 16:11:54 +02:00
ImGui_ImplVulkan_ViewportData ( ) { WindowOwned = SwapChainNeedRebuild = false ; memset ( & RenderBuffers , 0 , sizeof ( RenderBuffers ) ) ; }
2024-01-03 18:33:44 +01:00
~ ImGui_ImplVulkan_ViewportData ( ) { }
2024-01-03 16:17:39 +01:00
} ;
// Vulkan data
struct ImGui_ImplVulkan_Data
{
ImGui_ImplVulkan_InitInfo VulkanInitInfo ;
VkDeviceSize BufferMemoryAlignment ;
VkPipelineCreateFlags PipelineCreateFlags ;
VkDescriptorSetLayout DescriptorSetLayout ;
VkPipelineLayout PipelineLayout ;
2023-04-12 21:56:35 +02:00
VkPipeline Pipeline ; // pipeline for main render pass (created by app)
VkPipeline PipelineForViewports ; // pipeline for secondary viewports (created by backend)
2024-01-03 16:17:39 +01:00
VkShaderModule ShaderModuleVert ;
VkShaderModule ShaderModuleFrag ;
// Font data
VkSampler FontSampler ;
VkDeviceMemory FontMemory ;
VkImage FontImage ;
VkImageView FontView ;
VkDescriptorSet FontDescriptorSet ;
VkCommandPool FontCommandPool ;
VkCommandBuffer FontCommandBuffer ;
// Render buffers for main window
2024-01-11 20:22:37 +01:00
ImGui_ImplVulkan_WindowRenderBuffers MainWindowRenderBuffers ;
2024-01-03 16:17:39 +01:00
ImGui_ImplVulkan_Data ( )
{
memset ( ( void * ) this , 0 , sizeof ( * this ) ) ;
BufferMemoryAlignment = 256 ;
}
} ;
2019-04-03 18:33:13 +02:00
//-----------------------------------------------------------------------------
// SHADERS
//-----------------------------------------------------------------------------
2016-03-09 16:39:54 +01:00
2018-03-02 19:23:01 +01:00
// Forward Declarations
2024-10-08 20:47:24 +02:00
static void ImGui_ImplVulkan_InitMultiViewportSupport ( ) ;
static void ImGui_ImplVulkan_ShutdownMultiViewportSupport ( ) ;
2018-03-02 19:23:01 +01:00
2024-01-03 16:17:39 +01:00
// backends/vulkan/glsl_shader.vert, compiled with:
2018-03-02 16:34:47 +01:00
// # glslangValidator -V -x -o glsl_shader.vert.u32 glsl_shader.vert
2019-04-03 11:23:54 +02:00
/*
# version 450 core
layout ( location = 0 ) in vec2 aPos ;
layout ( location = 1 ) in vec2 aUV ;
layout ( location = 2 ) in vec4 aColor ;
layout ( push_constant ) uniform uPushConstant { vec2 uScale ; vec2 uTranslate ; } pc ;
out gl_PerVertex { vec4 gl_Position ; } ;
layout ( location = 0 ) out struct { vec4 Color ; vec2 UV ; } Out ;
void main ( )
{
Out . Color = aColor ;
Out . UV = aUV ;
gl_Position = vec4 ( aPos * pc . uScale + pc . uTranslate , 0 , 1 ) ;
}
*/
2016-11-13 03:00:36 +01:00
static uint32_t __glsl_shader_vert_spv [ ] =
2016-04-03 17:32:53 +02:00
{
2016-11-13 03:00:36 +01:00
0x07230203 , 0x00010000 , 0x00080001 , 0x0000002e , 0x00000000 , 0x00020011 , 0x00000001 , 0x0006000b ,
2016-10-18 22:40:58 +02:00
0x00000001 , 0x4c534c47 , 0x6474732e , 0x3035342e , 0x00000000 , 0x0003000e , 0x00000000 , 0x00000001 ,
0x000a000f , 0x00000000 , 0x00000004 , 0x6e69616d , 0x00000000 , 0x0000000b , 0x0000000f , 0x00000015 ,
2016-11-13 03:00:36 +01:00
0x0000001b , 0x0000001c , 0x00030003 , 0x00000002 , 0x000001c2 , 0x00040005 , 0x00000004 , 0x6e69616d ,
2016-10-18 22:40:58 +02:00
0x00000000 , 0x00030005 , 0x00000009 , 0x00000000 , 0x00050006 , 0x00000009 , 0x00000000 , 0x6f6c6f43 ,
0x00000072 , 0x00040006 , 0x00000009 , 0x00000001 , 0x00005655 , 0x00030005 , 0x0000000b , 0x0074754f ,
0x00040005 , 0x0000000f , 0x6c6f4361 , 0x0000726f , 0x00030005 , 0x00000015 , 0x00565561 , 0x00060005 ,
2016-11-13 03:00:36 +01:00
0x00000019 , 0x505f6c67 , 0x65567265 , 0x78657472 , 0x00000000 , 0x00060006 , 0x00000019 , 0x00000000 ,
0x505f6c67 , 0x7469736f , 0x006e6f69 , 0x00030005 , 0x0000001b , 0x00000000 , 0x00040005 , 0x0000001c ,
0x736f5061 , 0x00000000 , 0x00060005 , 0x0000001e , 0x73755075 , 0x6e6f4368 , 0x6e617473 , 0x00000074 ,
0x00050006 , 0x0000001e , 0x00000000 , 0x61635375 , 0x0000656c , 0x00060006 , 0x0000001e , 0x00000001 ,
0x61725475 , 0x616c736e , 0x00006574 , 0x00030005 , 0x00000020 , 0x00006370 , 0x00040047 , 0x0000000b ,
0x0000001e , 0x00000000 , 0x00040047 , 0x0000000f , 0x0000001e , 0x00000002 , 0x00040047 , 0x00000015 ,
0x0000001e , 0x00000001 , 0x00050048 , 0x00000019 , 0x00000000 , 0x0000000b , 0x00000000 , 0x00030047 ,
0x00000019 , 0x00000002 , 0x00040047 , 0x0000001c , 0x0000001e , 0x00000000 , 0x00050048 , 0x0000001e ,
0x00000000 , 0x00000023 , 0x00000000 , 0x00050048 , 0x0000001e , 0x00000001 , 0x00000023 , 0x00000008 ,
0x00030047 , 0x0000001e , 0x00000002 , 0x00020013 , 0x00000002 , 0x00030021 , 0x00000003 , 0x00000002 ,
0x00030016 , 0x00000006 , 0x00000020 , 0x00040017 , 0x00000007 , 0x00000006 , 0x00000004 , 0x00040017 ,
0x00000008 , 0x00000006 , 0x00000002 , 0x0004001e , 0x00000009 , 0x00000007 , 0x00000008 , 0x00040020 ,
0x0000000a , 0x00000003 , 0x00000009 , 0x0004003b , 0x0000000a , 0x0000000b , 0x00000003 , 0x00040015 ,
0x0000000c , 0x00000020 , 0x00000001 , 0x0004002b , 0x0000000c , 0x0000000d , 0x00000000 , 0x00040020 ,
0x0000000e , 0x00000001 , 0x00000007 , 0x0004003b , 0x0000000e , 0x0000000f , 0x00000001 , 0x00040020 ,
0x00000011 , 0x00000003 , 0x00000007 , 0x0004002b , 0x0000000c , 0x00000013 , 0x00000001 , 0x00040020 ,
0x00000014 , 0x00000001 , 0x00000008 , 0x0004003b , 0x00000014 , 0x00000015 , 0x00000001 , 0x00040020 ,
0x00000017 , 0x00000003 , 0x00000008 , 0x0003001e , 0x00000019 , 0x00000007 , 0x00040020 , 0x0000001a ,
0x00000003 , 0x00000019 , 0x0004003b , 0x0000001a , 0x0000001b , 0x00000003 , 0x0004003b , 0x00000014 ,
0x0000001c , 0x00000001 , 0x0004001e , 0x0000001e , 0x00000008 , 0x00000008 , 0x00040020 , 0x0000001f ,
0x00000009 , 0x0000001e , 0x0004003b , 0x0000001f , 0x00000020 , 0x00000009 , 0x00040020 , 0x00000021 ,
0x00000009 , 0x00000008 , 0x0004002b , 0x00000006 , 0x00000028 , 0x00000000 , 0x0004002b , 0x00000006 ,
0x00000029 , 0x3f800000 , 0x00050036 , 0x00000002 , 0x00000004 , 0x00000000 , 0x00000003 , 0x000200f8 ,
0x00000005 , 0x0004003d , 0x00000007 , 0x00000010 , 0x0000000f , 0x00050041 , 0x00000011 , 0x00000012 ,
0x0000000b , 0x0000000d , 0x0003003e , 0x00000012 , 0x00000010 , 0x0004003d , 0x00000008 , 0x00000016 ,
0x00000015 , 0x00050041 , 0x00000017 , 0x00000018 , 0x0000000b , 0x00000013 , 0x0003003e , 0x00000018 ,
0x00000016 , 0x0004003d , 0x00000008 , 0x0000001d , 0x0000001c , 0x00050041 , 0x00000021 , 0x00000022 ,
0x00000020 , 0x0000000d , 0x0004003d , 0x00000008 , 0x00000023 , 0x00000022 , 0x00050085 , 0x00000008 ,
0x00000024 , 0x0000001d , 0x00000023 , 0x00050041 , 0x00000021 , 0x00000025 , 0x00000020 , 0x00000013 ,
0x0004003d , 0x00000008 , 0x00000026 , 0x00000025 , 0x00050081 , 0x00000008 , 0x00000027 , 0x00000024 ,
0x00000026 , 0x00050051 , 0x00000006 , 0x0000002a , 0x00000027 , 0x00000000 , 0x00050051 , 0x00000006 ,
0x0000002b , 0x00000027 , 0x00000001 , 0x00070050 , 0x00000007 , 0x0000002c , 0x0000002a , 0x0000002b ,
0x00000028 , 0x00000029 , 0x00050041 , 0x00000011 , 0x0000002d , 0x0000001b , 0x0000000d , 0x0003003e ,
0x0000002d , 0x0000002c , 0x000100fd , 0x00010038
2016-03-09 16:39:54 +01:00
} ;
2024-01-03 16:17:39 +01:00
// backends/vulkan/glsl_shader.frag, compiled with:
2018-03-02 16:34:47 +01:00
// # glslangValidator -V -x -o glsl_shader.frag.u32 glsl_shader.frag
2019-04-03 11:23:54 +02:00
/*
# version 450 core
layout ( location = 0 ) out vec4 fColor ;
layout ( set = 0 , binding = 0 ) uniform sampler2D sTexture ;
layout ( location = 0 ) in struct { vec4 Color ; vec2 UV ; } In ;
void main ( )
{
fColor = In . Color * texture ( sTexture , In . UV . st ) ;
}
*/
2016-11-13 03:00:36 +01:00
static uint32_t __glsl_shader_frag_spv [ ] =
2016-04-03 17:32:53 +02:00
{
2016-10-18 22:40:58 +02:00
0x07230203 , 0x00010000 , 0x00080001 , 0x0000001e , 0x00000000 , 0x00020011 , 0x00000001 , 0x0006000b ,
0x00000001 , 0x4c534c47 , 0x6474732e , 0x3035342e , 0x00000000 , 0x0003000e , 0x00000000 , 0x00000001 ,
0x0007000f , 0x00000004 , 0x00000004 , 0x6e69616d , 0x00000000 , 0x00000009 , 0x0000000d , 0x00030010 ,
0x00000004 , 0x00000007 , 0x00030003 , 0x00000002 , 0x000001c2 , 0x00040005 , 0x00000004 , 0x6e69616d ,
0x00000000 , 0x00040005 , 0x00000009 , 0x6c6f4366 , 0x0000726f , 0x00030005 , 0x0000000b , 0x00000000 ,
0x00050006 , 0x0000000b , 0x00000000 , 0x6f6c6f43 , 0x00000072 , 0x00040006 , 0x0000000b , 0x00000001 ,
0x00005655 , 0x00030005 , 0x0000000d , 0x00006e49 , 0x00050005 , 0x00000016 , 0x78655473 , 0x65727574 ,
0x00000000 , 0x00040047 , 0x00000009 , 0x0000001e , 0x00000000 , 0x00040047 , 0x0000000d , 0x0000001e ,
0x00000000 , 0x00040047 , 0x00000016 , 0x00000022 , 0x00000000 , 0x00040047 , 0x00000016 , 0x00000021 ,
0x00000000 , 0x00020013 , 0x00000002 , 0x00030021 , 0x00000003 , 0x00000002 , 0x00030016 , 0x00000006 ,
0x00000020 , 0x00040017 , 0x00000007 , 0x00000006 , 0x00000004 , 0x00040020 , 0x00000008 , 0x00000003 ,
0x00000007 , 0x0004003b , 0x00000008 , 0x00000009 , 0x00000003 , 0x00040017 , 0x0000000a , 0x00000006 ,
0x00000002 , 0x0004001e , 0x0000000b , 0x00000007 , 0x0000000a , 0x00040020 , 0x0000000c , 0x00000001 ,
0x0000000b , 0x0004003b , 0x0000000c , 0x0000000d , 0x00000001 , 0x00040015 , 0x0000000e , 0x00000020 ,
0x00000001 , 0x0004002b , 0x0000000e , 0x0000000f , 0x00000000 , 0x00040020 , 0x00000010 , 0x00000001 ,
0x00000007 , 0x00090019 , 0x00000013 , 0x00000006 , 0x00000001 , 0x00000000 , 0x00000000 , 0x00000000 ,
0x00000001 , 0x00000000 , 0x0003001b , 0x00000014 , 0x00000013 , 0x00040020 , 0x00000015 , 0x00000000 ,
0x00000014 , 0x0004003b , 0x00000015 , 0x00000016 , 0x00000000 , 0x0004002b , 0x0000000e , 0x00000018 ,
0x00000001 , 0x00040020 , 0x00000019 , 0x00000001 , 0x0000000a , 0x00050036 , 0x00000002 , 0x00000004 ,
0x00000000 , 0x00000003 , 0x000200f8 , 0x00000005 , 0x00050041 , 0x00000010 , 0x00000011 , 0x0000000d ,
0x0000000f , 0x0004003d , 0x00000007 , 0x00000012 , 0x00000011 , 0x0004003d , 0x00000014 , 0x00000017 ,
0x00000016 , 0x00050041 , 0x00000019 , 0x0000001a , 0x0000000d , 0x00000018 , 0x0004003d , 0x0000000a ,
0x0000001b , 0x0000001a , 0x00050057 , 0x00000007 , 0x0000001c , 0x00000017 , 0x0000001b , 0x00050085 ,
0x00000007 , 0x0000001d , 0x00000012 , 0x0000001c , 0x0003003e , 0x00000009 , 0x0000001d , 0x000100fd ,
0x00010038
2016-03-09 16:39:54 +01:00
} ;
2019-04-03 18:33:13 +02:00
//-----------------------------------------------------------------------------
// FUNCTIONS
//-----------------------------------------------------------------------------
2021-06-30 15:22:15 +02:00
// Backend data stored in io.BackendRendererUserData to allow support for multiple Dear ImGui contexts
// It is STRONGLY preferred that you use docking branch with multi-viewports (== single Dear ImGui context + multiple windows) instead of multiple Dear ImGui contexts.
// FIXME: multi-context support is not tested and probably dysfunctional in this backend.
static ImGui_ImplVulkan_Data * ImGui_ImplVulkan_GetBackendData ( )
{
2022-10-11 12:22:29 +02:00
return ImGui : : GetCurrentContext ( ) ? ( ImGui_ImplVulkan_Data * ) ImGui : : GetIO ( ) . BackendRendererUserData : nullptr ;
2021-06-30 15:22:15 +02:00
}
2018-02-16 22:50:19 +01:00
static uint32_t ImGui_ImplVulkan_MemoryType ( VkMemoryPropertyFlags properties , uint32_t type_bits )
2016-03-09 16:39:54 +01:00
{
2021-06-28 16:52:10 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
2016-03-09 16:39:54 +01:00
VkPhysicalDeviceMemoryProperties prop ;
2019-04-04 22:36:12 +02:00
vkGetPhysicalDeviceMemoryProperties ( v - > PhysicalDevice , & prop ) ;
2016-04-03 17:32:53 +02:00
for ( uint32_t i = 0 ; i < prop . memoryTypeCount ; i + + )
2020-06-30 15:31:54 +02:00
if ( ( prop . memoryTypes [ i ] . propertyFlags & properties ) = = properties & & type_bits & ( 1 < < i ) )
2016-03-09 16:39:54 +01:00
return i ;
2018-03-02 23:59:21 +01:00
return 0xFFFFFFFF ; // Unable to find memoryType
2016-03-09 16:39:54 +01:00
}
2016-04-03 17:32:53 +02:00
2018-03-02 23:59:21 +01:00
static void check_vk_result ( VkResult err )
2016-03-09 16:39:54 +01:00
{
2021-06-28 16:52:10 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
if ( ! bd )
return ;
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
2019-04-04 22:36:12 +02:00
if ( v - > CheckVkResultFn )
v - > CheckVkResultFn ( err ) ;
2016-03-09 16:39:54 +01:00
}
2024-01-11 14:57:38 +01:00
// Same as IM_MEMALIGN(). 'alignment' must be a power of two.
static inline VkDeviceSize AlignBufferSize ( VkDeviceSize size , VkDeviceSize alignment )
{
return ( size + alignment - 1 ) & ~ ( alignment - 1 ) ;
}
2024-10-07 21:53:46 +02:00
static void CreateOrResizeBuffer ( VkBuffer & buffer , VkDeviceMemory & buffer_memory , VkDeviceSize & buffer_size , VkDeviceSize new_size , VkBufferUsageFlagBits usage )
2018-03-02 16:34:47 +01:00
{
2021-06-28 16:52:10 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
2018-03-02 16:34:47 +01:00
VkResult err ;
2018-08-28 18:22:36 +02:00
if ( buffer ! = VK_NULL_HANDLE )
2019-04-04 22:36:12 +02:00
vkDestroyBuffer ( v - > Device , buffer , v - > Allocator ) ;
2019-04-05 20:27:46 +02:00
if ( buffer_memory ! = VK_NULL_HANDLE )
2019-04-04 22:36:12 +02:00
vkFreeMemory ( v - > Device , buffer_memory , v - > Allocator ) ;
2018-03-02 16:34:47 +01:00
2024-01-11 14:57:38 +01:00
VkDeviceSize buffer_size_aligned = AlignBufferSize ( IM_MAX ( v - > MinAllocationSize , new_size ) , bd - > BufferMemoryAlignment ) ;
2018-03-02 16:34:47 +01:00
VkBufferCreateInfo buffer_info = { } ;
buffer_info . sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO ;
2024-01-11 14:57:38 +01:00
buffer_info . size = buffer_size_aligned ;
2018-03-02 16:34:47 +01:00
buffer_info . usage = usage ;
buffer_info . sharingMode = VK_SHARING_MODE_EXCLUSIVE ;
2019-04-04 22:36:12 +02:00
err = vkCreateBuffer ( v - > Device , & buffer_info , v - > Allocator , & buffer ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2018-03-02 16:34:47 +01:00
VkMemoryRequirements req ;
2019-04-04 22:36:12 +02:00
vkGetBufferMemoryRequirements ( v - > Device , buffer , & req ) ;
2021-06-28 16:52:10 +02:00
bd - > BufferMemoryAlignment = ( bd - > BufferMemoryAlignment > req . alignment ) ? bd - > BufferMemoryAlignment : req . alignment ;
2018-03-02 16:34:47 +01:00
VkMemoryAllocateInfo alloc_info = { } ;
alloc_info . sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO ;
2024-01-11 14:42:48 +01:00
alloc_info . allocationSize = req . size ;
2018-03-02 16:34:47 +01:00
alloc_info . memoryTypeIndex = ImGui_ImplVulkan_MemoryType ( VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT , req . memoryTypeBits ) ;
2019-04-04 22:36:12 +02:00
err = vkAllocateMemory ( v - > Device , & alloc_info , v - > Allocator , & buffer_memory ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2018-03-02 16:34:47 +01:00
2019-04-04 22:36:12 +02:00
err = vkBindBufferMemory ( v - > Device , buffer , buffer_memory , 0 ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2024-01-11 14:57:38 +01:00
buffer_size = buffer_size_aligned ;
2018-03-02 16:34:47 +01:00
}
2024-01-11 20:22:37 +01:00
static void ImGui_ImplVulkan_SetupRenderState ( ImDrawData * draw_data , VkPipeline pipeline , VkCommandBuffer command_buffer , ImGui_ImplVulkan_FrameRenderBuffers * rb , int fb_width , int fb_height )
2019-04-30 22:15:59 +02:00
{
2021-06-28 16:52:10 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
2022-01-20 15:32:49 +01:00
// Bind pipeline:
2019-04-30 22:15:59 +02:00
{
2020-09-08 16:47:06 +02:00
vkCmdBindPipeline ( command_buffer , VK_PIPELINE_BIND_POINT_GRAPHICS , pipeline ) ;
2019-04-30 22:15:59 +02:00
}
// Bind Vertex And Index Buffer:
2019-07-05 03:28:34 +02:00
if ( draw_data - > TotalVtxCount > 0 )
2019-04-30 22:15:59 +02:00
{
VkBuffer vertex_buffers [ 1 ] = { rb - > VertexBuffer } ;
VkDeviceSize vertex_offset [ 1 ] = { 0 } ;
vkCmdBindVertexBuffers ( command_buffer , 0 , 1 , vertex_buffers , vertex_offset ) ;
vkCmdBindIndexBuffer ( command_buffer , rb - > IndexBuffer , 0 , sizeof ( ImDrawIdx ) = = 2 ? VK_INDEX_TYPE_UINT16 : VK_INDEX_TYPE_UINT32 ) ;
}
// Setup viewport:
{
VkViewport viewport ;
viewport . x = 0 ;
viewport . y = 0 ;
viewport . width = ( float ) fb_width ;
viewport . height = ( float ) fb_height ;
viewport . minDepth = 0.0f ;
viewport . maxDepth = 1.0f ;
vkCmdSetViewport ( command_buffer , 0 , 1 , & viewport ) ;
}
// Setup scale and translation:
2019-06-06 16:16:18 +02:00
// Our visible imgui space lies from draw_data->DisplayPps (top left) to draw_data->DisplayPos+data_data->DisplaySize (bottom right). DisplayPos is (0,0) for single viewport apps.
2019-04-30 22:15:59 +02:00
{
float scale [ 2 ] ;
scale [ 0 ] = 2.0f / draw_data - > DisplaySize . x ;
scale [ 1 ] = 2.0f / draw_data - > DisplaySize . y ;
float translate [ 2 ] ;
translate [ 0 ] = - 1.0f - draw_data - > DisplayPos . x * scale [ 0 ] ;
translate [ 1 ] = - 1.0f - draw_data - > DisplayPos . y * scale [ 1 ] ;
2021-06-28 16:52:10 +02:00
vkCmdPushConstants ( command_buffer , bd - > PipelineLayout , VK_SHADER_STAGE_VERTEX_BIT , sizeof ( float ) * 0 , sizeof ( float ) * 2 , scale ) ;
vkCmdPushConstants ( command_buffer , bd - > PipelineLayout , VK_SHADER_STAGE_VERTEX_BIT , sizeof ( float ) * 2 , sizeof ( float ) * 2 , translate ) ;
2019-04-30 22:15:59 +02:00
}
}
2018-06-22 10:02:02 +02:00
// Render function
2020-09-08 16:47:06 +02:00
void ImGui_ImplVulkan_RenderDrawData ( ImDrawData * draw_data , VkCommandBuffer command_buffer , VkPipeline pipeline )
2016-03-09 16:39:54 +01:00
{
2019-02-16 12:33:38 +01:00
// Avoid rendering when minimized, scale coordinates for retina displays (screen coordinates != framebuffer coordinates)
int fb_width = ( int ) ( draw_data - > DisplaySize . x * draw_data - > FramebufferScale . x ) ;
int fb_height = ( int ) ( draw_data - > DisplaySize . y * draw_data - > FramebufferScale . y ) ;
2019-07-05 03:28:34 +02:00
if ( fb_width < = 0 | | fb_height < = 0 )
2018-02-16 22:28:52 +01:00
return ;
2016-03-09 16:39:54 +01:00
2021-06-28 16:52:10 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
2020-09-08 16:47:06 +02:00
if ( pipeline = = VK_NULL_HANDLE )
2021-06-28 16:52:10 +02:00
pipeline = bd - > Pipeline ;
2019-04-05 17:48:47 +02:00
2019-04-05 18:52:40 +02:00
// Allocate array to store enough vertex/index buffers. Each unique viewport gets its own storage.
2021-06-29 15:34:54 +02:00
ImGui_ImplVulkan_ViewportData * viewport_renderer_data = ( ImGui_ImplVulkan_ViewportData * ) draw_data - > OwnerViewport - > RendererUserData ;
2022-10-11 15:59:23 +02:00
IM_ASSERT ( viewport_renderer_data ! = nullptr ) ;
2024-01-16 11:43:36 +01:00
ImGui_ImplVulkan_WindowRenderBuffers * wrb = & viewport_renderer_data - > RenderBuffers ;
2022-10-11 12:22:29 +02:00
if ( wrb - > FrameRenderBuffers = = nullptr )
2019-04-05 17:48:47 +02:00
{
wrb - > Index = 0 ;
wrb - > Count = v - > ImageCount ;
2024-01-11 20:22:37 +01:00
wrb - > FrameRenderBuffers = ( ImGui_ImplVulkan_FrameRenderBuffers * ) IM_ALLOC ( sizeof ( ImGui_ImplVulkan_FrameRenderBuffers ) * wrb - > Count ) ;
memset ( wrb - > FrameRenderBuffers , 0 , sizeof ( ImGui_ImplVulkan_FrameRenderBuffers ) * wrb - > Count ) ;
2019-04-05 17:48:47 +02:00
}
IM_ASSERT ( wrb - > Count = = v - > ImageCount ) ;
wrb - > Index = ( wrb - > Index + 1 ) % wrb - > Count ;
2024-01-11 20:22:37 +01:00
ImGui_ImplVulkan_FrameRenderBuffers * rb = & wrb - > FrameRenderBuffers [ wrb - > Index ] ;
2019-04-05 17:48:47 +02:00
2020-05-04 11:03:05 +02:00
if ( draw_data - > TotalVtxCount > 0 )
2016-03-09 16:39:54 +01:00
{
2020-05-04 11:03:05 +02:00
// Create or resize the vertex/index buffers
2024-10-07 21:53:46 +02:00
VkDeviceSize vertex_size = AlignBufferSize ( draw_data - > TotalVtxCount * sizeof ( ImDrawVert ) , bd - > BufferMemoryAlignment ) ;
VkDeviceSize index_size = AlignBufferSize ( draw_data - > TotalIdxCount * sizeof ( ImDrawIdx ) , bd - > BufferMemoryAlignment ) ;
2020-05-04 11:03:05 +02:00
if ( rb - > VertexBuffer = = VK_NULL_HANDLE | | rb - > VertexBufferSize < vertex_size )
CreateOrResizeBuffer ( rb - > VertexBuffer , rb - > VertexBufferMemory , rb - > VertexBufferSize , vertex_size , VK_BUFFER_USAGE_VERTEX_BUFFER_BIT ) ;
if ( rb - > IndexBuffer = = VK_NULL_HANDLE | | rb - > IndexBufferSize < index_size )
CreateOrResizeBuffer ( rb - > IndexBuffer , rb - > IndexBufferMemory , rb - > IndexBufferSize , index_size , VK_BUFFER_USAGE_INDEX_BUFFER_BIT ) ;
// Upload vertex/index data into a single contiguous GPU buffer
2022-10-11 12:22:29 +02:00
ImDrawVert * vtx_dst = nullptr ;
ImDrawIdx * idx_dst = nullptr ;
2024-01-11 14:57:38 +01:00
VkResult err = vkMapMemory ( v - > Device , rb - > VertexBufferMemory , 0 , vertex_size , 0 , ( void * * ) & vtx_dst ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2024-01-11 14:57:38 +01:00
err = vkMapMemory ( v - > Device , rb - > IndexBufferMemory , 0 , index_size , 0 , ( void * * ) & idx_dst ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2016-04-03 17:32:53 +02:00
for ( int n = 0 ; n < draw_data - > CmdListsCount ; n + + )
{
2024-10-07 17:52:57 +02:00
const ImDrawList * draw_list = draw_data - > CmdLists [ n ] ;
memcpy ( vtx_dst , draw_list - > VtxBuffer . Data , draw_list - > VtxBuffer . Size * sizeof ( ImDrawVert ) ) ;
memcpy ( idx_dst , draw_list - > IdxBuffer . Data , draw_list - > IdxBuffer . Size * sizeof ( ImDrawIdx ) ) ;
vtx_dst + = draw_list - > VtxBuffer . Size ;
idx_dst + = draw_list - > IdxBuffer . Size ;
2016-03-09 16:39:54 +01:00
}
VkMappedMemoryRange range [ 2 ] = { } ;
range [ 0 ] . sType = VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE ;
2019-04-05 17:48:47 +02:00
range [ 0 ] . memory = rb - > VertexBufferMemory ;
2017-02-11 12:08:59 +01:00
range [ 0 ] . size = VK_WHOLE_SIZE ;
2016-03-09 16:39:54 +01:00
range [ 1 ] . sType = VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE ;
2019-04-05 17:48:47 +02:00
range [ 1 ] . memory = rb - > IndexBufferMemory ;
2017-02-11 12:08:59 +01:00
range [ 1 ] . size = VK_WHOLE_SIZE ;
2019-04-04 22:36:12 +02:00
err = vkFlushMappedMemoryRanges ( v - > Device , 2 , range ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2019-04-05 17:48:47 +02:00
vkUnmapMemory ( v - > Device , rb - > VertexBufferMemory ) ;
vkUnmapMemory ( v - > Device , rb - > IndexBufferMemory ) ;
2016-03-09 16:39:54 +01:00
}
2016-04-03 17:32:53 +02:00
2019-04-30 22:15:59 +02:00
// Setup desired Vulkan state
2020-09-08 16:47:06 +02:00
ImGui_ImplVulkan_SetupRenderState ( draw_data , pipeline , command_buffer , rb , fb_width , fb_height ) ;
2016-04-03 17:32:53 +02:00
2024-10-07 21:00:07 +02:00
// Setup render state structure (for callbacks and custom texture bindings)
ImGuiPlatformIO & platform_io = ImGui : : GetPlatformIO ( ) ;
ImGui_ImplVulkan_RenderState render_state ;
render_state . CommandBuffer = command_buffer ;
render_state . Pipeline = pipeline ;
render_state . PipelineLayout = bd - > PipelineLayout ;
platform_io . Renderer_RenderState = & render_state ;
2019-02-16 12:27:46 +01:00
// Will project scissor/clipping rectangles into framebuffer space
ImVec2 clip_off = draw_data - > DisplayPos ; // (0,0) unless using multi-viewports
ImVec2 clip_scale = draw_data - > FramebufferScale ; // (1,1) unless using retina display which are often (2,2)
// Render command lists
2019-05-29 15:53:36 +02:00
// (Because we merged all buffers into a single one, we maintain our own offset into them)
int global_vtx_offset = 0 ;
int global_idx_offset = 0 ;
2016-04-03 17:32:53 +02:00
for ( int n = 0 ; n < draw_data - > CmdListsCount ; n + + )
{
2024-10-07 17:52:57 +02:00
const ImDrawList * draw_list = draw_data - > CmdLists [ n ] ;
for ( int cmd_i = 0 ; cmd_i < draw_list - > CmdBuffer . Size ; cmd_i + + )
2016-04-03 17:32:53 +02:00
{
2024-10-07 17:52:57 +02:00
const ImDrawCmd * pcmd = & draw_list - > CmdBuffer [ cmd_i ] ;
2022-10-11 12:22:29 +02:00
if ( pcmd - > UserCallback ! = nullptr )
2016-04-03 17:32:53 +02:00
{
2019-04-30 22:15:59 +02:00
// User callback, registered via ImDrawList::AddCallback()
// (ImDrawCallback_ResetRenderState is a special callback value used by the user to request the renderer to reset render state.)
if ( pcmd - > UserCallback = = ImDrawCallback_ResetRenderState )
2020-09-08 16:47:06 +02:00
ImGui_ImplVulkan_SetupRenderState ( draw_data , pipeline , command_buffer , rb , fb_width , fb_height ) ;
2019-04-30 22:15:59 +02:00
else
2024-10-07 17:52:57 +02:00
pcmd - > UserCallback ( draw_list , pcmd ) ;
2016-03-09 16:39:54 +01:00
}
2016-04-03 17:32:53 +02:00
else
{
2019-02-16 12:27:46 +01:00
// Project scissor/clipping rectangles into framebuffer space
2021-08-24 17:03:52 +02:00
ImVec2 clip_min ( ( pcmd - > ClipRect . x - clip_off . x ) * clip_scale . x , ( pcmd - > ClipRect . y - clip_off . y ) * clip_scale . y ) ;
ImVec2 clip_max ( ( pcmd - > ClipRect . z - clip_off . x ) * clip_scale . x , ( pcmd - > ClipRect . w - clip_off . y ) * clip_scale . y ) ;
// Clamp to viewport as vkCmdSetScissor() won't accept values that are off bounds
if ( clip_min . x < 0.0f ) { clip_min . x = 0.0f ; }
if ( clip_min . y < 0.0f ) { clip_min . y = 0.0f ; }
if ( clip_max . x > fb_width ) { clip_max . x = ( float ) fb_width ; }
if ( clip_max . y > fb_height ) { clip_max . y = ( float ) fb_height ; }
2021-11-30 21:48:29 +01:00
if ( clip_max . x < = clip_min . x | | clip_max . y < = clip_min . y )
2021-08-24 17:03:52 +02:00
continue ;
// Apply scissor/clipping rectangle
VkRect2D scissor ;
scissor . offset . x = ( int32_t ) ( clip_min . x ) ;
scissor . offset . y = ( int32_t ) ( clip_min . y ) ;
scissor . extent . width = ( uint32_t ) ( clip_max . x - clip_min . x ) ;
scissor . extent . height = ( uint32_t ) ( clip_max . y - clip_min . y ) ;
vkCmdSetScissor ( command_buffer , 0 , 1 , & scissor ) ;
2022-01-20 15:32:49 +01:00
// Bind DescriptorSet with font or user texture
2024-10-11 15:31:01 +02:00
VkDescriptorSet desc_set [ 1 ] = { ( VkDescriptorSet ) pcmd - > GetTexID ( ) } ;
2022-01-20 15:53:28 +01:00
if ( sizeof ( ImTextureID ) < sizeof ( ImU64 ) )
{
// We don't support texture switches if ImTextureID hasn't been redefined to be 64-bit. Do a flaky check that other textures haven't been used.
2024-10-11 15:31:01 +02:00
IM_ASSERT ( pcmd - > GetTexID ( ) = = ( ImTextureID ) bd - > FontDescriptorSet ) ;
2022-01-20 15:53:28 +01:00
desc_set [ 0 ] = bd - > FontDescriptorSet ;
}
2022-10-11 12:22:29 +02:00
vkCmdBindDescriptorSets ( command_buffer , VK_PIPELINE_BIND_POINT_GRAPHICS , bd - > PipelineLayout , 0 , 1 , desc_set , 0 , nullptr ) ;
2022-01-20 15:32:49 +01:00
2021-08-24 17:03:52 +02:00
// Draw
vkCmdDrawIndexed ( command_buffer , pcmd - > ElemCount , 1 , pcmd - > IdxOffset + global_idx_offset , pcmd - > VtxOffset + global_vtx_offset , 0 ) ;
2016-03-09 16:39:54 +01:00
}
}
2024-10-07 17:52:57 +02:00
global_idx_offset + = draw_list - > IdxBuffer . Size ;
global_vtx_offset + = draw_list - > VtxBuffer . Size ;
2016-03-09 16:39:54 +01:00
}
2024-10-07 21:00:07 +02:00
platform_io . Renderer_RenderState = NULL ;
2021-10-15 12:01:35 +02:00
// Note: at this point both vkCmdSetViewport() and vkCmdSetScissor() have been called.
// Our last values will leak into user/application rendering IF:
// - Your app uses a pipeline with VK_DYNAMIC_STATE_VIEWPORT or VK_DYNAMIC_STATE_SCISSOR dynamic state
2022-09-11 07:35:59 +02:00
// - And you forgot to call vkCmdSetViewport() and vkCmdSetScissor() yourself to explicitly set that state.
2021-10-15 12:01:35 +02:00
// If you use VK_DYNAMIC_STATE_VIEWPORT or VK_DYNAMIC_STATE_SCISSOR you are responsible for setting the values before rendering.
// In theory we should aim to backup/restore those values but I am not sure this is possible.
2021-10-15 12:11:11 +02:00
// We perform a call to vkCmdSetScissor() to set back a full viewport which is likely to fix things for 99% users but technically this is not perfect. (See github #4644)
VkRect2D scissor = { { 0 , 0 } , { ( uint32_t ) fb_width , ( uint32_t ) fb_height } } ;
vkCmdSetScissor ( command_buffer , 0 , 1 , & scissor ) ;
2016-03-09 16:39:54 +01:00
}
2023-11-10 14:35:33 +01:00
bool ImGui_ImplVulkan_CreateFontsTexture ( )
2016-03-09 16:39:54 +01:00
{
ImGuiIO & io = ImGui : : GetIO ( ) ;
2021-06-28 16:52:10 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
2023-11-10 14:35:33 +01:00
VkResult err ;
2016-03-09 16:39:54 +01:00
2023-11-10 14:17:11 +01:00
// Destroy existing texture (if any)
if ( bd - > FontView | | bd - > FontImage | | bd - > FontMemory | | bd - > FontDescriptorSet )
{
vkQueueWaitIdle ( v - > Queue ) ;
ImGui_ImplVulkan_DestroyFontsTexture ( ) ;
}
2023-11-10 14:35:33 +01:00
// Create command pool/buffer
if ( bd - > FontCommandPool = = VK_NULL_HANDLE )
{
VkCommandPoolCreateInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO ;
2024-01-03 14:11:40 +01:00
info . flags = 0 ;
2023-11-10 14:35:33 +01:00
info . queueFamilyIndex = v - > QueueFamily ;
2023-11-29 14:24:25 +01:00
vkCreateCommandPool ( v - > Device , & info , v - > Allocator , & bd - > FontCommandPool ) ;
2023-11-10 14:35:33 +01:00
}
if ( bd - > FontCommandBuffer = = VK_NULL_HANDLE )
{
VkCommandBufferAllocateInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO ;
info . commandPool = bd - > FontCommandPool ;
info . commandBufferCount = 1 ;
err = vkAllocateCommandBuffers ( v - > Device , & info , & bd - > FontCommandBuffer ) ;
check_vk_result ( err ) ;
}
// Start command buffer
{
err = vkResetCommandPool ( v - > Device , bd - > FontCommandPool , 0 ) ;
check_vk_result ( err ) ;
VkCommandBufferBeginInfo begin_info = { } ;
begin_info . sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO ;
begin_info . flags | = VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT ;
err = vkBeginCommandBuffer ( bd - > FontCommandBuffer , & begin_info ) ;
check_vk_result ( err ) ;
}
2016-03-09 16:39:54 +01:00
unsigned char * pixels ;
int width , height ;
io . Fonts - > GetTexDataAsRGBA32 ( & pixels , & width , & height ) ;
2020-06-30 15:31:54 +02:00
size_t upload_size = width * height * 4 * sizeof ( char ) ;
2016-03-09 16:39:54 +01:00
// Create the Image:
{
VkImageCreateInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_IMAGE_CREATE_INFO ;
info . imageType = VK_IMAGE_TYPE_2D ;
info . format = VK_FORMAT_R8G8B8A8_UNORM ;
info . extent . width = width ;
info . extent . height = height ;
info . extent . depth = 1 ;
info . mipLevels = 1 ;
info . arrayLayers = 1 ;
info . samples = VK_SAMPLE_COUNT_1_BIT ;
info . tiling = VK_IMAGE_TILING_OPTIMAL ;
2016-04-03 17:32:53 +02:00
info . usage = VK_IMAGE_USAGE_SAMPLED_BIT | VK_IMAGE_USAGE_TRANSFER_DST_BIT ;
2016-03-09 16:39:54 +01:00
info . sharingMode = VK_SHARING_MODE_EXCLUSIVE ;
info . initialLayout = VK_IMAGE_LAYOUT_UNDEFINED ;
2021-06-28 16:52:10 +02:00
err = vkCreateImage ( v - > Device , & info , v - > Allocator , & bd - > FontImage ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2016-03-09 16:39:54 +01:00
VkMemoryRequirements req ;
2021-06-28 16:52:10 +02:00
vkGetImageMemoryRequirements ( v - > Device , bd - > FontImage , & req ) ;
2016-03-09 16:39:54 +01:00
VkMemoryAllocateInfo alloc_info = { } ;
alloc_info . sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO ;
2024-01-02 17:06:21 +01:00
alloc_info . allocationSize = IM_MAX ( v - > MinAllocationSize , req . size ) ;
2018-02-16 22:50:19 +01:00
alloc_info . memoryTypeIndex = ImGui_ImplVulkan_MemoryType ( VK_MEMORY_PROPERTY_DEVICE_LOCAL_BIT , req . memoryTypeBits ) ;
2021-06-28 16:52:10 +02:00
err = vkAllocateMemory ( v - > Device , & alloc_info , v - > Allocator , & bd - > FontMemory ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2021-06-28 16:52:10 +02:00
err = vkBindImageMemory ( v - > Device , bd - > FontImage , bd - > FontMemory , 0 ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2016-03-09 16:39:54 +01:00
}
2016-04-03 17:32:53 +02:00
2016-03-09 16:39:54 +01:00
// Create the Image View:
{
VkImageViewCreateInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO ;
2021-06-28 16:52:10 +02:00
info . image = bd - > FontImage ;
2016-03-09 16:39:54 +01:00
info . viewType = VK_IMAGE_VIEW_TYPE_2D ;
info . format = VK_FORMAT_R8G8B8A8_UNORM ;
info . subresourceRange . aspectMask = VK_IMAGE_ASPECT_COLOR_BIT ;
info . subresourceRange . levelCount = 1 ;
info . subresourceRange . layerCount = 1 ;
2021-06-28 16:52:10 +02:00
err = vkCreateImageView ( v - > Device , & info , v - > Allocator , & bd - > FontView ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2016-03-09 16:39:54 +01:00
}
2016-04-03 17:32:53 +02:00
2022-01-20 15:32:49 +01:00
// Create the Descriptor Set:
bd - > FontDescriptorSet = ( VkDescriptorSet ) ImGui_ImplVulkan_AddTexture ( bd - > FontSampler , bd - > FontView , VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL ) ;
2016-04-03 17:32:53 +02:00
2016-03-09 16:39:54 +01:00
// Create the Upload Buffer:
2023-11-10 14:35:33 +01:00
VkDeviceMemory upload_buffer_memory ;
VkBuffer upload_buffer ;
2016-03-09 16:39:54 +01:00
{
VkBufferCreateInfo buffer_info = { } ;
buffer_info . sType = VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO ;
buffer_info . size = upload_size ;
buffer_info . usage = VK_BUFFER_USAGE_TRANSFER_SRC_BIT ;
buffer_info . sharingMode = VK_SHARING_MODE_EXCLUSIVE ;
2023-11-10 14:35:33 +01:00
err = vkCreateBuffer ( v - > Device , & buffer_info , v - > Allocator , & upload_buffer ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2016-03-09 16:39:54 +01:00
VkMemoryRequirements req ;
2023-11-10 14:35:33 +01:00
vkGetBufferMemoryRequirements ( v - > Device , upload_buffer , & req ) ;
2021-06-28 16:52:10 +02:00
bd - > BufferMemoryAlignment = ( bd - > BufferMemoryAlignment > req . alignment ) ? bd - > BufferMemoryAlignment : req . alignment ;
2016-03-09 16:39:54 +01:00
VkMemoryAllocateInfo alloc_info = { } ;
alloc_info . sType = VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO ;
2024-01-02 17:06:21 +01:00
alloc_info . allocationSize = IM_MAX ( v - > MinAllocationSize , req . size ) ;
2018-02-16 22:50:19 +01:00
alloc_info . memoryTypeIndex = ImGui_ImplVulkan_MemoryType ( VK_MEMORY_PROPERTY_HOST_VISIBLE_BIT , req . memoryTypeBits ) ;
2023-11-10 14:35:33 +01:00
err = vkAllocateMemory ( v - > Device , & alloc_info , v - > Allocator , & upload_buffer_memory ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2023-11-10 14:35:33 +01:00
err = vkBindBufferMemory ( v - > Device , upload_buffer , upload_buffer_memory , 0 ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2016-03-09 16:39:54 +01:00
}
2016-04-03 17:32:53 +02:00
2016-03-09 16:39:54 +01:00
// Upload to Buffer:
{
2022-10-11 12:22:29 +02:00
char * map = nullptr ;
2023-11-10 14:35:33 +01:00
err = vkMapMemory ( v - > Device , upload_buffer_memory , 0 , upload_size , 0 , ( void * * ) ( & map ) ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2016-03-09 16:39:54 +01:00
memcpy ( map , pixels , upload_size ) ;
VkMappedMemoryRange range [ 1 ] = { } ;
range [ 0 ] . sType = VK_STRUCTURE_TYPE_MAPPED_MEMORY_RANGE ;
2023-11-10 14:35:33 +01:00
range [ 0 ] . memory = upload_buffer_memory ;
2016-03-09 16:39:54 +01:00
range [ 0 ] . size = upload_size ;
2019-04-04 22:36:12 +02:00
err = vkFlushMappedMemoryRanges ( v - > Device , 1 , range ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2023-11-10 14:35:33 +01:00
vkUnmapMemory ( v - > Device , upload_buffer_memory ) ;
2016-03-09 16:39:54 +01:00
}
2018-02-18 21:15:51 +01:00
2016-03-10 12:30:38 +01:00
// Copy to Image:
2016-03-09 16:39:54 +01:00
{
2016-03-10 12:30:38 +01:00
VkImageMemoryBarrier copy_barrier [ 1 ] = { } ;
copy_barrier [ 0 ] . sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER ;
copy_barrier [ 0 ] . dstAccessMask = VK_ACCESS_TRANSFER_WRITE_BIT ;
copy_barrier [ 0 ] . oldLayout = VK_IMAGE_LAYOUT_UNDEFINED ;
copy_barrier [ 0 ] . newLayout = VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL ;
copy_barrier [ 0 ] . srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED ;
copy_barrier [ 0 ] . dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED ;
2021-06-28 16:52:10 +02:00
copy_barrier [ 0 ] . image = bd - > FontImage ;
2016-03-10 12:30:38 +01:00
copy_barrier [ 0 ] . subresourceRange . aspectMask = VK_IMAGE_ASPECT_COLOR_BIT ;
copy_barrier [ 0 ] . subresourceRange . levelCount = 1 ;
copy_barrier [ 0 ] . subresourceRange . layerCount = 1 ;
2023-11-10 14:35:33 +01:00
vkCmdPipelineBarrier ( bd - > FontCommandBuffer , VK_PIPELINE_STAGE_HOST_BIT , VK_PIPELINE_STAGE_TRANSFER_BIT , 0 , 0 , nullptr , 0 , nullptr , 1 , copy_barrier ) ;
2016-04-03 17:32:53 +02:00
2016-03-09 16:39:54 +01:00
VkBufferImageCopy region = { } ;
region . imageSubresource . aspectMask = VK_IMAGE_ASPECT_COLOR_BIT ;
region . imageSubresource . layerCount = 1 ;
region . imageExtent . width = width ;
region . imageExtent . height = height ;
2017-03-26 19:38:05 +02:00
region . imageExtent . depth = 1 ;
2023-11-10 14:35:33 +01:00
vkCmdCopyBufferToImage ( bd - > FontCommandBuffer , upload_buffer , bd - > FontImage , VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL , 1 , & region ) ;
2016-04-03 17:32:53 +02:00
2016-03-10 12:30:38 +01:00
VkImageMemoryBarrier use_barrier [ 1 ] = { } ;
use_barrier [ 0 ] . sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER ;
use_barrier [ 0 ] . srcAccessMask = VK_ACCESS_TRANSFER_WRITE_BIT ;
use_barrier [ 0 ] . dstAccessMask = VK_ACCESS_SHADER_READ_BIT ;
use_barrier [ 0 ] . oldLayout = VK_IMAGE_LAYOUT_TRANSFER_DST_OPTIMAL ;
use_barrier [ 0 ] . newLayout = VK_IMAGE_LAYOUT_SHADER_READ_ONLY_OPTIMAL ;
use_barrier [ 0 ] . srcQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED ;
use_barrier [ 0 ] . dstQueueFamilyIndex = VK_QUEUE_FAMILY_IGNORED ;
2021-06-28 16:52:10 +02:00
use_barrier [ 0 ] . image = bd - > FontImage ;
2016-03-10 12:30:38 +01:00
use_barrier [ 0 ] . subresourceRange . aspectMask = VK_IMAGE_ASPECT_COLOR_BIT ;
use_barrier [ 0 ] . subresourceRange . levelCount = 1 ;
use_barrier [ 0 ] . subresourceRange . layerCount = 1 ;
2023-11-10 14:35:33 +01:00
vkCmdPipelineBarrier ( bd - > FontCommandBuffer , VK_PIPELINE_STAGE_TRANSFER_BIT , VK_PIPELINE_STAGE_FRAGMENT_SHADER_BIT , 0 , 0 , nullptr , 0 , nullptr , 1 , use_barrier ) ;
2016-03-09 16:39:54 +01:00
}
2016-04-03 17:32:53 +02:00
// Store our identifier
2022-01-20 16:56:29 +01:00
io . Fonts - > SetTexID ( ( ImTextureID ) bd - > FontDescriptorSet ) ;
2016-03-09 16:39:54 +01:00
2023-11-10 14:35:33 +01:00
// End command buffer
VkSubmitInfo end_info = { } ;
end_info . sType = VK_STRUCTURE_TYPE_SUBMIT_INFO ;
end_info . commandBufferCount = 1 ;
end_info . pCommandBuffers = & bd - > FontCommandBuffer ;
err = vkEndCommandBuffer ( bd - > FontCommandBuffer ) ;
check_vk_result ( err ) ;
err = vkQueueSubmit ( v - > Queue , 1 , & end_info , VK_NULL_HANDLE ) ;
check_vk_result ( err ) ;
2023-12-19 18:25:02 +01:00
err = vkQueueWaitIdle ( v - > Queue ) ;
2023-11-10 14:35:33 +01:00
check_vk_result ( err ) ;
vkDestroyBuffer ( v - > Device , upload_buffer , v - > Allocator ) ;
vkFreeMemory ( v - > Device , upload_buffer_memory , v - > Allocator ) ;
2016-03-09 16:39:54 +01:00
return true ;
}
2023-11-10 14:35:33 +01:00
// You probably never need to call this, as it is called by ImGui_ImplVulkan_CreateFontsTexture() and ImGui_ImplVulkan_Shutdown().
2023-11-10 14:17:11 +01:00
void ImGui_ImplVulkan_DestroyFontsTexture ( )
{
ImGuiIO & io = ImGui : : GetIO ( ) ;
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
if ( bd - > FontDescriptorSet )
{
ImGui_ImplVulkan_RemoveTexture ( bd - > FontDescriptorSet ) ;
bd - > FontDescriptorSet = VK_NULL_HANDLE ;
io . Fonts - > SetTexID ( 0 ) ;
}
if ( bd - > FontView ) { vkDestroyImageView ( v - > Device , bd - > FontView , v - > Allocator ) ; bd - > FontView = VK_NULL_HANDLE ; }
if ( bd - > FontImage ) { vkDestroyImage ( v - > Device , bd - > FontImage , v - > Allocator ) ; bd - > FontImage = VK_NULL_HANDLE ; }
if ( bd - > FontMemory ) { vkFreeMemory ( v - > Device , bd - > FontMemory , v - > Allocator ) ; bd - > FontMemory = VK_NULL_HANDLE ; }
}
2020-09-08 16:47:06 +02:00
static void ImGui_ImplVulkan_CreateShaderModules ( VkDevice device , const VkAllocationCallbacks * allocator )
2016-03-09 16:39:54 +01:00
{
2020-09-08 16:47:06 +02:00
// Create the shader modules
2021-06-28 16:52:10 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
2021-08-24 21:53:54 +02:00
if ( bd - > ShaderModuleVert = = VK_NULL_HANDLE )
2016-03-09 16:39:54 +01:00
{
VkShaderModuleCreateInfo vert_info = { } ;
vert_info . sType = VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO ;
2016-10-18 22:40:58 +02:00
vert_info . codeSize = sizeof ( __glsl_shader_vert_spv ) ;
2016-03-09 16:39:54 +01:00
vert_info . pCode = ( uint32_t * ) __glsl_shader_vert_spv ;
2021-06-28 16:52:10 +02:00
VkResult err = vkCreateShaderModule ( device , & vert_info , allocator , & bd - > ShaderModuleVert ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2020-09-08 16:47:06 +02:00
}
2021-08-24 21:53:54 +02:00
if ( bd - > ShaderModuleFrag = = VK_NULL_HANDLE )
2020-09-08 16:47:06 +02:00
{
2016-03-09 16:39:54 +01:00
VkShaderModuleCreateInfo frag_info = { } ;
frag_info . sType = VK_STRUCTURE_TYPE_SHADER_MODULE_CREATE_INFO ;
2016-10-18 22:40:58 +02:00
frag_info . codeSize = sizeof ( __glsl_shader_frag_spv ) ;
2016-03-09 16:39:54 +01:00
frag_info . pCode = ( uint32_t * ) __glsl_shader_frag_spv ;
2021-06-28 16:52:10 +02:00
VkResult err = vkCreateShaderModule ( device , & frag_info , allocator , & bd - > ShaderModuleFrag ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2016-03-09 16:39:54 +01:00
}
2020-09-08 16:47:06 +02:00
}
2016-04-03 17:32:53 +02:00
2020-11-07 16:32:48 +01:00
static void ImGui_ImplVulkan_CreatePipeline ( VkDevice device , const VkAllocationCallbacks * allocator , VkPipelineCache pipelineCache , VkRenderPass renderPass , VkSampleCountFlagBits MSAASamples , VkPipeline * pipeline , uint32_t subpass )
2020-09-08 16:47:06 +02:00
{
2021-06-28 16:52:10 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
2020-09-08 16:47:06 +02:00
ImGui_ImplVulkan_CreateShaderModules ( device , allocator ) ;
2016-03-09 16:39:54 +01:00
VkPipelineShaderStageCreateInfo stage [ 2 ] = { } ;
stage [ 0 ] . sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO ;
stage [ 0 ] . stage = VK_SHADER_STAGE_VERTEX_BIT ;
2021-06-28 16:52:10 +02:00
stage [ 0 ] . module = bd - > ShaderModuleVert ;
2016-03-09 16:39:54 +01:00
stage [ 0 ] . pName = " main " ;
stage [ 1 ] . sType = VK_STRUCTURE_TYPE_PIPELINE_SHADER_STAGE_CREATE_INFO ;
stage [ 1 ] . stage = VK_SHADER_STAGE_FRAGMENT_BIT ;
2021-06-28 16:52:10 +02:00
stage [ 1 ] . module = bd - > ShaderModuleFrag ;
2016-03-09 16:39:54 +01:00
stage [ 1 ] . pName = " main " ;
VkVertexInputBindingDescription binding_desc [ 1 ] = { } ;
binding_desc [ 0 ] . stride = sizeof ( ImDrawVert ) ;
binding_desc [ 0 ] . inputRate = VK_VERTEX_INPUT_RATE_VERTEX ;
VkVertexInputAttributeDescription attribute_desc [ 3 ] = { } ;
attribute_desc [ 0 ] . location = 0 ;
attribute_desc [ 0 ] . binding = binding_desc [ 0 ] . binding ;
attribute_desc [ 0 ] . format = VK_FORMAT_R32G32_SFLOAT ;
2023-11-09 16:44:39 +01:00
attribute_desc [ 0 ] . offset = offsetof ( ImDrawVert , pos ) ;
2016-03-09 16:39:54 +01:00
attribute_desc [ 1 ] . location = 1 ;
attribute_desc [ 1 ] . binding = binding_desc [ 0 ] . binding ;
attribute_desc [ 1 ] . format = VK_FORMAT_R32G32_SFLOAT ;
2023-11-09 16:44:39 +01:00
attribute_desc [ 1 ] . offset = offsetof ( ImDrawVert , uv ) ;
2016-03-09 16:39:54 +01:00
attribute_desc [ 2 ] . location = 2 ;
attribute_desc [ 2 ] . binding = binding_desc [ 0 ] . binding ;
attribute_desc [ 2 ] . format = VK_FORMAT_R8G8B8A8_UNORM ;
2023-11-09 16:44:39 +01:00
attribute_desc [ 2 ] . offset = offsetof ( ImDrawVert , col ) ;
2016-03-09 16:39:54 +01:00
VkPipelineVertexInputStateCreateInfo vertex_info = { } ;
vertex_info . sType = VK_STRUCTURE_TYPE_PIPELINE_VERTEX_INPUT_STATE_CREATE_INFO ;
vertex_info . vertexBindingDescriptionCount = 1 ;
vertex_info . pVertexBindingDescriptions = binding_desc ;
vertex_info . vertexAttributeDescriptionCount = 3 ;
vertex_info . pVertexAttributeDescriptions = attribute_desc ;
VkPipelineInputAssemblyStateCreateInfo ia_info = { } ;
ia_info . sType = VK_STRUCTURE_TYPE_PIPELINE_INPUT_ASSEMBLY_STATE_CREATE_INFO ;
ia_info . topology = VK_PRIMITIVE_TOPOLOGY_TRIANGLE_LIST ;
VkPipelineViewportStateCreateInfo viewport_info = { } ;
viewport_info . sType = VK_STRUCTURE_TYPE_PIPELINE_VIEWPORT_STATE_CREATE_INFO ;
viewport_info . viewportCount = 1 ;
viewport_info . scissorCount = 1 ;
VkPipelineRasterizationStateCreateInfo raster_info = { } ;
raster_info . sType = VK_STRUCTURE_TYPE_PIPELINE_RASTERIZATION_STATE_CREATE_INFO ;
raster_info . polygonMode = VK_POLYGON_MODE_FILL ;
raster_info . cullMode = VK_CULL_MODE_NONE ;
raster_info . frontFace = VK_FRONT_FACE_COUNTER_CLOCKWISE ;
2016-08-27 19:08:24 +02:00
raster_info . lineWidth = 1.0f ;
2016-03-09 16:39:54 +01:00
VkPipelineMultisampleStateCreateInfo ms_info = { } ;
ms_info . sType = VK_STRUCTURE_TYPE_PIPELINE_MULTISAMPLE_STATE_CREATE_INFO ;
2020-09-08 16:47:06 +02:00
ms_info . rasterizationSamples = ( MSAASamples ! = 0 ) ? MSAASamples : VK_SAMPLE_COUNT_1_BIT ;
2016-03-09 16:39:54 +01:00
VkPipelineColorBlendAttachmentState color_attachment [ 1 ] = { } ;
color_attachment [ 0 ] . blendEnable = VK_TRUE ;
color_attachment [ 0 ] . srcColorBlendFactor = VK_BLEND_FACTOR_SRC_ALPHA ;
color_attachment [ 0 ] . dstColorBlendFactor = VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA ;
color_attachment [ 0 ] . colorBlendOp = VK_BLEND_OP_ADD ;
2021-02-17 19:29:07 +01:00
color_attachment [ 0 ] . srcAlphaBlendFactor = VK_BLEND_FACTOR_ONE ;
color_attachment [ 0 ] . dstAlphaBlendFactor = VK_BLEND_FACTOR_ONE_MINUS_SRC_ALPHA ;
2016-03-09 16:39:54 +01:00
color_attachment [ 0 ] . alphaBlendOp = VK_BLEND_OP_ADD ;
2016-04-03 17:32:53 +02:00
color_attachment [ 0 ] . colorWriteMask = VK_COLOR_COMPONENT_R_BIT | VK_COLOR_COMPONENT_G_BIT | VK_COLOR_COMPONENT_B_BIT | VK_COLOR_COMPONENT_A_BIT ;
2016-03-09 16:39:54 +01:00
2016-08-27 19:08:24 +02:00
VkPipelineDepthStencilStateCreateInfo depth_info = { } ;
depth_info . sType = VK_STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO ;
2016-03-09 16:39:54 +01:00
VkPipelineColorBlendStateCreateInfo blend_info = { } ;
blend_info . sType = VK_STRUCTURE_TYPE_PIPELINE_COLOR_BLEND_STATE_CREATE_INFO ;
blend_info . attachmentCount = 1 ;
blend_info . pAttachments = color_attachment ;
2016-04-03 17:32:53 +02:00
VkDynamicState dynamic_states [ 2 ] = { VK_DYNAMIC_STATE_VIEWPORT , VK_DYNAMIC_STATE_SCISSOR } ;
2016-03-09 16:39:54 +01:00
VkPipelineDynamicStateCreateInfo dynamic_state = { } ;
2016-08-20 13:27:03 +02:00
dynamic_state . sType = VK_STRUCTURE_TYPE_PIPELINE_DYNAMIC_STATE_CREATE_INFO ;
2018-03-12 17:37:28 +01:00
dynamic_state . dynamicStateCount = ( uint32_t ) IM_ARRAYSIZE ( dynamic_states ) ;
2016-03-09 16:39:54 +01:00
dynamic_state . pDynamicStates = dynamic_states ;
VkGraphicsPipelineCreateInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_GRAPHICS_PIPELINE_CREATE_INFO ;
2021-06-28 16:52:10 +02:00
info . flags = bd - > PipelineCreateFlags ;
2016-03-09 16:39:54 +01:00
info . stageCount = 2 ;
info . pStages = stage ;
info . pVertexInputState = & vertex_info ;
info . pInputAssemblyState = & ia_info ;
info . pViewportState = & viewport_info ;
info . pRasterizationState = & raster_info ;
info . pMultisampleState = & ms_info ;
2016-08-27 19:08:24 +02:00
info . pDepthStencilState = & depth_info ;
2016-03-09 16:39:54 +01:00
info . pColorBlendState = & blend_info ;
info . pDynamicState = & dynamic_state ;
2021-06-28 16:52:10 +02:00
info . layout = bd - > PipelineLayout ;
2020-09-08 16:47:06 +02:00
info . renderPass = renderPass ;
2020-11-07 16:32:48 +01:00
info . subpass = subpass ;
2022-02-19 20:15:58 +01:00
2023-07-03 17:48:28 +02:00
# ifdef IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
if ( bd - > VulkanInitInfo . UseDynamicRendering )
{
2024-02-12 17:18:52 +01:00
IM_ASSERT ( bd - > VulkanInitInfo . PipelineRenderingCreateInfo . sType = = VK_STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO_KHR & & " PipelineRenderingCreateInfo sType must be VK_STRUCTURE_TYPE_PIPELINE_RENDERING_CREATE_INFO_KHR " ) ;
IM_ASSERT ( bd - > VulkanInitInfo . PipelineRenderingCreateInfo . pNext = = nullptr & & " PipelineRenderingCreateInfo pNext must be NULL " ) ;
2023-12-23 20:01:48 +01:00
info . pNext = & bd - > VulkanInitInfo . PipelineRenderingCreateInfo ;
2022-02-19 20:15:58 +01:00
info . renderPass = VK_NULL_HANDLE ; // Just make sure it's actually nullptr.
}
# endif
2020-09-08 16:47:06 +02:00
VkResult err = vkCreateGraphicsPipelines ( device , pipelineCache , 1 , & info , allocator , pipeline ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2020-09-08 16:47:06 +02:00
}
bool ImGui_ImplVulkan_CreateDeviceObjects ( )
{
2021-06-28 16:52:10 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
2020-09-08 16:47:06 +02:00
VkResult err ;
2021-06-28 16:52:10 +02:00
if ( ! bd - > FontSampler )
2020-09-08 16:47:06 +02:00
{
2022-12-16 16:46:14 +01:00
// Bilinear sampling is required by default. Set 'io.Fonts->Flags |= ImFontAtlasFlags_NoBakedLines' or 'style.AntiAliasedLinesUseTex = false' to allow point/nearest sampling.
2020-09-08 16:47:06 +02:00
VkSamplerCreateInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_SAMPLER_CREATE_INFO ;
info . magFilter = VK_FILTER_LINEAR ;
info . minFilter = VK_FILTER_LINEAR ;
info . mipmapMode = VK_SAMPLER_MIPMAP_MODE_LINEAR ;
2024-10-07 22:02:55 +02:00
info . addressModeU = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE ;
info . addressModeV = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE ;
info . addressModeW = VK_SAMPLER_ADDRESS_MODE_CLAMP_TO_EDGE ;
2020-09-08 16:47:06 +02:00
info . minLod = - 1000 ;
info . maxLod = 1000 ;
info . maxAnisotropy = 1.0f ;
2021-06-28 16:52:10 +02:00
err = vkCreateSampler ( v - > Device , & info , v - > Allocator , & bd - > FontSampler ) ;
2020-09-08 16:47:06 +02:00
check_vk_result ( err ) ;
}
2021-06-28 16:52:10 +02:00
if ( ! bd - > DescriptorSetLayout )
2020-09-08 16:47:06 +02:00
{
VkDescriptorSetLayoutBinding binding [ 1 ] = { } ;
binding [ 0 ] . descriptorType = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER ;
binding [ 0 ] . descriptorCount = 1 ;
binding [ 0 ] . stageFlags = VK_SHADER_STAGE_FRAGMENT_BIT ;
VkDescriptorSetLayoutCreateInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_LAYOUT_CREATE_INFO ;
info . bindingCount = 1 ;
info . pBindings = binding ;
2021-06-28 16:52:10 +02:00
err = vkCreateDescriptorSetLayout ( v - > Device , & info , v - > Allocator , & bd - > DescriptorSetLayout ) ;
2020-09-08 16:47:06 +02:00
check_vk_result ( err ) ;
}
2021-06-28 16:52:10 +02:00
if ( ! bd - > PipelineLayout )
2020-09-08 16:47:06 +02:00
{
// Constants: we are using 'vec2 offset' and 'vec2 scale' instead of a full 3d projection matrix
VkPushConstantRange push_constants [ 1 ] = { } ;
push_constants [ 0 ] . stageFlags = VK_SHADER_STAGE_VERTEX_BIT ;
push_constants [ 0 ] . offset = sizeof ( float ) * 0 ;
push_constants [ 0 ] . size = sizeof ( float ) * 4 ;
2021-06-28 16:52:10 +02:00
VkDescriptorSetLayout set_layout [ 1 ] = { bd - > DescriptorSetLayout } ;
2020-09-08 16:47:06 +02:00
VkPipelineLayoutCreateInfo layout_info = { } ;
layout_info . sType = VK_STRUCTURE_TYPE_PIPELINE_LAYOUT_CREATE_INFO ;
layout_info . setLayoutCount = 1 ;
layout_info . pSetLayouts = set_layout ;
layout_info . pushConstantRangeCount = 1 ;
layout_info . pPushConstantRanges = push_constants ;
2021-06-28 16:52:10 +02:00
err = vkCreatePipelineLayout ( v - > Device , & layout_info , v - > Allocator , & bd - > PipelineLayout ) ;
2020-09-08 16:47:06 +02:00
check_vk_result ( err ) ;
}
2024-02-12 20:51:24 +01:00
ImGui_ImplVulkan_CreatePipeline ( v - > Device , v - > Allocator , v - > PipelineCache , v - > RenderPass , v - > MSAASamples , & bd - > Pipeline , v - > Subpass ) ;
2016-03-09 16:39:54 +01:00
return true ;
}
2019-04-03 19:21:06 +02:00
void ImGui_ImplVulkan_DestroyDeviceObjects ( )
2016-03-09 16:39:54 +01:00
{
2021-06-28 16:52:10 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
2019-04-05 18:52:40 +02:00
ImGui_ImplVulkanH_DestroyAllViewportsRenderBuffers ( v - > Device , v - > Allocator ) ;
2023-11-10 14:17:11 +01:00
ImGui_ImplVulkan_DestroyFontsTexture ( ) ;
2019-04-05 17:48:47 +02:00
2023-12-19 10:51:11 +01:00
if ( bd - > FontCommandBuffer ) { vkFreeCommandBuffers ( v - > Device , bd - > FontCommandPool , 1 , & bd - > FontCommandBuffer ) ; bd - > FontCommandBuffer = VK_NULL_HANDLE ; }
2023-11-10 14:35:33 +01:00
if ( bd - > FontCommandPool ) { vkDestroyCommandPool ( v - > Device , bd - > FontCommandPool , v - > Allocator ) ; bd - > FontCommandPool = VK_NULL_HANDLE ; }
2021-06-28 16:52:10 +02:00
if ( bd - > ShaderModuleVert ) { vkDestroyShaderModule ( v - > Device , bd - > ShaderModuleVert , v - > Allocator ) ; bd - > ShaderModuleVert = VK_NULL_HANDLE ; }
if ( bd - > ShaderModuleFrag ) { vkDestroyShaderModule ( v - > Device , bd - > ShaderModuleFrag , v - > Allocator ) ; bd - > ShaderModuleFrag = VK_NULL_HANDLE ; }
if ( bd - > FontSampler ) { vkDestroySampler ( v - > Device , bd - > FontSampler , v - > Allocator ) ; bd - > FontSampler = VK_NULL_HANDLE ; }
if ( bd - > DescriptorSetLayout ) { vkDestroyDescriptorSetLayout ( v - > Device , bd - > DescriptorSetLayout , v - > Allocator ) ; bd - > DescriptorSetLayout = VK_NULL_HANDLE ; }
if ( bd - > PipelineLayout ) { vkDestroyPipelineLayout ( v - > Device , bd - > PipelineLayout , v - > Allocator ) ; bd - > PipelineLayout = VK_NULL_HANDLE ; }
if ( bd - > Pipeline ) { vkDestroyPipeline ( v - > Device , bd - > Pipeline , v - > Allocator ) ; bd - > Pipeline = VK_NULL_HANDLE ; }
2023-04-12 21:56:35 +02:00
if ( bd - > PipelineForViewports ) { vkDestroyPipeline ( v - > Device , bd - > PipelineForViewports , v - > Allocator ) ; bd - > PipelineForViewports = VK_NULL_HANDLE ; }
2016-03-09 16:39:54 +01:00
}
2021-01-27 13:23:28 +01:00
bool ImGui_ImplVulkan_LoadFunctions ( PFN_vkVoidFunction ( * loader_func ) ( const char * function_name , void * user_data ) , void * user_data )
2018-02-20 14:09:46 +01:00
{
2021-01-27 13:23:28 +01:00
// Load function pointers
// You can use the default Vulkan loader using:
// ImGui_ImplVulkan_LoadFunctions([](const char* function_name, void*) { return vkGetInstanceProcAddr(your_vk_isntance, function_name); });
2024-04-19 15:16:54 +02:00
// But this would be roughly equivalent to not setting VK_NO_PROTOTYPES.
# ifdef IMGUI_IMPL_VULKAN_USE_LOADER
2021-01-27 13:23:28 +01:00
# define IMGUI_VULKAN_FUNC_LOAD(func) \
func = reinterpret_cast < decltype ( func ) > ( loader_func ( # func , user_data ) ) ; \
2022-10-11 12:22:29 +02:00
if ( func = = nullptr ) \
2021-01-27 13:23:28 +01:00
return false ;
IMGUI_VULKAN_FUNC_MAP ( IMGUI_VULKAN_FUNC_LOAD )
# undef IMGUI_VULKAN_FUNC_LOAD
2022-02-19 20:15:58 +01:00
2023-07-03 17:48:28 +02:00
# ifdef IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
// Manually load those two (see #5446)
ImGuiImplVulkanFuncs_vkCmdBeginRenderingKHR = reinterpret_cast < PFN_vkCmdBeginRenderingKHR > ( loader_func ( " vkCmdBeginRenderingKHR " , user_data ) ) ;
ImGuiImplVulkanFuncs_vkCmdEndRenderingKHR = reinterpret_cast < PFN_vkCmdEndRenderingKHR > ( loader_func ( " vkCmdEndRenderingKHR " , user_data ) ) ;
2022-02-19 20:15:58 +01:00
# endif
2021-01-27 13:23:28 +01:00
# else
IM_UNUSED ( loader_func ) ;
IM_UNUSED ( user_data ) ;
2021-01-26 18:34:12 +01:00
# endif
2022-02-19 20:15:58 +01:00
2021-01-27 13:23:28 +01:00
g_FunctionsLoaded = true ;
return true ;
}
2024-02-12 20:51:24 +01:00
bool ImGui_ImplVulkan_Init ( ImGui_ImplVulkan_InitInfo * info )
2016-03-09 16:39:54 +01:00
{
2021-01-27 13:23:28 +01:00
IM_ASSERT ( g_FunctionsLoaded & & " Need to call ImGui_ImplVulkan_LoadFunctions() if IMGUI_IMPL_VULKAN_NO_PROTOTYPES or VK_NO_PROTOTYPES are set! " ) ;
2021-01-26 18:34:12 +01:00
2023-07-03 17:48:28 +02:00
if ( info - > UseDynamicRendering )
{
# ifdef IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
2024-04-19 15:16:54 +02:00
# ifndef IMGUI_IMPL_VULKAN_USE_LOADER
2023-07-03 17:48:28 +02:00
ImGuiImplVulkanFuncs_vkCmdBeginRenderingKHR = reinterpret_cast < PFN_vkCmdBeginRenderingKHR > ( vkGetInstanceProcAddr ( info - > Instance , " vkCmdBeginRenderingKHR " ) ) ;
ImGuiImplVulkanFuncs_vkCmdEndRenderingKHR = reinterpret_cast < PFN_vkCmdEndRenderingKHR > ( vkGetInstanceProcAddr ( info - > Instance , " vkCmdEndRenderingKHR " ) ) ;
2022-02-19 20:15:58 +01:00
# endif
2023-07-03 17:48:28 +02:00
IM_ASSERT ( ImGuiImplVulkanFuncs_vkCmdBeginRenderingKHR ! = nullptr ) ;
IM_ASSERT ( ImGuiImplVulkanFuncs_vkCmdEndRenderingKHR ! = nullptr ) ;
2022-02-19 20:15:58 +01:00
# else
2023-07-03 17:48:28 +02:00
IM_ASSERT ( 0 & & " Can't use dynamic rendering when neither VK_VERSION_1_3 or VK_KHR_dynamic_rendering is defined. " ) ;
2022-02-19 20:15:58 +01:00
# endif
}
2018-11-30 18:18:15 +01:00
ImGuiIO & io = ImGui : : GetIO ( ) ;
2024-05-13 15:07:13 +02:00
IMGUI_CHECKVERSION ( ) ;
2022-10-11 12:22:29 +02:00
IM_ASSERT ( io . BackendRendererUserData = = nullptr & & " Already initialized a renderer backend! " ) ;
2021-06-28 16:52:10 +02:00
// Setup backend capabilities flags
2021-06-30 15:22:15 +02:00
ImGui_ImplVulkan_Data * bd = IM_NEW ( ImGui_ImplVulkan_Data ) ( ) ;
2021-06-28 16:52:10 +02:00
io . BackendRendererUserData = ( void * ) bd ;
2018-11-30 18:18:15 +01:00
io . BackendRendererName = " imgui_impl_vulkan " ;
2019-05-29 16:29:17 +02:00
io . BackendFlags | = ImGuiBackendFlags_RendererHasVtxOffset ; // We can honor the ImDrawCmd::VtxOffset field, allowing for large meshes.
2019-06-06 16:16:18 +02:00
io . BackendFlags | = ImGuiBackendFlags_RendererHasViewports ; // We can create multi-viewports on the Renderer side (optional)
2018-11-30 18:18:15 +01:00
2018-08-28 18:22:36 +02:00
IM_ASSERT ( info - > Instance ! = VK_NULL_HANDLE ) ;
IM_ASSERT ( info - > PhysicalDevice ! = VK_NULL_HANDLE ) ;
IM_ASSERT ( info - > Device ! = VK_NULL_HANDLE ) ;
IM_ASSERT ( info - > Queue ! = VK_NULL_HANDLE ) ;
IM_ASSERT ( info - > DescriptorPool ! = VK_NULL_HANDLE ) ;
2019-04-04 23:11:15 +02:00
IM_ASSERT ( info - > MinImageCount > = 2 ) ;
2019-04-05 17:22:24 +02:00
IM_ASSERT ( info - > ImageCount > = info - > MinImageCount ) ;
2023-07-03 17:48:28 +02:00
if ( info - > UseDynamicRendering = = false )
2024-02-12 20:51:24 +01:00
IM_ASSERT ( info - > RenderPass ! = VK_NULL_HANDLE ) ;
2018-03-02 23:59:21 +01:00
2021-06-28 16:52:10 +02:00
bd - > VulkanInitInfo = * info ;
2020-11-07 16:32:48 +01:00
2018-02-16 22:50:19 +01:00
ImGui_ImplVulkan_CreateDeviceObjects ( ) ;
2018-03-20 22:14:34 +01:00
2019-04-05 18:52:40 +02:00
// Our render function expect RendererUserData to be storing the window render buffer we need (for the main viewport we won't use ->Window)
ImGuiViewport * main_viewport = ImGui : : GetMainViewport ( ) ;
2021-06-29 15:34:54 +02:00
main_viewport - > RendererUserData = IM_NEW ( ImGui_ImplVulkan_ViewportData ) ( ) ;
2019-04-05 18:52:40 +02:00
2024-10-08 20:47:24 +02:00
ImGui_ImplVulkan_InitMultiViewportSupport ( ) ;
2018-03-02 19:23:01 +01:00
2016-03-09 16:39:54 +01:00
return true ;
}
2018-02-16 22:50:19 +01:00
void ImGui_ImplVulkan_Shutdown ( )
2016-03-09 16:39:54 +01:00
{
2021-06-30 15:22:15 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
2022-10-11 12:22:29 +02:00
IM_ASSERT ( bd ! = nullptr & & " No renderer backend to shutdown, or already shutdown? " ) ;
2021-09-20 18:43:05 +02:00
ImGuiIO & io = ImGui : : GetIO ( ) ;
2021-06-30 15:22:15 +02:00
2019-07-30 00:52:30 +02:00
// First destroy objects in all viewports
2019-04-03 19:21:06 +02:00
ImGui_ImplVulkan_DestroyDeviceObjects ( ) ;
2019-07-30 00:52:30 +02:00
// Manually delete main viewport render data in-case we haven't initialized for viewports
ImGuiViewport * main_viewport = ImGui : : GetMainViewport ( ) ;
2021-06-29 15:34:54 +02:00
if ( ImGui_ImplVulkan_ViewportData * vd = ( ImGui_ImplVulkan_ViewportData * ) main_viewport - > RendererUserData )
IM_DELETE ( vd ) ;
2022-10-11 15:59:23 +02:00
main_viewport - > RendererUserData = nullptr ;
2019-07-30 00:52:30 +02:00
// Clean up windows
2024-10-08 20:47:24 +02:00
ImGui_ImplVulkan_ShutdownMultiViewportSupport ( ) ;
2021-06-29 14:53:25 +02:00
2022-10-11 12:22:29 +02:00
io . BackendRendererName = nullptr ;
io . BackendRendererUserData = nullptr ;
2023-04-19 16:40:18 +02:00
io . BackendFlags & = ~ ( ImGuiBackendFlags_RendererHasVtxOffset | ImGuiBackendFlags_RendererHasViewports ) ;
2021-06-30 15:22:15 +02:00
IM_DELETE ( bd ) ;
2016-03-09 16:39:54 +01:00
}
2018-02-16 22:50:19 +01:00
void ImGui_ImplVulkan_NewFrame ( )
2016-03-09 16:39:54 +01:00
{
2021-06-29 17:53:41 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
2024-05-07 16:53:03 +02:00
IM_ASSERT ( bd ! = nullptr & & " Context or backend not initialized! Did you call ImGui_ImplVulkan_Init()? " ) ;
2023-11-10 14:35:33 +01:00
if ( ! bd - > FontDescriptorSet )
ImGui_ImplVulkan_CreateFontsTexture ( ) ;
2016-03-09 16:39:54 +01:00
}
2016-11-12 17:49:59 +01:00
2019-04-05 17:48:47 +02:00
void ImGui_ImplVulkan_SetMinImageCount ( uint32_t min_image_count )
2018-09-09 08:04:44 +02:00
{
2021-06-28 16:52:10 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
2019-04-04 23:11:15 +02:00
IM_ASSERT ( min_image_count > = 2 ) ;
2021-06-28 16:52:10 +02:00
if ( bd - > VulkanInitInfo . MinImageCount = = min_image_count )
2019-04-05 00:25:42 +02:00
return ;
2019-04-05 18:52:40 +02:00
IM_ASSERT ( 0 ) ; // FIXME-VIEWPORT: Unsupported. Need to recreate all swap chains!
2021-06-28 16:52:10 +02:00
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
2019-04-05 17:48:47 +02:00
VkResult err = vkDeviceWaitIdle ( v - > Device ) ;
check_vk_result ( err ) ;
2019-04-05 18:52:40 +02:00
ImGui_ImplVulkanH_DestroyAllViewportsRenderBuffers ( v - > Device , v - > Allocator ) ;
2019-06-06 16:16:18 +02:00
2021-06-28 16:52:10 +02:00
bd - > VulkanInitInfo . MinImageCount = min_image_count ;
2019-04-04 23:11:15 +02:00
}
2022-01-20 15:32:49 +01:00
// Register a texture
// FIXME: This is experimental in the sense that we are unsure how to best design/tackle this problem, please post to https://github.com/ocornut/imgui/pull/914 if you have suggestions.
2022-01-20 15:53:28 +01:00
VkDescriptorSet ImGui_ImplVulkan_AddTexture ( VkSampler sampler , VkImageView image_view , VkImageLayout image_layout )
2022-01-20 15:32:49 +01:00
{
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
// Create Descriptor Set:
VkDescriptorSet descriptor_set ;
{
VkDescriptorSetAllocateInfo alloc_info = { } ;
alloc_info . sType = VK_STRUCTURE_TYPE_DESCRIPTOR_SET_ALLOCATE_INFO ;
alloc_info . descriptorPool = v - > DescriptorPool ;
alloc_info . descriptorSetCount = 1 ;
alloc_info . pSetLayouts = & bd - > DescriptorSetLayout ;
VkResult err = vkAllocateDescriptorSets ( v - > Device , & alloc_info , & descriptor_set ) ;
check_vk_result ( err ) ;
}
// Update the Descriptor Set:
{
VkDescriptorImageInfo desc_image [ 1 ] = { } ;
desc_image [ 0 ] . sampler = sampler ;
desc_image [ 0 ] . imageView = image_view ;
desc_image [ 0 ] . imageLayout = image_layout ;
VkWriteDescriptorSet write_desc [ 1 ] = { } ;
write_desc [ 0 ] . sType = VK_STRUCTURE_TYPE_WRITE_DESCRIPTOR_SET ;
write_desc [ 0 ] . dstSet = descriptor_set ;
write_desc [ 0 ] . descriptorCount = 1 ;
write_desc [ 0 ] . descriptorType = VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER ;
write_desc [ 0 ] . pImageInfo = desc_image ;
2022-10-11 12:22:29 +02:00
vkUpdateDescriptorSets ( v - > Device , 1 , write_desc , 0 , nullptr ) ;
2022-01-20 15:32:49 +01:00
}
2022-01-20 15:53:28 +01:00
return descriptor_set ;
2022-01-20 15:32:49 +01:00
}
2018-08-22 17:59:58 +02:00
2022-10-04 12:02:48 +02:00
void ImGui_ImplVulkan_RemoveTexture ( VkDescriptorSet descriptor_set )
{
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
vkFreeDescriptorSets ( v - > Device , v - > DescriptorPool , 1 , & descriptor_set ) ;
}
2024-01-11 20:22:37 +01:00
void ImGui_ImplVulkan_DestroyFrameRenderBuffers ( VkDevice device , ImGui_ImplVulkan_FrameRenderBuffers * buffers , const VkAllocationCallbacks * allocator )
{
if ( buffers - > VertexBuffer ) { vkDestroyBuffer ( device , buffers - > VertexBuffer , allocator ) ; buffers - > VertexBuffer = VK_NULL_HANDLE ; }
if ( buffers - > VertexBufferMemory ) { vkFreeMemory ( device , buffers - > VertexBufferMemory , allocator ) ; buffers - > VertexBufferMemory = VK_NULL_HANDLE ; }
if ( buffers - > IndexBuffer ) { vkDestroyBuffer ( device , buffers - > IndexBuffer , allocator ) ; buffers - > IndexBuffer = VK_NULL_HANDLE ; }
if ( buffers - > IndexBufferMemory ) { vkFreeMemory ( device , buffers - > IndexBufferMemory , allocator ) ; buffers - > IndexBufferMemory = VK_NULL_HANDLE ; }
buffers - > VertexBufferSize = 0 ;
buffers - > IndexBufferSize = 0 ;
}
void ImGui_ImplVulkan_DestroyWindowRenderBuffers ( VkDevice device , ImGui_ImplVulkan_WindowRenderBuffers * buffers , const VkAllocationCallbacks * allocator )
{
for ( uint32_t n = 0 ; n < buffers - > Count ; n + + )
ImGui_ImplVulkan_DestroyFrameRenderBuffers ( device , & buffers - > FrameRenderBuffers [ n ] , allocator ) ;
IM_FREE ( buffers - > FrameRenderBuffers ) ;
buffers - > FrameRenderBuffers = nullptr ;
buffers - > Index = 0 ;
buffers - > Count = 0 ;
}
2018-06-08 19:37:33 +02:00
//-------------------------------------------------------------------------
2018-08-22 17:59:58 +02:00
// Internal / Miscellaneous Vulkan Helpers
2019-04-03 18:33:13 +02:00
// (Used by example's main.cpp. Used by multi-viewport features. PROBABLY NOT used by your own app.)
2018-03-01 22:16:51 +01:00
//-------------------------------------------------------------------------
2019-01-20 17:56:17 +01:00
// You probably do NOT need to use or care about those functions.
2018-08-22 17:59:58 +02:00
// Those functions only exist because:
// 1) they facilitate the readability and maintenance of the multiple main.cpp examples files.
// 2) the upcoming multi-viewport feature will need them internally.
2020-10-12 17:34:22 +02:00
// Generally we avoid exposing any kind of superfluous high-level helpers in the backends,
2018-08-22 17:59:58 +02:00
// but it is too much code to duplicate everywhere so we exceptionally expose them.
2019-04-03 18:33:13 +02:00
//
2019-04-04 22:27:29 +02:00
// Your engine/app will likely _already_ have code to setup all that stuff (swap chain, render pass, frame buffers, etc.).
2018-08-22 17:59:58 +02:00
// You may read this code to learn about Vulkan, but it is recommended you use you own custom tailored code to do equivalent work.
2019-04-03 18:33:13 +02:00
// (The ImGui_ImplVulkanH_XXX functions do not interact with any of the state used by the regular ImGui_ImplVulkan_XXX functions)
2018-03-01 22:16:51 +01:00
//-------------------------------------------------------------------------
2018-03-02 23:59:21 +01:00
VkSurfaceFormatKHR ImGui_ImplVulkanH_SelectSurfaceFormat ( VkPhysicalDevice physical_device , VkSurfaceKHR surface , const VkFormat * request_formats , int request_formats_count , VkColorSpaceKHR request_color_space )
2018-03-01 22:16:51 +01:00
{
2021-01-27 13:23:28 +01:00
IM_ASSERT ( g_FunctionsLoaded & & " Need to call ImGui_ImplVulkan_LoadFunctions() if IMGUI_IMPL_VULKAN_NO_PROTOTYPES or VK_NO_PROTOTYPES are set! " ) ;
2022-10-11 12:22:29 +02:00
IM_ASSERT ( request_formats ! = nullptr ) ;
2018-03-01 22:16:51 +01:00
IM_ASSERT ( request_formats_count > 0 ) ;
// Per Spec Format and View Format are expected to be the same unless VK_IMAGE_CREATE_MUTABLE_BIT was set at image creation
// Assuming that the default behavior is without setting this bit, there is no need for separate Swapchain image and image view format
// Additionally several new color spaces were introduced with Vulkan Spec v1.0.40,
// hence we must make sure that a format with the mostly available color space, VK_COLOR_SPACE_SRGB_NONLINEAR_KHR, is found and used.
uint32_t avail_count ;
2022-10-11 12:22:29 +02:00
vkGetPhysicalDeviceSurfaceFormatsKHR ( physical_device , surface , & avail_count , nullptr ) ;
2018-03-01 22:16:51 +01:00
ImVector < VkSurfaceFormatKHR > avail_format ;
avail_format . resize ( ( int ) avail_count ) ;
vkGetPhysicalDeviceSurfaceFormatsKHR ( physical_device , surface , & avail_count , avail_format . Data ) ;
// First check if only one format, VK_FORMAT_UNDEFINED, is available, which would imply that any format is available
if ( avail_count = = 1 )
{
if ( avail_format [ 0 ] . format = = VK_FORMAT_UNDEFINED )
{
VkSurfaceFormatKHR ret ;
ret . format = request_formats [ 0 ] ;
ret . colorSpace = request_color_space ;
return ret ;
}
else
{
// No point in searching another format
return avail_format [ 0 ] ;
}
}
else
{
2019-01-20 17:56:17 +01:00
// Request several formats, the first found will be used
2018-03-01 22:16:51 +01:00
for ( int request_i = 0 ; request_i < request_formats_count ; request_i + + )
for ( uint32_t avail_i = 0 ; avail_i < avail_count ; avail_i + + )
if ( avail_format [ avail_i ] . format = = request_formats [ request_i ] & & avail_format [ avail_i ] . colorSpace = = request_color_space )
return avail_format [ avail_i ] ;
// If none of the requested image formats could be found, use the first available
return avail_format [ 0 ] ;
}
}
2018-03-02 23:59:21 +01:00
VkPresentModeKHR ImGui_ImplVulkanH_SelectPresentMode ( VkPhysicalDevice physical_device , VkSurfaceKHR surface , const VkPresentModeKHR * request_modes , int request_modes_count )
2018-03-01 22:16:51 +01:00
{
2021-01-27 13:23:28 +01:00
IM_ASSERT ( g_FunctionsLoaded & & " Need to call ImGui_ImplVulkan_LoadFunctions() if IMGUI_IMPL_VULKAN_NO_PROTOTYPES or VK_NO_PROTOTYPES are set! " ) ;
2022-10-11 12:22:29 +02:00
IM_ASSERT ( request_modes ! = nullptr ) ;
2018-03-01 22:16:51 +01:00
IM_ASSERT ( request_modes_count > 0 ) ;
// Request a certain mode and confirm that it is available. If not use VK_PRESENT_MODE_FIFO_KHR which is mandatory
uint32_t avail_count = 0 ;
2022-10-11 12:22:29 +02:00
vkGetPhysicalDeviceSurfacePresentModesKHR ( physical_device , surface , & avail_count , nullptr ) ;
2018-03-01 22:16:51 +01:00
ImVector < VkPresentModeKHR > avail_modes ;
avail_modes . resize ( ( int ) avail_count ) ;
vkGetPhysicalDeviceSurfacePresentModesKHR ( physical_device , surface , & avail_count , avail_modes . Data ) ;
2018-08-25 21:15:37 +02:00
//for (uint32_t avail_i = 0; avail_i < avail_count; avail_i++)
// printf("[vulkan] avail_modes[%d] = %d\n", avail_i, avail_modes[avail_i]);
2018-03-01 22:16:51 +01:00
for ( int request_i = 0 ; request_i < request_modes_count ; request_i + + )
for ( uint32_t avail_i = 0 ; avail_i < avail_count ; avail_i + + )
if ( request_modes [ request_i ] = = avail_modes [ avail_i ] )
return request_modes [ request_i ] ;
return VK_PRESENT_MODE_FIFO_KHR ; // Always available
}
2018-03-02 19:23:01 +01:00
2019-04-05 17:54:16 +02:00
void ImGui_ImplVulkanH_CreateWindowCommandBuffers ( VkPhysicalDevice physical_device , VkDevice device , ImGui_ImplVulkanH_Window * wd , uint32_t queue_family , const VkAllocationCallbacks * allocator )
2018-03-02 23:59:21 +01:00
{
2019-04-05 17:54:16 +02:00
IM_ASSERT ( physical_device ! = VK_NULL_HANDLE & & device ! = VK_NULL_HANDLE ) ;
2024-01-19 14:50:32 +01:00
IM_UNUSED ( physical_device ) ;
2018-03-02 23:59:21 +01:00
2018-03-03 00:29:17 +01:00
// Create Command Buffers
VkResult err ;
2019-04-05 17:22:24 +02:00
for ( uint32_t i = 0 ; i < wd - > ImageCount ; i + + )
2018-03-03 00:29:17 +01:00
{
2019-04-04 23:28:29 +02:00
ImGui_ImplVulkanH_Frame * fd = & wd - > Frames [ i ] ;
2018-03-03 00:29:17 +01:00
{
VkCommandPoolCreateInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_COMMAND_POOL_CREATE_INFO ;
2024-01-03 14:11:40 +01:00
info . flags = 0 ;
2018-03-03 00:29:17 +01:00
info . queueFamilyIndex = queue_family ;
err = vkCreateCommandPool ( device , & info , allocator , & fd - > CommandPool ) ;
check_vk_result ( err ) ;
}
{
VkCommandBufferAllocateInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_ALLOCATE_INFO ;
info . commandPool = fd - > CommandPool ;
info . level = VK_COMMAND_BUFFER_LEVEL_PRIMARY ;
info . commandBufferCount = 1 ;
err = vkAllocateCommandBuffers ( device , & info , & fd - > CommandBuffer ) ;
check_vk_result ( err ) ;
}
{
VkFenceCreateInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_FENCE_CREATE_INFO ;
info . flags = VK_FENCE_CREATE_SIGNALED_BIT ;
err = vkCreateFence ( device , & info , allocator , & fd - > Fence ) ;
check_vk_result ( err ) ;
}
2024-01-19 14:50:32 +01:00
}
for ( uint32_t i = 0 ; i < wd - > SemaphoreCount ; i + + )
{
ImGui_ImplVulkanH_FrameSemaphores * fsd = & wd - > FrameSemaphores [ i ] ;
2018-03-03 00:29:17 +01:00
{
VkSemaphoreCreateInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_SEMAPHORE_CREATE_INFO ;
2019-04-05 06:50:21 +02:00
err = vkCreateSemaphore ( device , & info , allocator , & fsd - > ImageAcquiredSemaphore ) ;
2018-03-03 00:29:17 +01:00
check_vk_result ( err ) ;
2019-04-05 06:50:21 +02:00
err = vkCreateSemaphore ( device , & info , allocator , & fsd - > RenderCompleteSemaphore ) ;
2018-03-03 00:29:17 +01:00
check_vk_result ( err ) ;
}
}
}
2018-03-12 18:43:25 +01:00
int ImGui_ImplVulkanH_GetMinImageCountFromPresentMode ( VkPresentModeKHR present_mode )
{
if ( present_mode = = VK_PRESENT_MODE_MAILBOX_KHR )
return 3 ;
if ( present_mode = = VK_PRESENT_MODE_FIFO_KHR | | present_mode = = VK_PRESENT_MODE_FIFO_RELAXED_KHR )
return 2 ;
if ( present_mode = = VK_PRESENT_MODE_IMMEDIATE_KHR )
return 1 ;
IM_ASSERT ( 0 ) ;
return 1 ;
}
2019-04-04 22:27:29 +02:00
// Also destroy old swap chain and in-flight frames data, if any.
2019-04-05 17:54:16 +02:00
void ImGui_ImplVulkanH_CreateWindowSwapChain ( VkPhysicalDevice physical_device , VkDevice device , ImGui_ImplVulkanH_Window * wd , const VkAllocationCallbacks * allocator , int w , int h , uint32_t min_image_count )
2018-03-03 00:29:17 +01:00
{
2018-03-02 23:59:21 +01:00
VkResult err ;
VkSwapchainKHR old_swapchain = wd - > Swapchain ;
2021-08-24 21:53:54 +02:00
wd - > Swapchain = VK_NULL_HANDLE ;
2018-03-02 23:59:21 +01:00
err = vkDeviceWaitIdle ( device ) ;
check_vk_result ( err ) ;
2019-04-04 23:28:29 +02:00
// We don't use ImGui_ImplVulkanH_DestroyWindow() because we want to preserve the old swapchain to create the new one.
2018-03-02 23:59:21 +01:00
// Destroy old Framebuffer
2019-04-05 17:22:24 +02:00
for ( uint32_t i = 0 ; i < wd - > ImageCount ; i + + )
2019-04-05 17:54:16 +02:00
ImGui_ImplVulkanH_DestroyFrame ( device , & wd - > Frames [ i ] , allocator ) ;
2024-01-19 14:50:32 +01:00
for ( uint32_t i = 0 ; i < wd - > SemaphoreCount ; i + + )
2019-04-05 17:54:16 +02:00
ImGui_ImplVulkanH_DestroyFrameSemaphores ( device , & wd - > FrameSemaphores [ i ] , allocator ) ;
2019-04-05 20:27:46 +02:00
IM_FREE ( wd - > Frames ) ;
IM_FREE ( wd - > FrameSemaphores ) ;
2022-10-11 12:22:29 +02:00
wd - > Frames = nullptr ;
wd - > FrameSemaphores = nullptr ;
2019-04-05 17:22:24 +02:00
wd - > ImageCount = 0 ;
2018-03-02 23:59:21 +01:00
if ( wd - > RenderPass )
vkDestroyRenderPass ( device , wd - > RenderPass , allocator ) ;
2019-01-20 17:56:17 +01:00
2018-03-12 18:43:25 +01:00
// If min image count was not specified, request different count of images dependent on selected present mode
if ( min_image_count = = 0 )
min_image_count = ImGui_ImplVulkanH_GetMinImageCountFromPresentMode ( wd - > PresentMode ) ;
2018-03-02 23:59:21 +01:00
// Create Swapchain
{
VkSwapchainCreateInfoKHR info = { } ;
info . sType = VK_STRUCTURE_TYPE_SWAPCHAIN_CREATE_INFO_KHR ;
info . surface = wd - > Surface ;
2019-04-03 17:23:31 +02:00
info . minImageCount = min_image_count ;
2018-03-02 23:59:21 +01:00
info . imageFormat = wd - > SurfaceFormat . format ;
info . imageColorSpace = wd - > SurfaceFormat . colorSpace ;
info . imageArrayLayers = 1 ;
info . imageUsage = VK_IMAGE_USAGE_COLOR_ATTACHMENT_BIT ;
info . imageSharingMode = VK_SHARING_MODE_EXCLUSIVE ; // Assume that graphics family == present family
info . preTransform = VK_SURFACE_TRANSFORM_IDENTITY_BIT_KHR ;
info . compositeAlpha = VK_COMPOSITE_ALPHA_OPAQUE_BIT_KHR ;
info . presentMode = wd - > PresentMode ;
info . clipped = VK_TRUE ;
info . oldSwapchain = old_swapchain ;
VkSurfaceCapabilitiesKHR cap ;
err = vkGetPhysicalDeviceSurfaceCapabilitiesKHR ( physical_device , wd - > Surface , & cap ) ;
check_vk_result ( err ) ;
2018-08-25 21:15:37 +02:00
if ( info . minImageCount < cap . minImageCount )
2019-04-03 17:23:31 +02:00
info . minImageCount = cap . minImageCount ;
else if ( cap . maxImageCount ! = 0 & & info . minImageCount > cap . maxImageCount )
info . minImageCount = cap . maxImageCount ;
2018-03-02 23:59:21 +01:00
if ( cap . currentExtent . width = = 0xffffffff )
{
info . imageExtent . width = wd - > Width = w ;
info . imageExtent . height = wd - > Height = h ;
}
else
{
info . imageExtent . width = wd - > Width = cap . currentExtent . width ;
info . imageExtent . height = wd - > Height = cap . currentExtent . height ;
}
err = vkCreateSwapchainKHR ( device , & info , allocator , & wd - > Swapchain ) ;
check_vk_result ( err ) ;
2022-10-11 12:22:29 +02:00
err = vkGetSwapchainImagesKHR ( device , wd - > Swapchain , & wd - > ImageCount , nullptr ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2019-04-03 17:56:18 +02:00
VkImage backbuffers [ 16 ] = { } ;
2019-04-05 17:22:24 +02:00
IM_ASSERT ( wd - > ImageCount > = min_image_count ) ;
IM_ASSERT ( wd - > ImageCount < IM_ARRAYSIZE ( backbuffers ) ) ;
err = vkGetSwapchainImagesKHR ( device , wd - > Swapchain , & wd - > ImageCount , backbuffers ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
2018-09-11 22:18:24 +02:00
2024-01-19 14:50:32 +01:00
IM_ASSERT ( wd - > Frames = = nullptr & & wd - > FrameSemaphores = = nullptr ) ;
wd - > SemaphoreCount = wd - > ImageCount + 1 ;
2019-04-05 20:27:46 +02:00
wd - > Frames = ( ImGui_ImplVulkanH_Frame * ) IM_ALLOC ( sizeof ( ImGui_ImplVulkanH_Frame ) * wd - > ImageCount ) ;
2024-01-19 14:50:32 +01:00
wd - > FrameSemaphores = ( ImGui_ImplVulkanH_FrameSemaphores * ) IM_ALLOC ( sizeof ( ImGui_ImplVulkanH_FrameSemaphores ) * wd - > SemaphoreCount ) ;
2019-04-05 17:22:24 +02:00
memset ( wd - > Frames , 0 , sizeof ( wd - > Frames [ 0 ] ) * wd - > ImageCount ) ;
2024-01-19 14:50:32 +01:00
memset ( wd - > FrameSemaphores , 0 , sizeof ( wd - > FrameSemaphores [ 0 ] ) * wd - > SemaphoreCount ) ;
2019-04-05 17:22:24 +02:00
for ( uint32_t i = 0 ; i < wd - > ImageCount ; i + + )
2019-04-03 19:21:06 +02:00
wd - > Frames [ i ] . Backbuffer = backbuffers [ i ] ;
2018-03-02 23:59:21 +01:00
}
if ( old_swapchain )
vkDestroySwapchainKHR ( device , old_swapchain , allocator ) ;
// Create the Render Pass
2023-07-03 17:48:28 +02:00
if ( wd - > UseDynamicRendering = = false )
2018-03-02 23:59:21 +01:00
{
VkAttachmentDescription attachment = { } ;
attachment . format = wd - > SurfaceFormat . format ;
attachment . samples = VK_SAMPLE_COUNT_1_BIT ;
2018-03-15 17:52:53 +01:00
attachment . loadOp = wd - > ClearEnable ? VK_ATTACHMENT_LOAD_OP_CLEAR : VK_ATTACHMENT_LOAD_OP_DONT_CARE ;
2018-03-02 23:59:21 +01:00
attachment . storeOp = VK_ATTACHMENT_STORE_OP_STORE ;
attachment . stencilLoadOp = VK_ATTACHMENT_LOAD_OP_DONT_CARE ;
attachment . stencilStoreOp = VK_ATTACHMENT_STORE_OP_DONT_CARE ;
attachment . initialLayout = VK_IMAGE_LAYOUT_UNDEFINED ;
attachment . finalLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR ;
VkAttachmentReference color_attachment = { } ;
color_attachment . attachment = 0 ;
color_attachment . layout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ;
VkSubpassDescription subpass = { } ;
subpass . pipelineBindPoint = VK_PIPELINE_BIND_POINT_GRAPHICS ;
subpass . colorAttachmentCount = 1 ;
subpass . pColorAttachments = & color_attachment ;
2018-03-20 16:05:31 +01:00
VkSubpassDependency dependency = { } ;
dependency . srcSubpass = VK_SUBPASS_EXTERNAL ;
dependency . dstSubpass = 0 ;
dependency . srcStageMask = VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT ;
dependency . dstStageMask = VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT ;
dependency . srcAccessMask = 0 ;
dependency . dstAccessMask = VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT ;
2018-03-02 23:59:21 +01:00
VkRenderPassCreateInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_RENDER_PASS_CREATE_INFO ;
info . attachmentCount = 1 ;
info . pAttachments = & attachment ;
info . subpassCount = 1 ;
info . pSubpasses = & subpass ;
2018-03-20 16:05:31 +01:00
info . dependencyCount = 1 ;
info . pDependencies = & dependency ;
2018-03-02 23:59:21 +01:00
err = vkCreateRenderPass ( device , & info , allocator , & wd - > RenderPass ) ;
check_vk_result ( err ) ;
2020-09-08 22:39:53 +02:00
// We do not create a pipeline by default as this is also used by examples' main.cpp,
// but secondary viewport in multi-viewport mode may want to create one with:
2024-02-12 20:51:24 +01:00
//ImGui_ImplVulkan_CreatePipeline(device, allocator, VK_NULL_HANDLE, wd->RenderPass, VK_SAMPLE_COUNT_1_BIT, &wd->Pipeline, v->Subpass);
2018-03-02 23:59:21 +01:00
}
// Create The Image Views
{
VkImageViewCreateInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_IMAGE_VIEW_CREATE_INFO ;
info . viewType = VK_IMAGE_VIEW_TYPE_2D ;
info . format = wd - > SurfaceFormat . format ;
info . components . r = VK_COMPONENT_SWIZZLE_R ;
info . components . g = VK_COMPONENT_SWIZZLE_G ;
info . components . b = VK_COMPONENT_SWIZZLE_B ;
info . components . a = VK_COMPONENT_SWIZZLE_A ;
VkImageSubresourceRange image_range = { VK_IMAGE_ASPECT_COLOR_BIT , 0 , 1 , 0 , 1 } ;
info . subresourceRange = image_range ;
2019-04-05 17:22:24 +02:00
for ( uint32_t i = 0 ; i < wd - > ImageCount ; i + + )
2018-03-02 23:59:21 +01:00
{
2019-04-04 23:28:29 +02:00
ImGui_ImplVulkanH_Frame * fd = & wd - > Frames [ i ] ;
2019-04-03 19:21:06 +02:00
info . image = fd - > Backbuffer ;
err = vkCreateImageView ( device , & info , allocator , & fd - > BackbufferView ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
}
}
// Create Framebuffer
2023-07-03 17:48:28 +02:00
if ( wd - > UseDynamicRendering = = false )
2018-03-02 23:59:21 +01:00
{
VkImageView attachment [ 1 ] ;
VkFramebufferCreateInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_FRAMEBUFFER_CREATE_INFO ;
info . renderPass = wd - > RenderPass ;
info . attachmentCount = 1 ;
info . pAttachments = attachment ;
info . width = wd - > Width ;
info . height = wd - > Height ;
info . layers = 1 ;
2019-04-05 17:22:24 +02:00
for ( uint32_t i = 0 ; i < wd - > ImageCount ; i + + )
2018-03-02 23:59:21 +01:00
{
2019-04-04 23:28:29 +02:00
ImGui_ImplVulkanH_Frame * fd = & wd - > Frames [ i ] ;
2019-04-03 19:21:06 +02:00
attachment [ 0 ] = fd - > BackbufferView ;
2019-04-03 17:56:18 +02:00
err = vkCreateFramebuffer ( device , & info , allocator , & fd - > Framebuffer ) ;
2018-03-02 23:59:21 +01:00
check_vk_result ( err ) ;
}
}
}
2020-05-25 12:05:11 +02:00
// Create or resize window
void ImGui_ImplVulkanH_CreateOrResizeWindow ( VkInstance instance , VkPhysicalDevice physical_device , VkDevice device , ImGui_ImplVulkanH_Window * wd , uint32_t queue_family , const VkAllocationCallbacks * allocator , int width , int height , uint32_t min_image_count )
2019-04-03 18:33:13 +02:00
{
2021-01-27 13:23:28 +01:00
IM_ASSERT ( g_FunctionsLoaded & & " Need to call ImGui_ImplVulkan_LoadFunctions() if IMGUI_IMPL_VULKAN_NO_PROTOTYPES or VK_NO_PROTOTYPES are set! " ) ;
2019-04-05 17:54:16 +02:00
( void ) instance ;
ImGui_ImplVulkanH_CreateWindowSwapChain ( physical_device , device , wd , allocator , width , height , min_image_count ) ;
2020-12-04 11:29:53 +01:00
//ImGui_ImplVulkan_CreatePipeline(device, allocator, VK_NULL_HANDLE, wd->RenderPass, VK_SAMPLE_COUNT_1_BIT, &wd->Pipeline, g_VulkanInitInfo.Subpass);
2019-04-05 17:54:16 +02:00
ImGui_ImplVulkanH_CreateWindowCommandBuffers ( physical_device , device , wd , queue_family , allocator ) ;
2019-04-03 18:33:13 +02:00
}
2019-04-04 23:28:29 +02:00
void ImGui_ImplVulkanH_DestroyWindow ( VkInstance instance , VkDevice device , ImGui_ImplVulkanH_Window * wd , const VkAllocationCallbacks * allocator )
2018-03-02 23:59:21 +01:00
{
2018-03-12 18:43:25 +01:00
vkDeviceWaitIdle ( device ) ; // FIXME: We could wait on the Queue if we had the queue in wd-> (otherwise VulkanH functions can't use globals)
2021-06-28 16:52:10 +02:00
//vkQueueWaitIdle(bd->Queue);
2018-03-12 18:43:25 +01:00
2019-04-05 17:22:24 +02:00
for ( uint32_t i = 0 ; i < wd - > ImageCount ; i + + )
2019-04-05 17:54:16 +02:00
ImGui_ImplVulkanH_DestroyFrame ( device , & wd - > Frames [ i ] , allocator ) ;
2024-01-19 14:50:32 +01:00
for ( uint32_t i = 0 ; i < wd - > SemaphoreCount ; i + + )
2019-04-05 17:54:16 +02:00
ImGui_ImplVulkanH_DestroyFrameSemaphores ( device , & wd - > FrameSemaphores [ i ] , allocator ) ;
2019-04-05 20:27:46 +02:00
IM_FREE ( wd - > Frames ) ;
IM_FREE ( wd - > FrameSemaphores ) ;
2022-10-11 12:22:29 +02:00
wd - > Frames = nullptr ;
wd - > FrameSemaphores = nullptr ;
2018-03-02 23:59:21 +01:00
vkDestroyRenderPass ( device , wd - > RenderPass , allocator ) ;
vkDestroySwapchainKHR ( device , wd - > Swapchain , allocator ) ;
vkDestroySurfaceKHR ( instance , wd - > Surface , allocator ) ;
2019-04-04 22:27:29 +02:00
2019-04-04 23:28:29 +02:00
* wd = ImGui_ImplVulkanH_Window ( ) ;
2018-03-02 23:59:21 +01:00
}
2019-04-05 17:54:16 +02:00
void ImGui_ImplVulkanH_DestroyFrame ( VkDevice device , ImGui_ImplVulkanH_Frame * fd , const VkAllocationCallbacks * allocator )
2019-04-05 06:50:21 +02:00
{
2018-09-11 22:18:24 +02:00
vkDestroyFence ( device , fd - > Fence , allocator ) ;
vkFreeCommandBuffers ( device , fd - > CommandPool , 1 , & fd - > CommandBuffer ) ;
vkDestroyCommandPool ( device , fd - > CommandPool , allocator ) ;
2019-04-03 15:48:22 +02:00
fd - > Fence = VK_NULL_HANDLE ;
fd - > CommandBuffer = VK_NULL_HANDLE ;
fd - > CommandPool = VK_NULL_HANDLE ;
2019-04-03 17:56:18 +02:00
2019-04-03 19:21:06 +02:00
vkDestroyImageView ( device , fd - > BackbufferView , allocator ) ;
2019-04-03 17:56:18 +02:00
vkDestroyFramebuffer ( device , fd - > Framebuffer , allocator ) ;
2019-04-05 17:48:47 +02:00
}
2019-04-04 22:27:29 +02:00
2019-04-05 17:54:16 +02:00
void ImGui_ImplVulkanH_DestroyFrameSemaphores ( VkDevice device , ImGui_ImplVulkanH_FrameSemaphores * fsd , const VkAllocationCallbacks * allocator )
2019-04-05 17:48:47 +02:00
{
vkDestroySemaphore ( device , fsd - > ImageAcquiredSemaphore , allocator ) ;
vkDestroySemaphore ( device , fsd - > RenderCompleteSemaphore , allocator ) ;
fsd - > ImageAcquiredSemaphore = fsd - > RenderCompleteSemaphore = VK_NULL_HANDLE ;
}
2019-04-04 22:27:29 +02:00
2019-04-05 18:52:40 +02:00
void ImGui_ImplVulkanH_DestroyAllViewportsRenderBuffers ( VkDevice device , const VkAllocationCallbacks * allocator )
{
ImGuiPlatformIO & platform_io = ImGui : : GetPlatformIO ( ) ;
for ( int n = 0 ; n < platform_io . Viewports . Size ; n + + )
2021-06-29 15:34:54 +02:00
if ( ImGui_ImplVulkan_ViewportData * vd = ( ImGui_ImplVulkan_ViewportData * ) platform_io . Viewports [ n ] - > RendererUserData )
2024-01-16 11:43:36 +01:00
ImGui_ImplVulkan_DestroyWindowRenderBuffers ( device , & vd - > RenderBuffers , allocator ) ;
2019-04-05 18:52:40 +02:00
}
2019-04-04 23:55:33 +02:00
2018-03-02 23:04:56 +01:00
//--------------------------------------------------------------------------------------------------------
2018-04-24 17:09:50 +02:00
// MULTI-VIEWPORT / PLATFORM INTERFACE SUPPORT
2020-10-14 14:43:45 +02:00
// This is an _advanced_ and _optional_ feature, allowing the backend to create and handle multiple viewports simultaneously.
2018-04-24 17:09:50 +02:00
// If you are new to dear imgui or creating a new binding for dear imgui, it is recommended that you completely ignore this section first..
//--------------------------------------------------------------------------------------------------------
2018-03-02 19:23:01 +01:00
2018-03-18 18:44:57 +01:00
static void ImGui_ImplVulkan_CreateWindow ( ImGuiViewport * viewport )
2018-03-02 19:23:01 +01:00
{
2021-06-29 14:53:25 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
2021-06-29 15:34:54 +02:00
ImGui_ImplVulkan_ViewportData * vd = IM_NEW ( ImGui_ImplVulkan_ViewportData ) ( ) ;
viewport - > RendererUserData = vd ;
ImGui_ImplVulkanH_Window * wd = & vd - > Window ;
2021-06-29 14:53:25 +02:00
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
2018-03-02 19:23:01 +01:00
2018-03-12 18:43:25 +01:00
// Create surface
2018-03-18 18:44:57 +01:00
ImGuiPlatformIO & platform_io = ImGui : : GetPlatformIO ( ) ;
2019-04-04 23:55:33 +02:00
VkResult err = ( VkResult ) platform_io . Platform_CreateVkSurface ( viewport , ( ImU64 ) v - > Instance , ( const void * ) v - > Allocator , ( ImU64 * ) & wd - > Surface ) ;
2018-03-12 18:43:25 +01:00
check_vk_result ( err ) ;
// Check for WSI support
VkBool32 res ;
2019-04-04 23:55:33 +02:00
vkGetPhysicalDeviceSurfaceSupportKHR ( v - > PhysicalDevice , v - > QueueFamily , wd - > Surface , & res ) ;
2018-03-12 18:43:25 +01:00
if ( res ! = VK_TRUE )
{
2019-04-05 20:28:42 +02:00
IM_ASSERT ( 0 ) ; // Error: no WSI support on physical device
return ;
2018-03-12 18:43:25 +01:00
}
2018-08-25 21:21:14 +02:00
// Select Surface Format
2024-02-14 14:39:26 +01:00
ImVector < VkFormat > requestSurfaceImageFormats ;
# ifdef IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
for ( uint32_t n = 0 ; n < v - > PipelineRenderingCreateInfo . colorAttachmentCount ; n + + )
requestSurfaceImageFormats . push_back ( v - > PipelineRenderingCreateInfo . pColorAttachmentFormats [ n ] ) ;
2023-11-11 01:12:07 +01:00
# endif
2024-02-14 14:39:26 +01:00
const VkFormat defaultFormats [ ] = { VK_FORMAT_B8G8R8A8_UNORM , VK_FORMAT_R8G8B8A8_UNORM , VK_FORMAT_B8G8R8_UNORM , VK_FORMAT_R8G8B8_UNORM } ;
for ( VkFormat format : defaultFormats )
requestSurfaceImageFormats . push_back ( format ) ;
2018-03-12 18:43:25 +01:00
const VkColorSpaceKHR requestSurfaceColorSpace = VK_COLORSPACE_SRGB_NONLINEAR_KHR ;
2024-02-14 14:39:26 +01:00
wd - > SurfaceFormat = ImGui_ImplVulkanH_SelectSurfaceFormat ( v - > PhysicalDevice , wd - > Surface , requestSurfaceImageFormats . Data , ( size_t ) requestSurfaceImageFormats . Size , requestSurfaceColorSpace ) ;
2018-03-02 19:23:01 +01:00
2018-08-25 21:21:14 +02:00
// Select Present Mode
// FIXME-VULKAN: Even thought mailbox seems to get us maximum framerate with a single window, it halves framerate with a second window etc. (w/ Nvidia and SDK 1.82.1)
VkPresentModeKHR present_modes [ ] = { VK_PRESENT_MODE_MAILBOX_KHR , VK_PRESENT_MODE_IMMEDIATE_KHR , VK_PRESENT_MODE_FIFO_KHR } ;
2019-04-04 23:55:33 +02:00
wd - > PresentMode = ImGui_ImplVulkanH_SelectPresentMode ( v - > PhysicalDevice , wd - > Surface , & present_modes [ 0 ] , IM_ARRAYSIZE ( present_modes ) ) ;
2018-08-25 21:21:14 +02:00
//printf("[vulkan] Secondary window selected PresentMode = %d\n", wd->PresentMode);
2018-03-12 18:43:25 +01:00
// Create SwapChain, RenderPass, Framebuffer, etc.
2018-03-15 17:52:53 +01:00
wd - > ClearEnable = ( viewport - > Flags & ImGuiViewportFlags_NoRendererClear ) ? false : true ;
2023-07-04 14:59:43 +02:00
wd - > UseDynamicRendering = v - > UseDynamicRendering ;
2020-05-25 18:32:15 +02:00
ImGui_ImplVulkanH_CreateOrResizeWindow ( v - > Instance , v - > PhysicalDevice , v - > Device , wd , v - > QueueFamily , v - > Allocator , ( int ) viewport - > Size . x , ( int ) viewport - > Size . y , v - > MinImageCount ) ;
2021-06-29 15:34:54 +02:00
vd - > WindowOwned = true ;
2023-04-12 21:56:35 +02:00
// Create pipeline (shared by all secondary viewports)
if ( bd - > PipelineForViewports = = VK_NULL_HANDLE )
ImGui_ImplVulkan_CreatePipeline ( v - > Device , v - > Allocator , VK_NULL_HANDLE , wd - > RenderPass , VK_SAMPLE_COUNT_1_BIT , & bd - > PipelineForViewports , 0 ) ;
2018-03-02 19:23:01 +01:00
}
2018-03-18 18:44:57 +01:00
static void ImGui_ImplVulkan_DestroyWindow ( ImGuiViewport * viewport )
2018-03-02 19:23:01 +01:00
{
2023-04-11 16:19:59 +02:00
// The main viewport (owned by the application) will always have RendererUserData == 0 since we didn't create the data for it.
2021-06-29 14:53:25 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
2021-06-29 15:34:54 +02:00
if ( ImGui_ImplVulkan_ViewportData * vd = ( ImGui_ImplVulkan_ViewportData * ) viewport - > RendererUserData )
2018-03-02 19:23:01 +01:00
{
2021-06-29 14:53:25 +02:00
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
2021-06-29 15:34:54 +02:00
if ( vd - > WindowOwned )
ImGui_ImplVulkanH_DestroyWindow ( v - > Instance , v - > Device , & vd - > Window , v - > Allocator ) ;
2024-01-16 11:43:36 +01:00
ImGui_ImplVulkan_DestroyWindowRenderBuffers ( v - > Device , & vd - > RenderBuffers , v - > Allocator ) ;
2021-06-29 15:34:54 +02:00
IM_DELETE ( vd ) ;
2018-03-02 19:23:01 +01:00
}
2022-10-11 15:59:23 +02:00
viewport - > RendererUserData = nullptr ;
2018-03-02 19:23:01 +01:00
}
2018-03-18 18:44:57 +01:00
static void ImGui_ImplVulkan_SetWindowSize ( ImGuiViewport * viewport , ImVec2 size )
2018-03-02 19:23:01 +01:00
{
2021-06-29 14:53:25 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
2021-06-29 15:34:54 +02:00
ImGui_ImplVulkan_ViewportData * vd = ( ImGui_ImplVulkan_ViewportData * ) viewport - > RendererUserData ;
2022-10-11 15:59:23 +02:00
if ( vd = = nullptr ) // This is nullptr for the main viewport (which is left to the user/app to handle)
2018-03-15 10:54:27 +01:00
return ;
2021-06-29 14:53:25 +02:00
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
2021-06-29 15:34:54 +02:00
vd - > Window . ClearEnable = ( viewport - > Flags & ImGuiViewportFlags_NoRendererClear ) ? false : true ;
ImGui_ImplVulkanH_CreateOrResizeWindow ( v - > Instance , v - > PhysicalDevice , v - > Device , & vd - > Window , v - > QueueFamily , v - > Allocator , ( int ) size . x , ( int ) size . y , v - > MinImageCount ) ;
2018-03-02 19:23:01 +01:00
}
2018-03-19 15:20:47 +01:00
static void ImGui_ImplVulkan_RenderWindow ( ImGuiViewport * viewport , void * )
2018-03-02 19:23:01 +01:00
{
2021-06-29 14:53:25 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
2021-06-29 15:34:54 +02:00
ImGui_ImplVulkan_ViewportData * vd = ( ImGui_ImplVulkan_ViewportData * ) viewport - > RendererUserData ;
ImGui_ImplVulkanH_Window * wd = & vd - > Window ;
2021-06-29 14:53:25 +02:00
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
2018-03-12 18:43:25 +01:00
VkResult err ;
2024-05-07 16:11:54 +02:00
if ( vd - > SwapChainNeedRebuild )
{
ImGui_ImplVulkanH_CreateOrResizeWindow ( v - > Instance , v - > PhysicalDevice , v - > Device , wd , v - > QueueFamily , v - > Allocator , ( int ) viewport - > Size . x , ( int ) viewport - > Size . y , v - > MinImageCount ) ;
vd - > SwapChainNeedRebuild = false ;
}
2019-04-05 00:00:29 +02:00
ImGui_ImplVulkanH_Frame * fd = & wd - > Frames [ wd - > FrameIndex ] ;
2019-04-05 06:50:21 +02:00
ImGui_ImplVulkanH_FrameSemaphores * fsd = & wd - > FrameSemaphores [ wd - > SemaphoreIndex ] ;
2018-03-12 18:43:25 +01:00
{
2021-06-08 04:09:49 +02:00
{
2024-05-07 16:11:54 +02:00
err = vkAcquireNextImageKHR ( v - > Device , wd - > Swapchain , UINT64_MAX , fsd - > ImageAcquiredSemaphore , VK_NULL_HANDLE , & wd - > FrameIndex ) ;
if ( err = = VK_ERROR_OUT_OF_DATE_KHR )
{
// Since we are not going to swap this frame anyway, it's ok that recreation happens on next frame.
vd - > SwapChainNeedRebuild = true ;
return ;
}
check_vk_result ( err ) ;
fd = & wd - > Frames [ wd - > FrameIndex ] ;
2021-06-08 04:09:49 +02:00
}
2018-03-12 18:43:25 +01:00
for ( ; ; )
{
2019-04-04 23:55:33 +02:00
err = vkWaitForFences ( v - > Device , 1 , & fd - > Fence , VK_TRUE , 100 ) ;
2018-03-12 18:43:25 +01:00
if ( err = = VK_SUCCESS ) break ;
if ( err = = VK_TIMEOUT ) continue ;
check_vk_result ( err ) ;
}
{
2019-04-04 23:55:33 +02:00
err = vkResetCommandPool ( v - > Device , fd - > CommandPool , 0 ) ;
2018-03-12 18:43:25 +01:00
check_vk_result ( err ) ;
VkCommandBufferBeginInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_COMMAND_BUFFER_BEGIN_INFO ;
info . flags | = VK_COMMAND_BUFFER_USAGE_ONE_TIME_SUBMIT_BIT ;
err = vkBeginCommandBuffer ( fd - > CommandBuffer , & info ) ;
check_vk_result ( err ) ;
}
{
2018-03-15 17:52:53 +01:00
ImVec4 clear_color = ImVec4 ( 0.0f , 0.0f , 0.0f , 1.0f ) ;
memcpy ( & wd - > ClearValue . color . float32 [ 0 ] , & clear_color , 4 * sizeof ( float ) ) ;
2023-07-04 14:59:43 +02:00
}
# ifdef IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
if ( v - > UseDynamicRendering )
{
// Transition swapchain image to a layout suitable for drawing.
VkImageMemoryBarrier barrier = { } ;
barrier . sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER ;
barrier . dstAccessMask = VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT ;
barrier . oldLayout = VK_IMAGE_LAYOUT_UNDEFINED ;
barrier . newLayout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ;
barrier . image = fd - > Backbuffer ;
barrier . subresourceRange . aspectMask = VK_IMAGE_ASPECT_COLOR_BIT ;
barrier . subresourceRange . levelCount = 1 ;
barrier . subresourceRange . layerCount = 1 ;
vkCmdPipelineBarrier ( fd - > CommandBuffer , VK_PIPELINE_STAGE_TOP_OF_PIPE_BIT , VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT , 0 , 0 , nullptr , 0 , nullptr , 1 , & barrier ) ;
VkRenderingAttachmentInfo attachmentInfo = { } ;
attachmentInfo . sType = VK_STRUCTURE_TYPE_RENDERING_ATTACHMENT_INFO_KHR ;
attachmentInfo . imageView = fd - > BackbufferView ;
attachmentInfo . imageLayout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ;
attachmentInfo . resolveMode = VK_RESOLVE_MODE_NONE ;
attachmentInfo . loadOp = VK_ATTACHMENT_LOAD_OP_CLEAR ;
attachmentInfo . storeOp = VK_ATTACHMENT_STORE_OP_STORE ;
attachmentInfo . clearValue = wd - > ClearValue ;
VkRenderingInfo renderingInfo = { } ;
renderingInfo . sType = VK_STRUCTURE_TYPE_RENDERING_INFO_KHR ;
renderingInfo . renderArea . extent . width = wd - > Width ;
renderingInfo . renderArea . extent . height = wd - > Height ;
renderingInfo . layerCount = 1 ;
renderingInfo . viewMask = 0 ;
renderingInfo . colorAttachmentCount = 1 ;
renderingInfo . pColorAttachments = & attachmentInfo ;
ImGuiImplVulkanFuncs_vkCmdBeginRenderingKHR ( fd - > CommandBuffer , & renderingInfo ) ;
}
else
# endif
{
2018-03-12 18:43:25 +01:00
VkRenderPassBeginInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_RENDER_PASS_BEGIN_INFO ;
info . renderPass = wd - > RenderPass ;
2019-04-05 00:00:29 +02:00
info . framebuffer = fd - > Framebuffer ;
2018-03-12 18:43:25 +01:00
info . renderArea . extent . width = wd - > Width ;
info . renderArea . extent . height = wd - > Height ;
2018-03-15 17:52:53 +01:00
info . clearValueCount = ( viewport - > Flags & ImGuiViewportFlags_NoRendererClear ) ? 0 : 1 ;
2022-10-11 15:59:23 +02:00
info . pClearValues = ( viewport - > Flags & ImGuiViewportFlags_NoRendererClear ) ? nullptr : & wd - > ClearValue ;
2018-03-12 18:43:25 +01:00
vkCmdBeginRenderPass ( fd - > CommandBuffer , & info , VK_SUBPASS_CONTENTS_INLINE ) ;
}
}
2023-04-12 21:56:35 +02:00
ImGui_ImplVulkan_RenderDrawData ( viewport - > DrawData , fd - > CommandBuffer , bd - > PipelineForViewports ) ;
2018-03-12 18:43:25 +01:00
{
2023-07-04 14:59:43 +02:00
# ifdef IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
if ( v - > UseDynamicRendering )
{
ImGuiImplVulkanFuncs_vkCmdEndRenderingKHR ( fd - > CommandBuffer ) ;
// Transition image to a layout suitable for presentation
VkImageMemoryBarrier barrier = { } ;
barrier . sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER ;
barrier . srcAccessMask = VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT ;
barrier . oldLayout = VK_IMAGE_LAYOUT_COLOR_ATTACHMENT_OPTIMAL ;
barrier . newLayout = VK_IMAGE_LAYOUT_PRESENT_SRC_KHR ;
barrier . image = fd - > Backbuffer ;
barrier . subresourceRange . aspectMask = VK_IMAGE_ASPECT_COLOR_BIT ;
barrier . subresourceRange . levelCount = 1 ;
barrier . subresourceRange . layerCount = 1 ;
vkCmdPipelineBarrier ( fd - > CommandBuffer , VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT , VK_PIPELINE_STAGE_BOTTOM_OF_PIPE_BIT , 0 , 0 , nullptr , 0 , nullptr , 1 , & barrier ) ;
}
else
# endif
{
vkCmdEndRenderPass ( fd - > CommandBuffer ) ;
}
2018-03-12 18:43:25 +01:00
{
VkPipelineStageFlags wait_stage = VK_PIPELINE_STAGE_COLOR_ATTACHMENT_OUTPUT_BIT ;
VkSubmitInfo info = { } ;
info . sType = VK_STRUCTURE_TYPE_SUBMIT_INFO ;
info . waitSemaphoreCount = 1 ;
2019-04-05 06:50:21 +02:00
info . pWaitSemaphores = & fsd - > ImageAcquiredSemaphore ;
2018-03-12 18:43:25 +01:00
info . pWaitDstStageMask = & wait_stage ;
info . commandBufferCount = 1 ;
info . pCommandBuffers = & fd - > CommandBuffer ;
info . signalSemaphoreCount = 1 ;
2019-04-05 06:50:21 +02:00
info . pSignalSemaphores = & fsd - > RenderCompleteSemaphore ;
2018-03-12 18:43:25 +01:00
err = vkEndCommandBuffer ( fd - > CommandBuffer ) ;
check_vk_result ( err ) ;
2019-04-04 23:55:33 +02:00
err = vkResetFences ( v - > Device , 1 , & fd - > Fence ) ;
2018-03-12 18:43:25 +01:00
check_vk_result ( err ) ;
2019-04-04 23:55:33 +02:00
err = vkQueueSubmit ( v - > Queue , 1 , & info , fd - > Fence ) ;
2018-03-12 18:43:25 +01:00
check_vk_result ( err ) ;
}
}
2018-03-02 19:23:01 +01:00
}
2018-03-19 15:20:47 +01:00
static void ImGui_ImplVulkan_SwapBuffers ( ImGuiViewport * viewport , void * )
2018-03-02 19:23:01 +01:00
{
2021-06-29 14:53:25 +02:00
ImGui_ImplVulkan_Data * bd = ImGui_ImplVulkan_GetBackendData ( ) ;
2021-06-29 15:34:54 +02:00
ImGui_ImplVulkan_ViewportData * vd = ( ImGui_ImplVulkan_ViewportData * ) viewport - > RendererUserData ;
ImGui_ImplVulkanH_Window * wd = & vd - > Window ;
2021-06-29 14:53:25 +02:00
ImGui_ImplVulkan_InitInfo * v = & bd - > VulkanInitInfo ;
2018-03-12 18:43:25 +01:00
2024-05-07 16:11:54 +02:00
if ( vd - > SwapChainNeedRebuild ) // Frame data became invalid in the middle of rendering
return ;
2018-03-12 18:43:25 +01:00
VkResult err ;
2019-04-05 00:00:29 +02:00
uint32_t present_index = wd - > FrameIndex ;
2018-03-12 18:43:25 +01:00
2019-04-05 06:50:21 +02:00
ImGui_ImplVulkanH_FrameSemaphores * fsd = & wd - > FrameSemaphores [ wd - > SemaphoreIndex ] ;
2018-03-12 18:43:25 +01:00
VkPresentInfoKHR info = { } ;
info . sType = VK_STRUCTURE_TYPE_PRESENT_INFO_KHR ;
info . waitSemaphoreCount = 1 ;
2019-04-05 06:50:21 +02:00
info . pWaitSemaphores = & fsd - > RenderCompleteSemaphore ;
2018-03-12 18:43:25 +01:00
info . swapchainCount = 1 ;
info . pSwapchains = & wd - > Swapchain ;
2019-04-05 00:00:29 +02:00
info . pImageIndices = & present_index ;
2019-04-04 23:55:33 +02:00
err = vkQueuePresentKHR ( v - > Queue , & info ) ;
2021-03-18 18:16:49 +01:00
if ( err = = VK_ERROR_OUT_OF_DATE_KHR | | err = = VK_SUBOPTIMAL_KHR )
2024-05-07 16:11:54 +02:00
{
vd - > SwapChainNeedRebuild = true ;
2024-07-29 15:48:54 +02:00
if ( err = = VK_ERROR_OUT_OF_DATE_KHR )
return ;
}
else
{
check_vk_result ( err ) ;
2024-05-07 16:11:54 +02:00
}
2019-04-05 00:00:29 +02:00
2024-01-19 14:50:32 +01:00
wd - > FrameIndex = ( wd - > FrameIndex + 1 ) % wd - > ImageCount ; // This is for the next vkWaitForFences()
wd - > SemaphoreIndex = ( wd - > SemaphoreIndex + 1 ) % wd - > SemaphoreCount ; // Now we can use the next set of semaphores
2018-03-02 19:23:01 +01:00
}
2024-10-08 20:47:24 +02:00
void ImGui_ImplVulkan_InitMultiViewportSupport ( )
2018-03-02 19:23:01 +01:00
{
2018-03-18 18:44:57 +01:00
ImGuiPlatformIO & platform_io = ImGui : : GetPlatformIO ( ) ;
2018-04-10 19:21:52 +02:00
if ( ImGui : : GetIO ( ) . ConfigFlags & ImGuiConfigFlags_ViewportsEnable )
2022-10-11 15:59:23 +02:00
IM_ASSERT ( platform_io . Platform_CreateVkSurface ! = nullptr & & " Platform needs to setup the CreateVkSurface handler. " ) ;
2018-03-18 18:44:57 +01:00
platform_io . Renderer_CreateWindow = ImGui_ImplVulkan_CreateWindow ;
platform_io . Renderer_DestroyWindow = ImGui_ImplVulkan_DestroyWindow ;
platform_io . Renderer_SetWindowSize = ImGui_ImplVulkan_SetWindowSize ;
platform_io . Renderer_RenderWindow = ImGui_ImplVulkan_RenderWindow ;
platform_io . Renderer_SwapBuffers = ImGui_ImplVulkan_SwapBuffers ;
2018-03-02 19:23:01 +01:00
}
2024-10-08 20:47:24 +02:00
void ImGui_ImplVulkan_ShutdownMultiViewportSupport ( )
2018-03-02 19:23:01 +01:00
{
2020-03-06 17:53:09 +01:00
ImGui : : DestroyPlatformWindows ( ) ;
2018-03-02 19:23:01 +01:00
}
2023-07-20 23:18:47 +02:00
2023-07-13 11:27:52 +02:00
//-----------------------------------------------------------------------------
# endif // #ifndef IMGUI_DISABLE