3f4995fb9b
Summary:
The current way to specify the OpenGL context attributes does no longer
scale as can be seen in D6344. There are too many different context
attribute sets and with every addition we grow lots of copied code. The
chances to introduce errors in that code which is difficult to debug are
very high. As can be seen in the glx backend which defines major 1,
minor 2, but it should be major 2, minor 1.
This change reworks this code by creating a builder class which contains
only an abstract definition of what needs to be in the attributes.
E.g. the version, whether it's robust and so on.
Now we can just have a list of possible attributes in a well described
way:
auto builder;
builder.setVersion(3, 1);
builder.setRobust(true);
All possible builders are added to a list and operated on in a for loop
which tries to creat a context. Once it succeeded it breaks the list.
In addition a debug statement is added which prints out the set of
options which went into the context.
So far this is only done for EGL, GLX can follow once D6344 is merged.
Test Plan: New unit test added, kwin_wayland OpenGL tests run and verified
Reviewers: #kwin, #plasma
Subscribers: plasma-devel, kwin
Tags: #kwin
Differential Revision: https://phabricator.kde.org/D6396
489 lines
16 KiB
C++
489 lines
16 KiB
C++
/********************************************************************
|
|
KWin - the KDE window manager
|
|
This file is part of the KDE project.
|
|
|
|
Copyright (C) 2015 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/>.
|
|
*********************************************************************/
|
|
#include "abstract_egl_backend.h"
|
|
#include "egl_context_attribute_builder.h"
|
|
#include "options.h"
|
|
#include "platform.h"
|
|
#include "wayland_server.h"
|
|
#include <KWayland/Server/buffer_interface.h>
|
|
#include <KWayland/Server/display.h>
|
|
#include <KWayland/Server/surface_interface.h>
|
|
// kwin libs
|
|
#include <kwinglplatform.h>
|
|
// Qt
|
|
#include <QOpenGLContext>
|
|
#include <QOpenGLFramebufferObject>
|
|
|
|
#include <memory>
|
|
|
|
namespace KWin
|
|
{
|
|
|
|
typedef GLboolean(*eglBindWaylandDisplayWL_func)(EGLDisplay dpy, wl_display *display);
|
|
typedef GLboolean(*eglUnbindWaylandDisplayWL_func)(EGLDisplay dpy, wl_display *display);
|
|
typedef GLboolean(*eglQueryWaylandBufferWL_func)(EGLDisplay dpy, struct wl_resource *buffer, EGLint attribute, EGLint *value);
|
|
eglBindWaylandDisplayWL_func eglBindWaylandDisplayWL = nullptr;
|
|
eglUnbindWaylandDisplayWL_func eglUnbindWaylandDisplayWL = nullptr;
|
|
eglQueryWaylandBufferWL_func eglQueryWaylandBufferWL = nullptr;
|
|
|
|
#ifndef EGL_WAYLAND_BUFFER_WL
|
|
#define EGL_WAYLAND_BUFFER_WL 0x31D5
|
|
#endif
|
|
#ifndef EGL_WAYLAND_PLANE_WL
|
|
#define EGL_WAYLAND_PLANE_WL 0x31D6
|
|
#endif
|
|
#ifndef EGL_WAYLAND_Y_INVERTED_WL
|
|
#define EGL_WAYLAND_Y_INVERTED_WL 0x31DB
|
|
#endif
|
|
|
|
AbstractEglBackend::AbstractEglBackend()
|
|
: OpenGLBackend()
|
|
{
|
|
}
|
|
|
|
AbstractEglBackend::~AbstractEglBackend() = default;
|
|
|
|
void AbstractEglBackend::unbindWaylandDisplay()
|
|
{
|
|
auto display = kwinApp()->platform()->sceneEglDisplay();
|
|
if (eglUnbindWaylandDisplayWL && display != EGL_NO_DISPLAY) {
|
|
eglUnbindWaylandDisplayWL(display, *(WaylandServer::self()->display()));
|
|
}
|
|
}
|
|
|
|
void AbstractEglBackend::cleanup()
|
|
{
|
|
cleanupGL();
|
|
doneCurrent();
|
|
eglDestroyContext(m_display, m_context);
|
|
cleanupSurfaces();
|
|
eglReleaseThread();
|
|
}
|
|
|
|
void AbstractEglBackend::cleanupSurfaces()
|
|
{
|
|
if (m_surface != EGL_NO_SURFACE) {
|
|
eglDestroySurface(m_display, m_surface);
|
|
}
|
|
}
|
|
|
|
bool AbstractEglBackend::initEglAPI()
|
|
{
|
|
EGLint major, minor;
|
|
if (eglInitialize(m_display, &major, &minor) == EGL_FALSE) {
|
|
qCWarning(KWIN_CORE) << "eglInitialize failed";
|
|
EGLint error = eglGetError();
|
|
if (error != EGL_SUCCESS) {
|
|
qCWarning(KWIN_CORE) << "Error during eglInitialize " << error;
|
|
}
|
|
return false;
|
|
}
|
|
EGLint error = eglGetError();
|
|
if (error != EGL_SUCCESS) {
|
|
qCWarning(KWIN_CORE) << "Error during eglInitialize " << error;
|
|
return false;
|
|
}
|
|
qCDebug(KWIN_CORE) << "Egl Initialize succeeded";
|
|
|
|
if (eglBindAPI(isOpenGLES() ? EGL_OPENGL_ES_API : EGL_OPENGL_API) == EGL_FALSE) {
|
|
qCCritical(KWIN_CORE) << "bind OpenGL API failed";
|
|
return false;
|
|
}
|
|
qCDebug(KWIN_CORE) << "EGL version: " << major << "." << minor;
|
|
const QByteArray eglExtensions = eglQueryString(m_display, EGL_EXTENSIONS);
|
|
setExtensions(eglExtensions.split(' '));
|
|
return true;
|
|
}
|
|
|
|
typedef void (*eglFuncPtr)();
|
|
static eglFuncPtr getProcAddress(const char* name)
|
|
{
|
|
return eglGetProcAddress(name);
|
|
}
|
|
|
|
void AbstractEglBackend::initKWinGL()
|
|
{
|
|
GLPlatform *glPlatform = GLPlatform::instance();
|
|
glPlatform->detect(EglPlatformInterface);
|
|
options->setGlPreferBufferSwap(options->glPreferBufferSwap()); // resolve autosetting
|
|
if (options->glPreferBufferSwap() == Options::AutoSwapStrategy)
|
|
options->setGlPreferBufferSwap('e'); // for unknown drivers - should not happen
|
|
glPlatform->printResults();
|
|
initGL(&getProcAddress);
|
|
}
|
|
|
|
void AbstractEglBackend::initBufferAge()
|
|
{
|
|
setSupportsBufferAge(false);
|
|
|
|
if (hasExtension(QByteArrayLiteral("EGL_EXT_buffer_age"))) {
|
|
const QByteArray useBufferAge = qgetenv("KWIN_USE_BUFFER_AGE");
|
|
|
|
if (useBufferAge != "0")
|
|
setSupportsBufferAge(true);
|
|
}
|
|
}
|
|
|
|
void AbstractEglBackend::initWayland()
|
|
{
|
|
if (!WaylandServer::self()) {
|
|
return;
|
|
}
|
|
if (hasExtension(QByteArrayLiteral("EGL_WL_bind_wayland_display"))) {
|
|
eglBindWaylandDisplayWL = (eglBindWaylandDisplayWL_func)eglGetProcAddress("eglBindWaylandDisplayWL");
|
|
eglUnbindWaylandDisplayWL = (eglUnbindWaylandDisplayWL_func)eglGetProcAddress("eglUnbindWaylandDisplayWL");
|
|
eglQueryWaylandBufferWL = (eglQueryWaylandBufferWL_func)eglGetProcAddress("eglQueryWaylandBufferWL");
|
|
// only bind if not already done
|
|
if (waylandServer()->display()->eglDisplay() != eglDisplay()) {
|
|
if (!eglBindWaylandDisplayWL(eglDisplay(), *(WaylandServer::self()->display()))) {
|
|
eglUnbindWaylandDisplayWL = nullptr;
|
|
eglQueryWaylandBufferWL = nullptr;
|
|
} else {
|
|
waylandServer()->display()->setEglDisplay(eglDisplay());
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void AbstractEglBackend::initClientExtensions()
|
|
{
|
|
// Get the list of client extensions
|
|
const char* clientExtensionsCString = eglQueryString(EGL_NO_DISPLAY, EGL_EXTENSIONS);
|
|
const QByteArray clientExtensionsString = QByteArray::fromRawData(clientExtensionsCString, qstrlen(clientExtensionsCString));
|
|
if (clientExtensionsString.isEmpty()) {
|
|
// If eglQueryString() returned NULL, the implementation doesn't support
|
|
// EGL_EXT_client_extensions. Expect an EGL_BAD_DISPLAY error.
|
|
(void) eglGetError();
|
|
}
|
|
|
|
m_clientExtensions = clientExtensionsString.split(' ');
|
|
}
|
|
|
|
bool AbstractEglBackend::hasClientExtension(const QByteArray &ext) const
|
|
{
|
|
return m_clientExtensions.contains(ext);
|
|
}
|
|
|
|
bool AbstractEglBackend::makeCurrent()
|
|
{
|
|
if (QOpenGLContext *context = QOpenGLContext::currentContext()) {
|
|
// Workaround to tell Qt that no QOpenGLContext is current
|
|
context->doneCurrent();
|
|
}
|
|
const bool current = eglMakeCurrent(m_display, m_surface, m_surface, m_context);
|
|
return current;
|
|
}
|
|
|
|
void AbstractEglBackend::doneCurrent()
|
|
{
|
|
eglMakeCurrent(m_display, EGL_NO_SURFACE, EGL_NO_SURFACE, EGL_NO_CONTEXT);
|
|
}
|
|
|
|
bool AbstractEglBackend::isOpenGLES() const
|
|
{
|
|
if (qstrcmp(qgetenv("KWIN_COMPOSE"), "O2ES") == 0) {
|
|
return true;
|
|
}
|
|
return QOpenGLContext::openGLModuleType() == QOpenGLContext::LibGLES;
|
|
}
|
|
|
|
bool AbstractEglBackend::createContext()
|
|
{
|
|
const bool haveRobustness = hasExtension(QByteArrayLiteral("EGL_EXT_create_context_robustness"));
|
|
const bool haveCreateContext = hasExtension(QByteArrayLiteral("EGL_KHR_create_context"));
|
|
|
|
std::vector<std::unique_ptr<AbstractOpenGLContextAttributeBuilder>> candidates;
|
|
if (isOpenGLES()) {
|
|
if (haveCreateContext && haveRobustness) {
|
|
auto glesRobust = std::unique_ptr<AbstractOpenGLContextAttributeBuilder>(new EglOpenGLESContextAttributeBuilder);
|
|
glesRobust->setVersion(2);
|
|
glesRobust->setRobust(true);
|
|
candidates.push_back(std::move(glesRobust));
|
|
}
|
|
auto gles = std::unique_ptr<AbstractOpenGLContextAttributeBuilder>(new EglOpenGLESContextAttributeBuilder);
|
|
gles->setVersion(2);
|
|
candidates.push_back(std::move(gles));
|
|
} else {
|
|
if (options->glCoreProfile() && haveCreateContext) {
|
|
if (haveRobustness) {
|
|
auto robustCore = std::unique_ptr<AbstractOpenGLContextAttributeBuilder>(new EglContextAttributeBuilder);
|
|
robustCore->setVersion(3, 1);
|
|
robustCore->setRobust(true);
|
|
candidates.push_back(std::move(robustCore));
|
|
}
|
|
auto core = std::unique_ptr<AbstractOpenGLContextAttributeBuilder>(new EglContextAttributeBuilder);
|
|
core->setVersion(3, 1);
|
|
candidates.push_back(std::move(core));
|
|
}
|
|
if (haveRobustness && haveCreateContext) {
|
|
auto robust = std::unique_ptr<AbstractOpenGLContextAttributeBuilder>(new EglContextAttributeBuilder);
|
|
robust->setRobust(true);
|
|
candidates.push_back(std::move(robust));
|
|
}
|
|
candidates.emplace_back(new EglContextAttributeBuilder);
|
|
}
|
|
|
|
EGLContext ctx = EGL_NO_CONTEXT;
|
|
for (auto it = candidates.begin(); it != candidates.end(); it++) {
|
|
const auto attribs = (*it)->build();
|
|
ctx = eglCreateContext(m_display, config(), EGL_NO_CONTEXT, attribs.data());
|
|
if (ctx != EGL_NO_CONTEXT) {
|
|
qCDebug(KWIN_CORE) << "Created EGL context with attributes:" << (*it).get();
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (ctx == EGL_NO_CONTEXT) {
|
|
qCCritical(KWIN_CORE) << "Create Context failed";
|
|
return false;
|
|
}
|
|
m_context = ctx;
|
|
return true;
|
|
}
|
|
|
|
void AbstractEglBackend::setEglDisplay(const EGLDisplay &display) {
|
|
m_display = display;
|
|
kwinApp()->platform()->setSceneEglDisplay(display);
|
|
}
|
|
|
|
AbstractEglTexture::AbstractEglTexture(SceneOpenGL::Texture *texture, AbstractEglBackend *backend)
|
|
: SceneOpenGL::TexturePrivate()
|
|
, q(texture)
|
|
, m_backend(backend)
|
|
, m_image(EGL_NO_IMAGE_KHR)
|
|
{
|
|
m_target = GL_TEXTURE_2D;
|
|
}
|
|
|
|
AbstractEglTexture::~AbstractEglTexture()
|
|
{
|
|
if (m_image != EGL_NO_IMAGE_KHR) {
|
|
eglDestroyImageKHR(m_backend->eglDisplay(), m_image);
|
|
}
|
|
}
|
|
|
|
OpenGLBackend *AbstractEglTexture::backend()
|
|
{
|
|
return m_backend;
|
|
}
|
|
|
|
bool AbstractEglTexture::loadTexture(WindowPixmap *pixmap)
|
|
{
|
|
const auto &buffer = pixmap->buffer();
|
|
if (buffer.isNull()) {
|
|
if (updateFromFBO(pixmap->fbo())) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
// try Wayland loading
|
|
if (auto s = pixmap->surface()) {
|
|
s->resetTrackedDamage();
|
|
}
|
|
if (buffer->shmBuffer()) {
|
|
return loadShmTexture(buffer);
|
|
} else {
|
|
return loadEglTexture(buffer);
|
|
}
|
|
}
|
|
|
|
void AbstractEglTexture::updateTexture(WindowPixmap *pixmap)
|
|
{
|
|
const auto &buffer = pixmap->buffer();
|
|
if (buffer.isNull()) {
|
|
const auto &fbo = pixmap->fbo();
|
|
if (!fbo.isNull()) {
|
|
if (m_texture != fbo->texture()) {
|
|
updateFromFBO(fbo);
|
|
}
|
|
return;
|
|
}
|
|
return;
|
|
}
|
|
auto s = pixmap->surface();
|
|
if (!buffer->shmBuffer()) {
|
|
q->bind();
|
|
EGLImageKHR image = attach(buffer);
|
|
q->unbind();
|
|
if (image != EGL_NO_IMAGE_KHR) {
|
|
eglDestroyImageKHR(m_backend->eglDisplay(), m_image);
|
|
m_image = image;
|
|
}
|
|
if (s) {
|
|
s->resetTrackedDamage();
|
|
}
|
|
return;
|
|
}
|
|
// shm fallback
|
|
const QImage &image = buffer->data();
|
|
if (image.isNull() || !s) {
|
|
return;
|
|
}
|
|
Q_ASSERT(image.size() == m_size);
|
|
q->bind();
|
|
const QRegion damage = s->trackedDamage();
|
|
s->resetTrackedDamage();
|
|
auto scale = s->scale(); //damage is normalised, so needs converting up to match texture
|
|
|
|
// TODO: this should be shared with GLTexture::update
|
|
if (GLPlatform::instance()->isGLES()) {
|
|
if (s_supportsARGB32 && (image.format() == QImage::Format_ARGB32 || image.format() == QImage::Format_ARGB32_Premultiplied)) {
|
|
const QImage im = image.convertToFormat(QImage::Format_ARGB32_Premultiplied);
|
|
for (const QRect &rect : damage.rects()) {
|
|
auto scaledRect = QRect(rect.x() * scale, rect.y() * scale, rect.width() * scale, rect.height() * scale);
|
|
glTexSubImage2D(m_target, 0, scaledRect.x(), scaledRect.y(), scaledRect.width(), scaledRect.height(),
|
|
GL_BGRA_EXT, GL_UNSIGNED_BYTE, im.copy(scaledRect).bits());
|
|
}
|
|
} else {
|
|
const QImage im = image.convertToFormat(QImage::Format_RGBA8888_Premultiplied);
|
|
for (const QRect &rect : damage.rects()) {
|
|
auto scaledRect = QRect(rect.x() * scale, rect.y() * scale, rect.width() * scale, rect.height() * scale);
|
|
glTexSubImage2D(m_target, 0, scaledRect.x(), scaledRect.y(), scaledRect.width(), scaledRect.height(),
|
|
GL_RGBA, GL_UNSIGNED_BYTE, im.copy(scaledRect).bits());
|
|
}
|
|
}
|
|
} else {
|
|
const QImage im = image.convertToFormat(QImage::Format_ARGB32_Premultiplied);
|
|
for (const QRect &rect : damage.rects()) {
|
|
auto scaledRect = QRect(rect.x() * scale, rect.y() * scale, rect.width() * scale, rect.height() * scale);
|
|
glTexSubImage2D(m_target, 0, scaledRect.x(), scaledRect.y(), scaledRect.width(), scaledRect.height(),
|
|
GL_BGRA, GL_UNSIGNED_BYTE, im.copy(scaledRect).bits());
|
|
}
|
|
}
|
|
q->unbind();
|
|
}
|
|
|
|
bool AbstractEglTexture::loadShmTexture(const QPointer< KWayland::Server::BufferInterface > &buffer)
|
|
{
|
|
const QImage &image = buffer->data();
|
|
if (image.isNull()) {
|
|
return false;
|
|
}
|
|
|
|
glGenTextures(1, &m_texture);
|
|
q->setWrapMode(GL_CLAMP_TO_EDGE);
|
|
q->setFilter(GL_LINEAR);
|
|
q->bind();
|
|
|
|
const QSize &size = image.size();
|
|
// TODO: this should be shared with GLTexture(const QImage&, GLenum)
|
|
GLenum format = 0;
|
|
switch (image.format()) {
|
|
case QImage::Format_ARGB32:
|
|
case QImage::Format_ARGB32_Premultiplied:
|
|
format = GL_RGBA8;
|
|
break;
|
|
case QImage::Format_RGB32:
|
|
format = GL_RGB8;
|
|
break;
|
|
default:
|
|
return false;
|
|
}
|
|
if (GLPlatform::instance()->isGLES()) {
|
|
if (s_supportsARGB32 && format == GL_RGBA8) {
|
|
const QImage im = image.convertToFormat(QImage::Format_ARGB32_Premultiplied);
|
|
glTexImage2D(m_target, 0, GL_BGRA_EXT, im.width(), im.height(),
|
|
0, GL_BGRA_EXT, GL_UNSIGNED_BYTE, im.bits());
|
|
} else {
|
|
const QImage im = image.convertToFormat(QImage::Format_RGBA8888_Premultiplied);
|
|
glTexImage2D(m_target, 0, GL_RGBA, im.width(), im.height(),
|
|
0, GL_RGBA, GL_UNSIGNED_BYTE, im.bits());
|
|
}
|
|
} else {
|
|
glTexImage2D(m_target, 0, format, size.width(), size.height(), 0,
|
|
GL_BGRA, GL_UNSIGNED_BYTE, image.bits());
|
|
}
|
|
|
|
q->unbind();
|
|
q->setYInverted(true);
|
|
m_size = size;
|
|
updateMatrix();
|
|
return true;
|
|
}
|
|
|
|
bool AbstractEglTexture::loadEglTexture(const QPointer< KWayland::Server::BufferInterface > &buffer)
|
|
{
|
|
if (!eglQueryWaylandBufferWL) {
|
|
return false;
|
|
}
|
|
if (!buffer->resource()) {
|
|
return false;
|
|
}
|
|
|
|
glGenTextures(1, &m_texture);
|
|
q->setWrapMode(GL_CLAMP_TO_EDGE);
|
|
q->setFilter(GL_LINEAR);
|
|
q->bind();
|
|
m_image = attach(buffer);
|
|
q->unbind();
|
|
|
|
if (EGL_NO_IMAGE_KHR == m_image) {
|
|
qCDebug(KWIN_CORE) << "failed to create egl image";
|
|
q->discard();
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
EGLImageKHR AbstractEglTexture::attach(const QPointer< KWayland::Server::BufferInterface > &buffer)
|
|
{
|
|
EGLint format, yInverted;
|
|
eglQueryWaylandBufferWL(m_backend->eglDisplay(), buffer->resource(), EGL_TEXTURE_FORMAT, &format);
|
|
if (format != EGL_TEXTURE_RGB && format != EGL_TEXTURE_RGBA) {
|
|
qCDebug(KWIN_CORE) << "Unsupported texture format: " << format;
|
|
return EGL_NO_IMAGE_KHR;
|
|
}
|
|
if (!eglQueryWaylandBufferWL(m_backend->eglDisplay(), buffer->resource(), EGL_WAYLAND_Y_INVERTED_WL, &yInverted)) {
|
|
// if EGL_WAYLAND_Y_INVERTED_WL is not supported wl_buffer should be treated as if value were EGL_TRUE
|
|
yInverted = EGL_TRUE;
|
|
}
|
|
|
|
const EGLint attribs[] = {
|
|
EGL_WAYLAND_PLANE_WL, 0,
|
|
EGL_NONE
|
|
};
|
|
EGLImageKHR image = eglCreateImageKHR(m_backend->eglDisplay(), EGL_NO_CONTEXT, EGL_WAYLAND_BUFFER_WL,
|
|
(EGLClientBuffer)buffer->resource(), attribs);
|
|
if (image != EGL_NO_IMAGE_KHR) {
|
|
glEGLImageTargetTexture2DOES(GL_TEXTURE_2D, (GLeglImageOES)image);
|
|
m_size = buffer->size();
|
|
updateMatrix();
|
|
q->setYInverted(yInverted);
|
|
}
|
|
return image;
|
|
}
|
|
|
|
bool AbstractEglTexture::updateFromFBO(const QSharedPointer<QOpenGLFramebufferObject> &fbo)
|
|
{
|
|
if (fbo.isNull()) {
|
|
return false;
|
|
}
|
|
m_texture = fbo->texture();
|
|
m_size = fbo->size();
|
|
q->setWrapMode(GL_CLAMP_TO_EDGE);
|
|
q->setFilter(GL_LINEAR);
|
|
q->setYInverted(false);
|
|
updateMatrix();
|
|
return true;
|
|
}
|
|
|
|
}
|
|
|