AnimationShaderContract.h File Reference

#include <PhosphorShaders/CustomParamsKey.h>
#include <QString>

Go to the source code of this file.

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

Functions
QString	PhosphorAnimationShaders::AnimationShaderContract::slotKey (int vec, char comp)
	Format a customParams slot key — thin forwarder onto PhosphorShaders::CustomParams::slotKey, the cross-library canonical helper.
QString	PhosphorAnimationShaders::AnimationShaderContract::slotKey (int slot)
	Flat-slot overload: slot is 0..31 across the 8 vec4 slots.
QString	PhosphorAnimationShaders::AnimationShaderContract::colorKey (int slot)
	Format a customColor slot key — thin forwarder onto PhosphorShaders::CustomColors::colorKey.
bool	PhosphorAnimationShaders::AnimationShaderContract::isValidWrapToken (const QString &wrap)
	The accepted texture wrap vocabulary, shared by every animation validation site (metadata parse in AnimationShaderEffect::fromJson, and runtime-override translation in AnimationShaderRegistry).
bool	PhosphorAnimationShaders::AnimationShaderContract::isValidFilterToken (const QString &filter)
	The accepted buffer filter vocabulary: linear / nearest / mipmap.

Variables
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kITime = "iTime"
	float iTime — transition progress, normally in [0.0, 1.0].
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIResolution = "iResolution"
	vec2 iResolution — surface size in logical pixels.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kITimeDelta = "iTimeDelta"
	float iTimeDelta — wall-clock seconds between consecutive paint ticks that fed this transition.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIFrame = "iFrame"
	int iFrame — per-leg frame counter.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIDate = "iDate"
	vec4 iDate — local-time (year, month, day, seconds-since-midnight).
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIIsReversed = "iIsReversed"
	int iIsReversed — direction signal for asymmetric leg rendering.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kISurfaceScreenPos = "iSurfaceScreenPos"
	vec4 iSurfaceScreenPos — the shader surface's position plus the host screen dimensions, both in logical pixels.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIAnchorSize = "iAnchorSize"
	vec2 iAnchorSize — captured anchor (card) pixel size in logical pixels.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIAnchorPosInFbo = "iAnchorPosInFbo"
	vec2 iAnchorPosInFbo is the anchor's top-left position inside the FBO, in logical pixels.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIAnchorRectInTexture = "iAnchorRectInTexture"
	vec4 iAnchorRectInTexture — the card's UV sub-rect within uTexture0, as (x, y, width, height) in the texture's [0, 1] space.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIFromRect = "iFromRect"
	vec4 iFromRect / vec4 iToRect — geometry-morph endpoints in logical screen pixels (x, y, width, height).
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIToRect = "iToRect"
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIIconRect = "iIconRect"
	vec4 iIconRect — the window's task-manager icon rectangle in logical screen pixels (x, y, width, height), same coordinate space as iFromRect / iToRect and as iSurfaceScreenPos.xy + iAnchorSize (the window's frame rect).
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kUOldWindow = "uOldWindow"
	sampler2D uOldWindow — snapshot of the window's content captured at the old frame size just before the instant moveResize.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kUSurfaceLayer = "uSurfaceLayer"
	sampler2D uSurfaceLayer — COMPOSITOR PATH ONLY.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIHasSurfaceLayer = "iHasSurfaceLayer"
	int iHasSurfaceLayer — COMPOSITOR PATH ONLY.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIHasOldWindow = "iHasOldWindow"
	int iHasOldWindow — COMPOSITOR PATH ONLY.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIOldWindowOpacity = "iOldWindowOpacity"
	float iOldWindowOpacity — COMPOSITOR PATH ONLY.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIMoveVelocity = "iMoveVelocity"
	vec2 iMoveVelocity — COMPOSITOR PATH ONLY.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIMoveOffset = "iMoveOffset"
	vec2 iMoveOffset — COMPOSITOR PATH ONLY.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIMoveVelocity2 = "iMoveVelocity2"
	vec2 iMoveVelocity2 — COMPOSITOR PATH ONLY.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIMoveTrail = "iMoveTrail"
	vec2 iMoveTrail[16] — COMPOSITOR PATH ONLY.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIMoveMesh = "iMoveMesh"
	vec2 iMoveMesh[16] — COMPOSITOR PATH ONLY.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kILayerRectInTexture = "iLayerRectInTexture"
	Card/anchor-space [0,1] sub-rect of the animated surface WITHIN uSurfaceLayer's canvas (xy offset, zw scale) — the layer analogue of iAnchorRectInTexture.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIWindowOpacity = "iWindowOpacity"
	float iWindowOpacity — the window's effective rule-resolved opacity in [0.0, 1.0], COMPOSITOR PATH ONLY.
constexpr int	PhosphorAnimationShaders::AnimationShaderContract::kMaxUserTextureSlots = 3
	Maximum number of user-declared textures per animation effect.
constexpr int	PhosphorAnimationShaders::AnimationShaderContract::kMaxBufferPasses = 4
	Multipass buffer-pass budget.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIAudioSpectrumSize = "iAudioSpectrumSize"
	int iAudioSpectrumSize — CAVA bar count, 0 while the audio visualizer is off or cava is unavailable.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kUAudioSpectrum = "uAudioSpectrum"
	sampler2D uAudioSpectrum — the CAVA spectrum texture (bars×1, R = bar value in 0..1).
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kIMouse = "iMouse"
	vec4 iMouse — cursor position in shader-local pixels.
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kCustomParamsArray = "customParams"
	vec4 customParams[N] — per-effect declared parameter slots.
constexpr int	PhosphorAnimationShaders::AnimationShaderContract::kMaxCustomParams = PhosphorShaders::CustomParams::kVecCount
	Number of vec4 slots in the customParams array (8).
constexpr int	PhosphorAnimationShaders::AnimationShaderContract::kMaxParameterSlots = PhosphorShaders::CustomParams::kFlatSlotCount
	Number of float sub-slots (4 per vec4 × 8 vec4s = 32).
constexpr const char *	PhosphorAnimationShaders::AnimationShaderContract::kCustomColorsArray = "customColors"
	vec4 customColors[N] — per-effect declared color parameter slots.
constexpr int	PhosphorAnimationShaders::AnimationShaderContract::kMaxCustomColors = PhosphorShaders::CustomColors::kColorCount