framerate_gui.cpp File Reference

GUI for displaying framerate/game speed information. More...

#include "stdafx.h"
#include "framerate_type.h"
#include <chrono>
#include "gfx_func.h"
#include "newgrf_sound.h"
#include "window_gui.h"
#include "window_func.h"
#include "string_func.h"
#include "strings_func.h"
#include "console_func.h"
#include "console_type.h"
#include "company_base.h"
#include "ai/ai_info.hpp"
#include "ai/ai_instance.hpp"
#include "game/game.hpp"
#include "game/game_instance.hpp"
#include "timer/timer.h"
#include "timer/timer_window.h"
#include "zoom_func.h"
#include "widgets/framerate_widget.h"
#include <atomic>
#include <mutex>
#include "table/strings.h"
#include "safeguards.h"

Go to the source code of this file.

Data Structures
struct	anonymous_namespace{framerate_gui.cpp}::PerformanceData
struct	FramerateWindow
struct	FramerateWindow::CachedDecimal
struct	FrametimeGraphWindow

Namespaces
namespace	anonymous_namespace{framerate_gui.cpp}
	Private declarations for performance measurement implementation.

Functions
static TimingMeasurement	GetPerformanceTimer ()
	Return a timestamp with TIMESTAMP_PRECISION ticks per second precision.
void	ShowFrametimeGraphWindow (PerformanceElement elem)
	Open a graph window for a performance element.
static std::string_view	GetAIName (int ai_index)
void	ShowFramerateWindow ()
	Open the general framerate window.
void	ConPrintFramerate ()
	Print performance statistics to game console.
void	ProcessPendingPerformanceMeasurements ()
	This drains the PFE_SOUND measurement data queue into _pf_data.

Variables
static std::mutex	_sound_perf_lock
static std::atomic< bool >	_sound_perf_pending
static std::vector< TimingMeasurement >	_sound_perf_measurements
const int	anonymous_namespace{framerate_gui.cpp}::NUM_FRAMERATE_POINTS = 512
	Number of data points to keep in buffer for each performance measurement.
const TimingMeasurement	anonymous_namespace{framerate_gui.cpp}::TIMESTAMP_PRECISION = 1000000
	Units a second is divided into in performance measurements
static const double	anonymous_namespace{framerate_gui.cpp}::GL_RATE = 1000.0 / MILLISECONDS_PER_TICK
	Game loop rate, cycles per second
PerformanceData	anonymous_namespace{framerate_gui.cpp}::_pf_data [PFE_MAX]
	Storage for all performance element measurements.
static const PerformanceElement	DISPLAY_ORDER_PFE [PFE_MAX]
static constexpr std::initializer_list< NWidgetPart >	_framerate_window_widgets
static WindowDesc	_framerate_display_desc (WindowPosition::Automatic, "framerate_display", 0, 0, WC_FRAMERATE_DISPLAY, WC_NONE, {}, _framerate_window_widgets)
	Window definition for the frame rate window.
static constexpr std::initializer_list< NWidgetPart >	_frametime_graph_window_widgets
static WindowDesc	_frametime_graph_window_desc (WindowPosition::Automatic, "frametime_graph", 140, 90, WC_FRAMETIME_GRAPH, WC_NONE, {}, _frametime_graph_window_widgets)
	Window definition for the frame rate graph window.

Detailed Description

GUI for displaying framerate/game speed information.

Definition in file framerate_gui.cpp.

Function Documentation

ConPrintFramerate()

void ConPrintFramerate

(

)

Print performance statistics to game console.

Definition at line 1045 of file framerate_gui.cpp.

References anonymous_namespace{framerate_gui.cpp}::_pf_data, CC_ERROR, IConsolePrint(), anonymous_namespace{framerate_gui.cpp}::NUM_FRAMERATE_POINTS, PFE_AI0, PFE_DRAWING, PFE_GAMELOOP, PFE_MAX, and PFE_VIDEO.

Referenced by ConFramerate().

GetAIName()

std::string_view GetAIName ( int ai_index )

static

Definition at line 401 of file framerate_gui.cpp.

GetPerformanceTimer()

TimingMeasurement GetPerformanceTimer ( )

static

Return a timestamp with TIMESTAMP_PRECISION ticks per second precision.

The basis of the timestamp is implementation defined, but the value should be steady, so differences can be taken to reliably measure intervals.

Returns

The current 'time' for performance measurements.

Definition at line 258 of file framerate_gui.cpp.

Referenced by PerformanceMeasurer::Paused(), PerformanceAccumulator::PerformanceAccumulator(), PerformanceMeasurer::PerformanceMeasurer(), PerformanceAccumulator::Reset(), PerformanceAccumulator::~PerformanceAccumulator(), and PerformanceMeasurer::~PerformanceMeasurer().

ProcessPendingPerformanceMeasurements()

void ProcessPendingPerformanceMeasurements

(

)

This drains the PFE_SOUND measurement data queue into _pf_data.

PFE_SOUND measurements are made by the mixer thread and so cannot be stored into _pf_data directly, because this would not be thread safe and would violate the invariants of the FPS and frame graph windows.

See also

PerformanceMeasurement::~PerformanceMeasurement()

Definition at line 1113 of file framerate_gui.cpp.

References anonymous_namespace{framerate_gui.cpp}::_pf_data, anonymous_namespace{framerate_gui.cpp}::PerformanceData::Add(), and PFE_SOUND.

Referenced by UpdateWindows().

ShowFramerateWindow()

void ShowFramerateWindow

(

)

Open the general framerate window.

Definition at line 1029 of file framerate_gui.cpp.

References _framerate_display_desc, and AllocateWindowDescFront().

Referenced by ConFramerateWindow(), and MenuClickHelp().

ShowFrametimeGraphWindow()

void ShowFrametimeGraphWindow

(

PerformanceElement

elem

)

Open a graph window for a performance element.

Parameters

elem	The element to show the graph for.

Definition at line 1038 of file framerate_gui.cpp.

References _frametime_graph_window_desc, AllocateWindowDescFront(), and PFE_MAX.

Referenced by FramerateWindow::OnClick().

Variable Documentation

_framerate_window_widgets

std::initializer_list<NWidgetPart> _framerate_window_widgets

staticconstexpr

Definition at line 408 of file framerate_gui.cpp.

_frametime_graph_window_widgets

std::initializer_list<NWidgetPart> _frametime_graph_window_widgets

staticconstexpr

Definition at line 732 of file framerate_gui.cpp.

_sound_perf_lock

std::mutex _sound_perf_lock

static

Definition at line 40 of file framerate_gui.cpp.

_sound_perf_measurements

std::vector<TimingMeasurement> _sound_perf_measurements

static

Definition at line 42 of file framerate_gui.cpp.

_sound_perf_pending

std::atomic<bool> _sound_perf_pending

static

Definition at line 41 of file framerate_gui.cpp.

DISPLAY_ORDER_PFE

const PerformanceElement DISPLAY_ORDER_PFE[PFE_MAX]

static

Definition at line 369 of file framerate_gui.cpp.