Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::ShaderProgram::UniformProperty Struct Reference

#include <kanzi/core.ui/platform/graphics_backend/gl/shader.hpp>

Public Member Functions

 UniformProperty ()=default
 Constructor. More...
 
 UniformProperty (const string_view &name, PropertyDataType dataType, unsigned int elementCount, optional< AbstractPropertyType > propertyType, UniformBindingType bindingType, optional< FixedUniform > fixedOperation, FixedUniformFunction func, UniformTransformation transformation)
 Constructor for generic render values. More...
 

Public Attributes

UniformBindingType bindingAssociation
 The type of binding associated with the uniform. More...
 
PropertyDataType dataType
 Uniform data type. More...
 
unsigned int elementCount
 Uniform element count. More...
 
FixedUniformFunction fixedFunction
 Corresponding function pointer. More...
 
optional< FixedUniformfixedOperation
 Corresponding fixed uniform. More...
 
string name
 Name of the uniform. More...
 
optional< AbstractPropertyTypepropertyType
 Corresponding property type. More...
 
UniformTransformation transformation
 Uniform transformation. More...
 
int uniformLocation
 Uniform ID. More...
 

Constructor & Destructor Documentation

◆ UniformProperty() [1/2]

kanzi::ShaderProgram::UniformProperty::UniformProperty ( )
explicitdefault

Constructor.

◆ UniformProperty() [2/2]

kanzi::ShaderProgram::UniformProperty::UniformProperty ( const string_view &  name,
PropertyDataType  dataType,
unsigned int  elementCount,
optional< AbstractPropertyType propertyType,
UniformBindingType  bindingType,
optional< FixedUniform fixedOperation,
FixedUniformFunction  func,
UniformTransformation  transformation 
)
inlineexplicit

Constructor for generic render values.

There may be a binding for this value or the value may be set manually.

Parameters
nameRender value name.
dataTypeUniform data type.
elementCountNumber of elements in the uniform.
propertyTypeProperty type corresponding with the Render value. Can be nullopt.
bindingTypeThe type of binding associated with the uniform.
fixedOperationFixed uniform identifier.
funcPotential function pointer to use.
transformationUniform transformation.

Member Data Documentation

◆ name

string kanzi::ShaderProgram::UniformProperty::name

Name of the uniform.

This corresponds with the unqualified name of the property type if a property type is set.

◆ dataType

PropertyDataType kanzi::ShaderProgram::UniformProperty::dataType

Uniform data type.

◆ elementCount

unsigned int kanzi::ShaderProgram::UniformProperty::elementCount

Uniform element count.

Usually 1, but can be more for uniforms with arrays.

◆ propertyType

optional<AbstractPropertyType> kanzi::ShaderProgram::UniformProperty::propertyType

Corresponding property type.

Can be nullopt.

◆ bindingAssociation

UniformBindingType kanzi::ShaderProgram::UniformProperty::bindingAssociation

The type of binding associated with the uniform.

Uniforms may associate with a manually defined binding contained in the regular binding set. If manual binding is not present, the binding association may instruct to create a default binding.

◆ fixedOperation

optional<FixedUniform> kanzi::ShaderProgram::UniformProperty::fixedOperation

Corresponding fixed uniform.

Can be nullopt.

◆ fixedFunction

FixedUniformFunction kanzi::ShaderProgram::UniformProperty::fixedFunction

Corresponding function pointer.

Can be nullptr.

◆ transformation

UniformTransformation kanzi::ShaderProgram::UniformProperty::transformation

Uniform transformation.

◆ uniformLocation

int kanzi::ShaderProgram::UniformProperty::uniformLocation

Uniform ID.


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