Phosphor
Qt6 / Wayland library suite for window-management tools
 
Loading...
Searching...
No Matches
Public Types | Signals | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
PhosphorRendering::ShaderEffect Class Reference

QQuickItem that renders a fullscreen fragment shader via Qt RHI. More...

#include <phosphor-rendering/include/PhosphorRendering/ShaderEffect.h>

Inheritance diagram for PhosphorRendering::ShaderEffect:
[legend]

Public Types

enum class  Status { Null , Loading , Ready , Error }
 Auto-tick mode. More...
 

Signals

void iTimeChanged ()
 
void iTimeDeltaChanged ()
 
void iFrameChanged ()
 
void iResolutionChanged ()
 
void iMouseChanged ()
 
void isReversedChanged ()
 
void playingChanged ()
 
void shaderSourceChanged ()
 
void vertexShaderUrlChanged ()
 
void shaderParamsChanged ()
 
void sourceItemChanged ()
 
void bufferShaderPathChanged ()
 
void bufferShaderPathsChanged ()
 
void bufferFeedbackChanged ()
 
void bufferScaleChanged ()
 
void bufferWrapChanged ()
 
void bufferWrapsChanged ()
 
void bufferFilterChanged ()
 
void bufferFiltersChanged ()
 
void customParamsChanged ()
 
void customColorsChanged ()
 
void audioSpectrumChanged ()
 
void wallpaperTextureChanged ()
 
void useWallpaperChanged ()
 
void useDepthBufferChanged ()
 
void statusChanged ()
 Emitted when status() transitions.
 
void errorLogChanged ()
 

Public Member Functions

 ShaderEffect (QQuickItem *parent=nullptr)
 
 ~ShaderEffect () override
 
virtual void setUniformExtension (std::shared_ptr< PhosphorShaders::IUniformExtension > extension)
 Attach a uniform extension that appends custom data after BaseUniforms.
 
std::shared_ptr< PhosphorShaders::IUniformExtension > uniformExtension () const
 
qreal iTime () const
 
void setITime (qreal time)
 
qreal iTimeDelta () const
 
void setITimeDelta (qreal delta)
 
int iFrame () const
 
void setIFrame (int frame)
 
bool isPlaying () const
 
void setPlaying (bool playing)
 
bool isReversed () const
 
void setIsReversed (bool reverse)
 Direction signal forwarded to ShaderNodeRhi → BaseUniforms::iIsReversed.
 
QSizeF iResolution () const
 
void setIResolution (const QSizeF &resolution)
 
QPointF iMouse () const
 
void setIMouse (const QPointF &mouse)
 
QUrl shaderSource () const
 
void setShaderSource (const QUrl &source)
 
QUrl vertexShaderUrl () const
 
void setVertexShaderUrl (const QUrl &source)
 
QVariantMap shaderParams () const
 
virtual void setShaderParams (const QVariantMap &params)
 Push a parameter map onto the shader.
 
QQuickItem * sourceItem () const
 Live texture-provider source bound to SRB binding 7 (uTexture0).
 
void setSourceItem (QQuickItem *item)
 
QString bufferShaderPath () const
 
void setBufferShaderPath (const QString &path)
 
QStringList bufferShaderPaths () const
 
void setBufferShaderPaths (const QStringList &paths)
 
bool bufferFeedback () const
 
void setBufferFeedback (bool enable)
 
qreal bufferScale () const
 
void setBufferScale (qreal scale)
 
QString bufferWrap () const
 
void setBufferWrap (const QString &wrap)
 
QStringList bufferWraps () const
 
void setBufferWraps (const QStringList &wraps)
 
QString bufferFilter () const
 
void setBufferFilter (const QString &filter)
 
QStringList bufferFilters () const
 
void setBufferFilters (const QStringList &filters)
 
QVector4D customParams1 () const
 
void setCustomParams1 (const QVector4D &params)
 
QVector4D customParams2 () const
 
void setCustomParams2 (const QVector4D &params)
 
QVector4D customParams3 () const
 
void setCustomParams3 (const QVector4D &params)
 
QVector4D customParams4 () const
 
void setCustomParams4 (const QVector4D &params)
 
QVector4D customParams5 () const
 
void setCustomParams5 (const QVector4D &params)
 
QVector4D customParams6 () const
 
void setCustomParams6 (const QVector4D &params)
 
QVector4D customParams7 () const
 
void setCustomParams7 (const QVector4D &params)
 
QVector4D customParams8 () const
 
void setCustomParams8 (const QVector4D &params)
 
QColor customColor1 () const
 
void setCustomColor1 (const QColor &color)
 
