Karma::KarmaGuiLayer Class Reference

Inheritance diagram for Karma::KarmaGuiLayer:

Collaboration diagram for Karma::KarmaGuiLayer:

Public Member Functions
	KarmaGuiLayer (Window *relevantWindow)
virtual void	OnAttach () override
	A function called on Layer when the Layer is pushed or OverLay is pushed.
virtual void	OnDetach () override
	A function called on Layer when the LayerStack is destroyed.
virtual void	KarmaGuiRender (float deltaTime) override
	Function called in each game loop, specifically for rendering purposes.
virtual void	OnUpdate (float deltaTime) override
	Function called in each game loop.
void	Begin ()
void	End ()
virtual void	OnEvent (Event &event) override
	For dispatching Events specific to the Layer.
void	CreateDescriptorPool ()
void	GiveLoopBeginControlToVulkan ()
void	FrameRender (KarmaGui_ImplVulkanH_Window *windowData, KGDrawData *drawData)
void	FramePresent (KarmaGui_ImplVulkanH_Window *windowData)
void	GiveLoopEndControlToVulkan ()
void	GracefulVulkanShutDown ()
void	CleanUpVulkanAndWindowData ()
Public Member Functions inherited from Karma::Layer
	Layer (const std::string &name="Layer")
	A constructor.
virtual	~Layer ()
	A destructor.
const std::string &	GetName () const
	Getter for the name of the Layer (debugging purposes).

Additional Inherited Members
Protected Attributes inherited from Karma::Layer
std::string	m_DebugName

Member Function Documentation

KarmaGuiRender()

void Karma::KarmaGuiLayer::KarmaGuiRender ( float deltaTime )

overridevirtual

Function called in each game loop, specifically for rendering purposes.

This is part of KarmaGui rendering sequence, thus different from OnUpdate().

See also

Application::Run()

Since

Karma 1.0.0

Implements Karma::Layer.

OnAttach()

void Karma::KarmaGuiLayer::OnAttach ( )

overridevirtual

A function called on Layer when the Layer is pushed or OverLay is pushed.

See also

Application::PushLayer, Application::PushOverlay

Since

Karma 1.0.0

Implements Karma::Layer.

OnDetach()

void Karma::KarmaGuiLayer::OnDetach ( )

overridevirtual

A function called on Layer when the LayerStack is destroyed.

See also

LayerStack::~LayerStack()

Since

Karma 1.0.0

Implements Karma::Layer.

OnEvent()

void Karma::KarmaGuiLayer::OnEvent ( Event & event )

overridevirtual

For dispatching Events specific to the Layer.

Note

GLFW calls the Application::OnEvent which further calls the OnEvent function in the subsequent layers and, depending on m_Handled, the depth of the call chain (measured in the sense of for-loop, upon the ordered layers) is determined.

Since

Karma 1.0.0

Reimplemented from Karma::Layer.

OnUpdate()

void Karma::KarmaGuiLayer::OnUpdate ( float deltaTime )

overridevirtual

Function called in each game loop.

Parameters

deltaTime

The time step (or interval) gap between two consecutive calls (previous single loop iteration time)

See also

Application::Run()

Since

Karma 1.0.0

Implements Karma::Layer.

---

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

• Karma/src/Karma/KarmaGui/KarmaGuiLayer.h
• Karma/src/Karma/KarmaGui/KarmaGuiLayer.cpp