PhosphorAnimationShaders::AnimationShaderEffect::ParameterInfo Struct Reference

Declared shader inputs beyond the standard set (iTime, iFrame, etc.). More...

#include <phosphor-animation/include/PhosphorAnimation/AnimationShaderEffect.h>

Public Attributes
QString	id
QString	name
QString	type
	"float", "int", "bool", "color"
QString	description
	Optional one-line tooltip for the settings UI.
QString	group
	Optional accordion group name for the settings UI.
QVariant	defaultValue
	JSON/QML key: default.
QVariant	minValue
	JSON/QML key: min.
QVariant	maxValue
	JSON/QML key: max.
QVariant	stepValue
	Optional slider step; JSON/QML key: step. QML falls back to (max-min)/200.

Detailed Description

Declared shader inputs beyond the standard set (iTime, iFrame, etc.).

Each entry maps parameterId → { type, default, min, max, ... }. Field names mirror the regular shader pack format (PhosphorRendering::ShaderRegistry::ParameterInfo) so animation packs and overlay packs can share QML editor components.

C++ field name vs JSON key asymmetry: the QVariant fields are suffixed Value because default is a C++ keyword in some contexts; the wire-format and QML-facing keys are the bare forms (default/min/max/step). See toJson() / fromJson() in animationshadereffect.cpp for the mapping, and AnimationsPageController::parameterInfoToMap for the QML side.

Member Data Documentation

defaultValue

QVariant PhosphorAnimationShaders::AnimationShaderEffect::ParameterInfo::defaultValue

JSON/QML key: default.

description

QString PhosphorAnimationShaders::AnimationShaderEffect::ParameterInfo::description

Optional one-line tooltip for the settings UI.

group

QString PhosphorAnimationShaders::AnimationShaderEffect::ParameterInfo::group

Optional accordion group name for the settings UI.

id

QString PhosphorAnimationShaders::AnimationShaderEffect::ParameterInfo::id

maxValue

QVariant PhosphorAnimationShaders::AnimationShaderEffect::ParameterInfo::maxValue

JSON/QML key: max.

minValue

QVariant PhosphorAnimationShaders::AnimationShaderEffect::ParameterInfo::minValue

JSON/QML key: min.

name

QString PhosphorAnimationShaders::AnimationShaderEffect::ParameterInfo::name

stepValue

QVariant PhosphorAnimationShaders::AnimationShaderEffect::ParameterInfo::stepValue

Optional slider step; JSON/QML key: step. QML falls back to (max-min)/200.

type

QString PhosphorAnimationShaders::AnimationShaderEffect::ParameterInfo::type

"float", "int", "bool", "color"

---

The documentation for this struct was generated from the following file:

• phosphor-animation/include/PhosphorAnimation/AnimationShaderEffect.h