AnimationShaderContract.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorShaders/CustomParamsKey.h>
 
#include <QString>
 
namespace PhosphorAnimationShaders {
 
namespace AnimationShaderContract {
 
inline constexpr const char* kITime = "iTime";
 
inline constexpr const char* kIResolution = "iResolution";
 
inline constexpr const char* kITimeDelta = "iTimeDelta";
 
inline constexpr const char* kIFrame = "iFrame";
 
inline constexpr const char* kIDate = "iDate";
 
inline constexpr const char* kIIsReversed = "iIsReversed";
 
inline constexpr const char* kISurfaceScreenPos = "iSurfaceScreenPos";
 
inline constexpr const char* kIAnchorSize = "iAnchorSize";
 
inline constexpr const char* kIAnchorPosInFbo = "iAnchorPosInFbo";
 
inline constexpr const char* kIAnchorRectInTexture = "iAnchorRectInTexture";
 
inline constexpr const char* kIFromRect = "iFromRect";
inline constexpr const char* kIToRect = "iToRect";
 
inline constexpr const char* kIIconRect = "iIconRect";
 
inline constexpr const char* kUOldWindow = "uOldWindow";
 
inline constexpr const char* kUSurfaceLayer = "uSurfaceLayer";
 
inline constexpr const char* kIHasSurfaceLayer = "iHasSurfaceLayer";
 
inline constexpr const char* kIHasOldWindow = "iHasOldWindow";
 
inline constexpr const char* kIOldWindowOpacity = "iOldWindowOpacity";
 
inline constexpr const char* kIMoveVelocity = "iMoveVelocity";
inline constexpr const char* kIMoveOffset = "iMoveOffset";
inline constexpr const char* kIMoveVelocity2 = "iMoveVelocity2";
inline constexpr const char* kIMoveTrail = "iMoveTrail";
inline constexpr const char* kIMoveMesh = "iMoveMesh";
inline constexpr const char* kILayerRectInTexture = "iLayerRectInTexture";
 
inline constexpr const char* kIWindowOpacity = "iWindowOpacity";
 
inline constexpr int kMaxUserTextureSlots = 3;
 
inline constexpr int kMaxBufferPasses = 4;
 
inline constexpr const char* kIAudioSpectrumSize = "iAudioSpectrumSize";
 
inline constexpr const char* kUAudioSpectrum = "uAudioSpectrum";
 
inline constexpr const char* kIMouse = "iMouse";
 
inline constexpr const char* kCustomParamsArray = "customParams";
 
inline constexpr int kMaxCustomParams = PhosphorShaders::CustomParams::kVecCount;
 
inline constexpr int kMaxParameterSlots = PhosphorShaders::CustomParams::kFlatSlotCount;
 
inline QString slotKey(int vec, char comp)
{
    return PhosphorShaders::CustomParams::slotKey(vec, comp);
}
 
inline QString slotKey(int slot)
{
    return PhosphorShaders::CustomParams::slotKey(slot);
}
 
inline constexpr const char* kCustomColorsArray = "customColors";
inline constexpr int kMaxCustomColors = PhosphorShaders::CustomColors::kColorCount;
 
inline QString colorKey(int slot)
{
    return PhosphorShaders::CustomColors::colorKey(slot);
}
 
 
 
inline bool isValidWrapToken(const QString& wrap)
{
    // Thin forwarder onto the cross-library canonical predicate in
    // <PhosphorShaders/CustomParamsKey.h> (already included above), so all
    // three shader families share one wrap vocabulary rather than each
    // hand-rolling its own token list that can drift.
    return PhosphorShaders::isValidWrapToken(wrap);
}
 
inline bool isValidFilterToken(const QString& filter)
{
    // Forwarder onto PhosphorShaders::isValidFilterToken, for the same reason
    // as isValidWrapToken above.
    return PhosphorShaders::isValidFilterToken(filter);
}
 
} // namespace AnimationShaderContract
 
} // namespace PhosphorAnimationShaders
 
// The compile-time link between AnimationShaderContract::kMaxUserTextureSlots
// and PhosphorRendering::kMaxUserTextures lives in
// libs/phosphor-animation/src/contract_pins.cpp. It cannot live in this header
// because translation units that only need contract definitions (notably the
// kwin-effect, which already pulls in epoxy/gl.h via KWin) must not be forced
// to also pull in <QtQuick/QSGTextureProvider> via ShaderNodeRhi.h — epoxy and
// Qt's qopenglext.h declare overlapping GL function-pointer typedefs that
// conflict when both end up in the same TU.