From e85aa551ebe5f882c9771dc3ea2b90b02b286a49 Mon Sep 17 00:00:00 2001
From: Laszlo Agocs <laszlo.agocs@qt.io>
Date: Mon, 8 Apr 2019 17:05:28 +0200
Subject: vulkan: Add debug message filtering

[ChangeLog][QtGui] Added support for filtering Vulkan debug messages in
QVulkanInstance. This is especially useful for processing or suppressing
messages from the validation layers.

Change-Id: Idf0d7889085948daf5b1a53d2a9b11081e967609
Reviewed-by: Paul Olav Tvete <paul.tvete@qt.io>
---
 src/gui/vulkan/qplatformvulkaninstance.cpp |  5 ++++
 src/gui/vulkan/qplatformvulkaninstance.h   |  1 +
 src/gui/vulkan/qvulkaninstance.cpp         | 46 ++++++++++++++++++++++++++++++
 src/gui/vulkan/qvulkaninstance.h           |  5 ++++
 4 files changed, 57 insertions(+)

(limited to 'src/gui')

diff --git a/src/gui/vulkan/qplatformvulkaninstance.cpp b/src/gui/vulkan/qplatformvulkaninstance.cpp
index 6201d3ec11..9d044bfd58 100644
--- a/src/gui/vulkan/qplatformvulkaninstance.cpp
+++ b/src/gui/vulkan/qplatformvulkaninstance.cpp
@@ -85,4 +85,9 @@ void QPlatformVulkanInstance::presentQueued(QWindow *window)
     Q_UNUSED(window);
 }
 
+void QPlatformVulkanInstance::setDebugFilters(const QVector<QVulkanInstance::DebugFilter> &filters)
+{
+    Q_UNUSED(filters);
+}
+
 QT_END_NAMESPACE
diff --git a/src/gui/vulkan/qplatformvulkaninstance.h b/src/gui/vulkan/qplatformvulkaninstance.h
index 9f34803f7b..d47c59b5db 100644
--- a/src/gui/vulkan/qplatformvulkaninstance.h
+++ b/src/gui/vulkan/qplatformvulkaninstance.h
@@ -78,6 +78,7 @@ public:
     virtual PFN_vkVoidFunction getInstanceProcAddr(const char *name) = 0;
     virtual bool supportsPresent(VkPhysicalDevice physicalDevice, uint32_t queueFamilyIndex, QWindow *window) = 0;
     virtual void presentQueued(QWindow *window);
+    virtual void setDebugFilters(const QVector<QVulkanInstance::DebugFilter> &filters);
 
 private:
     QScopedPointer<QPlatformVulkanInstancePrivate> d_ptr;
diff --git a/src/gui/vulkan/qvulkaninstance.cpp b/src/gui/vulkan/qvulkaninstance.cpp
index 2941bfd01f..0605d88cca 100644
--- a/src/gui/vulkan/qvulkaninstance.cpp
+++ b/src/gui/vulkan/qvulkaninstance.cpp
@@ -269,6 +269,7 @@ public:
     VkResult errorCode;
     QScopedPointer<QVulkanFunctions> funcs;
     QHash<VkDevice, QVulkanDeviceFunctions *> deviceFuncs;
+    QVector<QVulkanInstance::DebugFilter> debugFilters;
 };
 
 bool QVulkanInstancePrivate::ensureVulkan()
@@ -570,6 +571,7 @@ bool QVulkanInstance::create()
         d_ptr->extensions = d_ptr->platformInst->enabledExtensions();
         d_ptr->errorCode = VK_SUCCESS;
         d_ptr->funcs.reset(new QVulkanFunctions(this));
+        d_ptr->platformInst->setDebugFilters(d_ptr->debugFilters);
         return true;
     }
 
@@ -785,6 +787,50 @@ void QVulkanInstance::presentQueued(QWindow *window)
     d_ptr->platformInst->presentQueued(window);
 }
 
+/*!
+    \typedef QVulkanInstance::DebugFilter
+
+    Typedef for debug filtering callback functions.
+
+    \sa installDebugOutputFilter(), removeDebugOutputFilter()
+ */
+
+/*!
+    Installs a \a filter function that is called for every Vulkan debug
+    message. When the callback returns \c true, the message is stopped (filtered
+    out) and will not appear on the debug output.
+
+    \note Filtering is only effective when NoDebugOutputRedirect is not
+    \l{setFlags()}{set}. Installing filters has no effect otherwise.
+
+    \note This function can be called before create().
+
+    \sa removeDebugOutputFilter()
+ */
+void QVulkanInstance::installDebugOutputFilter(DebugFilter filter)
+{
+    if (!d_ptr->debugFilters.contains(filter)) {
+        d_ptr->debugFilters.append(filter);
+        if (d_ptr->platformInst)
+            d_ptr->platformInst->setDebugFilters(d_ptr->debugFilters);
+    }
+}
+
+/*!
+    Removes a \a filter function previously installed by
+    installDebugOutputFilter().
+
+    \note This function can be called before create().
+
+    \sa installDebugOutputFilter()
+ */
+void QVulkanInstance::removeDebugOutputFilter(DebugFilter filter)
+{
+    d_ptr->debugFilters.removeOne(filter);
+    if (d_ptr->platformInst)
+        d_ptr->platformInst->setDebugFilters(d_ptr->debugFilters);
+}
+
 #ifndef QT_NO_DEBUG_STREAM
 QDebug operator<<(QDebug dbg, const QVulkanLayer &layer)
 {
diff --git a/src/gui/vulkan/qvulkaninstance.h b/src/gui/vulkan/qvulkaninstance.h
index f28975f911..70f2fd5102 100644
--- a/src/gui/vulkan/qvulkaninstance.h
+++ b/src/gui/vulkan/qvulkaninstance.h
@@ -188,6 +188,11 @@ public:
 
     void presentQueued(QWindow *window);
 
+    typedef bool (*DebugFilter)(VkDebugReportFlagsEXT flags, VkDebugReportObjectTypeEXT objectType, uint64_t object,
+                                size_t location, int32_t messageCode, const char *pLayerPrefix, const char *pMessage);
+    void installDebugOutputFilter(DebugFilter filter);
+    void removeDebugOutputFilter(DebugFilter filter);
+
 private:
     QScopedPointer<QVulkanInstancePrivate> d_ptr;
     Q_DISABLE_COPY(QVulkanInstance)
-- 
cgit v1.2.3