Kanzi  3.9.6
Kanzi Engine API
kanzi::ShaderProgram::FixedUniformFunctionInfo Struct Reference

Information on fixed uniform function. More...

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

Public Attributes

KzuExpressionValidatorOperation bindingOperation
 Binding operation instruction enum or KZU_EXPRESSION_VALIDATOR_OPERATION_WRITE as placeholder is none. More...
 
PropertyDataType dataType
 Uniform data type. More...
 
FixedUniform enumValue
 Uniform enumeration value. Kanzi uses this for sanity checking. More...
 
FixedUniformFunction function
 The C++ function to use or nullptr if none. When this is set, Kanzi ignores the optional property binding. More...
 
const char * name
 Uniform name without optional kz prefix. For example, WorldMatrix. More...
 
optional< AbstractPropertyTypeproperty
 Optional property binding. Kanzi uses this only if function is nullptr. More...
 

Detailed Description

Information on fixed uniform function.

These are the valid combinations of the function and property fields:

  • If the function is set, Kanzi uses that function and ignores the property.
  • If the function is nullptr and the property is set, Kanzi uses the binding to that property.
  • If the function is nullptr and property is nullopt, Kanzi pushes the function to the shader explicitly.
    Since
    Kanzi 3.9.6

Member Data Documentation

◆ name

const char* kanzi::ShaderProgram::FixedUniformFunctionInfo::name

Uniform name without optional kz prefix. For example, WorldMatrix.

◆ enumValue

FixedUniform kanzi::ShaderProgram::FixedUniformFunctionInfo::enumValue

Uniform enumeration value. Kanzi uses this for sanity checking.

◆ bindingOperation

KzuExpressionValidatorOperation kanzi::ShaderProgram::FixedUniformFunctionInfo::bindingOperation

Binding operation instruction enum or KZU_EXPRESSION_VALIDATOR_OPERATION_WRITE as placeholder is none.

◆ function

FixedUniformFunction kanzi::ShaderProgram::FixedUniformFunctionInfo::function

The C++ function to use or nullptr if none. When this is set, Kanzi ignores the optional property binding.

◆ property

optional<AbstractPropertyType> kanzi::ShaderProgram::FixedUniformFunctionInfo::property

Optional property binding. Kanzi uses this only if function is nullptr.

◆ dataType

PropertyDataType kanzi::ShaderProgram::FixedUniformFunctionInfo::dataType

Uniform data type.


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