Phosphor
Qt6 / Wayland library suite for window-management tools
Loading...
Searching...
No Matches
PointerShaderContract.h File Reference
#include <PhosphorShaders/CustomParamsKey.h>
#include <QString>

Go to the source code of this file.

Namespaces

namespace  PhosphorPointerShaders
namespace  PhosphorPointerShaders::PointerShaderContract
 Cross-runtime named-uniform contract for pointer shaders.

Functions

bool PhosphorPointerShaders::PointerShaderContract::isValidWrapToken (const QString &wrap)
 The accepted texture wrap vocabulary (forwarder onto the canonical predicate in <PhosphorShaders/CustomParamsKey.h>).
QString PhosphorPointerShaders::PointerShaderContract::paramKey (int vec, char comp)
 Format a customParams slot key (customParams<N>_<x|y|z|w>).
QString PhosphorPointerShaders::PointerShaderContract::paramKey (int slot)
 Flat-slot overload: slot is 0..31 across the 8 vec4 slots.
QString PhosphorPointerShaders::PointerShaderContract::colorKey (int slot)
 Format a customColor<N> slot key (1-based on the wire).

Variables

constexpr const char * PhosphorPointerShaders::PointerShaderContract::kITime = "iTime"
 float iTime — seconds since the current burst of pointer activity began.
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kIResolution = "iResolution"
 vec2 iResolution — canvas size in device px.
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kIMouse = "iMouse"
 vec4 iMouse — .xy pointer position in canvas px, .zw = .xy / iResolution.
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kCustomParamsArray = "customParams"
 vec4 customParams[8] / vec4 customColors[16] — declared parameter slots.
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kCustomColorsArray = "customColors"
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kIChannelResolution = "iChannelResolution"
 vec4 iChannelResolution[4] — multipass buffer sizes (.xy).
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kITextureResolution = "iTextureResolution"
 vec4 iTextureResolution[4] — user texture sizes (.xy).
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kUPointerVelocity = "uPointerVelocity"
 vec4 uPointerVelocity — .xy device px/s, .z speed (length), .w the filtered speed over the current stroke (PointerFrameState::filteredSpeed, read by pointerFilteredSpeed()).
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kUPointerPress = "uPointerPress"
 vec4 uPointerPress — .xy canvas px of the last button press, .z seconds since it (kNeverSeconds when none this session), .w button (1 left, 2 right, 3 middle, 0 none).
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kUPointerRelease = "uPointerRelease"
 vec4 uPointerRelease — same shape as uPointerPress for the last release.
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kUPointerState = "uPointerState"
 vec4 uPointerState — .x pressed-button bitmask as float (1 left, 2 right, 4 middle), .y seconds since the last motion, .z logical-to-device scale, .w trail point count actually filled (0..32).
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kUCursorRect = "uCursorRect"
 vec4 uCursorRect — cursor sprite rect in canvas px (x, y, w, h) with the hotspot already applied, so it is where the sprite is drawn.
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kUPointerFlags = "uPointerFlags"
 vec4 uPointerFlags — .x = 1.0 when uCursorSprite is bound (needsCursor honoured), else 0.
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kUPointerTrail = "uPointerTrail"
 vec4 uPointerTrail[32] — newest first.
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kUCursorSprite = "uCursorSprite"
 sampler2D uCursorSprite — the cursor image, bound only for packs that declare needsCursor.
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kUTexture1 = "uTexture1"
 sampler2D uTexture1..3 — user-declared image textures (metadata textures).
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kUTexture2 = "uTexture2"
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kUTexture3 = "uTexture3"
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kIChannel0 = "iChannel0"
 sampler2D iChannel0..3 — multipass buffers, declared by the opt-in pointer_multipass.glsl include (bindings 2-5 on the UBO runtime, the FIRST FOUR of the shared table's eight-wide channel block).
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kIChannel1 = "iChannel1"
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kIChannel2 = "iChannel2"
constexpr const char * PhosphorPointerShaders::PointerShaderContract::kIChannel3 = "iChannel3"
constexpr int PhosphorPointerShaders::PointerShaderContract::kMaxTrailPoints = 32
 Ring capacity of uPointerTrail.
constexpr int PhosphorPointerShaders::PointerShaderContract::kMaxCustomParams = PhosphorShaders::CustomParams::kVecCount
 Number of vec4 slots in customParams (8).
constexpr int PhosphorPointerShaders::PointerShaderContract::kMaxCustomColors = PhosphorShaders::CustomColors::kColorCount
 Number of customColors slots (16).
constexpr int PhosphorPointerShaders::PointerShaderContract::kMaxParameterSlots = PhosphorShaders::CustomParams::kFlatSlotCount
 Number of float sub-slots (4 × 8 = 32), the per-effect scalar budget.
constexpr int PhosphorPointerShaders::PointerShaderContract::kMaxUserTextureSlots = 3
 Maximum number of user-declared textures per pointer effect.
constexpr int PhosphorPointerShaders::PointerShaderContract::kMaxBufferPasses = 2
 Maximum number of buffer passes a pointer pack may declare.
constexpr int PhosphorPointerShaders::PointerShaderContract::kMaxDeclaredParameters = 48
 Maximum number of declared parameters a pack may carry across both pools.
constexpr double PhosphorPointerShaders::PointerShaderContract::kPointerCurveTension = 0.25
 Catmull-Rom tension used by every path pack's curve, mirroring kPointerCurveTension in data/pointer/shared/pointer_lib.glsl.
constexpr int PhosphorPointerShaders::PointerShaderContract::kPointerCurveSteps = 4
 Straight pieces each path pack walks per curve span, mirroring kPointerCurveSteps in data/pointer/shared/pointer_lib.glsl.
constexpr double PhosphorPointerShaders::PointerShaderContract::kNeverSeconds = 1.0e6
 The "none this session" sentinel for the seconds-since lanes of uPointerPress.z, uPointerRelease.z and uPointerState.y: what the tail carries before the first press, release or motion.
constexpr double PhosphorPointerShaders::PointerShaderContract::kPreviewPeakSpeedPxPerSecond = 324.0
 Peak speed, in px per second, that the settings preview's simulated pointer ever reaches.