AnimationShaderEffect.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorAnimation/phosphoranimation_export.h>
 
#include <PhosphorShaders/CustomParamsKey.h>
 
#include <QJsonObject>
#include <QList>
#include <QString>
#include <QStringList>
#include <QVariant>
 
namespace PhosphorAnimationShaders {
 
struct PHOSPHORANIMATION_EXPORT AnimationShaderEffect
{
    QString id;
 
    QString name;
 
    QString description;
 
    QString author;
 
    QString version;
 
    QString category;
 
    QStringList appliesTo;
 
    QString fragmentShaderPath;
 
    QString vertexShaderPath;
 
    QString sourceDir;
 
    bool isUserEffect = false;
 
    QString previewPath;
 
    // ── Multipass / advanced features (opt-in, matching overlay ShaderInfo) ──
 
    QStringList bufferShaderPaths;
 
    bool isMultipass = false;
 
    bool useWallpaper = false;
 
    bool bufferFeedback = false;
 
    qreal bufferScale = 1.0;
 
    QString bufferWrap;
 
    QStringList bufferWraps;
 
    QString bufferFilter;
 
    QStringList bufferFilters;
 
    bool useDepthBuffer = false;
 
    bool useAudio = false;
 
    enum class FboExtentKind {
        Anchor,
        Surface,
    };
    FboExtentKind fboExtentKind = FboExtentKind::Anchor;
 
    int geometryGridSubdivisions = 0;
 
    static constexpr qreal kMinBufferScale = PhosphorShaders::kMinBufferScale;
    static constexpr qreal kMaxBufferScale = PhosphorShaders::kMaxBufferScale;
    static_assert(kMinBufferScale > 0.0 && kMinBufferScale < kMaxBufferScale,
                  "kMinBufferScale must be positive and strictly less than kMaxBufferScale");
 
    static constexpr int kMaxGeometryGridSubdivisions = 128;
 
    struct ParameterInfo
    {
        QString id;
        QString name;
        QString type; 
        QString description; 
        QString group; 
        QVariant defaultValue; 
        QVariant minValue; 
        QVariant maxValue; 
        QVariant stepValue; 
    };
    QList<ParameterInfo> parameters;
 
    struct TextureSlot
    {
        QString path; 
        QString
            wrap; 
 
        bool operator==(const TextureSlot& other) const
        {
            return path == other.path && wrap == other.wrap;
        }
        bool operator!=(const TextureSlot& other) const
        {
            return !(*this == other);
        }
    };
    QList<TextureSlot> textures;
 
    bool isValid() const
    {
        return !id.isEmpty() && !fragmentShaderPath.isEmpty();
    }
 
    QJsonObject toJson() const;
    static AnimationShaderEffect fromJson(const QJsonObject& obj);
 
    bool operator==(const AnimationShaderEffect& other) const;
    bool operator!=(const AnimationShaderEffect& other) const
    {
        return !(*this == other);
    }
};
 
PHOSPHORANIMATION_EXPORT bool shaderEffectAppliesToEventPath(const AnimationShaderEffect& effect, const QString& path);
 
PHOSPHORANIMATION_EXPORT bool shaderEffectIsCompositorOnly(const AnimationShaderEffect& effect);
 
} // namespace PhosphorAnimationShaders
 
// Mark TextureSlot as relocatable so QList can move-construct entries
// in-place during reallocation rather than running the copy/move ctor
// per element. The struct is two QStrings; QString itself is already
// Q_RELOCATABLE_TYPE, so the aggregate is safely bitwise-relocatable.
// Must sit at file scope outside the namespace per Qt convention.
Q_DECLARE_TYPEINFO(PhosphorAnimationShaders::AnimationShaderEffect::TextureSlot, Q_RELOCATABLE_TYPE);