NewGRFProfiler Struct Reference

Callback profiler for NewGRF development. More...

#include <newgrf_profiling.h>

Data Structures
struct	Call
	Measurement of a single sprite group resolution. More...

Public Member Functions
	NewGRFProfiler (const GRFFile *grffile)
	Create profiler object and begin profiling session. More...
	~NewGRFProfiler ()
	Complete profiling session and write data to file.
void	BeginResolve (const ResolverObject &resolver)
	Capture the start of a sprite group resolution. More...
void	EndResolve (const SpriteGroup *result)
	Capture the completion of a sprite group resolution.
void	RecursiveResolve ()
	Capture a recursive sprite group resolution.
void	Start ()
uint32_t	Finish ()
void	Abort ()
std::string	GetOutputFilename () const
	Get name of the file that will be written. More...

Static Public Member Functions
static void	StartTimer (uint64_t ticks)
	Start the timeout timer that will finish all profiling sessions.
static void	AbortTimer ()
	Abort the timeout timer, so the timer callback is never called.
static uint32_t	FinishAll ()

Data Fields
const GRFFile *	grffile
	Which GRF is being profiled.
bool	active
	Is this profiler collecting data.
uint64_t	start_tick
	Tick number this profiler was started on.
Call	cur_call
	Data for current call in progress.
std::vector< Call >	calls
	All calls collected so far.

Detailed Description

Callback profiler for NewGRF development.

Definition at line 23 of file newgrf_profiling.h.

Constructor & Destructor Documentation

NewGRFProfiler()

NewGRFProfiler::NewGRFProfiler

(

const GRFFile *

grffile

)

Create profiler object and begin profiling session.

Parameters

grffile	The GRF file to collect profiling data on
end_date	Game date to end profiling on

Definition at line 30 of file newgrf_profiling.cpp.

References grffile.

Member Function Documentation

BeginResolve()

void NewGRFProfiler::BeginResolve

(

const ResolverObject &

resolver

)

Capture the start of a sprite group resolution.

Parameters

resolver

Data about sprite group being resolved

Definition at line 45 of file newgrf_profiling.cpp.

References ResolverObject::callback, NewGRFProfiler::Call::cb, TimerGameTick::counter, cur_call, NewGRFProfiler::Call::feat, ResolverObject::GetDebugID(), ResolverObject::GetFeature(), NewGRFProfiler::Call::item, NewGRFProfiler::Call::root_sprite, ResolverObject::root_spritegroup, NewGRFProfiler::Call::subs, NewGRFProfiler::Call::tick, and NewGRFProfiler::Call::time.

GetOutputFilename()

std::string NewGRFProfiler::GetOutputFilename

(

)

const

Get name of the file that will be written.

Returns

File name of profiling output file.

Definition at line 132 of file newgrf_profiling.cpp.

References BSWAP32(), FiosGetScreenshotDir(), and grffile.

---

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

• src/newgrf_profiling.h
• src/newgrf_profiling.cpp