Kanzi 4.0.0-beta2
kanzi::ShaderProgram::TextureProperty Struct Reference

Description of a Shader Texture. More...

#include <kanzi/core.ui/graphics3d/shader.hpp>

Public Member Functions

 TextureProperty ()=default
 Constructor.
 
 TextureProperty (string_view name, PropertyDataType dataType, optional< AbstractPropertyType > propertyType, UniformBindingType bindingType, optional< FixedUniform > fixedOperation, FixedUniformFunction func, uint16_t setIndex, gfx::ImageType imageType)
 Constructor for generic render values.
 

Public Attributes

UniformBindingType bindingAssociation
 The type of binding associated with the uniform.
 
PropertyDataType dataType
 Uniform data type.
 
FixedUniformFunction fixedFunction
 Corresponding function pointer.
 
optional< FixedUniformfixedOperation
 Corresponding fixed uniform.
 
gfx::ImageType imageType
 Image type derived from reflection data.
 
string name
 Name of the uniform.
 
optional< AbstractPropertyTypepropertyType
 Corresponding property type.
 
uint16_t setIndex
 Resource Set Index.
 

Detailed Description

Description of a Shader Texture.

Since
Kanzi 4.0.0

Constructor & Destructor Documentation

◆ TextureProperty() [1/2]

kanzi::ShaderProgram::TextureProperty::TextureProperty ( )
explicitdefault

Constructor.

◆ TextureProperty() [2/2]

kanzi::ShaderProgram::TextureProperty::TextureProperty ( string_view name,
PropertyDataType dataType,
optional< AbstractPropertyType > propertyType,
UniformBindingType bindingType,
optional< FixedUniform > fixedOperation,
FixedUniformFunction func,
uint16_t setIndex,
gfx::ImageType imageType )
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.
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.
setIndexResource Set index.
imageTypeImage type derived from reflection data.

Member Data Documentation

◆ name

string kanzi::ShaderProgram::TextureProperty::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::TextureProperty::dataType

Uniform data type.

◆ propertyType

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

Corresponding property type.

Can be nullopt.

◆ bindingAssociation

UniformBindingType kanzi::ShaderProgram::TextureProperty::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::TextureProperty::fixedOperation

Corresponding fixed uniform.

Can be nullopt.

◆ fixedFunction

FixedUniformFunction kanzi::ShaderProgram::TextureProperty::fixedFunction

Corresponding function pointer.

Can be nullptr.

◆ setIndex

uint16_t kanzi::ShaderProgram::TextureProperty::setIndex

Resource Set Index.

◆ imageType

gfx::ImageType kanzi::ShaderProgram::TextureProperty::imageType

Image type derived from reflection data.


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