PhosphorShaders::ShaderRegistry::ParameterInfo Struct Reference

#include <phosphor-shaders/include/PhosphorShaders/ShaderRegistry.h>

Public Member Functions
QString	uniformName () const
	Convert slot to uniform name (e.g., slot 0 → "customParams1_x")

Public Attributes
QString	id
QString	name
QString	group
QString	type
	"float", "color", "int", "bool", "image"
int	slot = -1
QVariant	defaultValue
QVariant	minValue
QVariant	maxValue
bool	useZoneColor = false
	Hint: consumer may bind to app-specific color.
QString	wrap
QString	unit
	Unit the value is expressed in.

Member Function Documentation

uniformName()

QString PhosphorShaders::ShaderRegistry::ParameterInfo::uniformName

(

)

const

Convert slot to uniform name (e.g., slot 0 → "customParams1_x")

Member Data Documentation

defaultValue

QVariant PhosphorShaders::ShaderRegistry::ParameterInfo::defaultValue

group

QString PhosphorShaders::ShaderRegistry::ParameterInfo::group

id

QString PhosphorShaders::ShaderRegistry::ParameterInfo::id

maxValue

QVariant PhosphorShaders::ShaderRegistry::ParameterInfo::maxValue

minValue

QVariant PhosphorShaders::ShaderRegistry::ParameterInfo::minValue

name

QString PhosphorShaders::ShaderRegistry::ParameterInfo::name

slot

int PhosphorShaders::ShaderRegistry::ParameterInfo::slot = -1

type

QString PhosphorShaders::ShaderRegistry::ParameterInfo::type

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

unit

QString PhosphorShaders::ShaderRegistry::ParameterInfo::unit

Unit the value is expressed in.

Empty for a plain number; "px" declares the value to be logical pixels of the real surface the shader draws on. A host that renders the shader at reduced size — a settings preview standing a 300px pane in for a 2560px screen — scales such values by that reduction, so the effect reads as a faithful miniature rather than an effect several times too coarse. The runtime paths draw at true size and scale nothing.

useZoneColor

bool PhosphorShaders::ShaderRegistry::ParameterInfo::useZoneColor = false

Hint: consumer may bind to app-specific color.

wrap

QString PhosphorShaders::ShaderRegistry::ParameterInfo::wrap

---

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

• phosphor-shaders/include/PhosphorShaders/ShaderRegistry.h