kwin/src/wayland/shadow_interface.h
Martin Gräßlin 69832442a1 Add a Shadow protocol
The shadow protocol is inspired by the KWin's X11 protocol and the
DecorationShadow in KDecoration2.

A shadow is attached to a surface (after a commit on surface) and
consists of several image parts (represented through a buffer):
* top-left
* top
* top-right
* right
* bottom-right
* bottom
* bottom-left
* left

In addition there is an offset on each side.

For more information see also the X11 protocol described at [1].

Note: the protocol is currently missing documentation and changing
the shadow is not yet properly delegated to the server API.

[1] https://community.kde.org/KWin/Shadow
2015-07-15 11:11:30 +02:00

79 lines
2.2 KiB
C++

/********************************************************************
Copyright 2015 Martin Gräßlin <mgraesslin@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) version 3, or any
later version accepted by the membership of KDE e.V. (or its
successor approved by the membership of KDE e.V.), which shall
act as a proxy defined in Section 6 of version 3 of the license.
This library 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
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library. If not, see <http://www.gnu.org/licenses/>.
*********************************************************************/
#ifndef KWAYLAND_SERVER_SHADOW_INTERFACE_H
#define KWAYLAND_SERVER_SHADOW_INTERFACE_H
#include "global.h"
#include "resource.h"
#include <QObject>
#include <QMarginsF>
#include <KWayland/Server/kwaylandserver_export.h>
namespace KWayland
{
namespace Server
{
class BufferInterface;
class Display;
class KWAYLANDSERVER_EXPORT ShadowManagerInterface : public Global
{
Q_OBJECT
public:
virtual ~ShadowManagerInterface();
private:
explicit ShadowManagerInterface(Display *display, QObject *parent = nullptr);
friend class Display;
class Private;
};
class KWAYLANDSERVER_EXPORT ShadowInterface : public Resource
{
Q_OBJECT
public:
virtual ~ShadowInterface();
BufferInterface *left() const;
BufferInterface *topLeft() const;
BufferInterface *top() const;
BufferInterface *topRight() const;
BufferInterface *right() const;
BufferInterface *bottomRight() const;
BufferInterface *bottom() const;
BufferInterface *bottomLeft() const;
QMarginsF offset() const;
private:
explicit ShadowInterface(ShadowManagerInterface *parent, wl_resource *parentResource);
friend class ShadowManagerInterface;
class Private;
Private *d_func() const;
};
}
}
#endif