Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
ShaderPresetStore.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2026 fuddlesworth
2// SPDX-License-Identifier: LGPL-2.1-or-later
3
4#pragma once
5
8#include <PhosphorShaders/phosphorshaders_export.h>
9
11
12#include <QList>
13#include <QObject>
14#include <QString>
15
16#include <array>
17#include <memory>
18
19namespace PhosphorShaders {
20
22
35PHOSPHORSHADERS_EXPORT QString standardUserPresetRoot(const QString& subdirectory);
36
38PHOSPHORSHADERS_EXPORT QString userPresetDirectory(const QString& root, ShaderFamily family);
39
52PHOSPHORSHADERS_EXPORT int migrateLegacyOverlayPresets(const QString& root);
53
116class PHOSPHORSHADERS_EXPORT ShaderPresetStore : public QObject
117{
118 Q_OBJECT
119
120public:
121 explicit ShaderPresetStore(QObject* parent = nullptr);
123
126
151 void load(const QString& root, const QList<ShaderFamily>& families = {});
152
156
166 bool publishes(ShaderFamily family) const;
167
179
181 QString directoryFor(ShaderFamily family) const;
182
183private:
187 class Sink;
188
191 struct Publisher
192 {
193 std::unique_ptr<Sink> sink;
194 std::unique_ptr<PhosphorFsLoader::DirectoryLoader> loader;
195
196 bool active() const
197 {
198 return loader != nullptr;
199 }
200 };
201
210 static constexpr std::size_t slotOf(ShaderFamily family)
211 {
212 return static_cast<std::size_t>(family);
213 }
214
222 ShaderPresetRegistry m_registry;
223
226 std::array<Publisher, ShaderFamilyCount> m_publishers;
227
228 QString m_root;
229};
230
231} // namespace PhosphorShaders
The one place a presetId on an assignment turns into parameters.
Definition ShaderPresetRegistry.h:51
ShaderPresetStore(QObject *parent=nullptr)
ShaderPresetRegistry & registry()
The registry every consumer resolves through.
void load(const QString &root, const QList< ShaderFamily > &families={})
Import any legacy overlay presets, then scan the named families.
const ShaderPresetRegistry & registry() const
ShaderPresetStore(const ShaderPresetStore &)=delete
bool rescanNow(ShaderFamily family)
Rescan family's directory synchronously, so the registry reflects the new state before this returns.
bool publishes(ShaderFamily family) const
Whether this store publishes family, i.e.
QString directoryFor(ShaderFamily family) const
Where a new user preset for family belongs.
ShaderPresetStore & operator=(const ShaderPresetStore &)=delete
LiveReload
Opt-in policy for directory watching.
Definition WatchedDirectorySet.h:40
Definition ShaderProfile.h:21
PHOSPHORSHADERS_EXPORT QString userPresetDirectory(const QString &root, ShaderFamily family)
The directory holding family's user presets under root.
PhosphorFsLoader::LiveReload LiveReload
Definition ShaderPresetStore.h:21
ShaderFamily
Which shader family a preset belongs to.
Definition ShaderPreset.h:28
PHOSPHORSHADERS_EXPORT int migrateLegacyOverlayPresets(const QString &root)
Import pre-existing overlay preset files into the family layout.
PHOSPHORSHADERS_EXPORT QString standardUserPresetRoot(const QString &subdirectory)
The standard root for user-saved shader presets: <XDG_DATA_HOME>/<subdirectory>, where subdirectory i...