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
108 lines
3.4 KiB
C++
108 lines
3.4 KiB
C++
/********************************************************************
|
|
KWin - the KDE window manager
|
|
This file is part of the KDE project.
|
|
|
|
Copyright (C) 2013 Martin Gräßlin <mgraesslin@kde.org>
|
|
|
|
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_SCENE_QPAINTER_BACKEND_H
|
|
#define KWIN_SCENE_QPAINTER_BACKEND_H
|
|
|
|
class QImage;
|
|
class QRegion;
|
|
class QSize;
|
|
class QString;
|
|
|
|
namespace KWin {
|
|
class OverlayWindow;
|
|
|
|
class QPainterBackend
|
|
{
|
|
public:
|
|
virtual ~QPainterBackend();
|
|
virtual void present(int mask, const QRegion &damage) = 0;
|
|
|
|
/**
|
|
* @brief Returns the OverlayWindow used by the backend.
|
|
*
|
|
* A backend does not have to use an OverlayWindow, this is mostly for the X world.
|
|
* In case the backend does not use an OverlayWindow it is allowed to return @c null.
|
|
* It's the task of the caller to check whether it is @c null.
|
|
*
|
|
* @return :OverlayWindow*
|
|
*/
|
|
virtual OverlayWindow *overlayWindow();
|
|
virtual bool usesOverlayWindow() const = 0;
|
|
virtual void prepareRenderingFrame() = 0;
|
|
/**
|
|
* @brief Shows the Overlay Window
|
|
*
|
|
* Default implementation does nothing.
|
|
*/
|
|
virtual void showOverlay();
|
|
/**
|
|
* @brief React on screen geometry changes.
|
|
*
|
|
* Default implementation does nothing. Override if specific functionality is required.
|
|
*
|
|
* @param size The new screen size
|
|
*/
|
|
virtual void screenGeometryChanged(const QSize &size);
|
|
/**
|
|
* @brief Whether the creation of the Backend failed.
|
|
*
|
|
* The SceneQPainter should test whether the Backend got constructed correctly. If this method
|
|
* returns @c true, the SceneQPainter should not try to start the rendering.
|
|
*
|
|
* @return bool @c true if the creation of the Backend failed, @c false otherwise.
|
|
*/
|
|
bool isFailed() const {
|
|
return m_failed;
|
|
}
|
|
|
|
virtual QImage *buffer() = 0;
|
|
/**
|
|
* Overload for the case that there is a different buffer per screen.
|
|
* Default implementation just calls buffer.
|
|
* @param screenId The id of the screen as used in Screens
|
|
* @todo Get a better identifier for screen then a counter variable
|
|
*/
|
|
virtual QImage *bufferForScreen(int screenId);
|
|
virtual bool needsFullRepaint() const = 0;
|
|
/**
|
|
* Whether the rendering needs to be split per screen.
|
|
* Default implementation returns @c false.
|
|
*/
|
|
virtual bool perScreenRendering() const;
|
|
|
|
protected:
|
|
QPainterBackend();
|
|
/**
|
|
* @brief Sets the backend initialization to failed.
|
|
*
|
|
* This method should be called by the concrete subclass in case the initialization failed.
|
|
* The given @p reason is logged as a warning.
|
|
*
|
|
* @param reason The reason why the initialization failed.
|
|
*/
|
|
void setFailed(const QString &reason);
|
|
|
|
private:
|
|
bool m_failed;
|
|
};
|
|
|
|
} // KWin
|
|
|
|
#endif
|