SimpleExample Class Reference

#include <SimpleExample.h>

Inheritance diagram for SimpleExample:

Private Member Functions
bool	Init () override
	Initializes the example.
bool	Update () override
	Updates the example.
bool	Draw () override
	Renders the example.
void	Quit () override
	Cleans up resources.
const std::string &	getName () override

Private Attributes
std::string	name = "SimpleExample"

Additional Inherited Members
Public Member Functions inherited from Common::BaseProject
virtual	~BaseProject ()=default
Static Public Attributes inherited from Common::BaseProject
static bool	hasUI = false

Member Function Documentation

Draw()

bool SimpleExample::Draw ( )

overrideprivatevirtual

Renders the example.

This function is called every frame after updating. It handles all the rendering operations, including acquiring a GPU command buffer, clearing the screen, and submitting the frame to the GPU.

Parameters

context

Reference to the global Context object.

Returns

true if rendering succeeds, false otherwise.

Exceptions

SDL_Exception

if an SDL operation fails.

Implements Common::BaseProject.

getName()

const std::string & SimpleExample::getName ( )

inlinenodiscardoverrideprivatevirtual

Implements Common::BaseProject.

Init()

bool SimpleExample::Init ( )

overrideprivatevirtual

Initializes the example.

This function runs once at the start and is used to set up the necessary resources.

Parameters

context

Reference to the global Context object.

Returns

true if initialization succeeds, false otherwise.

Exceptions

SDL_Exception

if an SDL operation fails.

Implements Common::BaseProject.

Quit()

void SimpleExample::Quit ( )

overrideprivatevirtual

Cleans up resources.

This function is called once during shutdown. It is used to free any allocated resources, close files, and perform necessary cleanup.

Parameters

context

Reference to the global Context object.

Exceptions

SDL_Exception

if an SDL operation fails.

Implements Common::BaseProject.

Update()

bool SimpleExample::Update ( )

overrideprivatevirtual

Updates the example.

This function is called every frame before rendering. It is typically used to update game logic, process input, and prepare data for rendering.

Parameters

context

Reference to the global Context object.

Returns

true if the update succeeds, false otherwise.

Exceptions

SDL_Exception

if an SDL operation fails.

Implements Common::BaseProject.

Member Data Documentation

name

std::string SimpleExample::name = "SimpleExample"

private

---

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

• /Users/runner/work/Garage/Garage/src/Projects/SimpleExample/SimpleExample.h
• /Users/runner/work/Garage/Garage/src/Projects/SimpleExample/SimpleExample.cpp