gui2::tracked_drawable Class Reference

Middleware class that tracks framerate and times. More...

#include <tracked_drawable.hpp>

Inheritance diagram for gui2::tracked_drawable:

Classes
struct	frame_info

Public Member Functions
	tracked_drawable ()
auto	get_info () const -> utils::optional< frame_info >
	Returns the current frame time and info, or nullopt if no times have been recorded. More...

Protected Member Functions
	~tracked_drawable ()
void	update_count ()
	Records time since last invocation. More...

Private Types
using	clock = std::chrono::steady_clock
using	times = std::tuple< clock::duration, clock::duration, clock::duration >

Private Member Functions
void	process () override
	Inherited from events::pump_monitor. More...
auto	get_times () const -> times
	Get min, average, and max frametimes in steady_clock resolution. More...
Private Member Functions inherited from events::pump_monitor
	pump_monitor ()
virtual	~pump_monitor ()

Private Attributes
boost::circular_buffer< clock::duration >	frametimes_
unsigned	render_count_
unsigned	render_counter_
clock::time_point	last_lap_
clock::time_point	last_render_

Detailed Description

Middleware class that tracks framerate and times.

It should be used in conjunction with classes that implement top_level_drawable. Strictly, it will measure the between invocations of update_count, which should be invoked from the render function.

Definition at line 34 of file tracked_drawable.hpp.

Member Typedef Documentation

clock

using gui2::tracked_drawable::clock = std::chrono::steady_clock

private

Definition at line 64 of file tracked_drawable.hpp.

times

using gui2::tracked_drawable::times = std::tuple<clock::duration, clock::duration, clock::duration>

private

Definition at line 65 of file tracked_drawable.hpp.

Constructor & Destructor Documentation

tracked_drawable()

gui2::tracked_drawable::tracked_drawable

(

)

Definition at line 28 of file tracked_drawable.cpp.

~tracked_drawable()

gui2::tracked_drawable::~tracked_drawable ( )

protected

Definition at line 37 of file tracked_drawable.cpp.

References gui2::dialogs::fps::hide().

Member Function Documentation

get_info()

auto gui2::tracked_drawable::get_info

(

)

const -> utils::optional<frame_info>

Returns the current frame time and info, or nullopt if no times have been recorded.

Definition at line 54 of file tracked_drawable.cpp.

References frametimes_, get_times(), render_count_, and s.

get_times()

auto gui2::tracked_drawable::get_times ( ) const -> times

private

Get min, average, and max frametimes in steady_clock resolution.

Definition at line 76 of file tracked_drawable.cpp.

References frametimes_.

Referenced by get_info().

process()

void gui2::tracked_drawable::process ( )

overrideprivatevirtual

Inherited from events::pump_monitor.

Implements events::pump_monitor.

Definition at line 45 of file tracked_drawable.cpp.

References prefs::get(), gui2::dialogs::fps::hide(), and gui2::dialogs::fps::show().

update_count()

void gui2::tracked_drawable::update_count ( )

protected

Records time since last invocation.

Definition at line 87 of file tracked_drawable.cpp.

References frametimes_, last_lap_, last_render_, render_count_, render_counter_, and s.

Member Data Documentation

frametimes_

boost::circular_buffer<clock::duration> gui2::tracked_drawable::frametimes_

private

Definition at line 70 of file tracked_drawable.hpp.

Referenced by get_info(), get_times(), and update_count().

last_lap_

clock::time_point gui2::tracked_drawable::last_lap_

private

Definition at line 75 of file tracked_drawable.hpp.

Referenced by update_count().

last_render_

clock::time_point gui2::tracked_drawable::last_render_

private

Definition at line 76 of file tracked_drawable.hpp.

Referenced by update_count().

render_count_

unsigned gui2::tracked_drawable::render_count_

private

Definition at line 72 of file tracked_drawable.hpp.

Referenced by get_info(), and update_count().

render_counter_

unsigned gui2::tracked_drawable::render_counter_

private

Definition at line 73 of file tracked_drawable.hpp.

Referenced by update_count().

---

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

• gui/core/tracked_drawable.hpp
• gui/core/tracked_drawable.cpp