Raven Engine v0.1
Loading...
Searching...
No Matches
Raven::ImGuiRenderer Class Referenceabstract

Interface for ImGui rendering backend implementations. More...

#include <ImGuiRenderer.h>

Inheritance diagram for Raven::ImGuiRenderer:
Raven::Castable< ImGuiRenderer > Raven::VulkanImGuiRenderer

Public Member Functions

virtual ~ImGuiRenderer ()=default
virtual void Init ()=0
 Initializes ImGui rendering resources and context.
virtual void Begin ()=0
 Begins a new ImGui frame. Should be called before any ImGui draw calls.
virtual void End ()=0
 Ends the current ImGui frame and submits draw commands to the GPU.
virtual void Shutdown ()=0
 Cleans up ImGui resources and shuts down the renderer.

Static Public Member Functions

static Scope< ImGuiRendererCreate (const Ref< RenderPass > &renderPass)
 Factory method to create a platform and backend-specific ImGuiRenderer instance.

Detailed Description

Interface for ImGui rendering backend implementations.

Manages ImGui context initialization, frame lifecycle, rendering submission, and resource cleanup.

Backend implementations must provide concrete definitions for lifecycle methods.

Constructor & Destructor Documentation

◆ ~ImGuiRenderer()

virtual Raven::ImGuiRenderer::~ImGuiRenderer ( )
virtualdefault

Member Function Documentation

◆ Begin()

virtual void Raven::ImGuiRenderer::Begin ( )
pure virtual

Begins a new ImGui frame. Should be called before any ImGui draw calls.

Implemented in Raven::VulkanImGuiRenderer.

◆ Create()

Scope< ImGuiRenderer > Raven::ImGuiRenderer::Create ( const Ref< RenderPass > & renderPass)
static

Factory method to create a platform and backend-specific ImGuiRenderer instance.

Parameters
renderPassRenderPass reference for ImGui's rendering setup.
Returns
Scope-managed instance of ImGuiRenderer.

◆ End()

virtual void Raven::ImGuiRenderer::End ( )
pure virtual

Ends the current ImGui frame and submits draw commands to the GPU.

Implemented in Raven::VulkanImGuiRenderer.

◆ Init()

virtual void Raven::ImGuiRenderer::Init ( )
pure virtual

Initializes ImGui rendering resources and context.

Implemented in Raven::VulkanImGuiRenderer.

◆ Shutdown()

virtual void Raven::ImGuiRenderer::Shutdown ( )
pure virtual

Cleans up ImGui resources and shuts down the renderer.

Implemented in Raven::VulkanImGuiRenderer.


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