phosphor-surface-quick

Qt Quick host for surface shader packs.

phosphor-surface holds the surface shader pack subsystem and stays Core/Gui-only so the KWin effect can link it without Qt Quick. This library is the on-screen half for a Qt Quick scene. SurfaceShaderItem is a PhosphorRendering::ShaderEffect subclass that renders one surface pack over one live item, uploading the surface UBO through SurfaceUniformProfile instead of the overlay one. SurfaceDecoration is the QML chain host: it finds the content's shaderAnchor item, captures it into a hidden texture source, runs one SurfaceShaderItem per resolved stage, and draws the result over the anchor's rect. With an empty decorationChain it stays inert and the content draws with its own chrome. Both ship in the org.phosphor.surface QML module, which the PlasmaZones daemon, the settings app's decoration preview, and the phosphor-shell binary load.

Full API →

Key types

SurfaceShaderItem
ShaderEffect subclass rendering one surface pack, with surface scale, focus, frame geometry, and backdrop inputs.
SurfaceDecoration
QML chain host: captures the anchor item and runs one SurfaceShaderItem per resolved stage over it.

Dependencies

See also

References