Foundation
Loading...
Searching...
No Matches
ImGui.hpp
Go to the documentation of this file.
1#pragma once
2#define IMGUI_DISABLE_OBSOLETE_FUNCTIONS
3#define IMGUI_DEFINE_MATH_OPERATORS
4#define IMGUI_DISABLE_DEFAULT_ALLOCATORS
5#include <SDL3/SDL.h>
6#include <imgui.h>
7
8#include <RHICore/Device.hpp>
18
19/* -- Internals -- */
20void ImGui_ImplFoundation_ImplUpdateTexture(ImTextureData* tex);
28 Foundation::RenderCore::Renderer* renderer, bool clear,
37// ^^^ Internals
38
39/* -- APIs -- */
54void ImGui_ImplFoundation_Init(Foundation::RHI::RHIDevice* device, SDL_Window* window);
55
62void ImGui_ImplFoundation_ProcessEvent(SDL_Event* event);
69
76
83ImTextureID
86
92void ImGui_ImplFoundation_RemoveImage(ImTextureID textureID);
93
106template <typename FSetup, typename FRecordPrologue>
108 Foundation::Core::StringView name, bool clear,
109 FSetup&& setup, FRecordPrologue&& recordPrologue)
110{
111 using namespace Foundation;
112 using namespace RenderCore;
113 using namespace RHI;
114 ResourceHandle vtxBuffer, idxBuffer, linSampler, nearSampler;
115 ImGui_ImplFoundation_ImplCreateResources(renderer, vtxBuffer, idxBuffer, linSampler, nearSampler);
116 return renderer->CreatePass(
117 "ImGui", RHIDeviceQueueType::Graphics, 0u,
118 [=](PassHandle self, Renderer* r)
119 {
120 ImGui_ImplFoundation_ImplPassSetup(self, r, vtxBuffer, idxBuffer, linSampler, nearSampler);
121 setup(self, r);
122 },
123 [=](PassHandle self, Renderer* r, RHICommandList* cmd)
124 {
125 recordPrologue(self, r, cmd);
126 ImGui_ImplFoundation_ImplPassRecord(self, r, clear, cmd, vtxBuffer, idxBuffer);
127 });
128}
129
130template <typename FSetup>
132{
133 return ImGui_ImplFoundation_CreatePass(renderer, name, clear, std::forward<FSetup>(setup),
135}
136
137
143// ^^^ APIs
Foundation::RenderCore::PassHandle ImGui_ImplFoundation_CreatePass(Foundation::RenderCore::Renderer *renderer, Foundation::Core::StringView name, bool clear, FSetup &&setup, FRecordPrologue &&recordPrologue)
Creates a render pass that will draw the ImGui UI.
Definition ImGui.hpp:107
void ImGui_ImplFoundation_NewFrame()
Starts a new ImGui frame.
Definition ImGui.cpp:51
ImTextureID ImGui_ImplFoundation_AddImage(Foundation::RHI::RHITextureView *textureView, ImGui_ImplFoundation_ImageSampler sampler=ImGuiImplFoundationImageSamplerLinear)
Registers a texture with the ImGui backend so it can be displayed in the UI.
Definition ImGui.cpp:165
void ImGui_ImplFoundation_Shutdown()
Shuts down the ImGui backend and releases all resources.
Definition ImGui.cpp:52
void ImGui_ImplFoundation_SetupContextWithDefaultStyles()
Applies a default, vaguely stylish theme to the ImGui context.
Definition ImGui.cpp:361
void ImGui_ImplFoundation_ImplUpdateTexture(ImTextureData *tex)
Definition ImGui.cpp:69
void ImGui_ImplFoundation_RemoveImage(ImTextureID textureID)
Unregisters a texture from the ImGui backend.
Definition ImGui.cpp:171
ImGui_ImplFoundation_ImageSampler
Sampler type for added image.
Definition ImGui.hpp:14
@ ImGuiImplFoundationImageSamplerLinear
Definition ImGui.hpp:15
@ ImGuiImplFoundationImageSamplerNearest
Definition ImGui.hpp:16
void ImGui_ImplFoundation_ImplCreateResources(Foundation::RenderCore::Renderer *renderer, Foundation::RenderCore::ResourceHandle &outVtxBuffer, Foundation::RenderCore::ResourceHandle &outIdxBuffer, Foundation::RenderCore::ResourceHandle &outLinearSampler, Foundation::RenderCore::ResourceHandle &outNearestSampler)
void ImGui_ImplFoundation_ProcessEvent(SDL_Event *event)
Processes one SDL event and forwards it to ImGui.
Definition ImGui.cpp:50
void ImGui_ImplFoundation_ImplPassSetup(Foundation::RenderCore::PassHandle self, Foundation::RenderCore::Renderer *renderer, Foundation::RenderCore::ResourceHandle vtxBuffer, Foundation::RenderCore::ResourceHandle idxBuffer, Foundation::RenderCore::ResourceHandle linSampler, Foundation::RenderCore::ResourceHandle nearSampler)
void ImGui_ImplFoundation_Init(Foundation::RHI::RHIDevice *device, SDL_Window *window)
Definition ImGui.cpp:32
void ImGui_ImplFoundation_ImplPassRecord(Foundation::RenderCore::PassHandle self, Foundation::RenderCore::Renderer *renderer, bool clear, Foundation::RHI::RHICommandList *cmd, Foundation::RenderCore::ResourceHandle vtxBuffer, Foundation::RenderCore::ResourceHandle idxBuffer)
Definition Command.hpp:42
Definition Device.hpp:246
Definition Resource.hpp:238
Renderer implementing a Frame Graph system with automatic resource tracking and synchronization.
Definition Renderer.hpp:377
PassHandle CreatePass(StringView name, RHIDeviceQueueType queue, size_t priority, FSetup &&setup, FRecord &&record)
Create a render pass from a Setup(Renderer*, PassHandle) and Record(Renderer*, PassHandle,...
Definition Renderer.hpp:680
std::basic_string_view< char > StringView
Alias for std::basic_string_view<char>
Definition Container.hpp:56
Handle ResourceHandle
Definition Renderer.hpp:22
Handle PassHandle
Definition Renderer.hpp:21
Definition Allocator.hpp:6
Default "no-op" functor for Record()
Definition Renderer.hpp:247