2018-09-13 14:44:08 +00:00
// dear imgui: Renderer for Vulkan
2018-06-08 17:37:33 +00:00
// This needs to be used along with a Platform Binding (e.g. GLFW, SDL, Win32, custom..)
2019-05-29 13:53:36 +00:00
// Implemented features:
2019-11-20 10:58:25 +00:00
// [X] Renderer: Support for large meshes (64k+ vertices) with 16-bit indices.
2018-06-08 17:37:33 +00:00
// Missing features:
2018-06-11 10:33:51 +00:00
// [ ] Renderer: User texture binding. Changes of ImTextureID aren't supported by this binding! See https://github.com/ocornut/imgui/pull/914
2018-06-08 17:37:33 +00:00
// You can copy and use unmodified imgui_impl_* files in your project. See main.cpp for an example of using this.
2018-07-04 17:06:28 +00:00
// If you are new to dear imgui, read examples/README.txt and read the documentation at the top of imgui.cpp.
2018-06-08 17:37:33 +00:00
// https://github.com/ocornut/imgui
2019-01-20 16:56:17 +00:00
// The aim of imgui_impl_vulkan.h/.cpp is to be usable in your engine without any modification.
2018-08-22 14:43:29 +00: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/
2019-04-03 17:21:06 +00:00
// Important note to the reader who wish to integrate imgui_impl_vulkan.cpp/.h in their own engine/app.
2019-04-05 18:27:46 +00:00
// - Common ImGui_ImplVulkan_XXX functions and structures are used to interface with imgui_impl_vulkan.cpp/.h.
2019-04-03 17:21:06 +00:00
// You will use those if you want to use this rendering back-end in your engine/app.
2019-10-15 13:20:27 +00:00
// - Helper ImGui_ImplVulkanH_XXX functions and structures are only used by this example (main.cpp) and by
2019-04-03 17:21:06 +00:00
// the back-end itself (imgui_impl_vulkan.cpp), but should PROBABLY NOT be used by your own engine/app code.
// Read comments in imgui_impl_vulkan.h.
2018-11-01 19:56:36 +00:00
# pragma once
2020-04-07 09:02:29 +00:00
# include "imgui.h" // IMGUI_IMPL_API
2018-06-08 17:37:33 +00:00
# include <vulkan/vulkan.h>
2019-04-03 17:21:06 +00:00
// Initialization data, for ImGui_ImplVulkan_Init()
// [Please zero-clear before use!]
2018-06-08 17:37:33 +00:00
struct ImGui_ImplVulkan_InitInfo
{
2019-04-04 21:28:29 +00:00
VkInstance Instance ;
VkPhysicalDevice PhysicalDevice ;
VkDevice Device ;
uint32_t QueueFamily ;
VkQueue Queue ;
VkPipelineCache PipelineCache ;
VkDescriptorPool DescriptorPool ;
2019-04-05 15:22:24 +00:00
uint32_t MinImageCount ; // >= 2
uint32_t ImageCount ; // >= MinImageCount
2019-07-31 18:50:50 +00:00
VkSampleCountFlagBits MSAASamples ; // >= VK_SAMPLE_COUNT_1_BIT
2019-04-04 21:28:29 +00:00
const VkAllocationCallbacks * Allocator ;
void ( * CheckVkResultFn ) ( VkResult err ) ;
2018-06-08 17:37:33 +00:00
} ;
2018-08-22 14:43:29 +00:00
// Called by user code
2018-06-21 10:04:00 +00:00
IMGUI_IMPL_API bool ImGui_ImplVulkan_Init ( ImGui_ImplVulkan_InitInfo * info , VkRenderPass render_pass ) ;
IMGUI_IMPL_API void ImGui_ImplVulkan_Shutdown ( ) ;
IMGUI_IMPL_API void ImGui_ImplVulkan_NewFrame ( ) ;
2020-09-08 14:47:06 +00:00
IMGUI_IMPL_API void ImGui_ImplVulkan_RenderDrawData ( ImDrawData * draw_data , VkCommandBuffer command_buffer , VkPipeline pipeline = VK_NULL_HANDLE ) ;
2018-06-21 10:04:00 +00:00
IMGUI_IMPL_API bool ImGui_ImplVulkan_CreateFontsTexture ( VkCommandBuffer command_buffer ) ;
2019-04-03 17:21:06 +00:00
IMGUI_IMPL_API void ImGui_ImplVulkan_DestroyFontUploadObjects ( ) ;
2019-04-05 15:48:47 +00: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 14:43:29 +00:00
2018-08-22 15:59:58 +00:00
2018-06-08 17:37:33 +00:00
//-------------------------------------------------------------------------
2018-08-22 15:59:58 +00:00
// Internal / Miscellaneous Vulkan Helpers
2019-04-03 17:21:06 +00:00
// (Used by example's main.cpp. Used by multi-viewport features. PROBABLY NOT used by your own engine/app.)
2018-06-08 17:37:33 +00:00
//-------------------------------------------------------------------------
2019-01-20 16:56:17 +00:00
// You probably do NOT need to use or care about those functions.
2018-08-22 15:59:58 +00: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.
2019-01-20 16:56:17 +00:00
// Generally we avoid exposing any kind of superfluous high-level helpers in the bindings,
2018-08-22 15:59:58 +00:00
// but it is too much code to duplicate everywhere so we exceptionally expose them.
2019-04-03 16:33:13 +00:00
//
2019-04-03 17:21:06 +00:00
// Your engine/app will likely _already_ have code to setup all that stuff (swap chain, render pass, frame buffers, etc.).
2018-08-22 15:59:58 +00: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 16:33:13 +00:00
// (The ImGui_ImplVulkanH_XXX functions do not interact with any of the state used by the regular ImGui_ImplVulkan_XXX functions)
2018-06-08 17:37:33 +00:00
//-------------------------------------------------------------------------
2019-04-04 21:28:29 +00:00
struct ImGui_ImplVulkanH_Frame ;
struct ImGui_ImplVulkanH_Window ;
2018-06-08 17:37:33 +00:00
2019-04-04 21:28:29 +00:00
// Helpers
2020-05-25 10:05:11 +00: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-04 21:28:29 +00:00
IMGUI_IMPL_API void ImGui_ImplVulkanH_DestroyWindow ( VkInstance instance , VkDevice device , ImGui_ImplVulkanH_Window * wnd , const VkAllocationCallbacks * allocator ) ;
2018-06-21 10:04:00 +00: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-08 17:37:33 +00:00
2018-08-22 15:59:58 +00:00
// Helper structure to hold the data needed by one rendering frame
2019-04-04 21:28:29 +00:00
// (Used by example's main.cpp. Used by multi-viewport features. Probably NOT used by your own engine/app.)
2019-04-04 20:27:29 +00:00
// [Please zero-clear before use!]
2019-04-04 21:28:29 +00:00
struct ImGui_ImplVulkanH_Frame
2018-06-08 17:37:33 +00:00
{
VkCommandPool CommandPool ;
VkCommandBuffer CommandBuffer ;
VkFence Fence ;
2019-04-03 17:21:06 +00:00
VkImage Backbuffer ;
VkImageView BackbufferView ;
2019-04-03 15:56:18 +00:00
VkFramebuffer Framebuffer ;
2018-06-08 17:37:33 +00:00
} ;
2019-04-05 04:50:21 +00:00
struct ImGui_ImplVulkanH_FrameSemaphores
{
VkSemaphore ImageAcquiredSemaphore ;
VkSemaphore RenderCompleteSemaphore ;
} ;
2018-08-22 15:59:58 +00:00
// Helper structure to hold the data needed by one rendering context into one OS window
2019-04-04 21:28:29 +00: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-08 17:37:33 +00:00
{
int Width ;
int Height ;
VkSwapchainKHR Swapchain ;
VkSurfaceKHR Surface ;
VkSurfaceFormatKHR SurfaceFormat ;
VkPresentModeKHR PresentMode ;
VkRenderPass RenderPass ;
2020-09-08 14:47:06 +00:00
VkPipeline Pipeline ; // The window pipeline uses a different VkRenderPass than the user's
2018-06-08 17:37:33 +00:00
bool ClearEnable ;
VkClearValue ClearValue ;
2019-04-04 20:27:29 +00:00
uint32_t FrameIndex ; // Current frame being rendered to (0 <= FrameIndex < FrameInFlightCount)
2019-04-05 15:22:24 +00:00
uint32_t ImageCount ; // Number of simultaneous in-flight frames (returned by vkGetSwapchainImagesKHR, usually derived from min_image_count)
2019-04-05 04:50:21 +00:00
uint32_t SemaphoreIndex ; // Current set of swapchain wait semaphores we're using (needs to be distinct from per frame data)
2019-04-05 15:22:24 +00:00
ImGui_ImplVulkanH_Frame * Frames ;
ImGui_ImplVulkanH_FrameSemaphores * FrameSemaphores ;
2019-04-05 15:48:47 +00:00
2019-10-15 13:20:27 +00:00
ImGui_ImplVulkanH_Window ( )
{
memset ( this , 0 , sizeof ( * this ) ) ;
2019-04-04 20:27:29 +00:00
PresentMode = VK_PRESENT_MODE_MAX_ENUM_KHR ;
ClearEnable = true ;
}
2018-06-08 17:37:33 +00:00
} ;