PhosphorAnimationShaders Namespace Reference

Namespaces
namespace	AnimationShaderContract
	Cross-runtime named-uniform contract for animation/transition shaders.

Classes
struct	AnimationAppRule
	One per-window animation override entry. More...
class	AnimationAppRuleList
	Ordered list of AnimationAppRule entries with first-match resolver. More...
struct	AnimationShaderEffect
	Metadata for a single animation shader effect (transition). More...
class	AnimationShaderRegistry
	Registry of available animation shader transition effects. More...
class	ShaderProfile
	Per-event shader effect selection and configuration. More...
class	ShaderProfileTree
	Hierarchical ShaderProfile storage with walk-up inheritance. More...

Functions
PHOSPHORANIMATION_EXPORT ShaderProfile	resolveAnimationShaderProfile (const AnimationAppRuleList &rules, const ShaderProfileTree &tree, const QString &windowClass, const QString &eventPath)
	Cascade resolver: window-class rule → per-event tree.
PHOSPHORANIMATION_EXPORT int	resolveAnimationDuration (const AnimationAppRuleList &rules, const QString &windowClass, const QString &eventPath, int defaultDurationMs)
	Duration cascade: window-class timing rule → per-event default.
PHOSPHORANIMATION_EXPORT PhosphorAnimation::Profile	resolveAnimationMotionProfile (const AnimationAppRuleList &rules, const PhosphorAnimation::Profile &base, const QString &windowClass, const QString &eventPath, const PhosphorAnimation::CurveRegistry &curveRegistry)
	Motion-profile cascade: window-class timing rule → base profile.

Function Documentation

resolveAnimationDuration()

PHOSPHORANIMATION_EXPORT int PhosphorAnimationShaders::resolveAnimationDuration	(	const AnimationAppRuleList &	rules,
		const QString &	windowClass,
		const QString &	eventPath,
		int	defaultDurationMs
	)

Duration cascade: window-class timing rule → per-event default.

Returns the duration in milliseconds that should drive the animation for a single (windowClass, eventPath) event:

1. AnimationAppRuleList::resolveTiming — first matching rule. A hit with durationMs > 0 returns that value, clamped to [Limits::MinAnimationDurationMs, Limits::MaxAnimationDurationMs] so a malformed rule can't feed an unbounded duration into the kwin-effect's QTimer::singleShot teardown timer or the shader transition's per-frame elapsed-time math. A hit with durationMs <= 0 is the documented "inherit per-event default" sentinel and falls through to step 2.
2. The caller-provided defaultDurationMs (typically the global Settings::animationDuration or a per-event-derived value).

Empty windowClass or empty eventPath short-circuits to step 2 — no rule can match either case, so the caller's default applies.

The curve override on a Timing rule is intentionally not surfaced here — curve cascades through the motion ProfileTree, which is a separate plumbing layer.

resolveAnimationMotionProfile()

PHOSPHORANIMATION_EXPORT PhosphorAnimation::Profile PhosphorAnimationShaders::resolveAnimationMotionProfile	(	const AnimationAppRuleList &	rules,
		const PhosphorAnimation::Profile &	base,
		const QString &	windowClass,
		const QString &	eventPath,
		const PhosphorAnimation::CurveRegistry &	curveRegistry
	)

Motion-profile cascade: window-class timing rule → base profile.

Returns a PhosphorAnimation::Profile whose curve and duration fields have been replaced with the matching Timing rule's values when one is engaged. The cascade is:

1. AnimationAppRuleList::resolveTiming — first matching rule. A non-empty curve field is parsed through curveRegistry; the override only takes effect when the registry returns a non-null curve, so a malformed curve string falls through to the base curve instead of dropping motion entirely. A rule durationMs > 0 overrides the base duration, clamped to [Limits::MinAnimationDurationMs, Limits::MaxAnimationDurationMs] so this path stays aligned with resolveAnimationDuration's shader-side cap (zero / negative is the documented inherit sentinel and leaves the base duration untouched).
2. The caller-provided base profile (typically the WindowAnimator's configured global profile).

Empty windowClass or empty eventPath short-circuits to the base profile — no rule can match either case. Callers pass the returned profile into the snap-animation startup as a per-call override rather than mutating the animator's global profile, so adjacent windows on the same compositor still animate with the global curve.

resolveAnimationShaderProfile()

PHOSPHORANIMATION_EXPORT ShaderProfile PhosphorAnimationShaders::resolveAnimationShaderProfile	(	const AnimationAppRuleList &	rules,
		const ShaderProfileTree &	tree,
		const QString &	windowClass,
		const QString &	eventPath
	)

Cascade resolver: window-class rule → per-event tree.

Returns the ShaderProfile that should drive a single (windowClass, eventPath) animation event. The cascade is:

1. AnimationAppRuleList::resolveShader — first matching rule. A hit produces a ShaderProfile whose effectId and parameters are taken verbatim from the rule. The rule's empty effectId is preserved as engaged-empty (the documented "explicitly no shader" sentinel on ShaderProfile), so a rule can disable the per-event default for matching windows without falling through to the tree.
2. ShaderProfileTree::resolve(eventPath) — the per-event walk-up (event leaf → category → baseline → library default).

Empty windowClass short-circuits to step 2 (no rule can match an unidentified window — and AnimationAppRuleList::resolveShader also returns nullopt on empty windowClass as a defence in depth). Empty eventPath skips the rule walk (no rule's eventPath can exact-match an empty string) and is forwarded to ShaderProfileTree::resolve(QString()), which walks an empty parent chain back to the baseline + library defaults.