Phosphor
Qt6 / Wayland library suite for window-management tools
 
Loading...
Searching...
No Matches
org.plasmazones.Shader

Shader management interface. Provides shader discovery, parameter introspection, compilation lifecycle, and user shader directory monitoring.

Well-known name org.plasmazones.Shader
Source XML org.plasmazones.Shader.xml
Methods 9
Signals 3
Properties 0

Methods

<tt>availableShaders()</tt>

Get list of available shader effects with metadata.

Arg Direction Type Description
shaders out av *(array<variant>)* List of shader metadata maps.

<tt>shaderInfo()</tt>

Get detailed information about a specific shader.

Arg Direction Type Description
shaderId in s *(string)* Shader UUID.
info out a{sv} *(dict<string,variant>)* Shader metadata map (empty if not found).

<tt>defaultShaderParams()</tt>

Get default parameter values for a shader.

Arg Direction Type Description
shaderId in s *(string)* Shader UUID.
params out a{sv} *(dict<string,variant>)* Map of parameter IDs to default values.

<tt>translateShaderParams()</tt>

Translate shader params from semantic IDs to uniform names for the renderer.

Arg Direction Type Description
shaderId in s *(string)* Shader UUID.
params in a{sv} *(dict<string,variant>)* Params with semantic ID keys.
uniforms out a{sv} *(dict<string,variant>)* Params with uniform name keys.

<tt>shadersEnabled()</tt>

Check if shader effects are enabled (compiled with shader support).

Arg Direction Type Description
enabled out b *(bool)*

<tt>userShadersEnabled()</tt>

Check if user-installed shaders are supported.

Arg Direction Type Description
enabled out b *(bool)*

<tt>userShaderDirectory()</tt>

Get path to user shader installation directory.

Arg Direction Type Description
path out s *(string)*

<tt>openUserShaderDirectory()</tt>

Open user shader directory in the file manager.

No arguments.

<tt>refreshShaders()</tt>

Reload all shaders from disk.

No arguments.

Signals

<tt>shaderCompilationStarted</tt>

Shader compilation/bake started.

Arg Direction Type Description
shaderId out s *(string)* Shader being compiled.

<tt>shaderCompilationFinished</tt>

Shader compilation/bake completed.

Arg Direction Type Description
shaderId out s *(string)* Shader that was compiled.
success out b *(bool)* True if compilation succeeded.
error out s *(string)* Error message if failed.

<tt>shadersChanged</tt>

Shader list changed (added, removed, or reloaded).

No payload.