684b4b635e
Summary:
So far we were following a bit unique and rare doxygen comment style:
/**
* Contents of the comment.
**/
Doxygen comments with this style look balanced and neat, but many people
that contribute to KWin don't follow this style. Instead, they prefer
more traditional doxygen comment style, i.e.
/**
* Contents of the comment.
*/
Reviewing such changes has been a bit frustrating for me (so selfish!)
and for other contributors.
This change switches doxygen comment style in KWin to a more traditional
style. The main reason for doing this is to make code review process easier
for new contributors as well us.
Reviewers: #kwin, davidedmundson
Reviewed By: #kwin, davidedmundson
Subscribers: kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D22812
131 lines
3.3 KiB
C++
131 lines
3.3 KiB
C++
/********************************************************************
|
|
KWin - the KDE window manager
|
|
This file is part of the KDE project.
|
|
|
|
Copyright 2015 Martin Gräßlin <mgraesslin@kde.org>
|
|
Copyright 2019 Roman Gilg <subdiff@gmail.com>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*********************************************************************/
|
|
#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 FramebufferOutput : public AbstractWaylandOutput
|
|
{
|
|
Q_OBJECT
|
|
|
|
public:
|
|
FramebufferOutput(QObject *parent = nullptr) : AbstractWaylandOutput(parent) {}
|
|
~FramebufferOutput() override = default;
|
|
|
|
QSize pixelSize() const override {
|
|
return m_pixelSize;
|
|
}
|
|
void setPixelSize(const QSize &set) {
|
|
m_pixelSize = set;
|
|
}
|
|
|
|
void setRawPhysicalSize(const QSize &set) {
|
|
AbstractWaylandOutput::setRawPhysicalSize(set);
|
|
}
|
|
|
|
private:
|
|
QSize m_pixelSize;
|
|
};
|
|
|
|
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;
|
|
|
|
Screens *createScreens(QObject *parent = nullptr) override;
|
|
QPainterBackend *createQPainterBackend() override;
|
|
|
|
QSize screenSize() const override;
|
|
|
|
void init() override;
|
|
|
|
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
|