Rumba C++ SDK
maquina::ShaderParam Class Reference

A shader parameter descriptor. More...

#include <Shader.h>

Public Member Functions

 ShaderParam (std::string name, const Value &default_value)
 Construct a shader program parameter. {std::runtime_error,RuntimeError} in case of an unsupported default_value type. More...
 
 ShaderParam (std::string name, ShaderParamType type, const Value &default_value)
 

Public Attributes

std::string name
 The parameter's name. More...
 
Value default_value
 The parameter's default value if not provided in the shader instance. More...
 
int offset =-1
 The parameter's offset in the shader parameter structure (in bytes, computed by the engine) More...
 
ShaderParamType type
 The parameter type (computed by the constructor) More...
 

Detailed Description

A shader parameter descriptor.

Constructor & Destructor Documentation

◆ ShaderParam() [1/2]

maquina::ShaderParam::ShaderParam ( std::string  name,
const Value default_value 
)

Construct a shader program parameter. {std::runtime_error,RuntimeError} in case of an unsupported default_value type.

Parameters
nameThe parameter's name.
default_valueThe parameter's default value if not provided in the shader instance. Must be a simple type, not an ExprCall.

◆ ShaderParam() [2/2]

maquina::ShaderParam::ShaderParam ( std::string  name,
ShaderParamType  type,
const Value default_value 
)
Parameters
nameThe parameter's name.
typeThe parameter's type when the default expression is not a simple type.
default_valueThe parameter's default value if not provided in the shader instance.

Member Data Documentation

◆ default_value

Value maquina::ShaderParam::default_value

The parameter's default value if not provided in the shader instance.

◆ name

std::string maquina::ShaderParam::name

The parameter's name.

◆ offset

int maquina::ShaderParam::offset =-1

The parameter's offset in the shader parameter structure (in bytes, computed by the engine)

◆ type

ShaderParamType maquina::ShaderParam::type

The parameter type (computed by the constructor)


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