2020-10-12 23:34:22 +08:00
// dear imgui: Renderer Backend for Vulkan
// This needs to be used along with a Platform Backend (e.g. GLFW, SDL, Win32, custom..)
2018-06-09 01:37:33 +08:00
2019-05-29 21:53:36 +08:00
// Implemented features:
2022-01-20 22:53:28 +08:00
// [!] Renderer: User texture binding. Use 'VkDescriptorSet' as ImTextureID. Read the FAQ about ImTextureID! See https://github.com/ocornut/imgui/pull/914 for discussions.
2023-02-07 19:24:42 +08:00
// [X] Renderer: Large meshes support (64k+ vertices) with 16-bit indices.
2022-01-20 22:53:28 +08:00
// Important: on 32-bit systems, user texture binding is only supported if your imconfig file has '#define ImTextureID ImU64'.
// See imgui_impl_vulkan.cpp file for details.
2018-06-09 01:37:33 +08:00
2019-01-21 00:56:17 +08:00
// The aim of imgui_impl_vulkan.h/.cpp is to be usable in your engine without any modification.
2018-08-22 22:43:29 +08: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 19:47:08 +08: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-04 01:21:06 +08:00
// Important note to the reader who wish to integrate imgui_impl_vulkan.cpp/.h in their own engine/app.
2019-04-06 02:27:46 +08:00
// - Common ImGui_ImplVulkan_XXX functions and structures are used to interface with imgui_impl_vulkan.cpp/.h.
2020-10-12 23:34:22 +08:00
// You will use those if you want to use this rendering backend in your engine/app.
2019-10-15 21:20:27 +08:00
// - Helper ImGui_ImplVulkanH_XXX functions and structures are only used by this example (main.cpp) and by
2020-10-12 23:34:22 +08:00
// the backend itself (imgui_impl_vulkan.cpp), but should PROBABLY NOT be used by your own engine/app code.
2019-04-04 01:21:06 +08:00
// Read comments in imgui_impl_vulkan.h.
2018-11-02 03:56:36 +08:00
# pragma once
2023-07-13 17:27:52 +08:00
# ifndef IMGUI_DISABLE
2020-04-07 17:02:29 +08:00
# include "imgui.h" // IMGUI_IMPL_API
2021-01-27 01:34:12 +08:00
2021-01-27 20:23:28 +08:00
// [Configuration] in order to use a custom Vulkan function loader:
// (1) You'll need to disable default Vulkan function prototypes.
// We provide a '#define IMGUI_IMPL_VULKAN_NO_PROTOTYPES' convenience configuration flag.
// In order to make sure this is visible from the imgui_impl_vulkan.cpp compilation unit:
// - Add '#define IMGUI_IMPL_VULKAN_NO_PROTOTYPES' in your imconfig.h file
// - Or as a compilation flag in your build system
// - Or uncomment here (not recommended because you'd be modifying imgui sources!)
// - Do not simply add it in a .cpp file!
// (2) Call ImGui_ImplVulkan_LoadFunctions() before ImGui_ImplVulkan_Init() with your custom function.
// If you have no idea what this is, leave it alone!
2021-01-27 01:34:12 +08:00
//#define IMGUI_IMPL_VULKAN_NO_PROTOTYPES
2021-01-27 20:23:28 +08:00
// Vulkan includes
# if defined(IMGUI_IMPL_VULKAN_NO_PROTOTYPES) && !defined(VK_NO_PROTOTYPES)
# define VK_NO_PROTOTYPES
2021-01-27 01:34:12 +08:00
# endif
2024-01-22 17:03:46 +08:00
# if defined(VK_USE_PLATFORM_WIN32_KHR) && !defined(NOMINMAX)
# define NOMINMAX
2018-06-09 01:37:33 +08:00
# include <vulkan/vulkan.h>
2024-01-22 17:03:46 +08:00
# else
# include <vulkan/vulkan.h>
# endif
2024-02-13 01:46:01 +08:00
# if defined(VK_VERSION_1_3) || defined(VK_KHR_dynamic_rendering)
# define IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
# endif
2018-06-09 01:37:33 +08:00
2019-04-04 01:21:06 +08:00
// Initialization data, for ImGui_ImplVulkan_Init()
2023-12-24 03:01:48 +08:00
// - VkDescriptorPool should be created with VK_DESCRIPTOR_POOL_CREATE_FREE_DESCRIPTOR_SET_BIT,
// and must contain a pool size large enough to hold an ImGui VK_DESCRIPTOR_TYPE_COMBINED_IMAGE_SAMPLER descriptor.
// - When using dynamic rendering, set UseDynamicRendering=true and fill PipelineRenderingCreateInfo structure.
2019-04-04 01:21:06 +08:00
// [Please zero-clear before use!]
2018-06-09 01:37:33 +08:00
struct ImGui_ImplVulkan_InitInfo
{
2021-01-27 20:23:28 +08:00
VkInstance Instance ;
VkPhysicalDevice PhysicalDevice ;
VkDevice Device ;
uint32_t QueueFamily ;
VkQueue Queue ;
2023-12-24 03:01:48 +08:00
VkDescriptorPool DescriptorPool ; // See requirements in note above
2024-02-13 03:51:24 +08:00
VkRenderPass RenderPass ; // Ignored if using dynamic rendering
2023-12-24 03:01:48 +08:00
uint32_t MinImageCount ; // >= 2
uint32_t ImageCount ; // >= MinImageCount
VkSampleCountFlagBits MSAASamples ; // 0 defaults to VK_SAMPLE_COUNT_1_BIT
// (Optional)
2021-01-27 20:23:28 +08:00
VkPipelineCache PipelineCache ;
uint32_t Subpass ;
2023-07-03 23:48:28 +08:00
2023-12-24 03:01:48 +08:00
// (Optional) Dynamic Rendering
// Need to explicitly enable VK_KHR_dynamic_rendering extension to use this, even for Vulkan 1.3.
bool UseDynamicRendering ;
2024-02-13 01:46:01 +08:00
# ifdef IMGUI_IMPL_VULKAN_HAS_DYNAMIC_RENDERING
2023-12-24 03:01:48 +08:00
VkPipelineRenderingCreateInfoKHR PipelineRenderingCreateInfo ;
2024-02-13 01:46:01 +08:00
# endif
2023-07-03 23:48:28 +08:00
2023-12-24 03:01:48 +08:00
// (Optional) Allocation, Debugging
2021-01-27 20:23:28 +08:00
const VkAllocationCallbacks * Allocator ;
void ( * CheckVkResultFn ) ( VkResult err ) ;
2024-01-03 00:06:21 +08:00
VkDeviceSize MinAllocationSize ; // Minimum allocation size. Set to 1024*1024 to satisfy zealous best practices validation layer and waste a little memory.
2018-06-09 01:37:33 +08:00
} ;
2018-08-22 22:43:29 +08:00
// Called by user code
2024-02-13 03:51:24 +08:00
IMGUI_IMPL_API bool ImGui_ImplVulkan_Init ( ImGui_ImplVulkan_InitInfo * info ) ;
2022-01-20 22:53:28 +08:00
IMGUI_IMPL_API void ImGui_ImplVulkan_Shutdown ( ) ;
IMGUI_IMPL_API void ImGui_ImplVulkan_NewFrame ( ) ;
IMGUI_IMPL_API void ImGui_ImplVulkan_RenderDrawData ( ImDrawData * draw_data , VkCommandBuffer command_buffer , VkPipeline pipeline = VK_NULL_HANDLE ) ;
2023-11-10 21:35:33 +08:00
IMGUI_IMPL_API bool ImGui_ImplVulkan_CreateFontsTexture ( ) ;
2023-11-10 21:17:11 +08:00
IMGUI_IMPL_API void ImGui_ImplVulkan_DestroyFontsTexture ( ) ;
2022-01-20 22:53:28 +08:00
IMGUI_IMPL_API void ImGui_ImplVulkan_SetMinImageCount ( uint32_t min_image_count ) ; // To override MinImageCount after initialization (e.g. if swap chain is recreated)
2018-08-22 22:43:29 +08:00
2022-01-20 22:32:49 +08:00
// Register a texture (VkDescriptorSet == ImTextureID)
2022-10-04 18:02:48 +08:00
// 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 22:53:28 +08:00
IMGUI_IMPL_API VkDescriptorSet ImGui_ImplVulkan_AddTexture ( VkSampler sampler , VkImageView image_view , VkImageLayout image_layout ) ;
2022-10-04 18:02:48 +08:00
IMGUI_IMPL_API void ImGui_ImplVulkan_RemoveTexture ( VkDescriptorSet descriptor_set ) ;
2022-01-20 22:32:49 +08:00
2021-01-27 20:23:28 +08:00
// Optional: load Vulkan functions with a custom function loader
// This is only useful with IMGUI_IMPL_VULKAN_NO_PROTOTYPES / VK_NO_PROTOTYPES
2022-10-11 18:22:29 +08:00
IMGUI_IMPL_API bool ImGui_ImplVulkan_LoadFunctions ( PFN_vkVoidFunction ( * loader_func ) ( const char * function_name , void * user_data ) , void * user_data = nullptr ) ;
2018-08-22 23:59:58 +08:00
2018-06-09 01:37:33 +08:00
//-------------------------------------------------------------------------
2018-08-22 23:59:58 +08:00
// Internal / Miscellaneous Vulkan Helpers
2019-04-04 01:21:06 +08:00
// (Used by example's main.cpp. Used by multi-viewport features. PROBABLY NOT used by your own engine/app.)
2018-06-09 01:37:33 +08:00
//-------------------------------------------------------------------------
2019-01-21 00:56:17 +08:00
// You probably do NOT need to use or care about those functions.
2018-08-22 23:59:58 +08:00
// Those functions only exist because:
// 1) they facilitate the readability and maintenance of the multiple main.cpp examples files.
2023-02-07 19:24:42 +08:00
// 2) the multi-viewport / platform window implementation needs them internally.
// Generally we avoid exposing any kind of superfluous high-level helpers in the bindings,
2018-08-22 23:59:58 +08:00
// but it is too much code to duplicate everywhere so we exceptionally expose them.
2019-04-04 00:33:13 +08:00
//
2019-04-04 01:21:06 +08:00
// Your engine/app will likely _already_ have code to setup all that stuff (swap chain, render pass, frame buffers, etc.).
2018-08-22 23:59:58 +08: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-04 00:33:13 +08:00
// (The ImGui_ImplVulkanH_XXX functions do not interact with any of the state used by the regular ImGui_ImplVulkan_XXX functions)
2018-06-09 01:37:33 +08:00
//-------------------------------------------------------------------------
2019-04-05 05:28:29 +08:00
struct ImGui_ImplVulkanH_Frame ;
struct ImGui_ImplVulkanH_Window ;
2018-06-09 01:37:33 +08:00
2019-04-05 05:28:29 +08:00
// Helpers
2020-05-25 18:05:11 +08:00
IMGUI_IMPL_API void ImGui_ImplVulkanH_CreateOrResizeWindow ( VkInstance instance , VkPhysicalDevice physical_device , VkDevice device , ImGui_ImplVulkanH_Window * wnd , uint32_t queue_family , const VkAllocationCallbacks * allocator , int w , int h , uint32_t min_image_count ) ;
2019-04-05 05:28:29 +08:00
IMGUI_IMPL_API void ImGui_ImplVulkanH_DestroyWindow ( VkInstance instance , VkDevice device , ImGui_ImplVulkanH_Window * wnd , const VkAllocationCallbacks * allocator ) ;
2018-06-21 18:04:00 +08:00
IMGUI_IMPL_API VkSurfaceFormatKHR ImGui_ImplVulkanH_SelectSurfaceFormat ( VkPhysicalDevice physical_device , VkSurfaceKHR surface , const VkFormat * request_formats , int request_formats_count , VkColorSpaceKHR request_color_space ) ;
IMGUI_IMPL_API VkPresentModeKHR ImGui_ImplVulkanH_SelectPresentMode ( VkPhysicalDevice physical_device , VkSurfaceKHR surface , const VkPresentModeKHR * request_modes , int request_modes_count ) ;
IMGUI_IMPL_API int ImGui_ImplVulkanH_GetMinImageCountFromPresentMode ( VkPresentModeKHR present_mode ) ;
2018-06-09 01:37:33 +08:00
2018-08-22 23:59:58 +08:00
// Helper structure to hold the data needed by one rendering frame
2019-04-05 05:28:29 +08:00
// (Used by example's main.cpp. Used by multi-viewport features. Probably NOT used by your own engine/app.)
2019-04-05 04:27:29 +08:00
// [Please zero-clear before use!]
2019-04-05 05:28:29 +08:00
struct ImGui_ImplVulkanH_Frame
2018-06-09 01:37:33 +08:00
{
VkCommandPool CommandPool ;
VkCommandBuffer CommandBuffer ;
VkFence Fence ;
2019-04-04 01:21:06 +08:00
VkImage Backbuffer ;
VkImageView BackbufferView ;
2019-04-03 23:56:18 +08:00
VkFramebuffer Framebuffer ;
2018-06-09 01:37:33 +08:00
} ;
2019-04-05 12:50:21 +08:00
struct ImGui_ImplVulkanH_FrameSemaphores
{
VkSemaphore ImageAcquiredSemaphore ;
VkSemaphore RenderCompleteSemaphore ;
} ;
2018-08-22 23:59:58 +08:00
// Helper structure to hold the data needed by one rendering context into one OS window
2019-04-05 05:28:29 +08:00
// (Used by example's main.cpp. Used by multi-viewport features. Probably NOT used by your own engine/app.)
struct ImGui_ImplVulkanH_Window
2018-06-09 01:37:33 +08:00
{
int Width ;
int Height ;
VkSwapchainKHR Swapchain ;
VkSurfaceKHR Surface ;
VkSurfaceFormatKHR SurfaceFormat ;
VkPresentModeKHR PresentMode ;
VkRenderPass RenderPass ;
2020-09-09 04:39:53 +08:00
VkPipeline Pipeline ; // The window pipeline may uses a different VkRenderPass than the one passed in ImGui_ImplVulkan_InitInfo
2022-02-20 03:15:58 +08:00
bool UseDynamicRendering ;
2018-06-09 01:37:33 +08:00
bool ClearEnable ;
VkClearValue ClearValue ;
2019-04-05 04:27:29 +08:00
uint32_t FrameIndex ; // Current frame being rendered to (0 <= FrameIndex < FrameInFlightCount)
2019-04-05 23:22:24 +08:00
uint32_t ImageCount ; // Number of simultaneous in-flight frames (returned by vkGetSwapchainImagesKHR, usually derived from min_image_count)
2024-01-19 21:50:32 +08:00
uint32_t SemaphoreCount ; // Number of simultaneous in-flight frames + 1, to be able to use it in vkAcquireNextImageKHR
2019-04-05 12:50:21 +08:00
uint32_t SemaphoreIndex ; // Current set of swapchain wait semaphores we're using (needs to be distinct from per frame data)
2019-04-05 23:22:24 +08:00
ImGui_ImplVulkanH_Frame * Frames ;
ImGui_ImplVulkanH_FrameSemaphores * FrameSemaphores ;
2019-04-05 23:48:47 +08:00
2019-10-15 21:20:27 +08:00
ImGui_ImplVulkanH_Window ( )
{
2022-03-13 14:15:32 +08:00
memset ( ( void * ) this , 0 , sizeof ( * this ) ) ;
2022-05-03 18:51:51 +08:00
PresentMode = ( VkPresentModeKHR ) ~ 0 ; // Ensure we get an error if user doesn't set this.
2019-04-05 04:27:29 +08:00
ClearEnable = true ;
}
2018-06-09 01:37:33 +08:00
} ;
2023-07-13 17:27:52 +08:00
# endif // #ifndef IMGUI_DISABLE