KisFpsDecoration Class Reference

#include <kis_fps_decoration.h>

Inheritance diagram for KisFpsDecoration:

Public Member Functions
void	drawDecoration (QPainter &gc, const QRectF &updateRect, const KisCoordinatesConverter *converter, KisCanvas2 *canvas) override
	KisFpsDecoration (QPointer< KisView > view)
	~KisFpsDecoration () override
Public Member Functions inherited from KisCanvasDecoration
const QString &	id () const
	KisCanvasDecoration (const QString &id, QPointer< KisView >parent)
virtual void	notifyWindowMinimized (bool minimized)
void	paint (QPainter &gc, const QRectF &updateRect, const KisCoordinatesConverter *converter, KisCanvas2 *canvas)
int	priority () const
void	setView (QPointer< KisView > imageView)
bool	visible () const
	~KisCanvasDecoration () override
Public Member Functions inherited from KisShared
bool	deref ()
bool	ref ()
int	refCount ()
QAtomicInt *	sharedWeakReference ()

Static Public Attributes
static const QString	idTag = "fps_decoration"

Private Member Functions
bool	draw (const QString &text, QSize &outSize)
QString	getText () const

Private Attributes
QFont	m_font
QPixmap	m_pixmap
QGraphicsPixmapItem *	m_pixmapItem
QGraphicsScene *	m_scene
QGraphicsDropShadowEffect *	m_shadow

Additional Inherited Members
Public Slots inherited from KisCanvasDecoration
virtual void	setVisible (bool v)
void	toggleVisibility ()
Static Public Member Functions inherited from KisCanvasDecoration
static bool	comparePriority (KisCanvasDecorationSP decoration1, KisCanvasDecorationSP decoration2)
Protected Member Functions inherited from KisCanvasDecoration
int	decorationThickness () const
void	setPriority (int value)
QPointer< KisView >	view () const
Protected Member Functions inherited from KisShared
	KisShared ()
	~KisShared ()

Detailed Description

Definition at line 18 of file kis_fps_decoration.h.

Constructor & Destructor Documentation

KisFpsDecoration()

KisFpsDecoration::KisFpsDecoration

(

QPointer< KisView >

view

)

Definition at line 21 of file kis_fps_decoration.cpp.

    : KisCanvasDecoration(idTag, view)
    , m_font(QApplication::font())
    , m_pixmap(1, 1) // need non-zero pixmap for initial setup
{
    setVisible(true);
 
    m_shadow = new QGraphicsDropShadowEffect(this);
    m_shadow->setBlurRadius(0.5);
    m_shadow->setOffset(0);
    m_shadow->setColor(QColor(0x30, 0x30, 0x30));
 
    m_scene = new QGraphicsScene(this);
    m_pixmapItem = m_scene->addPixmap(m_pixmap);
    m_pixmapItem->setGraphicsEffect(m_shadow);
}

References m_pixmap, m_pixmapItem, m_scene, m_shadow, and KisCanvasDecoration::setVisible().

~KisFpsDecoration()

KisFpsDecoration::~KisFpsDecoration ( )

override

Definition at line 38 of file kis_fps_decoration.cpp.

{
}

Member Function Documentation

draw()

bool KisFpsDecoration::draw ( const QString & text, QSize & outSize )

private

Definition at line 76 of file kis_fps_decoration.cpp.

{
    m_pixmap.fill(Qt::transparent);
 
    const int flags = Qt::AlignLeft | Qt::AlignTop | Qt::TextDontClip;
    QRect bounds;
 
    QPainter painter(&m_pixmap);
    painter.setFont(m_font);
 
    painter.setPen(QPen(QColor(0xF0, 0xF0, 0xF0)));
    painter.drawText(m_pixmap.rect().translated(1, 1), flags, text, &bounds);
 
    outSize = bounds.size() + QSize(1, 1);
 
    if (m_pixmap.width() < outSize.width() || m_pixmap.height() != outSize.height()) {
        return false; // pixmap is too small and needs a resize. rarely happens.
    }
 
    return true;
}

References bounds, m_font, and m_pixmap.

drawDecoration()

void KisFpsDecoration::drawDecoration ( QPainter & gc, const QRectF & updateRect, const KisCoordinatesConverter * converter, KisCanvas2 * canvas )

overridevirtual

Implements KisCanvasDecoration.

Definition at line 42 of file kis_fps_decoration.cpp.

{
    // we always paint into a pixmap instead of directly into gc, as the latter
    // approach is known to cause garbled graphics on macOS, Windows, and even
    // sometimes Linux.
 
    const QString text = getText();
 
    // note that USUALLY the pixmap will have the right size. in very rare cases
    // (e.g. on the very first call) the computed bounding rect will not be right
    // and the pixmap will need a resize. it is faster to NOT usually calculate
    // the necessary bounds with an extra call like QFontMetrics::boundingRect()
    // here, as USUALLY the pixmap will be right and thus an extra call would be
    // unnecessary overhead.
 
    QSize size;
 
    if (!draw(text, size)) {
        // the pixmap is too small, we need to make it larger. make it 10% wider
        // than the measured width to avoid resizing again as soon as the text
        // gets a bit wider due to different content.
 
        m_pixmap = QPixmap(size.width() * 1.1f, size.height());
 
        KIS_ASSERT(draw(text, size));
    }
 
    QRectF r = m_pixmap.rect();
    r |= m_shadow->boundingRectFor(r);
 
    m_pixmapItem->setPixmap(m_pixmap);
    m_scene->render(&gc, r.translated(20, 20), r);
}

References draw(), getText(), KIS_ASSERT, m_pixmap, m_pixmapItem, m_scene, and m_shadow.

getText()

QString KisFpsDecoration::getText ( ) const

private

Definition at line 98 of file kis_fps_decoration.cpp.

{
    QStringList lines;
 
    if (KisOpenglCanvasDebugger::instance()->showFpsOnCanvas()) {
        const qreal value = KisOpenglCanvasDebugger::instance()->accumulatedFps();
        lines << QString("Canvas FPS: %1").arg(QString::number(value, 'f', 1));
    }
 
    KisStrokeSpeedMonitor *monitor = KisStrokeSpeedMonitor::instance();
 
    if (monitor->haveStrokeSpeedMeasurement()) {
        lines << QString("Last cursor/brush speed (px/ms): %1/%2%3")
                .arg(monitor->lastCursorSpeed(), 0, 'f', 1)
                .arg(monitor->lastRenderingSpeed(), 0, 'f', 1)
                .arg(monitor->lastStrokeSaturated() ? " (!)" : "");
        lines << QString("Last brush framerate: %1 fps")
                .arg(monitor->lastFps(), 0, 'f', 1);
 
        lines << QString("Average cursor/brush speed (px/ms): %1/%2")
                .arg(monitor->avgCursorSpeed(), 0, 'f', 1)
                .arg(monitor->avgRenderingSpeed(), 0, 'f', 1);
        lines << QString("Average brush framerate: %1 fps")
                .arg(monitor->avgFps(), 0, 'f', 1);
    }
 
    return lines.join('\n');
}

References KisOpenglCanvasDebugger::accumulatedFps(), KisStrokeSpeedMonitor::avgCursorSpeed, KisStrokeSpeedMonitor::avgFps, KisStrokeSpeedMonitor::avgRenderingSpeed, KisStrokeSpeedMonitor::haveStrokeSpeedMeasurement(), KisOpenglCanvasDebugger::instance(), KisStrokeSpeedMonitor::instance(), KisStrokeSpeedMonitor::lastCursorSpeed, KisStrokeSpeedMonitor::lastFps, KisStrokeSpeedMonitor::lastRenderingSpeed, KisStrokeSpeedMonitor::lastStrokeSaturated, and value().

Member Data Documentation

idTag

const QString KisFpsDecoration::idTag = "fps_decoration"

static

Definition at line 25 of file kis_fps_decoration.h.

m_font

QFont KisFpsDecoration::m_font

private

Definition at line 31 of file kis_fps_decoration.h.

m_pixmap

QPixmap KisFpsDecoration::m_pixmap

private

Definition at line 32 of file kis_fps_decoration.h.

m_pixmapItem

QGraphicsPixmapItem* KisFpsDecoration::m_pixmapItem

private

Definition at line 35 of file kis_fps_decoration.h.

m_scene

QGraphicsScene* KisFpsDecoration::m_scene

private

Definition at line 34 of file kis_fps_decoration.h.

m_shadow

QGraphicsDropShadowEffect* KisFpsDecoration::m_shadow

private

Definition at line 36 of file kis_fps_decoration.h.

---

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

• libs/ui/kis_fps_decoration.h
• libs/ui/kis_fps_decoration.cpp