1fb9f6f13a
The main advantage of SPDX license identifiers over the traditional license headers is that it's more difficult to overlook inappropriate licenses for kwin, for example GPL 3. We also don't have to copy a lot of boilerplate text. In order to create this change, I ran licensedigger -r -c from the toplevel source directory.
97 lines
2.9 KiB
C++
97 lines
2.9 KiB
C++
/********************************************************************
|
|
KWin - the KDE window manager
|
|
This file is part of the KDE project.
|
|
|
|
SPDX-FileCopyrightText: 2013 Martin Gräßlin <mgraesslin@kde.org>
|
|
|
|
SPDX-License-Identifier: GPL-2.0-or-later
|
|
*********************************************************************/
|
|
#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
|