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, AbstractPropertyType propertyType, UniformBindingType bindingType, optional< FixedUniform > fixedOperation, FixedUniformFunction func, uint16_t setIndex, gfx::ImageType imageType, bool hasSampler)
	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< FixedUniform >	fixedOperation
	Corresponding fixed uniform.

bool	hasSampler
	Whether the texture has a sampler.

gfx::ImageType	imageType
	Image type derived from reflection data.

string	name
	Name of the uniform.

AbstractPropertyType	propertyType
	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,
		AbstractPropertyType	propertyType,
		UniformBindingType	bindingType,
		optional< FixedUniform >	fixedOperation,
		FixedUniformFunction	func,
		uint16_t	setIndex,
		gfx::ImageType	imageType,
		bool	hasSampler )

inlineexplicit

Constructor for generic render values.

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

Parameters

name	Render value name.
dataType	Uniform data type.
propertyType	Property type corresponding with the Render value. Can be nullopt.
bindingType	The type of binding associated with the uniform.
fixedOperation	Fixed uniform identifier.
func	Potential function pointer to use.
setIndex	Resource Set index.
imageType	Image type derived from reflection data.
hasSampler	Whether the texture has a sampler.

Since: Kanzi 4.1.0 added the hasSampler parameter.

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

AbstractPropertyType kanzi::ShaderProgram::TextureProperty::propertyType

Corresponding property type.

Can be empty.

Since: Kanzi 4.1.0 changed the type to AbstractPropertyType.

◆ 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.

◆ hasSampler

bool kanzi::ShaderProgram::TextureProperty::hasSampler

Whether the texture has a sampler.

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

kanzi/core.ui/graphics3d/shader.hpp

Public Member Functions

Public Attributes