imgui_impl_vulkan.h (imgui-1.86) | : | imgui_impl_vulkan.h (imgui-1.87) | ||
---|---|---|---|---|
// dear imgui: Renderer Backend for Vulkan | // dear imgui: Renderer Backend for Vulkan | |||
// This needs to be used along with a Platform Backend (e.g. GLFW, SDL, Win32, c ustom..) | // This needs to be used along with a Platform Backend (e.g. GLFW, SDL, Win32, c ustom..) | |||
// Implemented features: | // Implemented features: | |||
// [X] Renderer: Support for large meshes (64k+ vertices) with 16-bit indices. | // [X] Renderer: Support for large meshes (64k+ vertices) with 16-bit indices. | |||
// Missing features: | // [!] Renderer: User texture binding. Use 'VkDescriptorSet' as ImTextureID. Re | |||
// [ ] Renderer: User texture binding. Changes of ImTextureID aren't supported | ad the FAQ about ImTextureID! See https://github.com/ocornut/imgui/pull/914 for | |||
by this backend! See https://github.com/ocornut/imgui/pull/914 | discussions. | |||
// 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. | ||||
// You can use unmodified imgui_impl_* files in your project. See examples/ fold er for examples of using this. | // You can use unmodified imgui_impl_* files in your project. See examples/ fold er 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. | // Prefer including the entire imgui/ repository into your project (either as a copy or as a submodule), and only build the backends you need. | |||
// If you are new to Dear ImGui, read documentation from the docs/ folder + read the top of imgui.cpp. | // If you are new to Dear ImGui, read documentation from the docs/ folder + read the top of imgui.cpp. | |||
// Read online: https://github.com/ocornut/imgui/tree/master/docs | // Read online: https://github.com/ocornut/imgui/tree/master/docs | |||
// The aim of imgui_impl_vulkan.h/.cpp is to be usable in your engine without an y modification. | // The aim of imgui_impl_vulkan.h/.cpp is to be usable in your engine without an y modification. | |||
// IF YOU FEEL YOU NEED TO MAKE ANY CHANGE TO THIS CODE, please share them and y our feedback at https://github.com/ocornut/imgui/ | // IF YOU FEEL YOU NEED TO MAKE ANY CHANGE TO THIS CODE, please share them and y our feedback at https://github.com/ocornut/imgui/ | |||
// Important note to the reader who wish to integrate imgui_impl_vulkan.cpp/.h i n their own engine/app. | // Important note to the reader who wish to integrate imgui_impl_vulkan.cpp/.h i n their own engine/app. | |||
skipping to change at line 59 | skipping to change at line 61 | |||
VkInstance Instance; | VkInstance Instance; | |||
VkPhysicalDevice PhysicalDevice; | VkPhysicalDevice PhysicalDevice; | |||
VkDevice Device; | VkDevice Device; | |||
uint32_t QueueFamily; | uint32_t QueueFamily; | |||
VkQueue Queue; | VkQueue Queue; | |||
VkPipelineCache PipelineCache; | VkPipelineCache PipelineCache; | |||
VkDescriptorPool DescriptorPool; | VkDescriptorPool DescriptorPool; | |||
uint32_t Subpass; | uint32_t Subpass; | |||
uint32_t MinImageCount; // >= 2 | uint32_t MinImageCount; // >= 2 | |||
uint32_t ImageCount; // >= MinImageCount | uint32_t ImageCount; // >= MinImageCount | |||
VkSampleCountFlagBits MSAASamples; // >= VK_SAMPLE_COUN T_1_BIT | VkSampleCountFlagBits MSAASamples; // >= VK_SAMPLE_COUN T_1_BIT (0 -> default to VK_SAMPLE_COUNT_1_BIT) | |||
const VkAllocationCallbacks* Allocator; | const VkAllocationCallbacks* Allocator; | |||
void (*CheckVkResultFn)(VkResult err); | void (*CheckVkResultFn)(VkResult err); | |||
}; | }; | |||
// Called by user code | // Called by user code | |||
IMGUI_IMPL_API bool ImGui_ImplVulkan_Init(ImGui_ImplVulkan_InitInfo* info, V | IMGUI_IMPL_API bool ImGui_ImplVulkan_Init(ImGui_ImplVulkan_InitInfo* inf | |||
kRenderPass render_pass); | o, VkRenderPass render_pass); | |||
IMGUI_IMPL_API void ImGui_ImplVulkan_Shutdown(); | IMGUI_IMPL_API void ImGui_ImplVulkan_Shutdown(); | |||
IMGUI_IMPL_API void ImGui_ImplVulkan_NewFrame(); | IMGUI_IMPL_API void ImGui_ImplVulkan_NewFrame(); | |||
IMGUI_IMPL_API void ImGui_ImplVulkan_RenderDrawData(ImDrawData* draw_data, V | IMGUI_IMPL_API void ImGui_ImplVulkan_RenderDrawData(ImDrawData* draw_dat | |||
kCommandBuffer command_buffer, VkPipeline pipeline = VK_NULL_HANDLE); | a, VkCommandBuffer command_buffer, VkPipeline pipeline = VK_NULL_HANDLE); | |||
IMGUI_IMPL_API bool ImGui_ImplVulkan_CreateFontsTexture(VkCommandBuffer comm | IMGUI_IMPL_API bool ImGui_ImplVulkan_CreateFontsTexture(VkCommandBuffer | |||
and_buffer); | command_buffer); | |||
IMGUI_IMPL_API void ImGui_ImplVulkan_DestroyFontUploadObjects(); | IMGUI_IMPL_API void ImGui_ImplVulkan_DestroyFontUploadObjects(); | |||
IMGUI_IMPL_API void ImGui_ImplVulkan_SetMinImageCount(uint32_t min_image_cou | IMGUI_IMPL_API void ImGui_ImplVulkan_SetMinImageCount(uint32_t min_image | |||
nt); // To override MinImageCount after initialization (e.g. if swap chain is re | _count); // To override MinImageCount after initialization (e.g. if swap chain i | |||
created) | s recreated) | |||
// Register a texture (VkDescriptorSet == ImTextureID) | ||||
// FIXME: This is experimental in the sense that we are unsure how to best desig | ||||
n/tackle this problem, please post to https://github.com/ocornut/imgui/pull/914 | ||||
if you have suggestions. | ||||
IMGUI_IMPL_API VkDescriptorSet ImGui_ImplVulkan_AddTexture(VkSampler sampler, Vk | ||||
ImageView image_view, VkImageLayout image_layout); | ||||
// Optional: load Vulkan functions with a custom function loader | // Optional: load Vulkan functions with a custom function loader | |||
// This is only useful with IMGUI_IMPL_VULKAN_NO_PROTOTYPES / VK_NO_PROTOTYPES | // This is only useful with IMGUI_IMPL_VULKAN_NO_PROTOTYPES / VK_NO_PROTOTYPES | |||
IMGUI_IMPL_API bool ImGui_ImplVulkan_LoadFunctions(PFN_vkVoidFunction(*loade r_func)(const char* function_name, void* user_data), void* user_data = NULL); | IMGUI_IMPL_API bool ImGui_ImplVulkan_LoadFunctions(PFN_vkVoidFunction(*l oader_func)(const char* function_name, void* user_data), void* user_data = NULL) ; | |||
//------------------------------------------------------------------------- | //------------------------------------------------------------------------- | |||
// Internal / Miscellaneous Vulkan Helpers | // Internal / Miscellaneous Vulkan Helpers | |||
// (Used by example's main.cpp. Used by multi-viewport features. PROBABLY NOT us ed by your own engine/app.) | // (Used by example's main.cpp. Used by multi-viewport features. PROBABLY NOT us ed by your own engine/app.) | |||
//------------------------------------------------------------------------- | //------------------------------------------------------------------------- | |||
// You probably do NOT need to use or care about those functions. | // You probably do NOT need to use or care about those functions. | |||
// Those functions only exist because: | // Those functions only exist because: | |||
// 1) they facilitate the readability and maintenance of the multiple main.cpp examples files. | // 1) they facilitate the readability and maintenance of the multiple main.cpp examples files. | |||
// 2) the upcoming multi-viewport feature will need them internally. | // 2) the upcoming multi-viewport feature will need them internally. | |||
// Generally we avoid exposing any kind of superfluous high-level helpers in the backends, | // Generally we avoid exposing any kind of superfluous high-level helpers in the backends, | |||
End of changes. 4 change blocks. | ||||
17 lines changed or deleted | 28 lines changed or added |