6#include <PhosphorAnimation/phosphoranimation_export.h>
226 "kMinBufferScale must be positive and strictly less than kMaxBufferScale");
294 return !(*
this == other);
321 return !(*
this == other);
Q_DECLARE_TYPEINFO(PhosphorAnimationShaders::AnimationShaderEffect::TextureSlot, Q_RELOCATABLE_TYPE)
Definition AnimationShaderContract.h:10
PHOSPHORANIMATION_EXPORT bool shaderEffectAppliesToEventPath(const AnimationShaderEffect &effect, const QString &path)
True iff effect may meaningfully run on event path.
PHOSPHORANIMATION_EXPORT bool shaderEffectIsCompositorOnly(const AnimationShaderEffect &effect)
True iff effect can ONLY execute on the compositor (kwin-effect) runtime and never on the daemon's ov...
constexpr double kMaxBufferScale
Definition CustomParamsKey.h:37
constexpr double kMinBufferScale
Lower / upper bounds on a multipass bufferScale (FBO downscale factor).
Definition CustomParamsKey.h:36
QMap< QString, QVariantMap > PackPresets
Pack-declared named parameter presets: preset name → { paramId → value }.
Definition ShaderPresetParse.h:32
Declared shader inputs beyond the standard set (iTime, iFrame, etc.).
Definition AnimationShaderEffect.h:249
QVariant maxValue
JSON/QML key: max.
Definition AnimationShaderEffect.h:257
QString name
Definition AnimationShaderEffect.h:251
QString description
Optional one-line tooltip for the settings UI.
Definition AnimationShaderEffect.h:253
QVariant minValue
JSON/QML key: min.
Definition AnimationShaderEffect.h:256
QVariant stepValue
Optional slider step; JSON/QML key: step. QML falls back to (max-min)/200.
Definition AnimationShaderEffect.h:258
QString group
Optional accordion group name for the settings UI.
Definition AnimationShaderEffect.h:254
QVariant defaultValue
JSON/QML key: default.
Definition AnimationShaderEffect.h:255
QString id
Definition AnimationShaderEffect.h:250
QString type
"float", "int", "bool", "color"
Definition AnimationShaderEffect.h:252
User texture slot.
Definition AnimationShaderEffect.h:283
QString wrap
"clamp" / "repeat" / "mirror"; empty = runtime default. Other values are rejected by fromJson.
Definition AnimationShaderEffect.h:286
bool operator!=(const TextureSlot &other) const
Definition AnimationShaderEffect.h:292
QString path
Filename relative to the effect's sourceDir.
Definition AnimationShaderEffect.h:284
bool operator==(const TextureSlot &other) const
Definition AnimationShaderEffect.h:288
Metadata for a single animation shader effect (transition).
Definition AnimationShaderEffect.h:47
QString version
Semantic version of this effect pack.
Definition AnimationShaderEffect.h:61
FboExtentKind
How wide the shader effect's render target is — relative to its anchor (default), or filling the surf...
Definition AnimationShaderEffect.h:196
@ Anchor
Definition AnimationShaderEffect.h:197
bool useDepthBuffer
Allocate a depth buffer alongside the colour FBO so the shader can sample window depth.
Definition AnimationShaderEffect.h:156
QString fragmentShaderPath
Path to the fragment shader (relative to the effect dir).
Definition AnimationShaderEffect.h:94
QString author
Author attribution.
Definition AnimationShaderEffect.h:58
bool isMultipass
Opt-in multipass mode.
Definition AnimationShaderEffect.h:121
static AnimationShaderEffect fromJson(const QJsonObject &obj)
QString category
Category for settings-UI grouping (e.g. "Fade", "Geometric", "Glitch").
Definition AnimationShaderEffect.h:64
int geometryGridSubdivisions
Per-axis subdivision count for geometry shaders that deform the drawn quad in the vertex stage (e....
Definition AnimationShaderEffect.h:214
QString bufferFilter
Default filter mode for all buffer samplers.
Definition AnimationShaderEffect.h:148
PhosphorShaders::PackPresets presets
Pack-declared named parameter presets: preset name -> { paramId -> value }.
Definition AnimationShaderEffect.h:308
QList< TextureSlot > textures
Definition AnimationShaderEffect.h:297
bool isUserEffect
Whether this effect was loaded from a user-local directory.
Definition AnimationShaderEffect.h:104
QStringList bufferShaderPaths
Buffer-pass shader paths (relative to effect dir).
Definition AnimationShaderEffect.h:114
QJsonObject toJson() const
QString id
Stable identifier — lookup key in the registry.
Definition AnimationShaderEffect.h:49
bool operator!=(const AnimationShaderEffect &other) const
Definition AnimationShaderEffect.h:319
bool operator==(const AnimationShaderEffect &other) const
QString sourceDir
Resolved absolute directory containing this effect's assets.
Definition AnimationShaderEffect.h:101
QString name
Human-readable display name (localizable by the consumer).
Definition AnimationShaderEffect.h:52
QList< ParameterInfo > parameters
Definition AnimationShaderEffect.h:260
bool useAudio
Audio-reactive opt-in (JSON key audio, matching the surface pack vocabulary).
Definition AnimationShaderEffect.h:172
QString bufferWrap
Default wrap mode for all buffer samplers.
Definition AnimationShaderEffect.h:140
static constexpr qreal kMaxBufferScale
Definition AnimationShaderEffect.h:224
QStringList bufferWraps
Per-buffer wrap-mode overrides; index aligns with bufferShaderPaths.
Definition AnimationShaderEffect.h:144
QString description
One-line description for settings UI tooltips.
Definition AnimationShaderEffect.h:55
QStringList bufferFilters
Per-buffer filter-mode overrides; index aligns with bufferShaderPaths.
Definition AnimationShaderEffect.h:152
bool isValid() const
Definition AnimationShaderEffect.h:310
qreal bufferScale
Render-target scale relative to the surface size.
Definition AnimationShaderEffect.h:135
FboExtentKind fboExtentKind
Definition AnimationShaderEffect.h:200
static constexpr qreal kMinBufferScale
Lower / upper bounds on bufferScale (multipass FBO downscale factor) — forwarders onto the cross-libr...
Definition AnimationShaderEffect.h:223
static constexpr int kMaxGeometryGridSubdivisions
Upper bound for geometryGridSubdivisions.
Definition AnimationShaderEffect.h:234
QString previewPath
Preview image path (relative to the effect dir). For settings UI.
Definition AnimationShaderEffect.h:107
QString vertexShaderPath
Path to the vertex shader (relative to the effect dir).
Definition AnimationShaderEffect.h:98
bool bufferFeedback
Enable per-pass feedback (last frame's buffer is sampleable as iChannel<N>).
Definition AnimationShaderEffect.h:130
QStringList appliesTo
Event-class tokens this effect is meaningful on.
Definition AnimationShaderEffect.h:89
bool useWallpaper
Bind the user's wallpaper as a sampler.
Definition AnimationShaderEffect.h:126