Files
emulator/src/citron/uisettings.h
T

306 lines
19 KiB
C++

// SPDX-FileCopyrightText: 2016 Citra Emulator Project
// SPDX-FileCopyrightText: 2025 citron Emulator Project
// SPDX-License-Identifier: GPL-2.0-or-later
#pragma once
#include <array>
#include <atomic>
#include <vector>
#include <QByteArray>
#include <QMetaType>
#include <QString>
#include <QStringList>
#include <QVector>
#include "common/common_types.h"
#include "common/settings.h"
#include "common/settings_enums.h"
#include "configuration/qt_config.h"
using Settings::Category;
using Settings::ConfirmStop;
using Settings::Setting;
using Settings::SwitchableSetting;
#ifndef CANNOT_EXPLICITLY_INSTANTIATE
namespace Settings {
extern template class Setting<bool>;
extern template class Setting<std::string>;
extern template class Setting<u16, true>;
extern template class Setting<u32>;
extern template class Setting<u8, true>;
extern template class Setting<u8>;
extern template class Setting<unsigned long long>;
} // namespace Settings
#endif
namespace UISettings {
bool IsDarkTheme();
bool IsGamescope();
struct ContextualShortcut {
std::string keyseq;
std::string controller_keyseq;
int context;
bool repeat;
};
struct Shortcut {
std::string name;
std::string group;
ContextualShortcut shortcut;
};
enum class Theme {
Default,
DefaultColorful,
Dark,
DarkColorful,
MidnightBlue,
MidnightBlueColorful,
};
static constexpr Theme default_theme{
#ifdef _WIN32
Theme::DarkColorful
#else
Theme::DefaultColorful
#endif
};
using Themes = std::array<std::pair<const char*, const char*>, 6>;
extern const Themes themes;
struct GameDir {
std::string path;
bool deep_scan = false;
bool expanded = false;
bool operator==(const GameDir& rhs) const {
return path == rhs.path;
}
bool operator!=(const GameDir& rhs) const {
return !operator==(rhs);
}
};
struct Values {
Settings::Linkage linkage{1000};
QByteArray geometry;
QByteArray state;
QByteArray renderwindow_geometry;
QByteArray configure_dialog_geometry;
QByteArray per_game_configure_geometry;
QByteArray gamelist_header_state;
Setting<bool> single_window_mode{linkage, true, "singleWindowMode", Category::Ui};
Setting<bool> fullscreen{linkage, false, "fullscreen", Category::Ui};
Setting<bool> display_titlebar{linkage, true, "displayTitleBars", Category::Ui};
Setting<bool> show_filter_bar{linkage, true, "showFilterBar", Category::Ui};
Setting<bool> show_status_bar{linkage, true, "showStatusBar", Category::Ui};
Setting<bool> show_performance_overlay{linkage, false, "showPerformanceOverlay", Category::Ui};
Setting<bool> show_vram_overlay{linkage, false, "showVramOverlay", Category::Ui};
Setting<ConfirmStop> confirm_before_stopping{linkage,
ConfirmStop::Ask_Always,
"confirmStop",
Category::UiGeneral,
Settings::Specialization::Default,
true,
true};
Setting<bool> first_start{linkage, true, "firstStart", Category::Ui};
Setting<bool> setup_resume{linkage, false, "setupResume", Category::Ui};
Setting<bool> pause_when_in_background{linkage,
false,
"pauseWhenInBackground",
Category::UiGeneral,
Settings::Specialization::Default,
true,
true};
Setting<bool> mute_when_in_background{linkage,
false,
"muteWhenInBackground",
Category::UiAudio,
Settings::Specialization::Default,
true,
true};
Setting<bool> hide_mouse{
linkage, true, "hideInactiveMouse", Category::UiGeneral, Settings::Specialization::Default,
true, true};
Setting<bool> controller_applet_disabled{linkage, false, "disableControllerApplet",
Category::UiGeneral};
// Set when Vulkan is known to crash the application
bool has_broken_vulkan = false;
Setting<bool> select_user_on_boot{linkage,
false,
"select_user_on_boot",
Category::UiGeneral,
Settings::Specialization::Default,
true,
true};
Setting<bool> disable_web_applet{linkage, true, "disable_web_applet", Category::Ui};
Setting<bool> check_for_updates_on_start{linkage, true, "check_for_updates_on_start", Category::Ui};
Setting<bool> auto_update_before_init{linkage, false, "auto_update_before_init", Category::Ui};
// GameBanana Mod Manager
Setting<bool> always_ask_manual_extraction{linkage, false, "always_ask_manual_extraction", Category::Ui};
Setting<bool> disable_backup_archives{linkage, false, "disable_backup_archives", Category::Ui};
// User might not want backups. Allow them to disable/re-enable accordingly.
Setting<bool> updater_enable_backups{linkage, true, "updater/enableBackups", Category::Ui};
// The custom directory to store AppImage backups on Linux. If empty, backups are stored
// in a 'backup' folder next to the main AppImage.
Setting<std::string> updater_backup_path{linkage, "", "updater/backupPath", Category::Ui};
// Discord RPC
Setting<bool> enable_discord_presence{linkage, true, "enable_discord_presence", Category::Ui};
// logging
Setting<bool> show_console{linkage, false, "showConsole", Category::Ui};
// Screenshots
Setting<bool> enable_screenshot_save_as{linkage, true, "enable_screenshot_save_as",
Category::Screenshots};
Setting<u32> screenshot_height{linkage, 0, "screenshot_height", Category::Screenshots};
std::string roms_path;
std::string game_dir_deprecated;
bool game_dir_deprecated_deepscan;
QVector<GameDir> game_dirs;
QStringList recent_files;
QStringList recent_backgrounds;
Setting<std::string> language{linkage, {}, "language", Category::Paths};
std::string theme;
Setting<std::string> ui_positioning{linkage, "Vertical", "ui_positioning", Category::Ui};
Setting<std::string> steam_grid_db_api_key{linkage, "", "steam_grid_db_api_key", Category::Ui};
Setting<std::string> accent_color{linkage, "#4a9eff", "accent_color", Category::Ui};
Setting<bool> enable_rainbow_mode{linkage, false, "enable_rainbow_mode", Category::Ui};
Setting<std::string> neo_ui_theme{linkage, "none", "neo_ui_theme", Category::Ui};
Setting<std::string> custom_game_list_bg_path{linkage, "", "custom_game_list_bg_path", Category::Ui};
Setting<u8> custom_game_list_bg_opacity{linkage, 128, "custom_game_list_bg_opacity", Category::Ui};
Setting<std::string> custom_card_bg_color{linkage, "", "custom_card_bg_color", Category::Ui};
Setting<std::string> custom_card_text_color{linkage, "", "custom_card_text_color", Category::Ui};
Setting<std::string> custom_card_dim_text_color{linkage, "", "custom_card_dim_text_color", Category::Ui};
Setting<u8> custom_card_opacity{linkage, 255, "custom_card_opacity", Category::Ui};
Setting<std::string> custom_header_text_color{linkage, "", "custom_header_text_color", Category::Ui};
Setting<std::string> custom_header_bg_color{linkage, "", "custom_header_bg_color", Category::Ui};
Setting<u8> custom_header_opacity{linkage, 255, "custom_header_opacity", Category::Ui};
Setting<std::string> custom_status_bar_text_color{linkage, "", "custom_status_bar_text_color", Category::Ui};
Setting<std::string> custom_status_bar_bg_color{linkage, "", "custom_status_bar_bg_color", Category::Ui};
Setting<std::string> custom_status_bar_accent_color{linkage, "", "custom_status_bar_accent_color", Category::Ui};
Setting<std::string> custom_toolbar_text_color{linkage, "", "custom_toolbar_text_color", Category::Ui};
Setting<std::string> custom_toolbar_bg_color{linkage, "", "custom_toolbar_bg_color", Category::Ui};
Setting<std::string> custom_card_outline_color{linkage, "", "custom_card_outline_color", Category::Ui};
Setting<u8> custom_card_outline_size{linkage, 1, "custom_card_outline_size", Category::Ui};
Setting<std::string> custom_selection_color{linkage, "", "custom_selection_color", Category::Ui};
Setting<u8> custom_selection_opacity{linkage, 153, "custom_selection_opacity", Category::Ui};
Setting<std::string> custom_list_bg_color{linkage, "", "custom_list_bg_color", Category::Ui};
Setting<u8> game_list_slider_mode{linkage, 0, "game_list_slider_mode", Category::Ui};
// Shortcut name <Shortcut, context>
std::vector<Shortcut> shortcuts;
Setting<u32> callout_flags{linkage, 0, "calloutFlags", Category::Ui};
// multiplayer settings
Setting<std::string> multiplayer_nickname{linkage, {}, "nickname", Category::Multiplayer};
Setting<std::string> multiplayer_filter_text{linkage, {}, "filter_text", Category::Multiplayer};
Setting<bool> multiplayer_filter_games_owned{linkage, false, "filter_games_owned",
Category::Multiplayer};
Setting<bool> multiplayer_filter_hide_empty{linkage, false, "filter_games_hide_empty",
Category::Multiplayer};
Setting<bool> multiplayer_filter_hide_full{linkage, false, "filter_games_hide_full",
Category::Multiplayer};
Setting<std::string> multiplayer_ip{linkage, {}, "ip", Category::Multiplayer};
Setting<u16, true> multiplayer_port{linkage, 24872, 0,
UINT16_MAX, "port", Category::Multiplayer};
Setting<std::string> multiplayer_room_nickname{
linkage, {}, "room_nickname", Category::Multiplayer};
Setting<std::string> multiplayer_room_name{linkage, {}, "room_name", Category::Multiplayer};
Setting<u8, true> multiplayer_max_player{linkage, 8, 0, 8, "max_player", Category::Multiplayer};
Setting<u16, true> multiplayer_room_port{linkage, 24872, 0,
UINT16_MAX, "room_port", Category::Multiplayer};
Setting<u8, true> multiplayer_host_type{linkage, 0, 0, 1, "host_type", Category::Multiplayer};
Setting<unsigned long long> multiplayer_game_id{linkage, {}, "game_id", Category::Multiplayer};
Setting<std::string> multiplayer_room_description{
linkage, {}, "room_description", Category::Multiplayer};
std::pair<std::vector<std::string>, std::vector<std::string>> multiplayer_ban_list;
// Game List
Setting<bool> show_add_ons{linkage, true, "show_add_ons", Category::UiGameList};
Setting<u32> game_icon_size{linkage, 64, "game_icon_size", Category::UiGameList};
Setting<u32> game_font_size{linkage, 11, "game_font_size", Category::UiGameList};
Setting<u32> folder_icon_size{linkage, 48, "folder_icon_size", Category::UiGameList};
Setting<u8> row_1_text_id{linkage, 3, "row_1_text_id", Category::UiGameList};
Setting<u8> row_2_text_id{linkage, 2, "row_2_text_id", Category::UiGameList};
Setting<bool> game_list_grid_view{linkage, false, "game_list_grid_view", Category::UiGameList};
Setting<bool> game_list_poster_view{linkage, false, "game_list_poster_view", Category::UiGameList};
Setting<bool> auto_download_posters{linkage, true, "auto_download_posters", Category::UiGameList};
Setting<int> game_list_view_mode{linkage, 0, "game_list_view_mode", Category::UiGameList};
std::atomic_bool is_game_list_reload_pending{false};
Setting<bool> cache_game_list{linkage, true, "cache_game_list", Category::UiGameList};
Setting<bool> scan_nca{linkage, false, "scan_nca", Category::UiGameList};
Setting<bool> prompt_for_autoloader{linkage, true, "prompt_for_autoloader", Category::UiGameList};
Setting<bool> favorites_expanded{linkage, true, "favorites_expanded", Category::UiGameList};
QVector<u64> favorited_ids;
QStringList hidden_paths;
// Compatibility List
Setting<bool> show_compat{linkage, false, "show_compat", Category::UiGameList};
// Size & File Types Column
Setting<bool> show_size{linkage, true, "show_size", Category::UiGameList};
Setting<bool> show_types{linkage, true, "show_types", Category::UiGameList};
// Play time
Setting<bool> show_play_time{linkage, true, "show_play_time", Category::UiGameList};
// Online Column
Setting<bool> show_online_column{linkage, true, "show_online_column", Category::UiGameList};
bool configuration_applied;
bool reset_to_defaults;
bool shortcut_already_warned{false};
};
extern Values values;
u32 CalculateWidth(u32 height, Settings::AspectRatio ratio);
void SaveWindowState();
void RestoreWindowState(std::unique_ptr<QtConfig>& qtConfig);
// This shouldn't have anything except static initializers (no functions). So
// QKeySequence(...).toString() is NOT ALLOWED HERE.
// This must be in alphabetical order according to action name as it must have the same order as
// UISetting::values.shortcuts, which is alphabetically ordered.
// clang-format off
extern const std::array<Shortcut, 31> default_hotkeys;
// clang-format on
} // namespace UISettings
Q_DECLARE_METATYPE(UISettings::GameDir*);
// These metatype declarations cannot be in common/settings.h because core is devoid of QT
Q_DECLARE_METATYPE(Settings::CpuAccuracy);
Q_DECLARE_METATYPE(Settings::GpuAccuracy);
Q_DECLARE_METATYPE(Settings::FullscreenMode);
Q_DECLARE_METATYPE(Settings::NvdecEmulation);
Q_DECLARE_METATYPE(Settings::ResolutionSetup);
Q_DECLARE_METATYPE(Settings::ScalingFilter);
Q_DECLARE_METATYPE(Settings::AntiAliasing);
Q_DECLARE_METATYPE(Settings::RendererBackend);
Q_DECLARE_METATYPE(Settings::AstcRecompression);
Q_DECLARE_METATYPE(Settings::AstcDecodeMode);