Long live QOpenGLDebug!
Qt convenience classes for the GL_KHR_debug extension This allows the developer to 1) ask the GL for a log of the last generated messages; 2) emit Qt signals whenever the GL wants to tell us something. Change-Id: I830343a26714c51abb68ce1269163c145d1e2aac Reviewed-by: Samuel Rødal <samuel.rodal@digia.com>
This commit is contained in:
Giuseppe D'Angelo
The Qt Project
parent
583e9ef790
commit
b36cdba339
@ -30,7 +30,8 @@ contains(QT_CONFIG, opengl)|contains(QT_CONFIG, opengles2) {
|
||||
opengl/qrbtree_p.h \
|
||||
opengl/qopenglversionfunctions.h \
|
||||
opengl/qopenglversionfunctionsfactory_p.h \
|
||||
opengl/qopenglvertexarrayobject.h
|
||||
opengl/qopenglvertexarrayobject.h \
|
||||
opengl/qopengldebug.h
|
||||
|
||||
SOURCES += opengl/qopengl.cpp \
|
||||
opengl/qopenglfunctions.cpp \
|
||||
@ -49,7 +50,8 @@ contains(QT_CONFIG, opengl)|contains(QT_CONFIG, opengles2) {
|
||||
opengl/qtriangulator.cpp \
|
||||
opengl/qopenglversionfunctions.cpp \
|
||||
opengl/qopenglversionfunctionsfactory.cpp \
|
||||
opengl/qopenglvertexarrayobject.cpp
|
||||
opengl/qopenglvertexarrayobject.cpp \
|
||||
opengl/qopengldebug.cpp
|
||||
|
||||
!contains(QT_CONFIG, opengles2) {
|
||||
HEADERS += opengl/qopenglfunctions_1_0.h \
|
||||
|
||||
1806
src/gui/opengl/qopengldebug.cpp
Normal file
1806
src/gui/opengl/qopengldebug.cpp
Normal file
File diff suppressed because it is too large
Load Diff
220
src/gui/opengl/qopengldebug.h
Normal file
220
src/gui/opengl/qopengldebug.h
Normal file
@ -0,0 +1,220 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** Copyright (C) 2013 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author Giuseppe D'Angelo <giuseppe.dangelo@kdab.com>
|
||||
** Contact: http://www.qt-project.org/legal
|
||||
**
|
||||
** This file is part of the QtGui module of the Qt Toolkit.
|
||||
**
|
||||
** $QT_BEGIN_LICENSE:LGPL$
|
||||
** Commercial License Usage
|
||||
** Licensees holding valid commercial Qt licenses may use this file in
|
||||
** accordance with the commercial license agreement provided with the
|
||||
** Software or, alternatively, in accordance with the terms contained in
|
||||
** a written agreement between you and Digia. For licensing terms and
|
||||
** conditions see http://qt.digia.com/licensing. For further information
|
||||
** use the contact form at http://qt.digia.com/contact-us.
|
||||
**
|
||||
** GNU Lesser General Public License Usage
|
||||
** Alternatively, this file may be used under the terms of the GNU Lesser
|
||||
** General Public License version 2.1 as published by the Free Software
|
||||
** Foundation and appearing in the file LICENSE.LGPL included in the
|
||||
** packaging of this file. Please review the following information to
|
||||
** ensure the GNU Lesser General Public License version 2.1 requirements
|
||||
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
||||
**
|
||||
** In addition, as a special exception, Digia gives you certain additional
|
||||
** rights. These rights are described in the Digia Qt LGPL Exception
|
||||
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
||||
**
|
||||
** GNU General Public License Usage
|
||||
** Alternatively, this file may be used under the terms of the GNU
|
||||
** General Public License version 3.0 as published by the Free Software
|
||||
** Foundation and appearing in the file LICENSE.GPL included in the
|
||||
** packaging of this file. Please review the following information to
|
||||
** ensure the GNU General Public License version 3.0 requirements will be
|
||||
** met: http://www.gnu.org/copyleft/gpl.html.
|
||||
**
|
||||
**
|
||||
** $QT_END_LICENSE$
|
||||
**
|
||||
****************************************************************************/
|
||||
|
||||
#ifndef QOPENGLDEBUG_H
|
||||
#define QOPENGLDEBUG_H
|
||||
|
||||
#include <QtCore/qglobal.h>
|
||||
|
||||
#ifndef QT_NO_OPENGL
|
||||
|
||||
#include <QtCore/qshareddata.h>
|
||||
#include <QtCore/qflags.h>
|
||||
#include <QtCore/qlist.h>
|
||||
#include <QtCore/qvector.h>
|
||||
#include <QtCore/qmetatype.h>
|
||||
#include <QtCore/qdebug.h>
|
||||
#include <QtGui/qopenglcontext.h>
|
||||
|
||||
QT_BEGIN_NAMESPACE
|
||||
|
||||
class QOpenGLDebugLogger;
|
||||
class QOpenGLDebugLoggerPrivate;
|
||||
class QOpenGLDebugMessagePrivate;
|
||||
|
||||
class Q_GUI_EXPORT QOpenGLDebugMessage
|
||||
{
|
||||
public:
|
||||
enum Source {
|
||||
InvalidSource = 0x00000000,
|
||||
APISource = 0x00000001,
|
||||
WindowSystemSource = 0x00000002,
|
||||
ShaderCompilerSource = 0x00000004,
|
||||
ThirdPartySource = 0x00000008,
|
||||
ApplicationSource = 0x00000010,
|
||||
OtherSource = 0x00000020,
|
||||
LastSource = OtherSource, // private API
|
||||
AnySource = 0xffffffff
|
||||
};
|
||||
Q_DECLARE_FLAGS(Sources, Source)
|
||||
|
||||
enum Type {
|
||||
InvalidType = 0x00000000,
|
||||
ErrorType = 0x00000001,
|
||||
DeprecatedBehaviorType = 0x00000002,
|
||||
UndefinedBehaviorType = 0x00000004,
|
||||
PortabilityType = 0x00000008,
|
||||
PerformanceType = 0x00000010,
|
||||
OtherType = 0x00000020,
|
||||
MarkerType = 0x00000040,
|
||||
GroupPushType = 0x00000080,
|
||||
GroupPopType = 0x00000100,
|
||||
LastType = GroupPopType, // private API
|
||||
AnyType = 0xffffffff
|
||||
};
|
||||
Q_DECLARE_FLAGS(Types, Type)
|
||||
|
||||
enum Severity {
|
||||
InvalidSeverity = 0x00000000,
|
||||
HighSeverity = 0x00000001,
|
||||
MediumSeverity = 0x00000002,
|
||||
LowSeverity = 0x00000004,
|
||||
NotificationSeverity = 0x00000008,
|
||||
LastSeverity = NotificationSeverity, // private API
|
||||
AnySeverity = 0xffffffff
|
||||
};
|
||||
Q_DECLARE_FLAGS(Severities, Severity)
|
||||
|
||||
QOpenGLDebugMessage();
|
||||
QOpenGLDebugMessage(const QOpenGLDebugMessage &debugMessage);
|
||||
~QOpenGLDebugMessage();
|
||||
|
||||
QOpenGLDebugMessage &operator=(const QOpenGLDebugMessage &debugMessage);
|
||||
#ifdef Q_COMPILER_RVALUE_REFS
|
||||
inline QOpenGLDebugMessage &operator=(QOpenGLDebugMessage &&debugMessage)
|
||||
{ d.swap(debugMessage.d); return *this; }
|
||||
#endif
|
||||
inline void swap(QOpenGLDebugMessage &debugMessage) { d.swap(debugMessage.d); }
|
||||
|
||||
Source source() const;
|
||||
Type type() const;
|
||||
Severity severity() const;
|
||||
GLuint id() const;
|
||||
QString message() const;
|
||||
|
||||
static QOpenGLDebugMessage createApplicationMessage(const QString &text,
|
||||
GLuint id = 0,
|
||||
Severity severity = NotificationSeverity,
|
||||
Type type = OtherType);
|
||||
static QOpenGLDebugMessage createThirdPartyMessage(const QString &text,
|
||||
GLuint id = 0,
|
||||
Severity severity = NotificationSeverity,
|
||||
Type type = OtherType);
|
||||
|
||||
bool operator==(const QOpenGLDebugMessage &debugMessage) const;
|
||||
inline bool operator!=(const QOpenGLDebugMessage &debugMessage) const { return !operator==(debugMessage); }
|
||||
|
||||
private:
|
||||
friend class QOpenGLDebugLogger;
|
||||
friend class QOpenGLDebugLoggerPrivate;
|
||||
QSharedDataPointer<QOpenGLDebugMessagePrivate> d;
|
||||
};
|
||||
|
||||
Q_DECLARE_SHARED(QOpenGLDebugMessage)
|
||||
Q_DECLARE_OPERATORS_FOR_FLAGS(QOpenGLDebugMessage::Sources)
|
||||
Q_DECLARE_OPERATORS_FOR_FLAGS(QOpenGLDebugMessage::Types)
|
||||
Q_DECLARE_OPERATORS_FOR_FLAGS(QOpenGLDebugMessage::Severities)
|
||||
|
||||
#ifndef QT_NO_DEBUG_STREAM
|
||||
Q_GUI_EXPORT QDebug operator<<(QDebug debug, const QOpenGLDebugMessage &message);
|
||||
Q_GUI_EXPORT QDebug operator<<(QDebug debug, QOpenGLDebugMessage::Source source);
|
||||
Q_GUI_EXPORT QDebug operator<<(QDebug debug, QOpenGLDebugMessage::Type type);
|
||||
Q_GUI_EXPORT QDebug operator<<(QDebug debug, QOpenGLDebugMessage::Severity severity);
|
||||
#endif
|
||||
|
||||
class QOpenGLDebugLoggerPrivate;
|
||||
|
||||
class Q_GUI_EXPORT QOpenGLDebugLogger : public QObject
|
||||
{
|
||||
Q_OBJECT
|
||||
Q_ENUMS(LoggingMode)
|
||||
Q_PROPERTY(LoggingMode loggingMode READ loggingMode)
|
||||
|
||||
public:
|
||||
enum LoggingMode {
|
||||
AsynchronousLogging,
|
||||
SynchronousLogging
|
||||
};
|
||||
|
||||
explicit QOpenGLDebugLogger(QObject *parent = 0);
|
||||
~QOpenGLDebugLogger();
|
||||
|
||||
bool initialize();
|
||||
|
||||
bool isLogging() const;
|
||||
LoggingMode loggingMode() const;
|
||||
|
||||
qint64 maximumMessageLength() const;
|
||||
|
||||
void pushGroup(const QString &name,
|
||||
GLuint id = 0,
|
||||
QOpenGLDebugMessage::Source source = QOpenGLDebugMessage::ApplicationSource);
|
||||
void popGroup();
|
||||
|
||||
void enableMessages(QOpenGLDebugMessage::Sources sources = QOpenGLDebugMessage::AnySource,
|
||||
QOpenGLDebugMessage::Types types = QOpenGLDebugMessage::AnyType,
|
||||
QOpenGLDebugMessage::Severities severities = QOpenGLDebugMessage::AnySeverity);
|
||||
|
||||
void enableMessages(const QVector<GLuint> &ids,
|
||||
QOpenGLDebugMessage::Sources sources = QOpenGLDebugMessage::AnySource,
|
||||
QOpenGLDebugMessage::Types types = QOpenGLDebugMessage::AnyType);
|
||||
|
||||
void disableMessages(QOpenGLDebugMessage::Sources sources = QOpenGLDebugMessage::AnySource,
|
||||
QOpenGLDebugMessage::Types types = QOpenGLDebugMessage::AnyType,
|
||||
QOpenGLDebugMessage::Severities severities = QOpenGLDebugMessage::AnySeverity);
|
||||
|
||||
void disableMessages(const QVector<GLuint> &ids,
|
||||
QOpenGLDebugMessage::Sources sources = QOpenGLDebugMessage::AnySource,
|
||||
QOpenGLDebugMessage::Types types = QOpenGLDebugMessage::AnyType);
|
||||
|
||||
QList<QOpenGLDebugMessage> loggedMessages() const;
|
||||
|
||||
public Q_SLOTS:
|
||||
void logMessage(const QOpenGLDebugMessage &debugMessage);
|
||||
void startLogging(LoggingMode loggingMode = AsynchronousLogging);
|
||||
void stopLogging();
|
||||
|
||||
Q_SIGNALS:
|
||||
void messageLogged(const QOpenGLDebugMessage &debugMessage);
|
||||
|
||||
private:
|
||||
Q_DISABLE_COPY(QOpenGLDebugLogger)
|
||||
Q_DECLARE_PRIVATE(QOpenGLDebugLogger)
|
||||
Q_PRIVATE_SLOT(d_func(), void _q_contextAboutToBeDestroyed())
|
||||
};
|
||||
|
||||
QT_END_NAMESPACE
|
||||
|
||||
Q_DECLARE_METATYPE(QOpenGLDebugMessage)
|
||||
|
||||
#endif // QT_NO_OPENGL
|
||||
|
||||
#endif // QOPENGLDEBUG_H
|
||||
Loading…
Reference in New Issue
Block a user