kwin/platformsupport/scenes/opengl/abstract_egl_backend.h
Vlad Zahorodnii 6b2e6cfd53 Prevent EGL headers from including Xlib headers
One of the annoying things about EGL headers is that they include
platform headers by default, e.g. on X11, it's Xlib.h, etc.

The problem with Xlib.h is that it uses the define compiler directive to
declare constants and those constants have very generic names, e.g.
'None', which typically conflict with enums, etc.

In order to work around bad things coming from Xlib.h, we include
fixx11.h file that contains some workarounds to redefine some Xlib's
types.

There's a flag or rather two flags (EGL_NO_PLATFORM_SPECIFIC_TYPES and
EGL_NO_X11) that are cross-vendor and they can be used to prevent EGL
headers from including platform specific headers, such as Xlib.h [1]

The benefit of setting those two flags is that you can simply include
EGL/egl.h or epoxy/egl.h and the world won't explode due to Xlib.h

MESA_EGL_NO_X11_HEADERS is set to support older versions of Mesa.

[1] https://github.com/KhronosGroup/EGL-Registry/pull/111
2020-12-10 11:15:06 +02:00

131 lines
3.5 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-License-Identifier: GPL-2.0-or-later
*/
#ifndef KWIN_ABSTRACT_EGL_BACKEND_H
#define KWIN_ABSTRACT_EGL_BACKEND_H
#include "backend.h"
#include "texture.h"
#include <QObject>
#include <epoxy/egl.h>
class QOpenGLFramebufferObject;
namespace KWaylandServer
{
class BufferInterface;
}
namespace KWin
{
class EglDmabuf;
class AbstractOutput;
class KWIN_EXPORT AbstractEglBackend : public QObject, public OpenGLBackend
{
Q_OBJECT
public:
~AbstractEglBackend() override;
bool makeCurrent() override;
void doneCurrent() override;
EGLDisplay eglDisplay() const {
return m_display;
}
EGLContext context() const {
return m_context;
}
EGLSurface surface() const {
return m_surface;
}
EGLConfig config() const {
return m_config;
}
QSharedPointer<GLTexture> textureForOutput(AbstractOutput *output) const override;
static void setPrimaryBackend(AbstractEglBackend *primaryBackend) {
s_primaryBackend = primaryBackend;
}
static AbstractEglBackend *primaryBackend() {
return s_primaryBackend;
}
bool isPrimary() const {
return this == s_primaryBackend;
}
protected:
AbstractEglBackend();
void setEglDisplay(const EGLDisplay &display);
void setSurface(const EGLSurface &surface);
void setConfig(const EGLConfig &config);
void cleanup();
virtual void cleanupSurfaces();
bool initEglAPI();
void initKWinGL();
void initBufferAge();
void initClientExtensions();
void initWayland();
bool hasClientExtension(const QByteArray &ext) const;
bool isOpenGLES() const;
bool createContext();
private:
void teardown();
EGLDisplay m_display = EGL_NO_DISPLAY;
EGLSurface m_surface = EGL_NO_SURFACE;
EGLContext m_context = EGL_NO_CONTEXT;
EGLConfig m_config = nullptr;
// note: m_dmaBuf is nullptr if this is not the primary backend
EglDmabuf *m_dmaBuf = nullptr;
QList<QByteArray> m_clientExtensions;
static AbstractEglBackend * s_primaryBackend;
};
class KWIN_EXPORT AbstractEglTexture : public SceneOpenGLTexturePrivate
{
public:
~AbstractEglTexture() override;
bool loadTexture(WindowPixmap *pixmap) override;
void updateTexture(WindowPixmap *pixmap) override;
OpenGLBackend *backend() override;
protected:
AbstractEglTexture(SceneOpenGLTexture *texture, AbstractEglBackend *backend);
EGLImageKHR image() const {
return m_image;
}
void setImage(const EGLImageKHR &img) {
m_image = img;
}
SceneOpenGLTexture *texture() const {
return q;
}
private:
void createTextureSubImage(const QImage &image, const QRegion &damage);
bool createTextureImage(const QImage &image);
bool loadShmTexture(const QPointer<KWaylandServer::BufferInterface> &buffer);
bool loadEglTexture(const QPointer<KWaylandServer::BufferInterface> &buffer);
bool loadDmabufTexture(const QPointer< KWaylandServer::BufferInterface > &buffer);
bool loadInternalImageObject(WindowPixmap *pixmap);
EGLImageKHR attach(const QPointer<KWaylandServer::BufferInterface> &buffer);
bool updateFromFBO(const QSharedPointer<QOpenGLFramebufferObject> &fbo);
bool updateFromInternalImageObject(WindowPixmap *pixmap);
SceneOpenGLTexture *q;
AbstractEglBackend *m_backend;
EGLImageKHR m_image;
};
}
#endif