File diff r24596:eddf98238034 → r24597:afde5721a3b6
src/framerate_gui.cpp
Show inline comments
 
@@ -67,36 +67,36 @@ namespace {
 
		 * The rate is used for highlighting slow-running elements in the GUI.
 
		 */
 
		explicit PerformanceData(double expected_rate) : expected_rate(expected_rate), next_index(0), prev_index(0), num_valid(0) { }
 

	
 
		/** Collect a complete measurement, given start and ending times for a processing block */
 
		void Add(TimingMeasurement start_time, TimingMeasurement end_time)
 
		{
 
			this->durations[this->next_index] = end_time - start_time;
 
			this->timestamps[this->next_index] = start_time;
 
			this->prev_index = this->next_index;
 
			this->next_index += 1;
 
			if (this->next_index >= NUM_FRAMERATE_POINTS) this->next_index = 0;
 
			this->num_valid = min(NUM_FRAMERATE_POINTS, this->num_valid + 1);
 
			this->num_valid = std::min(NUM_FRAMERATE_POINTS, this->num_valid + 1);
 
		}
 

	
 
		/** Begin an accumulation of multiple measurements into a single value, from a given start time */
 
		void BeginAccumulate(TimingMeasurement start_time)
 
		{
 
			this->timestamps[this->next_index] = this->acc_timestamp;
 
			this->durations[this->next_index] = this->acc_duration;
 
			this->prev_index = this->next_index;
 
			this->next_index += 1;
 
			if (this->next_index >= NUM_FRAMERATE_POINTS) this->next_index = 0;
 
			this->num_valid = min(NUM_FRAMERATE_POINTS, this->num_valid + 1);
 
			this->num_valid = std::min(NUM_FRAMERATE_POINTS, this->num_valid + 1);
 

	
 
			this->acc_duration = 0;
 
			this->acc_timestamp = start_time;
 
		}
 

	
 
		/** Accumulate a period onto the current measurement */
 
		void AddAccumulate(TimingMeasurement duration)
 
		{
 
			this->acc_duration += duration;
 
		}
 

	
 
		/** Indicate a pause/expected discontinuity in processing the element */
 
@@ -106,25 +106,25 @@ namespace {
 
				this->timestamps[this->next_index] = start_time;
 
				this->durations[this->next_index] = INVALID_DURATION;
 
				this->prev_index = this->next_index;
 
				this->next_index += 1;
 
				if (this->next_index >= NUM_FRAMERATE_POINTS) this->next_index = 0;
 
				this->num_valid += 1;
 
			}
 
		}
 

	
 
		/** Get average cycle processing time over a number of data points */
 
		double GetAverageDurationMilliseconds(int count)
 
		{
 
			count = min(count, this->num_valid);
 
			count = std::min(count, this->num_valid);
 

	
 
			int first_point = this->prev_index - count;
 
			if (first_point < 0) first_point += NUM_FRAMERATE_POINTS;
 

	
 
			/* Sum durations, skipping invalid points */
 
			double sumtime = 0;
 
			for (int i = first_point; i < first_point + count; i++) {
 
				auto d = this->durations[i % NUM_FRAMERATE_POINTS];
 
				if (d != INVALID_DURATION) {
 
					sumtime += d;
 
				} else {
 
					/* Don't count the invalid durations */
 
@@ -386,65 +386,65 @@ struct FramerateWindow : Window {
 
	GUITimer next_update;
 
	int num_active;
 
	int num_displayed;
 

	
 
	struct CachedDecimal {
 
		StringID strid;
 
		uint32 value;
 

	
 
		inline void SetRate(double value, double target)
 
		{
 
			const double threshold_good = target * 0.95;
 
			const double threshold_bad = target * 2 / 3;
 
			value = min(9999.99, value);
 
			value = std::min(9999.99, value);
 
			this->value = (uint32)(value * 100);
 
			this->strid = (value > threshold_good) ? STR_FRAMERATE_FPS_GOOD : (value < threshold_bad) ? STR_FRAMERATE_FPS_BAD : STR_FRAMERATE_FPS_WARN;
 
		}
 

	
 
		inline void SetTime(double value, double target)
 
		{
 
			const double threshold_good = target / 3;
 
			const double threshold_bad = target;
 
			value = min(9999.99, value);
 
			value = std::min(9999.99, value);
 
			this->value = (uint32)(value * 100);
 
			this->strid = (value < threshold_good) ? STR_FRAMERATE_MS_GOOD : (value > threshold_bad) ? STR_FRAMERATE_MS_BAD : STR_FRAMERATE_MS_WARN;
 
		}
 

	
 
		inline void InsertDParams(uint n) const
 
		{
 
			SetDParam(n, this->value);
 
			SetDParam(n + 1, 2);
 
		}
 
	};
 

	
 
	CachedDecimal rate_gameloop;            ///< cached game loop tick rate
 
	CachedDecimal rate_drawing;             ///< cached drawing frame rate
 
	CachedDecimal speed_gameloop;           ///< cached game loop speed factor
 
	CachedDecimal times_shortterm[PFE_MAX]; ///< cached short term average times
 
	CachedDecimal times_longterm[PFE_MAX];  ///< cached long term average times
 

	
 
	static const int VSPACING = 3;          ///< space between column heading and values
 
	static const int MIN_ELEMENTS = 5;      ///< smallest number of elements to display
 
	static constexpr int VSPACING = 3;          ///< space between column heading and values
 
	static constexpr int MIN_ELEMENTS = 5;      ///< smallest number of elements to display
 

	
 
	FramerateWindow(WindowDesc *desc, WindowNumber number) : Window(desc)
 
	{
 
		this->InitNested(number);
 
		this->small = this->IsShaded();
 
		this->showing_memory = true;
 
		this->UpdateData();
 
		this->num_displayed = this->num_active;
 
		this->next_update.SetInterval(100);
 

	
 
		/* Window is always initialised to MIN_ELEMENTS height, resize to contain num_displayed */
 
		ResizeWindow(this, 0, (max(MIN_ELEMENTS, this->num_displayed) - MIN_ELEMENTS) * FONT_HEIGHT_NORMAL);
 
		ResizeWindow(this, 0, (std::max(MIN_ELEMENTS, this->num_displayed) - MIN_ELEMENTS) * FONT_HEIGHT_NORMAL);
 
	}
 

	
 
	void OnRealtimeTick(uint delta_ms) override
 
	{
 
		bool elapsed = this->next_update.Elapsed(delta_ms);
 

	
 
		/* Check if the shaded state has changed, switch caption text if it has */
 
		if (this->small != this->IsShaded()) {
 
			this->small = this->IsShaded();
 
			this->GetWidget<NWidgetLeaf>(WID_FRW_CAPTION)->SetDataTip(this->small ? STR_FRAMERATE_CAPTION_SMALL : STR_FRAMERATE_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS);
 
			elapsed = true;
 
		}
 
@@ -477,25 +477,25 @@ struct FramerateWindow : Window {
 
		}
 

	
 
		if (this->showing_memory != have_script) {
 
			NWidgetStacked *plane = this->GetWidget<NWidgetStacked>(WID_FRW_SEL_MEMORY);
 
			plane->SetDisplayedPlane(have_script ? 0 : SZSP_VERTICAL);
 
			this->showing_memory = have_script;
 
		}
 

	
 
		if (new_active != this->num_active) {
 
			this->num_active = new_active;
 
			Scrollbar *sb = this->GetScrollbar(WID_FRW_SCROLLBAR);
 
			sb->SetCount(this->num_active);
 
			sb->SetCapacity(min(this->num_displayed, this->num_active));
 
			sb->SetCapacity(std::min(this->num_displayed, this->num_active));
 
			this->ReInit();
 
		}
 
	}
 

	
 
	void SetStringParameters(int widget) const override
 
	{
 
		switch (widget) {
 
			case WID_FRW_CAPTION:
 
				/* When the window is shaded, the caption shows game loop rate and speed factor */
 
				if (!this->small) break;
 
				SetDParam(0, this->rate_gameloop.strid);
 
				this->rate_gameloop.InsertDParams(1);
 
@@ -546,37 +546,37 @@ struct FramerateWindow : Window {
 
				resize->width = 0;
 
				resize->height = FONT_HEIGHT_NORMAL;
 
				for (PerformanceElement e : DISPLAY_ORDER_PFE) {
 
					if (_pf_data[e].num_valid == 0) continue;
 
					Dimension line_size;
 
					if (e < PFE_AI0) {
 
						line_size = GetStringBoundingBox(STR_FRAMERATE_GAMELOOP + e);
 
					} else {
 
						SetDParam(0, e - PFE_AI0 + 1);
 
						SetDParamStr(1, GetAIName(e - PFE_AI0));
 
						line_size = GetStringBoundingBox(STR_FRAMERATE_AI);
 
					}
 
					size->width = max(size->width, line_size.width);
 
					size->width = std::max(size->width, line_size.width);
 
				}
 
				break;
 
			}
 

	
 
			case WID_FRW_TIMES_CURRENT:
 
			case WID_FRW_TIMES_AVERAGE:
 
			case WID_FRW_ALLOCSIZE: {
 
				*size = GetStringBoundingBox(STR_FRAMERATE_CURRENT + (widget - WID_FRW_TIMES_CURRENT));
 
				SetDParam(0, 999999);
 
				SetDParam(1, 2);
 
				Dimension item_size = GetStringBoundingBox(STR_FRAMERATE_MS_GOOD);
 
				size->width = max(size->width, item_size.width);
 
				size->width = std::max(size->width, item_size.width);
 
				size->height += FONT_HEIGHT_NORMAL * MIN_ELEMENTS + VSPACING;
 
				resize->width = 0;
 
				resize->height = FONT_HEIGHT_NORMAL;
 
				break;
 
			}
 
		}
 
	}
 

	
 
	/** Render a column of formatted average durations */
 
	void DrawElementTimesColumn(const Rect &r, StringID heading_str, const CachedDecimal *values) const
 
	{
 
		const Scrollbar *sb = this->GetScrollbar(WID_FRW_SCROLLBAR);
 
@@ -760,25 +760,25 @@ struct FrametimeGraphWindow : Window {
 
		}
 
	}
 

	
 
	void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
 
	{
 
		if (widget == WID_FGW_GRAPH) {
 
			SetDParam(0, 100);
 
			Dimension size_ms_label = GetStringBoundingBox(STR_FRAMERATE_GRAPH_MILLISECONDS);
 
			SetDParam(0, 100);
 
			Dimension size_s_label = GetStringBoundingBox(STR_FRAMERATE_GRAPH_SECONDS);
 

	
 
			/* Size graph in height to fit at least 10 vertical labels with space between, or at least 100 pixels */
 
			graph_size.height = max<uint>(100, 10 * (size_ms_label.height + 1));
 
			graph_size.height = std::max(100u, 10 * (size_ms_label.height + 1));
 
			/* Always 2:1 graph area */
 
			graph_size.width = 2 * graph_size.height;
 
			*size = graph_size;
 

	
 
			size->width += size_ms_label.width + 2;
 
			size->height += size_s_label.height + 2;
 
		}
 
	}
 

	
 
	void SelectHorizontalScale(TimingMeasurement range)
 
	{
 
		/* Determine horizontal scale based on period covered by 60 points
 
@@ -971,25 +971,25 @@ struct FrametimeGraphWindow : Window {
 
				points_drawn++;
 
				if (value > peak_value) {
 
					peak_value = value;
 
					peak_point = newpoint;
 
				}
 
			}
 

	
 
			/* If the peak value is significantly larger than the average, mark and label it */
 
			if (points_drawn > 0 && peak_value > TIMESTAMP_PRECISION / 100 && 2 * peak_value > 3 * value_sum / points_drawn) {
 
				TextColour tc_peak = (TextColour)(TC_IS_PALETTE_COLOUR | c_peak);
 
				GfxFillRect(peak_point.x - 1, peak_point.y - 1, peak_point.x + 1, peak_point.y + 1, c_peak);
 
				SetDParam(0, peak_value * 1000 / TIMESTAMP_PRECISION);
 
				int label_y = max(y_max, peak_point.y - FONT_HEIGHT_SMALL);
 
				int label_y = std::max(y_max, peak_point.y - FONT_HEIGHT_SMALL);
 
				if (peak_point.x - x_zero > (int)this->graph_size.width / 2) {
 
					DrawString(x_zero, peak_point.x - 2, label_y, STR_FRAMERATE_GRAPH_MILLISECONDS, tc_peak, SA_RIGHT | SA_FORCE, false, FS_SMALL);
 
				} else {
 
					DrawString(peak_point.x + 2, x_max, label_y, STR_FRAMERATE_GRAPH_MILLISECONDS, tc_peak, SA_LEFT | SA_FORCE, false, FS_SMALL);
 
				}
 
			}
 
		}
 
	}
 
};
 

	
 
static WindowDesc _frametime_graph_window_desc(
 
	WDP_AUTO, "frametime_graph", 140, 90,