VkCV Framework  0.0.1
CV Vulkan framework
vkcv::gui::GUI Class Referencefinal
Collaboration diagram for vkcv::gui::GUI:

Public Member Functions

 GUI (Core &core, WindowHandle &windowHandle)
 
 GUI (const GUI &other)=delete
 
 GUI (GUI &&other)=delete
 
GUIoperator= (const GUI &other)=delete
 
GUIoperator= (GUI &&other)=delete
 
virtual ~GUI ()
 
void beginGUI ()
 
void endGUI ()
 

Private Attributes

WindowHandle m_windowHandle
 
Corem_core
 
const Contextm_context
 
ImGuiContext * m_gui_context
 
vk::DescriptorPool m_descriptor_pool
 
vk::RenderPass m_render_pass
 
event_handle< int, int, int > f_mouseButton
 
event_handle< double, double > f_mouseScroll
 
event_handle< int, int, int, int > f_key
 
event_handle< unsigned int > f_char
 

Detailed Description

Constructor & Destructor Documentation

◆ GUI()

vkcv::gui::GUI::GUI ( Core core,
WindowHandle windowHandle 
)

Constructor of a new instance of ImGui management

Parameters
coreValid #Core instance of the framework
windowValid #Window instance of the framework

References vkcv::event< T >::add(), vkcv::Window::e_mouseButton, vkcv::Swapchain::getFormat(), vkcv::Swapchain::getImageCount(), vkcv::Core::getSwapchain(), vkcv::Window::getWindow(), and vkcv::Core::getWindow().

Here is the call graph for this function:

◆ ~GUI()

vkcv::gui::GUI::~GUI ( )
virtual

Destructor of a GUI instance

References vkcv::Window::e_mouseButton, vkcv::Core::getWindow(), and vkcv::event< T >::remove().

Here is the call graph for this function:

Member Function Documentation

◆ beginGUI()

void vkcv::gui::GUI::beginGUI ( )

Sets up a new frame for ImGui to draw

References vkcv::Swapchain::getExtent(), vkcv::Swapchain::getImageCount(), and vkcv::Core::getSwapchain().

Here is the call graph for this function:

◆ endGUI()

void vkcv::gui::GUI::endGUI ( )

Ends a frame for ImGui, renders it and draws it onto the currently active swapchain image of the core (ready to present).

References vkcv::Swapchain::getExtent(), and vkcv::Core::getSwapchain().

Here is the call graph for this function:

The documentation for this class was generated from the following files: