kwin/plugins/platforms/fbdev/fb_backend.h
Vlad Zahorodnii b8a70e62d5 Introduce RenderLoop
At the moment, our frame scheduling infrastructure is still heavily
based on Xinerama-style rendering. Specifically, we assume that painting
is driven by a single timer, etc.

This change introduces a new type - RenderLoop. Its main purpose is to
drive compositing on a specific output, or in case of X11, on the
overlay window.

With RenderLoop, compositing is synchronized to vblank events. It
exposes the last and the next estimated presentation timestamp. The
expected presentation timestamp can be used by effects to ensure that
animations are synchronized with the upcoming vblank event.

On Wayland, every outputs has its own render loop. On X11, per screen
rendering is not possible, therefore the platform exposes the render
loop for the overlay window. Ideally, the Scene has to expose the
RenderLoop, but as the first step towards better compositing scheduling
it's good as is for the time being.

The RenderLoop tries to minimize the latency by delaying compositing as
close as possible to the next vblank event. One tricky thing about it is
that if compositing is too close to the next vblank event, animations
may become a little bit choppy. However, increasing the latency reduces
the choppiness.

Given that, there is no any "silver bullet" solution for the choppiness
issue, a new option has been added in the Compositing KCM to specify the
amount of latency. By default, it's "Medium," but if a user is not
satisfied with the upstream default, they can tweak it.
2021-01-06 16:59:29 +00:00

120 lines
2.7 KiB
C++

/*
KWin - the KDE window manager
This file is part of the KDE project.
SPDX-FileCopyrightText: 2015 Martin Gräßlin <mgraesslin@kde.org>
SPDX-FileCopyrightText: 2019 Roman Gilg <subdiff@gmail.com>
SPDX-License-Identifier: GPL-2.0-or-later
*/
#ifndef KWIN_FB_BACKEND_H
#define KWIN_FB_BACKEND_H
#include "abstract_wayland_output.h"
#include "platform.h"
#include <QImage>
#include <QSize>
namespace KWin
{
class FramebufferBackend;
class VsyncMonitor;
class FramebufferOutput : public AbstractWaylandOutput
{
Q_OBJECT
public:
explicit FramebufferOutput(FramebufferBackend *backend, QObject *parent = nullptr);
~FramebufferOutput() override = default;
RenderLoop *renderLoop() const override;
VsyncMonitor *vsyncMonitor() const;
void init(const QSize &pixelSize, const QSize &physicalSize);
private:
void vblank(std::chrono::nanoseconds timestamp);
RenderLoop *m_renderLoop = nullptr;
VsyncMonitor *m_vsyncMonitor = nullptr;
};
class KWIN_EXPORT FramebufferBackend : public Platform
{
Q_OBJECT
Q_INTERFACES(KWin::Platform)
Q_PLUGIN_METADATA(IID "org.kde.kwin.Platform" FILE "fbdev.json")
public:
explicit FramebufferBackend(QObject *parent = nullptr);
~FramebufferBackend() override;
QPainterBackend *createQPainterBackend() override;
QSize screenSize() const override;
void init() override;
int fileDescriptor() const;
bool isValid() const {
return m_fd >= 0;
}
void map();
void unmap();
void *mappedMemory() const {
return m_memory;
}
int bytesPerLine() const {
return m_bytesPerLine;
}
int bufferSize() const {
return m_bufferLength;
}
quint32 bitsPerPixel() const {
return m_bitsPerPixel;
}
QImage::Format imageFormat() const;
/**
* @returns whether the imageFormat is BGR instead of RGB.
*/
bool isBGR() const {
return m_bgr;
}
Outputs outputs() const override;
Outputs enabledOutputs() const override;
QVector<CompositingType> supportedCompositors() const override {
return QVector<CompositingType>{QPainterCompositing};
}
private:
void openFrameBuffer();
bool handleScreenInfo();
void initImageFormat();
QVector<FramebufferOutput*> m_outputs;
QByteArray m_id;
struct Color {
quint32 offset;
quint32 length;
};
Color m_red;
Color m_green;
Color m_blue;
Color m_alpha;
quint32 m_bitsPerPixel = 0;
int m_fd = -1;
quint32 m_bufferLength = 0;
int m_bytesPerLine = 0;
void *m_memory = nullptr;
QImage::Format m_imageFormat = QImage::Format_Invalid;
bool m_bgr = false;
};
}
#endif