Phosphor
Qt6 / Wayland library suite for window-management tools
 
Loading...
Searching...
No Matches
PhosphorAnimationShaders::AnimationShaderEffect::TextureSlot Struct Reference

User texture slot. More...

#include <phosphor-animation/include/PhosphorAnimation/AnimationShaderEffect.h>

Public Member Functions

bool operator== (const TextureSlot &other) const
 
bool operator!= (const TextureSlot &other) const
 

Public Attributes

QString path
 Filename relative to the effect's sourceDir.
 
QString wrap
 "clamp" / "repeat" / "mirror"; empty = runtime default. Other values are rejected by fromJson.
 

Detailed Description

User texture slot.

Each entry binds an asset file to one of the canonical samplers iChannel1 / iChannel2 / iChannel3 (slots 0 / 1 / 2 here, which the runtimes map to texture-unit allocations 1 / 2 / 3 — slot 0 of the binding-7+ region is the surface itself / iChannel0, never user-declared).

path is resolved relative to the effect's sourceDir. Loading failures are non-fatal — the effect still installs and the affected sampler reads transparent black; a qCWarning logs the missing file. wrap mirrors the daemon-side overlay shader vocabulary; the only accepted values are "clamp", "repeat", "mirror", and the empty string (which selects the runtime default of clamp). Any other value is rejected by fromJson with a qCWarning and stored as empty, so the runtime falls back to the default rather than silently re-persisting the typo. Filter mode is not exposed here — both runtimes use linear filtering for user textures today. The slot index is the 0-based position in this list: the first entry binds to iChannel1, the second to iChannel2, etc. Up to three textures per effect; surplus entries are silently dropped at parse time.

Member Function Documentation

◆ operator!=()

bool PhosphorAnimationShaders::AnimationShaderEffect::TextureSlot::operator!= ( const TextureSlot other) const
inline

◆ operator==()

bool PhosphorAnimationShaders::AnimationShaderEffect::TextureSlot::operator== ( const TextureSlot other) const
inline

Member Data Documentation

◆ path

QString PhosphorAnimationShaders::AnimationShaderEffect::TextureSlot::path

Filename relative to the effect's sourceDir.

◆ wrap

QString PhosphorAnimationShaders::AnimationShaderEffect::TextureSlot::wrap

"clamp" / "repeat" / "mirror"; empty = runtime default. Other values are rejected by fromJson.


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