vkconfig: Add setting debug view

Author: christophe-lunarg

vkconfig_core/configurator.cpp

@@ -745,7 +745,7 @@ std::string Configurator::Log() const {
     }
 
     log += format(" - Use system tray: %s\n", this->use_system_tray ? "true" : "false");
-    log += format(" - Use layer developer mode: %s\n", this->use_layer_dev_mode ? "true" : "false");
+    log += format(" - Use layer developer mode: %s\n", this->use_layer_debug_mode ? "true" : "false");
     log += format(" - ${VULKAN_BIN}: %s\n", ::Path(Path::BIN).AbsolutePath().c_str());
     log += format(" - ${VULKAN_PROFILES}: %s\n", ::Path(Path::PROFILES).AbsolutePath().c_str());
     log += format(" - ${VULKAN_HOME}: %s\n", ::Path(Path::HOME).AbsolutePath().c_str());
@@ -971,8 +971,8 @@ bool Configurator::Load() {
         if (json_interface_object.value(GetToken(TAB_PREFERENCES)) != QJsonValue::Undefined) {
             const QJsonObject& json_object = json_interface_object.value(GetToken(TAB_PREFERENCES)).toObject();
 
-            if (json_object.value("use_layer_dev_mode") != QJsonValue::Undefined) {
-                this->use_layer_dev_mode = json_object.value("use_layer_dev_mode").toBool();
+            if (json_object.value("use_layer_debug_mode") != QJsonValue::Undefined) {
+                this->use_layer_debug_mode = json_object.value("use_layer_debug_mode").toBool();
             }
 
             if (json_object.value("use_notify_releases") != QJsonValue::Undefined) {
@@ -1053,7 +1053,7 @@ bool Configurator::Save() const {
     {
         QJsonObject json_object;
         json_object.insert("use_system_tray", this->use_system_tray);
-        json_object.insert("use_layer_dev_mode", this->use_layer_dev_mode);
+        json_object.insert("use_layer_debug_mode", this->use_layer_debug_mode);
         json_object.insert("use_notify_releases", this->use_notify_releases);
         json_object.insert("latest_sdk_version", this->latest_sdk_version.str().c_str());
         json_object.insert("last_vkconfig_version", Version::VKCONFIG.str().c_str());
@@ -1122,9 +1122,9 @@ bool Configurator::GetUseSystemTray() const { return this->use_system_tray; }
 
 void Configurator::SetUseSystemTray(bool enabled) { this->use_system_tray = enabled; }
 
-bool Configurator::GetUseLayerDevMode() const { return this->use_layer_dev_mode; }
+bool Configurator::GetUseLayerDebugMode() const { return this->use_layer_debug_mode; }
 
-void Configurator::SetUseLayerDevMode(bool enabled) { this->use_layer_dev_mode = enabled; }
+void Configurator::SetUseLayerDebugMode(bool enabled) { this->use_layer_debug_mode = enabled; }
 
 bool Configurator::GetUseNotifyReleases() const { return this->use_notify_releases; }
 

vkconfig_core/configurator.h

@@ -109,8 +109,8 @@ class Configurator {
     bool GetUseSystemTray() const;
     void SetUseSystemTray(bool enabled);
 
-    bool GetUseLayerDevMode() const;
-    void SetUseLayerDevMode(bool enabled);
+    bool GetUseLayerDebugMode() const;
+    void SetUseLayerDebugMode(bool enabled);
 
     bool GetUseNotifyReleases() const;
     void SetUseNotifyReleases(bool enabled);
@@ -163,7 +163,7 @@ class Configurator {
    private:
     int hide_message_boxes_flags = 0;
     bool use_system_tray = false;
-    bool use_layer_dev_mode = false;
+    bool use_layer_debug_mode = false;
     bool use_notify_releases = true;
     bool show_external_layers_settings = true;
     ExecutableScope executable_scope = EXECUTABLE_ANY;

vkconfig_core/header.cpp

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2020-2021 Valve Corporation
- * Copyright (c) 2020-2021 LunarG, Inc.
+ * Copyright (c) 2020-2025 Valve Corporation
+ * Copyright (c) 2020-2025 LunarG, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,37 +19,8 @@
  */
 
 #include "header.h"
-#include "util.h"
 #include "json.h"
 
-#include <cassert>
-
-SettingView GetSettingView(const char* token) {
-    assert(token != nullptr);
-    assert(std::strcmp(token, "") != 0);
-
-    for (int i = SETTING_VIEW_FIRST; i <= SETTING_VIEW_LAST; ++i) {
-        const SettingView state = static_cast<SettingView>(i);
-        if (ToUpperCase(token) == GetToken(state)) return state;
-    }
-
-    assert(0);  // Unknown token
-    return static_cast<SettingView>(-1);
-}
-
-const char* GetToken(SettingView state) {
-    assert(state >= SETTING_VIEW_FIRST && state <= SETTING_VIEW_LAST);
-
-    static const char* table[] = {
-        "STANDARD",  // SETTING_VIEW_STANDARD
-        "ADVANCED",  // SETTING_VIEW_ADVANCED
-        "HIDDEN",    // SETTING_VIEW_HIDDEN
-    };
-    static_assert(std::size(table) == SETTING_VIEW_COUNT, "The tranlation table size doesn't match the enum number of elements");
-
-    return table[state];
-}
-
 void LoadMetaHeader(Header& header, const QJsonObject& json_object) {
     header.label = ReadStringValue(json_object, "label");
     header.description = ReadStringValue(json_object, "description");

vkconfig_core/header.h

@@ -22,25 +22,12 @@
 
 #include "type_platform.h"
 #include "type_status.h"
+#include "type_view.h"
 #include "json.h"
 #include "path.h"
 
 #include <string>
 
-enum SettingView {
-    SETTING_VIEW_STANDARD = 0,
-    SETTING_VIEW_ADVANCED,
-    SETTING_VIEW_HIDDEN,
-
-    SETTING_VIEW_FIRST = SETTING_VIEW_STANDARD,
-    SETTING_VIEW_LAST = SETTING_VIEW_HIDDEN
-};
-
-enum { SETTING_VIEW_COUNT = SETTING_VIEW_LAST - SETTING_VIEW_FIRST + 1 };
-
-SettingView GetSettingView(const char* token);
-const char* GetToken(SettingView state);
-
 struct Header {
     Header() : status(STATUS_STABLE), view(SETTING_VIEW_STANDARD), platform_flags(PLATFORM_DESKTOP_BIT), expanded(true) {}
 

vkconfig_core/test/test_header.cpp

@@ -1,6 +1,6 @@
 /*
- * Copyright (c) 2020-2021 Valve Corporation
- * Copyright (c) 2020-2021 LunarG, Inc.
+ * Copyright (c) 2020-2025 Valve Corporation
+ * Copyright (c) 2020-2025 LunarG, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,3 +36,5 @@ TEST(test_header, get_setting_state_advanced) {
     EXPECT_EQ(SETTING_VIEW_ADVANCED, GetSettingView("ADVANCED"));
     EXPECT_STREQ("ADVANCED", GetToken(SETTING_VIEW_ADVANCED));
 }
+
+TEST(test_header, get_setting_state_unknown) { EXPECT_EQ(SETTING_VIEW_STANDARD, GetSettingView("UNKNOWN")); }

vkconfig_core/type_status.cpp

@@ -28,7 +28,7 @@ const char* GetToken(StatusType value) {
         "STABLE",     // STATUS_STABLE
         "BETA",       // STATUS_BETA
         "ALPHA",      // STATUS_ALPHA
-        "DEPRECATED"  // STATUS_ALPHA
+        "DEPRECATED"  // STATUS_DEPRECATED
     };
     static_assert(std::size(TOKENS) == STATUS_COUNT, "The tranlation table size doesn't match the enum number of elements");
 
@@ -47,5 +47,5 @@ StatusType GetStatusType(const char* token) {
         }
     }
 
-    return STATUS_INVALID;
+    return STATUS_STABLE;
 }

vkconfig_core/type_status.h

@@ -27,9 +27,7 @@ enum StatusType {
     STATUS_DEPRECATED,
 
     STATUS_FIRST = STATUS_STABLE,
-    STATUS_LAST = STATUS_DEPRECATED,
-
-    STATUS_INVALID
+    STATUS_LAST = STATUS_DEPRECATED
 };
 
 enum { STATUS_COUNT = STATUS_LAST - STATUS_FIRST + 1 };

vkconfig_core/type_view.cpp

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2020-2025 Valve Corporation
+ * Copyright (c) 2020-2025 LunarG, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Authors:
+ * - Christophe Riccio <christophe@lunarg.com>
+ */
+
+#include "type_view.h"
+#include "util.h"
+
+#include <cassert>
+
+SettingView GetSettingView(const char* token) {
+    assert(token != nullptr);
+    assert(std::strcmp(token, "") != 0);
+
+    for (int i = SETTING_VIEW_FIRST; i <= SETTING_VIEW_LAST; ++i) {
+        const SettingView state = static_cast<SettingView>(i);
+        if (ToUpperCase(token) == GetToken(state)) {
+            return state;
+        }
+    }
+
+    return SETTING_VIEW_STANDARD;  // Unknown token
+}
+
+const char* GetToken(SettingView state) {
+    assert(state >= SETTING_VIEW_FIRST && state <= SETTING_VIEW_LAST);
+
+    static const char* table[] = {
+        "STANDARD",  // SETTING_VIEW_STANDARD
+        "ADVANCED",  // SETTING_VIEW_ADVANCED
+        "DEBUG",     // SETTING_VIEW_DEBUG
+        "HIDDEN",    // SETTING_VIEW_HIDDEN
+    };
+    static_assert(std::size(table) == SETTING_VIEW_COUNT);
+
+    return table[state];
+}

vkconfig_core/type_view.h

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2020-2025 Valve Corporation
+ * Copyright (c) 2020-2025 LunarG, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ * Authors:
+ * - Christophe Riccio <christophe@lunarg.com>
+ */
+
+#pragma once
+
+enum SettingView {
+    SETTING_VIEW_STANDARD = 0,
+    SETTING_VIEW_ADVANCED,  // Deprecated in favor of SETTING_VIEW_DEBUG
+    SETTING_VIEW_DEBUG,
+    SETTING_VIEW_HIDDEN,
+
+    SETTING_VIEW_FIRST = SETTING_VIEW_STANDARD,
+    SETTING_VIEW_LAST = SETTING_VIEW_HIDDEN
+};
+
+enum { SETTING_VIEW_COUNT = SETTING_VIEW_LAST - SETTING_VIEW_FIRST + 1 };
+
+SettingView GetSettingView(const char* token);
+const char* GetToken(SettingView state);

vkconfig_gui/settings_tree.cpp

@@ -157,7 +157,7 @@ void SettingsTreeManager::CreateGUI() {
                 if (!IsPlatformSupported(layer_preset.platform_flags)) {
                     continue;
                 }
-                if (configurator.GetUseLayerDevMode()) {
+                if (configurator.GetUseLayerDebugMode()) {
                     if (layer_preset.view == SETTING_VIEW_HIDDEN) {
                         continue;
                     }
@@ -250,7 +250,7 @@ void SettingsTreeManager::BuildTreeItem(QTreeWidgetItem *parent, const SettingMe
     }
 
     Configurator &configurator = Configurator::Get();
-    if (configurator.GetUseLayerDevMode()) {
+    if (configurator.GetUseLayerDebugMode()) {
         if (meta_object.view == SETTING_VIEW_HIDDEN) {
             return;
         }
@@ -338,7 +338,7 @@ void SettingsTreeManager::BuildTreeItem(QTreeWidgetItem *parent, const SettingMe
                     continue;
                 }
 
-                if (configurator.GetUseLayerDevMode()) {
+                if (configurator.GetUseLayerDebugMode()) {
                     if (value.view == SETTING_VIEW_HIDDEN) {
                         return;
                     }
@@ -367,7 +367,7 @@ void SettingsTreeManager::BuildTreeItem(QTreeWidgetItem *parent, const SettingMe
                     continue;
                 }
 
-                if (configurator.GetUseLayerDevMode()) {
+                if (configurator.GetUseLayerDebugMode()) {
                     if (value.view == SETTING_VIEW_HIDDEN) {
                         return;
                     }