candlewick::DebugScene Class Reference

Scene for organizing debug entities and render systems. More...

#include <candlewick/core/DebugScene.h>

Public Types
enum	: Uint32 { TRANSFORM_SLOT = 0 }
enum	: Uint32 { COLOR_SLOT = 0 }

Public Member Functions
const Mesh &	getMesh (DebugMeshType type) const
	DebugScene (entt::registry &registry, const RenderContext &renderer)
	DebugScene (const DebugScene &)=delete
DebugScene &	operator= (const DebugScene &)=delete
	DebugScene (DebugScene &&other)
DebugScene &	operator= (DebugScene &&)=delete
const Device &	device () const noexcept
entt::registry &	registry ()
const entt::registry &	registry () const
template<std::derived_from< IDebugSubSystem > T, typename... Args>
T &	addSystem (entt::hashed_string::hash_type name, Args &&...args)
	Add a subsystem (IDebugSubSystem) to the scene.
template<std::derived_from< IDebugSubSystem > T>
T *	getSystem (entt::hashed_string::hash_type name)
	Get a subsystem by key (a hashed string)
template<std::derived_from< IDebugSubSystem > T>
T &	tryGetSystem (entt::hashed_string::hash_type name)
std::tuple< entt::entity, DebugMeshComponent & >	addTriad (const Float3 &scale=Float3::Ones())
	Just the basic 3D triad.
std::tuple< entt::entity, DebugMeshComponent & >	addLineGrid (const Float4 &color=0xE0A236FF_rgbaf)
	Add a basic line grid.
std::tuple< entt::entity, DebugMeshComponent & >	addArrow (const Float4 &color=0xEA2502FF_rgbaf)
	Add an arrow debug entity.
void	update ()
void	render (CommandBuffer &cmdBuf, const Camera &camera) const
void	release ()
	~DebugScene ()

Detailed Description

Scene for organizing debug entities and render systems.

This implements a basic render system for DebugMeshComponent.

This scene and all subsystems are assumed to use the same shaders and pipelines.

Member Enumeration Documentation

anonymous enum

anonymous enum : Uint32

Enumerator
COLOR_SLOT

anonymous enum

anonymous enum : Uint32

Enumerator
TRANSFORM_SLOT

Constructor & Destructor Documentation

DebugScene() [1/3]

candlewick::DebugScene::DebugScene	(	entt::registry &	registry,
		const RenderContext &	renderer )

DebugScene() [2/3]

candlewick::DebugScene::DebugScene ( const DebugScene & )

delete

DebugScene() [3/3]

candlewick::DebugScene::DebugScene

(

DebugScene &&

other

)

~DebugScene()

candlewick::DebugScene::~DebugScene ( )

inline

Member Function Documentation

addArrow()

std::tuple< entt::entity, DebugMeshComponent & > candlewick::DebugScene::addArrow

(

const Float4 &

color = 0xEA2502FF_rgbaf

)

Add an arrow debug entity.

addLineGrid()

std::tuple< entt::entity, DebugMeshComponent & > candlewick::DebugScene::addLineGrid

(

const Float4 &

color = 0xE0A236FF_rgbaf

)

Add a basic line grid.

Parameters

color

Grid color.

addSystem()

template<std::derived_from< IDebugSubSystem > T, typename... Args>

T & candlewick::DebugScene::addSystem ( entt::hashed_string::hash_type name, Args &&... args )

inline

Add a subsystem (IDebugSubSystem) to the scene.

addTriad()

std::tuple< entt::entity, DebugMeshComponent & > candlewick::DebugScene::addTriad

(

const Float3 &

scale = Float3::Ones()

)

Just the basic 3D triad.

device()

const Device & candlewick::DebugScene::device ( ) const

inlinenoexcept

getMesh()

const Mesh & candlewick::DebugScene::getMesh ( DebugMeshType type ) const

inline

getSystem()

template<std::derived_from< IDebugSubSystem > T>

T * candlewick::DebugScene::getSystem ( entt::hashed_string::hash_type name )

inline

Get a subsystem by key (a hashed string)

Template Parameters

T	The concrete derived type.

operator=() [1/2]

DebugScene & candlewick::DebugScene::operator= ( const DebugScene & )

delete

operator=() [2/2]

DebugScene & candlewick::DebugScene::operator= ( DebugScene && )

delete

registry() [1/2]

entt::registry & candlewick::DebugScene::registry ( )

inline

registry() [2/2]

const entt::registry & candlewick::DebugScene::registry ( ) const

inline

release()

void candlewick::DebugScene::release

(

)

render()

void candlewick::DebugScene::render	(	CommandBuffer &	cmdBuf,
		const Camera &	camera ) const

tryGetSystem()

template<std::derived_from< IDebugSubSystem > T>

T & candlewick::DebugScene::tryGetSystem ( entt::hashed_string::hash_type name )

inline

See also

getSystem().

update()

void candlewick::DebugScene::update ( )

inline

---

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

• src/candlewick/core/DebugScene.h