Display: clean up the FPS counter implementation
* Makes it more type-safe by using chrono types more directly. * Fixes a few design issues, such as the current time point being taken multiple times when updating the data. * Fixes min and max FPS times being swapped * Improved display
This commit is contained in:
Charles Dang
parent
fc1409e2d1
commit
05f4e21951
2 changed files with 59 additions and 36 deletions
|
|
@ -55,7 +55,6 @@
|
|||
|
||||
#include <boost/algorithm/string/trim.hpp>
|
||||
|
||||
|
||||
#include <algorithm>
|
||||
#include <array>
|
||||
#include <cmath>
|
||||
|
|
@ -63,6 +62,10 @@
|
|||
#include <numeric>
|
||||
#include <utility>
|
||||
|
||||
#ifdef __cpp_lib_format
|
||||
#include <format>
|
||||
#endif
|
||||
|
||||
#ifdef _WIN32
|
||||
#include <windows.h>
|
||||
#endif
|
||||
|
|
@ -1302,36 +1305,44 @@ void display::drawing_buffer_commit()
|
|||
drawing_buffer_.clear();
|
||||
}
|
||||
|
||||
// frametime is in milliseconds
|
||||
static unsigned calculate_fps(unsigned frametime)
|
||||
static unsigned calculate_fps(std::chrono::milliseconds frametime)
|
||||
{
|
||||
return frametime != 0u ? 1000u / frametime : 999u;
|
||||
using namespace std::chrono_literals;
|
||||
return frametime > 0ms ? 1s / frametime : 999u;
|
||||
}
|
||||
|
||||
void display::update_fps_label()
|
||||
{
|
||||
++current_frame_sample_;
|
||||
const int sample_freq = 10;
|
||||
constexpr int sample_freq = 10;
|
||||
|
||||
if(current_frame_sample_ != sample_freq) {
|
||||
return;
|
||||
} else {
|
||||
current_frame_sample_ = 0;
|
||||
}
|
||||
|
||||
const auto minmax_it = std::minmax_element(frametimes_.begin(), frametimes_.end());
|
||||
const unsigned render_avg = std::accumulate(frametimes_.begin(), frametimes_.end(), 0) / frametimes_.size();
|
||||
const auto [min_iter, max_iter] = std::minmax_element(frametimes_.begin(), frametimes_.end());
|
||||
|
||||
using namespace std::chrono_literals;
|
||||
const std::chrono::milliseconds render_avg = std::accumulate(frametimes_.begin(), frametimes_.end(), 0ms) / frametimes_.size();
|
||||
|
||||
// NOTE: max FPS corresponds to the *shortest* time between frames (that is, min_iter)
|
||||
const int avg_fps = calculate_fps(render_avg);
|
||||
const int max_fps = calculate_fps(*minmax_it.first);
|
||||
const int min_fps = calculate_fps(*minmax_it.second);
|
||||
const int max_fps = calculate_fps(*min_iter);
|
||||
const int min_fps = calculate_fps(*max_iter);
|
||||
|
||||
fps_history_.emplace_back(min_fps, avg_fps, max_fps);
|
||||
current_frame_sample_ = 0;
|
||||
|
||||
// flush out the stored fps values every so often
|
||||
if(fps_history_.size() == 1000) {
|
||||
std::string filename = filesystem::get_user_data_dir()+"/fps_log.csv";
|
||||
filesystem::scoped_ostream fps_log = filesystem::ostream_file(filename, std::ios_base::binary | std::ios_base::app);
|
||||
for(const auto& fps : fps_history_) {
|
||||
*fps_log << std::get<0>(fps) << "," << std::get<1>(fps) << "," << std::get<2>(fps) << "\n";
|
||||
std::string filename = filesystem::get_user_data_dir() + "/fps_log.csv";
|
||||
auto fps_log = filesystem::ostream_file(filename, std::ios_base::binary | std::ios_base::app);
|
||||
|
||||
for(const auto& [min, avg, max] : fps_history_) {
|
||||
*fps_log << min << "," << avg << "," << max << "\n";
|
||||
}
|
||||
|
||||
fps_history_.clear();
|
||||
}
|
||||
|
||||
|
|
@ -1339,23 +1350,35 @@ void display::update_fps_label()
|
|||
font::remove_floating_label(fps_handle_);
|
||||
fps_handle_ = 0;
|
||||
}
|
||||
|
||||
std::ostringstream stream;
|
||||
stream << "<tt> min/avg/max/act</tt>\n";
|
||||
stream << "<tt>FPS: " << std::setfill(' ') << std::setw(3) << min_fps << '/'<< std::setw(3) << avg_fps << '/' << std::setw(3) << max_fps << '/' << std::setw(3) << fps_actual_ << "</tt>\n";
|
||||
stream << "<tt>Time: " << std::setfill(' ') << std::setw(3) << *minmax_it.first << '/' << std::setw(3) << render_avg << '/' << std::setw(3) << *minmax_it.second << " ms</tt>\n";
|
||||
if (game_config::debug) {
|
||||
stream << "\nhex: " << drawn_hexes_*1.0/sample_freq;
|
||||
if (drawn_hexes_ != invalidated_hexes_)
|
||||
stream << " (" << (invalidated_hexes_-drawn_hexes_)*1.0/sample_freq << ")";
|
||||
#ifdef __cpp_lib_format
|
||||
stream << "<tt> " << std::format("{:<5}|{:<5}|{:<5}|{:<5}", "min", "avg", "max", "act") << "</tt>\n";
|
||||
stream << "<tt>FPS: " << std::format("{:<5}|{:<5}|{:<5}|{:<5}", min_fps, avg_fps, max_fps, fps_actual_) << "</tt>\n";
|
||||
stream << "<tt>Time: " << std::format("{:5}|{:5}|{:5}", *max_iter, render_avg, *min_iter) << "</tt>\n";
|
||||
#else
|
||||
stream << "<tt> min |avg |max |act </tt>\n";
|
||||
stream << "<tt>FPS: " << std::left << std::setfill(' ') << std::setw(5) << min_fps << '|' << std::setw(5) << avg_fps << '|' << std::setw(5) << max_fps << '|' << std::setw(5) << fps_actual_ << "</tt>\n";
|
||||
stream << "<tt>Time: " << std::left << std::setfill(' ') << std::setw(5) << max_iter->count() << '|' << std::setw(5) << render_avg.count() << '|' << std::setw(5) << min_iter->count() << "</tt>\n";
|
||||
#endif
|
||||
|
||||
if(game_config::debug) {
|
||||
stream << "\nhex: " << drawn_hexes_ * 1.0 / sample_freq;
|
||||
if(drawn_hexes_ != invalidated_hexes_) {
|
||||
stream << " (" << (invalidated_hexes_ - drawn_hexes_) * 1.0 / sample_freq << ")";
|
||||
}
|
||||
}
|
||||
|
||||
drawn_hexes_ = 0;
|
||||
invalidated_hexes_ = 0;
|
||||
|
||||
font::floating_label flabel(stream.str());
|
||||
flabel.set_font_size(12);
|
||||
flabel.set_font_size(14);
|
||||
flabel.set_color(debug_flag_set(DEBUG_BENCHMARK) ? font::BAD_COLOR : font::NORMAL_COLOR);
|
||||
flabel.set_position(10, 100);
|
||||
flabel.set_alignment(font::LEFT_ALIGN);
|
||||
flabel.set_bg_color({0, 0, 0, float_to_color(0.6)});
|
||||
flabel.set_border_size(5);
|
||||
|
||||
fps_handle_ = font::add_floating_label(flabel);
|
||||
}
|
||||
|
|
@ -1367,6 +1390,7 @@ void display::clear_fps_label()
|
|||
fps_handle_ = 0;
|
||||
drawn_hexes_ = 0;
|
||||
invalidated_hexes_ = 0;
|
||||
last_frame_finished_.reset();
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -1510,24 +1534,23 @@ void display::set_diagnostic(const std::string& msg)
|
|||
|
||||
void display::update_fps_count()
|
||||
{
|
||||
static int time_between_draws = prefs::get().draw_delay();
|
||||
if(time_between_draws < 0) {
|
||||
time_between_draws = 1000 / video::current_refresh_rate();
|
||||
using std::chrono::duration_cast;
|
||||
using std::chrono::steady_clock;
|
||||
|
||||
auto now = steady_clock::now();
|
||||
if(last_frame_finished_) {
|
||||
frametimes_.push_back(duration_cast<std::chrono::milliseconds>(now - *last_frame_finished_));
|
||||
}
|
||||
|
||||
frametimes_.push_back(SDL_GetTicks() - last_frame_finished_);
|
||||
fps_counter_++;
|
||||
using std::chrono::duration_cast;
|
||||
using std::chrono::seconds;
|
||||
using std::chrono::steady_clock;
|
||||
const seconds current_second = duration_cast<seconds>(steady_clock::now().time_since_epoch());
|
||||
last_frame_finished_ = now;
|
||||
++fps_counter_;
|
||||
|
||||
const auto current_second = duration_cast<std::chrono::seconds>(now.time_since_epoch());
|
||||
if(current_second != fps_start_) {
|
||||
fps_start_ = current_second;
|
||||
fps_actual_ = fps_counter_;
|
||||
fps_counter_ = 0;
|
||||
}
|
||||
|
||||
last_frame_finished_ = SDL_GetTicks();
|
||||
}
|
||||
|
||||
const theme::action* display::action_pressed()
|
||||
|
|
@ -2386,8 +2409,8 @@ void display::draw()
|
|||
}
|
||||
|
||||
if(prefs::get().show_fps() || debug_flag_set(DEBUG_BENCHMARK)) {
|
||||
update_fps_label();
|
||||
update_fps_count();
|
||||
update_fps_label();
|
||||
} else if(fps_handle_ != 0) {
|
||||
clear_fps_label();
|
||||
}
|
||||
|
|
|
|||
|
|
@ -761,12 +761,12 @@ protected:
|
|||
/** Event raised when the map is being scrolled */
|
||||
mutable events::generic_event scroll_event_;
|
||||
|
||||
boost::circular_buffer<unsigned> frametimes_; // in milliseconds
|
||||
boost::circular_buffer<std::chrono::milliseconds> frametimes_;
|
||||
int current_frame_sample_ = 0;
|
||||
unsigned int fps_counter_;
|
||||
std::chrono::seconds fps_start_;
|
||||
unsigned int fps_actual_;
|
||||
uint32_t last_frame_finished_ = 0u;
|
||||
utils::optional<std::chrono::steady_clock::time_point> last_frame_finished_ = {};
|
||||
|
||||
// Not set by the initializer:
|
||||
std::map<std::string, rect> reportLocations_;
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue