unravel::rendering_system Class Reference

Base class for different rendering paths in the ACE framework. More...

#include <rendering_system.h>

Public Member Functions
	rendering_system ()=default
	~rendering_system ()=default
auto	init (rtti::context &ctx) -> bool
	Initializes the rendering path with the given context.
auto	deinit (rtti::context &ctx) -> bool
	Deinitializes the rendering path with the given context.
void	on_frame_end (rtti::context &ctx, delta_t)
void	on_frame_update (scene &scn, delta_t dt)
	Prepares the scene for rendering.
void	on_frame_before_render (scene &scn, delta_t dt)
void	on_play_begin (hpp::span< const entt::handle > entities, delta_t dt)
auto	render_scene (scene &scn, delta_t dt) -> gfx::frame_buffer::ptr
	Renders the scene and returns the frame buffer.
void	render_scene (const gfx::frame_buffer::ptr &output, scene &scn, delta_t dt)
	Renders the scene to the specified output.
auto	render_scene (entt::handle camera_ent, camera_component &comp, scene &scn, delta_t dt) -> gfx::frame_buffer::ptr
	Renders the scene and returns the frame buffer.
void	render_scene (const gfx::frame_buffer::ptr &output, entt::handle camera_ent, camera_component &comp, scene &scn, delta_t dt)
	Renders the scene to the specified output.
void	add_debugdraw_call (const std::function< void(gfx::dd_raii &dd)> &callback)

Detailed Description

Base class for different rendering paths in the ACE framework.

Definition at line 23 of file rendering_system.h.

Constructor & Destructor Documentation

rendering_system()

unravel::rendering_system::rendering_system ( )

default

~rendering_system()

unravel::rendering_system::~rendering_system ( )

default

Member Function Documentation

add_debugdraw_call()

void unravel::rendering_system::add_debugdraw_call

(

const std::function< void(gfx::dd_raii &dd)> &

callback

)

Definition at line 159 of file rendering_system.cpp.

deinit()

auto unravel::rendering_system::deinit

(

rtti::context &

ctx

)

-> bool

Deinitializes the rendering path with the given context.

Parameters

ctx	The context to deinitialize.

Returns

True if deinitialization was successful, false otherwise.

Definition at line 34 of file rendering_system.cpp.

init()

auto unravel::rendering_system::init

(

rtti::context &

ctx

)

-> bool

Initializes the rendering path with the given context.

Parameters

ctx	The context to initialize with.

Returns

True if initialization was successful, false otherwise.

Definition at line 23 of file rendering_system.cpp.

on_frame_before_render()

void unravel::rendering_system::on_frame_before_render	(	scene &	scn,
		delta_t	dt )

Definition at line 56 of file rendering_system.cpp.

on_frame_end()

void unravel::rendering_system::on_frame_end	(	rtti::context &	ctx,
		delta_t	dt )

Definition at line 41 of file rendering_system.cpp.

on_frame_update()

void unravel::rendering_system::on_frame_update	(	scene &	scn,
		delta_t	dt )

Prepares the scene for rendering.

Parameters

scn	The scene to prepare.
dt	The delta time.

Definition at line 46 of file rendering_system.cpp.

on_play_begin()

void unravel::rendering_system::on_play_begin	(	hpp::span< const entt::handle >	entities,
		delta_t	dt )

Definition at line 64 of file rendering_system.cpp.

render_scene() [1/4]

void unravel::rendering_system::render_scene	(	const gfx::frame_buffer::ptr &	output,
		entt::handle	camera_ent,
		camera_component &	comp,
		scene &	scn,
		delta_t	dt )

Renders the scene to the specified output.

Parameters

output	The output frame buffer.
scn	The scene to render.
dt	The delta time.

Definition at line 105 of file rendering_system.cpp.

render_scene() [2/4]

void unravel::rendering_system::render_scene	(	const gfx::frame_buffer::ptr &	output,
		scene &	scn,
		delta_t	dt )

Renders the scene to the specified output.

Parameters

output	The output frame buffer.
scn	The scene to render.
dt	The delta time.

Definition at line 122 of file rendering_system.cpp.

render_scene() [3/4]

auto unravel::rendering_system::render_scene	(	entt::handle	camera_ent,
		camera_component &	comp,
		scene &	scn,
		delta_t	dt ) -> gfx::frame_buffer::ptr

Renders the scene and returns the frame buffer.

Parameters

scn	The scene to render.
dt	The delta time.

Returns

A shared pointer to the frame buffer containing the rendered scene.

Definition at line 74 of file rendering_system.cpp.

render_scene() [4/4]

auto unravel::rendering_system::render_scene	(	scene &	scn,
		delta_t	dt ) -> gfx::frame_buffer::ptr

Renders the scene and returns the frame buffer.

Parameters

scn	The scene to render.
dt	The delta time.

Returns

A shared pointer to the frame buffer containing the rendered scene.

Definition at line 91 of file rendering_system.cpp.

---

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

• C:/Workspace/github/UnravelEngine/UnravelEngine/engine/engine/rendering/ecs/systems/rendering_system.h
• C:/Workspace/github/UnravelEngine/UnravelEngine/engine/engine/rendering/ecs/systems/rendering_system.cpp