Introduce a simple frame rendered statistic

Authored by graesslin on Jul 16 2019, 7:42 PM.


Group Reviewers

One of the main gripes with KWin's composite support over the years is
for me the FPS effect. For developers it doesn't provide useful
information as it triggers constant repaints. This just doesn't match
how KWin actually renders. For users it's also not a good solution as it
shows multiple problems:

  • due to being graphical it influences the measurement
  • it is capped at 100 Hz which is not sufficient for 144 Hz screens
  • it is integrated into the effects system which is not deep enough to

properly measure

While the 100 Hz problem is solvable the general problem remains: the
fps effect is not showing the reality and this is unsolvable. Also we
see that users reference this effect a lot in bug reports and this is to
me a problem.

With this patch I try to address the problem by properly recording the
rendered frames in the compositor. It's kept simple and just puts the
timestamp in a queue with a max size of 5 sec at 144 Hz. In practice
this captures a longer time frame as KWin doesn't render that many

For a start the information is put into support information, but not as
fps. Fps makes IMHO no sense in KWin. So it shows the number of frames
and the duration in msec. A user could calculate the fps from it, but as
said, that's pretty useless. To indicate this an explanation text is

The chosen architecture allows to do more in future. One could for
example extract the framerate of the last second or constantly updating
the fps as a sliding average. The current implementation is inspired by
glxgears which just prints out the number of frames over the last five

Diff Detail

R108 KWin
Lint OK
No Unit Test Coverage
Build Status
Buildable 14155
Build 14173: arc lint + arc unit
graesslin created this revision.Jul 16 2019, 7:42 PM
Restricted Application added a project: KWin. · View Herald TranscriptJul 16 2019, 7:42 PM
Restricted Application added a subscriber: kwin. · View Herald Transcript
graesslin requested review of this revision.Jul 16 2019, 7:42 PM
alexeymin added inline comments.

naming... numberOfFrames()? frameCount()?..

graesslin updated this revision to Diff 62097.Jul 20 2019, 8:05 AM
  • numberFrames -> numberOfFrames
  • added missing copyright header
davidedmundson accepted this revision.Jul 20 2019, 8:11 AM
davidedmundson added a subscriber: davidedmundson.

As you say, the metric is somewhat useless on it's own.
But it's a nice starting point to doing something more useful. Ship it!

This revision is now accepted and ready to land.Jul 20 2019, 8:11 AM
zzag added a subscriber: zzag.Jul 20 2019, 11:57 AM

Note for ourselves: this needs to be per output in the future.


frameCount is a better candidate because it's shorter.