Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
SurfaceShaderContract.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2026 fuddlesworth
2// SPDX-License-Identifier: LGPL-2.1-or-later
3
4#pragma once
5
7
8#include <QString>
9
10namespace PhosphorSurfaceShaders {
11
112
122inline constexpr const char* kUTexture0 = "uTexture0";
123
129inline constexpr const char* kUSurfaceSize = "uSurfaceSize";
130
140inline constexpr const char* kUSurfaceFrameTopLeft = "uSurfaceFrameTopLeft";
141
148inline constexpr const char* kUSurfaceFrameSize = "uSurfaceFrameSize";
149
158inline constexpr const char* kUSurfaceScale = "uSurfaceScale";
159
179inline constexpr const char* kUSurfaceFocused = "uSurfaceFocused";
180
189inline constexpr const char* kITime = "iTime";
190
199inline constexpr const char* kUSurfaceOpacity = "uSurfaceOpacity";
200
211inline constexpr const char* kUBackdrop = "uBackdrop";
212
227inline constexpr const char* kUBackdropRect = "uBackdropRect";
228
234inline constexpr const char* kUHasBackdrop = "uHasBackdrop";
235
253inline constexpr const char* kIMouse = "iMouse";
254
266inline constexpr const char* kUTexture1 = "uTexture1";
267inline constexpr const char* kUTexture2 = "uTexture2";
268inline constexpr const char* kUTexture3 = "uTexture3";
269
277inline constexpr const char* kIAudioSpectrumSize = "iAudioSpectrumSize";
278
284inline constexpr const char* kUAudioSpectrum = "uAudioSpectrum";
285
291inline constexpr const char* kCustomParamsArray = "customParams";
292
309inline constexpr const char* kCustomColorsArray = "customColors";
310
320
325
330
339inline constexpr int kMaxUserTextureSlots = 3;
340
347inline bool isValidWrapToken(const QString& wrap)
348{
350}
351
357inline bool isValidFilterToken(const QString& filter)
358{
360}
361
371inline QString slotKey(int vec, char comp)
372{
374}
375
377inline QString slotKey(int slot)
378{
380}
381
389inline QString colorKey(int slot)
390{
392}
393
394} // namespace SurfaceShaderContract
395
396} // namespace PhosphorSurfaceShaders
QString colorKey(int slot)
Format a customColor key from a 0-based slot index.
Definition CustomParamsKey.h:224
constexpr int kColorCount
Number of color slots in BaseUniforms::customColors[16].
Definition CustomParamsKey.h:218
QString slotKey(int vec, char comp)
Format a customParams slot key from explicit (vec, comp) pair.
Definition CustomParamsKey.h:140
constexpr int kVecCount
Number of vec4 slots in BaseUniforms::customParams[8].
Definition CustomParamsKey.h:127
constexpr int kFlatSlotCount
Number of float sub-slots across all vec4s (4 × kVecCount).
Definition CustomParamsKey.h:133
bool isValidFilterToken(const QString &filter)
The accepted buffer filter vocabulary: linear / nearest / mipmap.
Definition CustomParamsKey.h:94
bool isValidWrapToken(const QString &wrap)
The accepted texture / buffer wrap vocabulary, shared by every validation site across the shader regi...
Definition CustomParamsKey.h:84
Cross-runtime named-uniform contract for surface shaders.
Definition SurfaceShaderContract.h:111
constexpr const char * kIMouse
vec4 iMouse — cursor position for hover-reactive packs.
Definition SurfaceShaderContract.h:253
constexpr const char * kCustomColorsArray
vec4 customColors[N] — per-effect declared color parameter slots.
Definition SurfaceShaderContract.h:309
constexpr const char * kUHasBackdrop
float uHasBackdrop — 1.0 when the host bound a backdrop this frame, else 0.0.
Definition SurfaceShaderContract.h:234
constexpr int kMaxUserTextureSlots
Maximum number of user-declared textures per surface effect.
Definition SurfaceShaderContract.h:339
constexpr int kMaxCustomParams
Number of vec4 slots in the customParams array (8).
Definition SurfaceShaderContract.h:319
constexpr const char * kUSurfaceSize
vec2 uSurfaceSize — the size of uTexture0 in device pixels.
Definition SurfaceShaderContract.h:129
constexpr const char * kUSurfaceFocused
float uSurfaceFocused — how focused the window owning this surface is, from 0.0 to 1....
Definition SurfaceShaderContract.h:179
bool isValidWrapToken(const QString &wrap)
The accepted texture / buffer wrap vocabulary — thin forwarder onto PhosphorShaders::isValidWrapToken...
Definition SurfaceShaderContract.h:347
constexpr const char * kUTexture3
Definition SurfaceShaderContract.h:268
constexpr int kMaxCustomColors
Number of customColors vec4 slots (16) — the per-color-param budget.
Definition SurfaceShaderContract.h:324
constexpr const char * kCustomParamsArray
vec4 customParams[N] — per-effect declared parameter slots.
Definition SurfaceShaderContract.h:291
bool isValidFilterToken(const QString &filter)
The accepted buffer filter vocabulary — thin forwarder onto PhosphorShaders::isValidFilterToken (see ...
Definition SurfaceShaderContract.h:357
constexpr const char * kUSurfaceOpacity
float uSurfaceOpacity — a constant 1.0 on BOTH runtimes.
Definition SurfaceShaderContract.h:199
QString slotKey(int vec, char comp)
Format a customParams slot key — thin forwarder onto PhosphorShaders::CustomParams::slotKey,...
Definition SurfaceShaderContract.h:371
constexpr const char * kUBackdropRect
vec4 uBackdropRect — a sub-rect of the bound backdrop in TOP-DOWN normalized coords (xy = min,...
Definition SurfaceShaderContract.h:227
constexpr const char * kUSurfaceFrameSize
vec2 uSurfaceFrameSize — the content/frame rect's size within uTexture0, in device pixels.
Definition SurfaceShaderContract.h:148
constexpr const char * kUTexture0
sampler2D uTexture0 — the live captured surface, and on the compositor it is NOT the same texture for...
Definition SurfaceShaderContract.h:122
constexpr const char * kUTexture2
Definition SurfaceShaderContract.h:267
constexpr int kMaxParameterSlots
Number of float sub-slots (4 per vec4 × 8 vec4s = 32).
Definition SurfaceShaderContract.h:329
constexpr const char * kUAudioSpectrum
sampler2D uAudioSpectrum — the CAVA spectrum as a bars×1 texture (R = bar value in 0....
Definition SurfaceShaderContract.h:284
QString colorKey(int slot)
Format a customColor slot key — thin forwarder onto PhosphorShaders::CustomColors::colorKey.
Definition SurfaceShaderContract.h:389
constexpr const char * kIAudioSpectrumSize
int iAudioSpectrumSize — number of CAVA spectrum bars, or 0 when audio is off.
Definition SurfaceShaderContract.h:277
constexpr const char * kUTexture1
sampler2D uTexture1..3 — user-declared image textures (metadata textures: logo, mask,...
Definition SurfaceShaderContract.h:266
constexpr const char * kITime
float iTime — continuously-increasing seconds for ANIMATED surface packs (pulsing glow,...
Definition SurfaceShaderContract.h:189
constexpr const char * kUSurfaceFrameTopLeft
vec2 uSurfaceFrameTopLeft — the content/frame rect's top-left within uTexture0, in device pixels,...
Definition SurfaceShaderContract.h:140
constexpr const char * kUSurfaceScale
float uSurfaceScale — the logical-to-device pixel scale of the output the surface is on.
Definition SurfaceShaderContract.h:158
constexpr const char * kUBackdrop
sampler2D uBackdrop — BOTH RUNTIMES, with different content.
Definition SurfaceShaderContract.h:211
Definition DecorationProfile.h:31