EngineDiagnostics Class Reference

#include "steam/engine/engine-diagnostics.hpp"

Description

Render engine diagnostic facility.

Creating an instance will activate additional tracing facilities within the render engine; results may be investigated through EngineDiagnostics public functions. The object acts like a smart handle, i.e. the tracing facilities will be disabled and disconnected when going out of scope.

Warning

not reentrant, no reference-counting. At any given time, at most a single instance of EngineDiagnostics may be used.

Definition at line 72 of file engine-diagnostics.hpp.

Public Member Functions
	EngineDiagnostics (EngineService &e)
	~EngineDiagnostics ()
bool	has_scheduled_jobs_for (Timings const &timings)

Private Attributes
EngineService &	engine_

Additional Inherited Members
Private Member Functions inherited from NonCopyable
	~NonCopyable ()=default
	NonCopyable ()=default
	NonCopyable (NonCopyable const &)=delete
NonCopyable &	operator= (NonCopyable const &)=delete

Constructor & Destructor Documentation

EngineDiagnostics()

EngineDiagnostics ( EngineService &  e )

inline

Definition at line 78 of file engine-diagnostics.hpp.

References EngineService::activateTracing(), and EngineDiagnostics::engine_.

Here is the call graph for this function:

~EngineDiagnostics()

~EngineDiagnostics ( )

inline

Definition at line 85 of file engine-diagnostics.hpp.

References EngineService::disableTracing(), and EngineDiagnostics::engine_.

Here is the call graph for this function:

Member Function Documentation

has_scheduled_jobs_for()

bool has_scheduled_jobs_for ( Timings const &  timings )

inline

Definition at line 93 of file engine-diagnostics.hpp.

Referenced by EngineInterface_test::run().

Here is the caller graph for this function:

Member Data Documentation

engine_

EngineService& engine_

private

Definition at line 75 of file engine-diagnostics.hpp.

Referenced by EngineDiagnostics::EngineDiagnostics(), and EngineDiagnostics::~EngineDiagnostics().

Inheritance diagram for EngineDiagnostics:

Collaboration diagram for EngineDiagnostics:

---

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

• engine-diagnostics.hpp