VEX Engine
Retro looking game engine made in vulkan mostly because i wanted to understand it better.
Loading...
Searching...
No Matches
EditorImGUIWrapper Class Reference

A specialized ImGUI wrapper for the editor, which customizes initialization for editor features. More...

#include <EditorImGUIWrapper.hpp>

Inheritance diagram for EditorImGUIWrapper:
vex::VulkanImGUIWrapper vex::ImGUIWrapper

Public Member Functions

 EditorImGUIWrapper (SDL_Window *window, vex::VulkanContext &vulkanContext)
 Constructs an EditorImGUIWrapper.
void init () override
 Initializes ImGUI for the editor, setting a custom layout file.
void beginFrame () override
 Overrides the base class function to begin a new ImGUI frame.
void processEvent (const SDL_Event *event) override
 Processes SDL events specifically for ImGUI interaction within the editor.
Public Member Functions inherited from vex::VulkanImGUIWrapper
 VulkanImGUIWrapper (SDL_Window *window, VulkanContext &vulkanContext)
 Constructor for VulkanImGUIWrapper.
virtual ~VulkanImGUIWrapper ()
 Destructor for VulkanImGUIWrapper.
VkDescriptorSet addTexture (VkSampler sampler, VkImageView imageView, VkImageLayout layout)
 Adds a texture to the ImGUI wrapper.
void removeTexture (VkDescriptorSet descriptorSet)
 Removes a texture from the ImGUI wrapper.
void init () override
 Initialization called inside Engine class.
void beginFrame () override
 Begining of UI rendering called in vex::Renderer::renderFrame.
void endFrame () override
 Ends UI rendering for frame.
void processEvent (const SDL_Event *event) override
 Its used to process input needed by interaction with ImGui.
void draw (VkCommandBuffer commandBuffer)
Public Member Functions inherited from vex::ImGUIWrapper
void addUIFunction (const std::function< void()> &func)
 Adds a function to be executed during UI rendering.
void executeUIFunctions ()
 Called between beginFrame and endFrame, executes all imgui functions added by addUIFunction.

Additional Inherited Members

Protected Attributes inherited from vex::ImGUIWrapper
std::vector< std::function< void()> > m_uiFunctions

Detailed Description

A specialized ImGUI wrapper for the editor, which customizes initialization for editor features.

Definition at line 13 of file EditorImGUIWrapper.hpp.

Constructor & Destructor Documentation

◆ EditorImGUIWrapper()

EditorImGUIWrapper::EditorImGUIWrapper ( SDL_Window * window,
vex::VulkanContext & vulkanContext )
inline

Constructs an EditorImGUIWrapper.

Parameters
SDL_Window*window - The main SDL window.
vex::VulkanContext&vulkanContext - The Vulkan context reference.

Definition at line 21 of file EditorImGUIWrapper.hpp.

Member Function Documentation

◆ beginFrame()

void EditorImGUIWrapper::beginFrame ( )
overridevirtual

Overrides the base class function to begin a new ImGUI frame.

Implements vex::ImGUIWrapper.

Definition at line 9 of file EditorImGUIWrapper.cpp.

◆ init()

void EditorImGUIWrapper::init ( )
inlineoverridevirtual

Initializes ImGUI for the editor, setting a custom layout file.

Implements vex::ImGUIWrapper.

Definition at line 25 of file EditorImGUIWrapper.hpp.

◆ processEvent()

void EditorImGUIWrapper::processEvent ( const SDL_Event * event)
overridevirtual

Processes SDL events specifically for ImGUI interaction within the editor.

Parameters
constSDL_Event* event - The SDL event to process.

Implements vex::ImGUIWrapper.

Definition at line 14 of file EditorImGUIWrapper.cpp.


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