Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
PointerShaderContract.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 PhosphorPointerShaders {
11
51
52// ── Base (both runtimes; UBO: BaseUniforms members) ──────────────────────
53
58inline constexpr const char* kITime = "iTime";
59
61inline constexpr const char* kIResolution = "iResolution";
62
65inline constexpr const char* kIMouse = "iMouse";
66
70inline constexpr const char* kCustomParamsArray = "customParams";
71inline constexpr const char* kCustomColorsArray = "customColors";
72
80inline constexpr const char* kIChannelResolution = "iChannelResolution";
81
84inline constexpr const char* kITextureResolution = "iTextureResolution";
85
86// ── Pointer tail (UBO offsets 672..1279, see PointerShaderUniforms.h) ────
87
92inline constexpr const char* kUPointerVelocity = "uPointerVelocity";
93
97inline constexpr const char* kUPointerPress = "uPointerPress";
98
101inline constexpr const char* kUPointerRelease = "uPointerRelease";
102
107inline constexpr const char* kUPointerState = "uPointerState";
108
112inline constexpr const char* kUCursorRect = "uCursorRect";
113
120inline constexpr const char* kUPointerFlags = "uPointerFlags";
121
125inline constexpr const char* kUPointerTrail = "uPointerTrail";
126
127// ── Samplers ─────────────────────────────────────────────────────────────
128
139inline constexpr const char* kUCursorSprite = "uCursorSprite";
140
150inline constexpr const char* kUTexture1 = "uTexture1";
151inline constexpr const char* kUTexture2 = "uTexture2";
152inline constexpr const char* kUTexture3 = "uTexture3";
153
158inline constexpr const char* kIChannel0 = "iChannel0";
159inline constexpr const char* kIChannel1 = "iChannel1";
160inline constexpr const char* kIChannel2 = "iChannel2";
161inline constexpr const char* kIChannel3 = "iChannel3";
162
163// ── Budgets ──────────────────────────────────────────────────────────────
164
166inline constexpr int kMaxTrailPoints = 32;
167
171
174
177
179inline constexpr int kMaxUserTextureSlots = 3;
180
184inline constexpr int kMaxBufferPasses = 2;
185
187inline constexpr int kMaxDeclaredParameters = 48;
188
201inline constexpr double kPointerCurveTension = 0.25;
202
205inline constexpr int kPointerCurveSteps = 4;
206
214inline constexpr double kNeverSeconds = 1.0e6;
215
231inline constexpr double kPreviewPeakSpeedPxPerSecond = 324.0;
232
235inline bool isValidWrapToken(const QString& wrap)
236{
238}
239
241inline QString paramKey(int vec, char comp)
242{
244}
245
247inline QString paramKey(int slot)
248{
250}
251
253inline QString colorKey(int slot)
254{
256}
257
258} // namespace PointerShaderContract
259
260} // namespace PhosphorPointerShaders
Cross-runtime named-uniform contract for pointer shaders.
Definition PointerShaderContract.h:50
constexpr const char * kUPointerFlags
vec4 uPointerFlags — .x = 1.0 when uCursorSprite is bound (needsCursor honoured), else 0.
Definition PointerShaderContract.h:120
bool isValidWrapToken(const QString &wrap)
The accepted texture wrap vocabulary (forwarder onto the canonical predicate in <PhosphorShaders/Cust...
Definition PointerShaderContract.h:235
constexpr int kMaxCustomParams
Number of vec4 slots in customParams (8).
Definition PointerShaderContract.h:170
constexpr const char * kCustomParamsArray
vec4 customParams[8] / vec4 customColors[16] — declared parameter slots.
Definition PointerShaderContract.h:70
constexpr const char * kCustomColorsArray
Definition PointerShaderContract.h:71
constexpr const char * kIResolution
vec2 iResolution — canvas size in device px.
Definition PointerShaderContract.h:61
constexpr double kNeverSeconds
The "none this session" sentinel for the seconds-since lanes of uPointerPress.z, uPointerRelease....
Definition PointerShaderContract.h:214
constexpr int kPointerCurveSteps
Straight pieces each path pack walks per curve span, mirroring kPointerCurveSteps in data/pointer/sha...
Definition PointerShaderContract.h:205
constexpr double kPreviewPeakSpeedPxPerSecond
Peak speed, in px per second, that the settings preview's simulated pointer ever reaches.
Definition PointerShaderContract.h:231
constexpr const char * kIChannelResolution
vec4 iChannelResolution[4] — multipass buffer sizes (.xy).
Definition PointerShaderContract.h:80
constexpr const char * kIChannel2
Definition PointerShaderContract.h:160
constexpr int kMaxUserTextureSlots
Maximum number of user-declared textures per pointer effect.
Definition PointerShaderContract.h:179
constexpr const char * kITime
float iTime — seconds since the current burst of pointer activity began.
Definition PointerShaderContract.h:58
QString paramKey(int vec, char comp)
Format a customParams slot key (customParams<N>_<x|y|z|w>).
Definition PointerShaderContract.h:241
constexpr int kMaxTrailPoints
Ring capacity of uPointerTrail.
Definition PointerShaderContract.h:166
QString colorKey(int slot)
Format a customColor<N> slot key (1-based on the wire).
Definition PointerShaderContract.h:253
constexpr const char * kUCursorRect
vec4 uCursorRect — cursor sprite rect in canvas px (x, y, w, h) with the hotspot already applied,...
Definition PointerShaderContract.h:112
constexpr int kMaxParameterSlots
Number of float sub-slots (4 × 8 = 32), the per-effect scalar budget.
Definition PointerShaderContract.h:176
constexpr const char * kUPointerPress
vec4 uPointerPress — .xy canvas px of the last button press, .z seconds since it (kNeverSeconds when ...
Definition PointerShaderContract.h:97
constexpr const char * kIChannel3
Definition PointerShaderContract.h:161
constexpr const char * kIChannel1
Definition PointerShaderContract.h:159
constexpr const char * kUPointerTrail
vec4 uPointerTrail[32] — newest first.
Definition PointerShaderContract.h:125
constexpr const char * kUTexture2
Definition PointerShaderContract.h:151
constexpr int kMaxDeclaredParameters
Maximum number of declared parameters a pack may carry across both pools.
Definition PointerShaderContract.h:187
constexpr const char * kUTexture1
sampler2D uTexture1..3 — user-declared image textures (metadata textures).
Definition PointerShaderContract.h:150
constexpr const char * kUPointerRelease
vec4 uPointerRelease — same shape as uPointerPress for the last release.
Definition PointerShaderContract.h:101
constexpr const char * kIMouse
vec4 iMouse — .xy pointer position in canvas px, .zw = .xy / iResolution.
Definition PointerShaderContract.h:65
constexpr const char * kUCursorSprite
sampler2D uCursorSprite — the cursor image, bound only for packs that declare needsCursor.
Definition PointerShaderContract.h:139
constexpr const char * kUTexture3
Definition PointerShaderContract.h:152
constexpr int kMaxCustomColors
Number of customColors slots (16).
Definition PointerShaderContract.h:173
constexpr double kPointerCurveTension
Catmull-Rom tension used by every path pack's curve, mirroring kPointerCurveTension in data/pointer/s...
Definition PointerShaderContract.h:201
constexpr const char * kIChannel0
sampler2D iChannel0..3 — multipass buffers, declared by the opt-in pointer_multipass....
Definition PointerShaderContract.h:158
constexpr const char * kUPointerVelocity
vec4 uPointerVelocity — .xy device px/s, .z speed (length), .w the filtered speed over the current st...
Definition PointerShaderContract.h:92
constexpr const char * kUPointerState
vec4 uPointerState — .x pressed-button bitmask as float (1 left, 2 right, 4 middle),...
Definition PointerShaderContract.h:107
constexpr const char * kITextureResolution
vec4 iTextureResolution[4] — user texture sizes (.xy).
Definition PointerShaderContract.h:84
constexpr int kMaxBufferPasses
Maximum number of buffer passes a pointer pack may declare.
Definition PointerShaderContract.h:184
Definition PointerFrameState.h:16
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 isValidWrapToken(const QString &wrap)
The accepted texture / buffer wrap vocabulary, shared by every validation site across the shader regi...
Definition CustomParamsKey.h:84