QColor customColor2 () const
 
void setCustomColor2 (const QColor &color)
 
QColor customColor3 () const
 
void setCustomColor3 (const QColor &color)
 
QColor customColor4 () const
 
void setCustomColor4 (const QColor &color)
 
QColor customColor5 () const
 
void setCustomColor5 (const QColor &color)
 
QColor customColor6 () const
 
void setCustomColor6 (const QColor &color)
 
QColor customColor7 () const
 
void setCustomColor7 (const QColor &color)
 
QColor customColor8 () const
 
void setCustomColor8 (const QColor &color)
 
QColor customColor9 () const
 
void setCustomColor9 (const QColor &color)
 
QColor customColor10 () const
 
void setCustomColor10 (const QColor &color)
 
QColor customColor11 () const
 
void setCustomColor11 (const QColor &color)
 
QColor customColor12 () const
 
void setCustomColor12 (const QColor &color)
 
QColor customColor13 () const
 
void setCustomColor13 (const QColor &color)
 
QColor customColor14 () const
 
void setCustomColor14 (const QColor &color)
 
QColor customColor15 () const
 
void setCustomColor15 (const QColor &color)
 
QColor customColor16 () const
 
void setCustomColor16 (const QColor &color)
 
QVector4D customParamAt (int index) const
 Read a customParams slot by index.
 
void setCustomParamAt (int index, const QVector4D &params)
 Write a customParams slot by index.
 
QColor customColorAt (int index) const
 Read a customColor slot by index.
 
void setCustomColorAt (int index, const QColor &color)
 Write a customColor slot by index.
 
QVariant audioSpectrumVariant () const
 
void setAudioSpectrumVariant (const QVariant &spectrum)
 
void setAudioSpectrum (const QVector< float > &spectrum)
 Direct setter from C++ avoiding QVariantList round-trip.
 
void setUserTexture (int slot, const QImage &image)
 Set a user texture (slots 0-3, bindings 7-10) directly from a QImage, bypassing the path-driven loader.
 
void setUserTextureWrap (int slot, const QString &wrap)
 Set user texture wrap mode (slots 0-3).
 
QImage wallpaperTexture () const
 
void setWallpaperTexture (const QImage &image)
 
bool useWallpaper () const
 
void setUseWallpaper (bool use)
 
bool useDepthBuffer () const
 
void setUseDepthBuffer (bool use)
 
void setShaderIncludePaths (const QStringList &paths)
 Set directories to search for #include directives in shaders.
 
QStringList shaderIncludePaths () const
 
Status status () const
 
QString errorLog () const
 
void reloadShader ()
 Force reload of shader from source (callable from QML).
 

Static Public Member Functions

static QImage loadUserTextureFile (const QString &path, int svgMaxDim)
 Static helper that loads a user-texture file (PNG/JPG/etc.
 

Static Public Attributes

static constexpr int kMaxSvgDimension = 2048
 Hard ceiling on the per-axis SVG rasterisation dimension applied by setShaderParams to the uTexture<N>_svgSize parameter.
 
static constexpr qint64 kMaxSvgPixelBytes = 16LL * 1024 * 1024
 Hard cap on the byte budget for a single rasterised SVG (16 MiB — matches RGBA8 at kMaxSvgDimension × kMaxSvgDimension).
 

Protected Member Functions

QSGNode * updatePaintNode (QSGNode *oldNode, UpdatePaintNodeData *data) override
 
void geometryChange (const QRectF &newGeometry, const QRectF &oldGeometry) override
 
void componentComplete () override
 
void itemChange (ItemChange change, const ItemChangeData &value) override
 
void syncBasePropertiesToNode (ShaderNodeRhi *node)
 Sync base properties (time, params, colors, audio, multipass, depth, wallpaper) to a render node.
 
bool consumeShaderDirty ()
 Atomically read-and-clear the shader-dirty flag.
 
virtual ShaderNodeRhi * createShaderNode ()
 Factory hook for the render node updatePaintNode() will create.
 
void setError (const QString &error)
 
void setStatus (Status newStatus)
 

Detailed Description

QQuickItem that renders a fullscreen fragment shader via Qt RHI.

Shadertoy-compatible: iTime, iTimeDelta, iFrame, iResolution, iMouse, multipass buffers, custom parameters, and custom colors.

Extend with IUniformExtension to append application-specific uniform data after the base UBO layout.

Consumers that want this type available in QML must register it themselves with qmlRegisterType() under their own module URI. The library does not ship a QML module — doing so would force every consumer onto one module name and duplicate registration with subclasses (e.g. ZoneShaderItem).

Member Enumeration Documentation

◆ Status

enum class PhosphorRendering::ShaderEffect::Status
strong

Auto-tick mode.

When true, this item hooks the host QQuickWindow's per-frame signal and advances iTime / iTimeDelta / iFrame on every rendered frame. The Shadertoy-style uniforms then "just work" for QML callers — no FrameAnimation / Timer plumbing required.

When false (default) the iTime/iTimeDelta/iFrame Q_PROPERTYs stay fully under the caller's control. This is what kwin-effect's SurfaceAnimator and phosphor-animation's transition shaders use: they drive iTime by hand to map the animation curve through the shader without committing to wall-clock pacing.

Toggling at runtime is supported. While true, the manual setters for iTime/iTimeDelta/iFrame are additive: the next frame's tick adds the wall-clock delta to whatever value is currently stored, so a manual write is preserved as a baseline rather than overwritten. iFrame is incremented by 1 per tick.

Shader loading and compilation status

Enumerator
Null 

No shader loaded.

Loading 

Shader is being loaded/compiled.

Ready 

Shader compiled successfully.

Error 

Shader compilation failed.

Constructor & Destructor Documentation

◆ ShaderEffect()

PhosphorRendering::ShaderEffect::ShaderEffect ( QQuickItem *  parent = nullptr)
explicit

◆ ~ShaderEffect()

PhosphorRendering::ShaderEffect::~ShaderEffect ( )
override

Member Function Documentation

◆ audioSpectrumChanged

void PhosphorRendering::ShaderEffect::audioSpectrumChanged ( )
signal

◆ audioSpectrumVariant()

QVariant PhosphorRendering::ShaderEffect::audioSpectrumVariant ( ) const

◆ bufferFeedback()

bool PhosphorRendering::ShaderEffect::bufferFeedback ( ) const
inline

◆ bufferFeedbackChanged

void PhosphorRendering::ShaderEffect::bufferFeedbackChanged ( )
signal

◆ bufferFilter()

QString PhosphorRendering::ShaderEffect::bufferFilter ( ) const
inline

◆ bufferFilterChanged

void PhosphorRendering::ShaderEffect::bufferFilterChanged ( )
signal

◆ bufferFilters()

QStringList PhosphorRendering::ShaderEffect::bufferFilters ( ) const
inline

◆ bufferFiltersChanged

void PhosphorRendering::ShaderEffect::bufferFiltersChanged ( )
signal

◆ bufferScale()

qreal PhosphorRendering::ShaderEffect::bufferScale ( ) const
inline

◆ bufferScaleChanged

void PhosphorRendering::ShaderEffect::bufferScaleChanged ( )
signal

◆ bufferShaderPath()

QString PhosphorRendering::ShaderEffect::bufferShaderPath ( ) const
inline

◆ bufferShaderPathChanged

void PhosphorRendering::ShaderEffect::bufferShaderPathChanged ( )
signal

◆ bufferShaderPaths()

QStringList PhosphorRendering::ShaderEffect::bufferShaderPaths ( ) const
inline

◆ bufferShaderPathsChanged

void PhosphorRendering::ShaderEffect::bufferShaderPathsChanged ( )
signal

◆ bufferWrap()

QString PhosphorRendering::ShaderEffect::bufferWrap ( ) const
inline

◆ bufferWrapChanged

void PhosphorRendering::ShaderEffect::bufferWrapChanged ( )
signal

◆ bufferWraps()

QStringList PhosphorRendering::ShaderEffect::bufferWraps ( ) const
inline

◆ bufferWrapsChanged

void PhosphorRendering::ShaderEffect::bufferWrapsChanged ( )
signal

◆ componentComplete()

void PhosphorRendering::ShaderEffect::componentComplete ( )
overrideprotected

◆ consumeShaderDirty()

bool PhosphorRendering::ShaderEffect::consumeShaderDirty ( )
inlineprotected

Atomically read-and-clear the shader-dirty flag.

Subclasses that override updatePaintNode() must call this to observe pending reload requests from setShaderSource / setShaderIncludePaths / reloadShader(). Without consuming the flag, runtime include-path changes never reach the render node.

◆ createShaderNode()

virtual ShaderNodeRhi * PhosphorRendering::ShaderEffect::createShaderNode ( )
protectedvirtual

Factory hook for the render node updatePaintNode() will create.

Default returns a plain ShaderNodeRhi. Subclasses that need an enriched node (e.g. ZoneShaderNodeRhi for zone-aware shaders with a labels texture binding) override this to return their own subclass — base updatePaintNode() will then drive that node through the same sync/render flow without subclasses having to duplicate it.

Called only when oldNode is null. Ownership transfers to the scene graph.

◆ customColor1()

QColor PhosphorRendering::ShaderEffect::customColor1 ( ) const
inline

◆ customColor10()

QColor PhosphorRendering::ShaderEffect::customColor10 ( ) const
inline

◆ customColor11()

QColor PhosphorRendering::ShaderEffect::customColor11 ( ) const
inline

◆ customColor12()

QColor PhosphorRendering::ShaderEffect::customColor12 ( ) const
inline

◆ customColor13()

QColor PhosphorRendering::ShaderEffect::customColor13 ( ) const
inline

◆ customColor14()

QColor PhosphorRendering::ShaderEffect::customColor14 ( ) const
inline

◆ customColor15()

QColor PhosphorRendering::ShaderEffect::customColor15 ( ) const
inline

◆ customColor16()

QColor PhosphorRendering::ShaderEffect::customColor16 ( ) const
inline

◆ customColor2()

QColor PhosphorRendering::ShaderEffect::customColor2 ( ) const
inline

◆ customColor3()

QColor PhosphorRendering::ShaderEffect::customColor3 ( ) const
inline

◆ customColor4()

QColor PhosphorRendering::ShaderEffect::customColor4 ( ) const
inline

◆ customColor5()

QColor PhosphorRendering::ShaderEffect::customColor5 ( ) const
inline

◆ customColor6()

QColor PhosphorRendering::ShaderEffect::customColor6 ( ) const
inline

◆ customColor7()

QColor PhosphorRendering::ShaderEffect::customColor7 ( ) const
inline

◆ customColor8()

QColor PhosphorRendering::ShaderEffect::customColor8 ( ) const
inline

◆ customColor9()

QColor PhosphorRendering::ShaderEffect::customColor9 ( ) const
inline

◆ customColorAt()

QColor PhosphorRendering::ShaderEffect::customColorAt ( int  index) const

Read a customColor slot by index.

Parameters
index[0, 16). Returns an invalid QColor for out-of-range indices.

◆ customColorsChanged

void PhosphorRendering::ShaderEffect::customColorsChanged ( )
signal

◆ customParamAt()

QVector4D PhosphorRendering::ShaderEffect::customParamAt ( int  index) const

Read a customParams slot by index.

Parameters
index[0, 8). Returns a zero vector for out-of-range indices.

◆ customParams1()

QVector4D PhosphorRendering::ShaderEffect::customParams1 ( ) const
inline

◆ customParams2()

QVector4D PhosphorRendering::ShaderEffect::customParams2 ( ) const
inline

◆ customParams3()

QVector4D PhosphorRendering::ShaderEffect::customParams3 ( ) const
inline

◆ customParams4()

QVector4D PhosphorRendering::ShaderEffect::customParams4 ( ) const
inline

◆ customParams5()

QVector4D PhosphorRendering::ShaderEffect::customParams5 ( ) const
inline

◆ customParams6()

QVector4D PhosphorRendering::ShaderEffect::customParams6 ( ) const
inline

◆ customParams7()

QVector4D PhosphorRendering::ShaderEffect::customParams7 ( ) const
inline

◆ customParams8()

QVector4D PhosphorRendering::ShaderEffect::customParams8 ( ) const
inline

◆ customParamsChanged

void PhosphorRendering::ShaderEffect::customParamsChanged ( )
signal

◆ errorLog()

QString PhosphorRendering::ShaderEffect::errorLog ( ) const
inline

◆ errorLogChanged

void PhosphorRendering::ShaderEffect::errorLogChanged ( )
signal

◆ geometryChange()

void PhosphorRendering::ShaderEffect::geometryChange ( const QRectF &  newGeometry,
const QRectF &  oldGeometry 
)
overrideprotected

◆ iFrame()

int PhosphorRendering::ShaderEffect::iFrame ( ) const
inline

◆ iFrameChanged

void PhosphorRendering::ShaderEffect::iFrameChanged ( )
signal

◆ iMouse()

QPointF PhosphorRendering::ShaderEffect::iMouse ( ) const
inline

◆ iMouseChanged

void PhosphorRendering::ShaderEffect::iMouseChanged ( )
signal

◆ iResolution()

QSizeF PhosphorRendering::ShaderEffect::iResolution ( ) const
inline

◆ iResolutionChanged

void PhosphorRendering::ShaderEffect::iResolutionChanged ( )
signal

◆ isPlaying()

bool PhosphorRendering::ShaderEffect::isPlaying ( ) const
inline

◆ isReversed()

bool PhosphorRendering::ShaderEffect::isReversed ( ) const
inline

◆ isReversedChanged

void PhosphorRendering::ShaderEffect::isReversedChanged ( )
signal

◆ itemChange()

void PhosphorRendering::ShaderEffect::itemChange ( ItemChange  change,
const ItemChangeData &  value 
)
overrideprotected

◆ iTime()

qreal PhosphorRendering::ShaderEffect::iTime ( ) const
inline

◆ iTimeChanged

void PhosphorRendering::ShaderEffect::iTimeChanged ( )
signal

◆ iTimeDelta()

qreal PhosphorRendering::ShaderEffect::iTimeDelta ( ) const
inline

◆ iTimeDeltaChanged

void PhosphorRendering::ShaderEffect::iTimeDeltaChanged ( )
signal

◆ loadUserTextureFile()

static QImage PhosphorRendering::ShaderEffect::loadUserTextureFile ( const QString &  path,
int  svgMaxDim 
)
static

Static helper that loads a user-texture file (PNG/JPG/etc.

via QImage; SVG/SVGZ via QSvgRenderer rasterised at svgMaxDim max-axis with the same byte-budget guard as setShaderParams). Thread-safe: each invocation constructs its own QSvgRenderer / QImage instance — callers may invoke from a worker thread (e.g. QtConcurrent::run) to off-load the cost from the GUI thread. Returns a null QImage on load failure (file missing, parse error, OOM); callers should keep their prior image in that case. The result is in QImage::Format_RGBA8888, ready for setUserTexture(slot, image) upload on the GUI thread.

◆ playingChanged

void PhosphorRendering::ShaderEffect::playingChanged ( )
signal

◆ reloadShader()

void PhosphorRendering::ShaderEffect::reloadShader ( )

Force reload of shader from source (callable from QML).

◆ setAudioSpectrum()

void PhosphorRendering::ShaderEffect::setAudioSpectrum ( const QVector< float > &  spectrum)

Direct setter from C++ avoiding QVariantList round-trip.

◆ setAudioSpectrumVariant()

void PhosphorRendering::ShaderEffect::setAudioSpectrumVariant ( const QVariant &  spectrum)

◆ setBufferFeedback()

void PhosphorRendering::ShaderEffect::setBufferFeedback ( bool  enable)

◆ setBufferFilter()

void PhosphorRendering::ShaderEffect::setBufferFilter ( const QString &  filter)

◆ setBufferFilters()

void PhosphorRendering::ShaderEffect::setBufferFilters ( const QStringList &  filters)

◆ setBufferScale()

void PhosphorRendering::ShaderEffect::setBufferScale ( qreal  scale)

◆ setBufferShaderPath()

void PhosphorRendering::ShaderEffect::setBufferShaderPath ( const QString &  path)

◆ setBufferShaderPaths()

void PhosphorRendering::ShaderEffect::setBufferShaderPaths ( const QStringList &  paths)

◆ setBufferWrap()

void PhosphorRendering::ShaderEffect::setBufferWrap ( const QString &  wrap)

◆ setBufferWraps()

void PhosphorRendering::ShaderEffect::setBufferWraps ( const QStringList &  wraps)

◆ setCustomColor1()

void PhosphorRendering::ShaderEffect::setCustomColor1 ( const QColor &  color)

◆ setCustomColor10()

void PhosphorRendering::ShaderEffect::setCustomColor10 ( const QColor &  color)

◆ setCustomColor11()

void PhosphorRendering::ShaderEffect::setCustomColor11 ( const QColor &  color)

◆ setCustomColor12()

void PhosphorRendering::ShaderEffect::setCustomColor12 ( const QColor &  color)

◆ setCustomColor13()

void PhosphorRendering::ShaderEffect::setCustomColor13 ( const QColor &  color)

◆ setCustomColor14()

void PhosphorRendering::ShaderEffect::setCustomColor14 ( const QColor &  color)

◆ setCustomColor15()

void PhosphorRendering::ShaderEffect::setCustomColor15 ( const QColor &  color)

◆ setCustomColor16()

void PhosphorRendering::ShaderEffect::setCustomColor16 ( const QColor &  color)

◆ setCustomColor2()

void PhosphorRendering::ShaderEffect::setCustomColor2 ( const QColor &  color)

◆ setCustomColor3()

void PhosphorRendering::ShaderEffect::setCustomColor3 ( const QColor &  color)

◆ setCustomColor4()

void PhosphorRendering::ShaderEffect::setCustomColor4 ( const QColor &  color)

◆ setCustomColor5()

void PhosphorRendering::ShaderEffect::setCustomColor5 ( const QColor &  color)

◆ setCustomColor6()

void PhosphorRendering::ShaderEffect::setCustomColor6 ( const QColor &  color)

◆ setCustomColor7()

void PhosphorRendering::ShaderEffect::setCustomColor7 ( const QColor &  color)

◆ setCustomColor8()

void PhosphorRendering::ShaderEffect::setCustomColor8 ( const QColor &  color)

◆ setCustomColor9()

void PhosphorRendering::ShaderEffect::setCustomColor9 ( const QColor &  color)

◆ setCustomColorAt()

void PhosphorRendering::ShaderEffect::setCustomColorAt ( int  index,
const QColor &  color 
)

Write a customColor slot by index.

Parameters
index[0, 16). Out-of-range indices are ignored.

◆ setCustomParamAt()

void PhosphorRendering::ShaderEffect::setCustomParamAt ( int  index,
const QVector4D &  params 
)

Write a customParams slot by index.

Parameters
index[0, 8). Out-of-range indices are ignored.

Emits customParamsChanged() and schedules an update only when the value actually differs from the stored slot.

◆ setCustomParams1()

void PhosphorRendering::ShaderEffect::setCustomParams1 ( const QVector4D &  params)

◆ setCustomParams2()

void PhosphorRendering::ShaderEffect::setCustomParams2 ( const QVector4D &  params)

◆ setCustomParams3()

void PhosphorRendering::ShaderEffect::setCustomParams3 ( const QVector4D &  params)

◆ setCustomParams4()

void PhosphorRendering::ShaderEffect::setCustomParams4 ( const QVector4D &  params)

◆ setCustomParams5()

void PhosphorRendering::ShaderEffect::setCustomParams5 ( const QVector4D &  params)

◆ setCustomParams6()

void PhosphorRendering::ShaderEffect::setCustomParams6 ( const QVector4D &  params)

◆ setCustomParams7()

void PhosphorRendering::ShaderEffect::setCustomParams7 ( const QVector4D &  params)

◆ setCustomParams8()

void PhosphorRendering::ShaderEffect::setCustomParams8 ( const QVector4D &  params)

◆ setError()

void PhosphorRendering::ShaderEffect::setError ( const QString &  error)
protected

◆ setIFrame()

void PhosphorRendering::ShaderEffect::setIFrame ( int  frame)

◆ setIMouse()

void PhosphorRendering::ShaderEffect::setIMouse ( const QPointF &  mouse)

◆ setIResolution()

void PhosphorRendering::ShaderEffect::setIResolution ( const QSizeF &  resolution)

◆ setIsReversed()

void PhosphorRendering::ShaderEffect::setIsReversed ( bool  reverse)

Direction signal forwarded to ShaderNodeRhi → BaseUniforms::iIsReversed.

SurfaceAnimator pushes this on every leg attach (false for show, true for hide). Symmetric shaders ignore the value; asymmetric shaders branch on it (see canonical animation_uniforms.glsl docs).

◆ setITime()

void PhosphorRendering::ShaderEffect::setITime ( qreal  time)

◆ setITimeDelta()

void PhosphorRendering::ShaderEffect::setITimeDelta ( qreal  delta)

◆ setPlaying()

void PhosphorRendering::ShaderEffect::setPlaying ( bool  playing)

◆ setShaderIncludePaths()

void PhosphorRendering::ShaderEffect::setShaderIncludePaths ( const QStringList &  paths)

Set directories to search for #include directives in shaders.

◆ setShaderParams()

virtual void PhosphorRendering::ShaderEffect::setShaderParams ( const QVariantMap &  params)
virtual

Push a parameter map onto the shader.

Recognised keys: • customParams<N>_<x|y|z|w> (1-based) — float vec4 sub-slots • customColor<N> (1-based) — color vec4 slots • uTexture<N> (0-based, 0..3) — file path for the user-texture sampler at SRB binding 7..10 / GLSL uTexture<N> • uTexture<N>_wrap — wrap mode string ("clamp" / "repeat" / "mirror"); ignored if no companion uTexture<N> resolves • uTexture<N>_svgSize — SVG rasterise max-axis dimension (clamped 64..2048; ignored for bitmap formats). The cap is exposed as ShaderEffect::kMaxSvgDimension for callers that want to mirror the clamp without hardcoding the value, and the per-rasterisation byte budget is exposed as ShaderEffect::kMaxSvgPixelBytes (a near-square doc whose RGBA8 size would exceed the budget is downscaled proportionally with a warning).

Trust boundary. uTexture<N> paths are passed verbatim to QImage::load / QSvgRenderer::load. This class does NOT sanitise traversal segments or enforce absolute-path-only — the caller is the trust boundary. AnimationShaderRegistry::translateAnimationParams already resolves and traversal-checks pack-default paths at scan time; the kwin-effect's m_textureCache lookup keys absolute paths. A direct caller (e.g. tests, custom QML embedding) that forwards untrusted strings into params["uTexture<N>"] MUST pre-resolve and traversal-check before calling.

SVG rasterisation cost. When the params map contains a uTexture<N> whose path resolves to an .svg / .svgz file (and the path or uTexture<N>_svgSize differs from the cached state for that slot), this method calls QSvgRenderer and QPainter synchronously on the calling thread to rasterise the document up to the clamped dimension. The cost scales with kMaxSvgPixelBytes in the worst case. Hot-path callers (e.g. per-frame parameter pushes) should pre-warm via loadUserTextureFile(path, svgMaxDim) from a worker thread (it's thread-safe per Qt docs: each call constructs its own QSvgRenderer / QImage instance with no shared mutable state) and call setUserTexture(slot, image) on the GUI thread to install the result. Bitmap formats are loaded via QImage and carry the same synchronous-IO caveat but no rasterisation cost.

Subclass contract. Overrides MUST chain to ShaderEffect::setShaderParams(params) (or replicate the full trust-boundary parse, including uTexture* / *_wrap / *_svgSize). Skipping the base call leaves user-texture paths uninterpreted and pinned to whatever the previous parse set — silent stale samplers across reloads.

◆ setShaderSource()

void PhosphorRendering::ShaderEffect::setShaderSource ( const QUrl &  source)

◆ setSourceItem()

void PhosphorRendering::ShaderEffect::setSourceItem ( QQuickItem *  item)

◆ setStatus()

void PhosphorRendering::ShaderEffect::setStatus ( Status  newStatus)
protected

◆ setUniformExtension()

virtual void PhosphorRendering::ShaderEffect::setUniformExtension ( std::shared_ptr< PhosphorShaders::IUniformExtension >  extension)
virtual

Attach a uniform extension that appends custom data after BaseUniforms.

Stored on this item and pushed down to the render node in syncBasePropertiesToNode(). virtual so a subclass that owns its own extension (e.g. ZoneShaderItem) can intercept stray assignments and preserve its internal extension contract instead of having the call silently no-op.

◆ setUseDepthBuffer()

void PhosphorRendering::ShaderEffect::setUseDepthBuffer ( bool  use)

◆ setUserTexture()

void PhosphorRendering::ShaderEffect::setUserTexture ( int  slot,
const QImage &  image 
)

Set a user texture (slots 0-3, bindings 7-10) directly from a QImage, bypassing the path-driven loader.

Clears the per-slot cached path and resets the companion svgSize / wrap settings so a subsequent params-driven load starts from a clean slot.

Mixing-with-setShaderParams contract: a subsequent setShaderParams(p) will reload the texture from p["uTextureN"] even when p is byte-equal to the cached params map. The intervening direct-push sets a private dirty flag that suppresses the equality short-circuit on the very next call, so the cleared path is honoured and the on-disk image replaces the directly-set QImage. After that one re-parse, the flag is cleared and the usual fast-path resumes.

◆ setUserTextureWrap()

void PhosphorRendering::ShaderEffect::setUserTextureWrap ( int  slot,
const QString &  wrap 
)

Set user texture wrap mode (slots 0-3).

"clamp", "repeat", or "mirror".

◆ setUseWallpaper()

void PhosphorRendering::ShaderEffect::setUseWallpaper ( bool  use)

◆ setVertexShaderUrl()

void PhosphorRendering::ShaderEffect::setVertexShaderUrl ( const QUrl &  source)

◆ setWallpaperTexture()

void PhosphorRendering::ShaderEffect::setWallpaperTexture ( const QImage &  image)

◆ shaderIncludePaths()

QStringList PhosphorRendering::ShaderEffect::shaderIncludePaths ( ) const
inline

◆ shaderParams()

QVariantMap PhosphorRendering::ShaderEffect::shaderParams ( ) const
inline

◆ shaderParamsChanged

void PhosphorRendering::ShaderEffect::shaderParamsChanged ( )
signal

◆ shaderSource()

QUrl PhosphorRendering::ShaderEffect::shaderSource ( ) const
inline

◆ shaderSourceChanged

void PhosphorRendering::ShaderEffect::shaderSourceChanged ( )
signal

◆ sourceItem()

QQuickItem * PhosphorRendering::ShaderEffect::sourceItem ( ) const
inline

Live texture-provider source bound to SRB binding 7 (uTexture0).

When set to a non-null QQuickItem, the shader samples that item's rendered visual every frame instead of whatever QImage was uploaded via setUserTexture(0, ...). This is what the SurfaceAnimator transition shaders (pixelate / dissolve / glitch) use to operate on the rendered surface — no async grab, no first-show gap, no stale snapshot.

The item is forced to layer.enabled = true on the QML side so QQuickItem::textureProvider() returns the layer's provider; the scene graph allocates an FBO and re-renders the item each frame the consumer dirties it. The shader effect's parent must NOT be the source item (or any of its descendants) — sampling within the same layer creates a feedback loop where the shader's own output is captured into the next frame's texture. Park the shader effect as a sibling of the source item instead.

Setting the property to nullptr unbinds the texture; subsequent frames fall back to the user-texture-0 QImage path (or the transparent fallback if neither has been set).

◆ sourceItemChanged

void PhosphorRendering::ShaderEffect::sourceItemChanged ( )
signal

◆ status()

Status PhosphorRendering::ShaderEffect::status ( ) const
inline

◆ statusChanged

void PhosphorRendering::ShaderEffect::statusChanged ( )
signal

Emitted when status() transitions.

May be raised on the render thread under Qt's threaded render loop (setStatus is called from updatePaintNode). Connect with Qt::AutoConnection or Qt::QueuedConnection only — Qt::DirectConnection from a slot on another thread will run that slot on the render thread, which is almost always wrong (V4 / QML JS / most app code is GUI-thread- only).

◆ syncBasePropertiesToNode()

void PhosphorRendering::ShaderEffect::syncBasePropertiesToNode ( ShaderNodeRhi *  node)
protected

Sync base properties (time, params, colors, audio, multipass, depth, wallpaper) to a render node.

Does NOT sync user textures, uniform extension, or shader source — these differ between ShaderEffect and subclasses (e.g. ZoneShaderItem).

Called from updatePaintNode(); subclasses that override updatePaintNode should call this instead of duplicating the property sync.

◆ uniformExtension()

std::shared_ptr< PhosphorShaders::IUniformExtension > PhosphorRendering::ShaderEffect::uniformExtension ( ) const

◆ updatePaintNode()

QSGNode * PhosphorRendering::ShaderEffect::updatePaintNode ( QSGNode *  oldNode,
UpdatePaintNodeData *  data 
)
overrideprotected

◆ useDepthBuffer()

bool PhosphorRendering::ShaderEffect::useDepthBuffer ( ) const
inline

◆ useDepthBufferChanged

void PhosphorRendering::ShaderEffect::useDepthBufferChanged ( )
signal

◆ useWallpaper()

bool PhosphorRendering::ShaderEffect::useWallpaper ( ) const
inline

◆ useWallpaperChanged

void PhosphorRendering::ShaderEffect::useWallpaperChanged ( )
signal

◆ vertexShaderUrl()

QUrl PhosphorRendering::ShaderEffect::vertexShaderUrl ( ) const
inline

◆ vertexShaderUrlChanged

void PhosphorRendering::ShaderEffect::vertexShaderUrlChanged ( )
signal

◆ wallpaperTexture()

QImage PhosphorRendering::ShaderEffect::wallpaperTexture ( ) const

◆ wallpaperTextureChanged

void PhosphorRendering::ShaderEffect::wallpaperTextureChanged ( )
signal

Member Data Documentation

◆ kMaxSvgDimension

constexpr int PhosphorRendering::ShaderEffect::kMaxSvgDimension = 2048
staticconstexpr

Hard ceiling on the per-axis SVG rasterisation dimension applied by setShaderParams to the uTexture<N>_svgSize parameter.

Exposed so consumers (UI sliders, validators, tests) can mirror the clamp range without hardcoding the value. The setter performs qBound(64, requested, kMaxSvgDimension); values outside the range are silently clamped, not rejected.

◆ kMaxSvgPixelBytes

constexpr qint64 PhosphorRendering::ShaderEffect::kMaxSvgPixelBytes = 16LL * 1024 * 1024
staticconstexpr

Hard cap on the byte budget for a single rasterised SVG (16 MiB — matches RGBA8 at kMaxSvgDimension × kMaxSvgDimension).

When a near-square doc would exceed this even after the per-axis clamp, the rasterisation is downscaled proportionally and a warning is logged. Exposed for the same mirror-the-cap reason as kMaxSvgDimension.

The documentation for this class was generated from the following file: