Kanzi  3.9.5
Kanzi Engine API
kanzi::ShaderProgram Class Reference

ShaderProgram defines programmable vertex and fragment operations done by the GPU for a draw call. More...

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

Inheritance diagram for kanzi::ShaderProgram:
[legend]

Classes

struct  BindingInfo
 Binding info. More...
 
struct  CreateInfo
 Struct that contains all the parameters that Kanzi needs to create a ShaderProgram. More...
 
struct  CreateInfoProgramBinary
 ShaderProgram creation parameters for initialized from vendor specific GL program binary. More...
 
struct  CreateInfoShaderBinary
 ShaderProgram creation parameters for initialized from vendor specific GL shader binary. More...
 
struct  CreateInfoShaderSources
 ShaderProgram creation parameters for initialized from shader source code strings. More...
 
struct  SamplerInfo
 
struct  UniformProperty
 

Public Types

using BindingContainer = vector< BindingInfo >
 Container for bindings in the material. More...
 
using BindingIterator = BindingContainer::const_iterator
 Binding iterator type. More...
 
typedef array< int, VertexAttribute::SemanticCountFixedAttributeArray
 
typedef FixedAttributeArray::const_iterator FixedAttributeArrayConstIterator
 
typedef FixedAttributeArray::iterator FixedAttributeArrayIterator
 
enum  FixedUniform {
  FixedUniform::ProjectionCameraWorldMatrix, FixedUniform::WorldMatrix, FixedUniform::ProjectionMatrix, FixedUniform::CameraMatrix,
  FixedUniform::CameraPosition, FixedUniform::ViewPosition, FixedUniform::Viewport, FixedUniform::WindowSize,
  FixedUniform::NormalMatrix, FixedUniform::CameraNormalMatrix, FixedUniform::CameraWorldMatrix, FixedUniform::NearFarPlane,
  FixedUniform::Time, FixedUniform::MorphWeights, FixedUniform::MatrixPalette, FixedUniform::Count,
  FixedUniform::Invalid
}
 Fixed uniform locations of the shader program. More...
 
typedef void(* FixedUniformFunction) (Renderer &renderer, int uniformLocation, const Material &material, RenderPass &renderPass, Node &node)
 Function pointer type for fixed operations that do not require a binding. More...
 
enum  UniformBindingType { UniformBindingTypeNone, UniformBindingTypeDefault, UniformBindingTypeManual }
 Uniform binding association type. More...
 
typedef vector< UniformPropertyUniformContainer
 
typedef UniformContainer::const_iterator UniformContainerConstIterator
 
typedef vector< int > UniformLocationContainer
 
enum  UniformTransformation {
  UniformTransformationPassThrough, UniformTransformationSRgbToLinear, UniformTransformationLinearToSRgb, UniformTransformationNotPresent,
  UniformTransformationCount
}
 How value for uniform should be transformed when setting uniform value. More...
 
- Public Types inherited from kanzi::GPUResource
enum  MemoryType { GpuOnly, GpuAndRam, RamOnly }
 Memory upload and RAM preservation strategy for GPU resources. More...
 
- Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 

Public Member Functions

BindingIterator beginBindings () const
 Gets an iterator to the beginning of bindings. More...
 
UniformContainerConstIterator beginFixedUniforms () const
 Gets a const iterator to the beginning of the fixed uniforms. More...
 
UniformContainerConstIterator beginUniforms () const
 Gets an const iterator to the beginning of the property uniforms. More...
 
void bind () const
 Binds the shader program for rendering. More...
 
BindingIterator endBindings () const
 Gets an iterator to the end of bindings. More...
 
UniformContainerConstIterator endFixedUniforms () const
 Gets a const iterator to the end of the fixed uniforms. More...
 
UniformContainerConstIterator endUniforms () const
 Gets an const iterator to the end of the property uniforms. More...
 
bool getBlendingControl () const
 Get shader blending control. More...
 
UniformTransformation getFixedUniformTransformation (FixedUniform fixedUniform) const
 Get uniform transformation for a fixed uniform. More...
 
unsigned int getProgramHandle () const
 Get shader program handle. More...
 
AbstractPropertyType getPropertyTypeByName (string_view propertyTypeName) const
 Gets property type from shader program by name. Returns 0 if not found. More...
 
bool getStrictWarningLogged () const
 
ShaderTextureUniform getTextureUniformLocation (unsigned int textureUnit) const
 Returns texture size uniform locations from shader program. More...
 
unsigned int getUniformElementCount (string_view name)
 Get uniform element count from the shader program by name. More...
 
int getUniformLocation (string_view name)
 Get uniform location from the shader program by name. More...
 
const ShaderAttributeCollectiongetVertexFormat () const
 
bool hasSamplersWithoutProperties () const
 Return true if shader program has samplers that have no corresponding texture property. More...
 
bool isDeployedOverride () const override
 GpuResoucre::isDeployedOverride() implementation. More...
 
void reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser) override
 Resource::reloadFromKzbOverride() implementation. More...
 
void setStrictWarningLogged ()
 
 ShaderProgram (Domain *domain, const CreateInfo &createInfo, string_view name)
 Constructor. More...
 
- Public Member Functions inherited from kanzi::GPUResource
unsigned int getGPUMemoryUsage () const
 
RenderergetRenderer () const
 
void invalidate ()
 Notify resource that graphics context was lost and all GPU resources are invalid. More...
 
bool isDeployed () const
 
 ~GPUResource () override
 
- Public Member Functions inherited from kanzi::Resource
virtual unsigned int getCPUMemoryUsage () const
 Function for getting the memory usage of a resource. More...
 
const string & getName () const
 Gets the resource name. More...
 
const string & getUrl () const
 Gets the resource URL. More...
 
bool isKeepAlive () const
 Tells if the resource has keep alive flag set. More...
 
void reload ()
 
void reloadFromFile (string_view filePath)
 
void reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
 
void setKeepAlive (bool keepAlive)
 Sets the keep alive flag. More...
 
void setUrl (string_view url)
 Sets the resource URL. More...
 
 ~Resource () override
 Destructor. More...
 
- Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr applyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
const MetaclassgetDynamicMetaclass () const override
 Returns the metaclass of the dynamic type of the object. More...
 
MainLoopSchedulergetMainLoopScheduler () const
 Returns the MainLoopScheduler instance of the associated Domain. More...
 
detail::MessageDispatcher * getMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
ScriptingContextSharedPtr getScriptingContext () const
 Gets the scripting context of the object. More...
 
 Object (Domain *domain)
 
void setScriptingContext (ScriptingContextSharedPtr context)
 Sets the scripting context of the object. More...
 
void unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
 ~Object () override
 
- Public Member Functions inherited from kanzi::MetaObject
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
virtual ~MetaObject ()
 
- Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 Returns the begin iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator beginPropertyStorage () const
 Returns the begin iterator to the internal property storage container. More...
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
PropertyStorageContainer::iterator endPropertyStorage ()
 Returns the end iterator to the internal property storage container. More...
 
PropertyStorageContainer::const_iterator endPropertyStorage () const
 Returns the end iterator to the internal property storage container. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property type. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
 Gets number of current notification handlers for given property type. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
 PropertyObject ()
 
void removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
 Remove all KZB properties that are not included in a given set. More...
 
void removeKzbProperties ()
 Remove all KZB properties. More...
 
template<typename DataType >
void removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer)
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property type. More...
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
virtual ~PropertyObject ()
 

Static Public Member Functions

static ShaderProgramSharedPtr create (Domain *domain, const CreateInfo &createInfo, string_view name)
 Create function. More...
 
static ResourceManager::LoadTaskSharedPtr createLoadTask (string_view name, KzbFile *kzbFile, ReadOnlyMemoryFilePtr file)
 
- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Static Public Member Functions inherited from kanzi::MetaObject
static const MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 

Protected Member Functions

void invalidateOverride () override
 GPUResource::invalidateOverride() implementation. More...
 
void reloadOverride () override
 Resource::reloadOverride() implementation. More...
 
- Protected Member Functions inherited from kanzi::GPUResource
virtual unsigned int getGPUMemoryUsageOverride () const
 Gets the amount of GPU memory consumed by the resource. More...
 
 GPUResource (Domain *domain, string_view name="")
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::Resource
virtual unsigned int getCPUMemoryUsageOverride () const
 
virtual void reloadFromFileOverride (string_view filePath)
 
 Resource (Domain *domain, string_view name)
 Constructor. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
void initialize ()
 
 MetaObject ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Acquires a local value source entry that is free for the assignment of a value. More...
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer)
 Internally adds a property value source. More...
 
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner)
 Internally adds a property value source. More...
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
 Copy local value from property storage. More...
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the property storage for given property type descriptor. More...
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
 Finds a property type descriptor by name and data type. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
 Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 Gets the top-level value source for a given property descriptor. More...
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
 
void onCopy (const PropertyObject &other)
 
void removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
 Removes a local value from the given property storage. More...
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 Removes a property value source. More...
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 

Friends

void swap (ShaderProgram &shader1, ShaderProgram &shader2)
 

Additional Inherited Members

- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtrAppliedStyleContainer
 Applied style container. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

ShaderProgram defines programmable vertex and fragment operations done by the GPU for a draw call.

For each draw call, graphics device executes a vertex shader for each vertex, rasterizes primitives, and for each rasterized fragment, the fragment shader is executed.

In order to create a ShaderProgram, you must prepare ShaderProgram::CreateInfo structure and make sure it is valid using CreateInfo::validate(), then create the ShaderProgram with ShaderProgram::create(). If ShaderProgram creation parameters are not valid, ShaderProgram::create() will throw an exception, which can stop program execution.

See also
ShaderProgram::CreateInfo
ShaderProgram::CreateInfoShaderSources
ShaderProgram::CreateInfoShaderBinary
ShaderProgram::CreateInfoProgramBinary

ShaderProgram consist of vertex shader, fragment shader, specification of vertex attributes consumed by the vertex shader, and specification of property types that are used to control uniforms,

Shader programs consume per vertex attribute data, and per draw call values known as uniforms.

Vertex attribute data is typically sourced from Meshes. Kanzi Shader lists a number of shader vertex attributes. Shader vertex attributes have name, semantic and semantic type. When Kanzi prepares a draw call, a mesh is typically used as source for attribute data that is consumed by the shader program. Each mesh has a number of mesh vertex attributes; these are mapped to shader vertex attributes based on attribute semantic and semantic index.

Uniforms are typically sourced from properties, for example Material properties, or from engine. Engine uniforms are for example final transform for the current Model3D node being drawn, camera transformation, or positions and colors of lights in the scene. Engine uniforms are also called "fixed uniforms" in Kanzi.

Values of uniforms can be transformed by Kanzi before they are sent to shader program. Currently only color uniforms have transformations available. With linear to sRGB transform, a linear color is convertex to sRGB when it is sent to uniform. With sRGB to linear transform, a sRGB color value is transformed to linear when it is sent to uniform.

Member Typedef Documentation

◆ FixedUniformFunction

typedef void(* kanzi::ShaderProgram::FixedUniformFunction) (Renderer &renderer, int uniformLocation, const Material &material, RenderPass &renderPass, Node &node)

Function pointer type for fixed operations that do not require a binding.

Parameters
rendererRenderer to use.
uniformShader uniform information.
renderPassLocal render pass context.
nodeLocal node context.

◆ FixedAttributeArray

◆ FixedAttributeArrayIterator

typedef FixedAttributeArray::iterator kanzi::ShaderProgram::FixedAttributeArrayIterator

◆ FixedAttributeArrayConstIterator

typedef FixedAttributeArray::const_iterator kanzi::ShaderProgram::FixedAttributeArrayConstIterator

◆ UniformContainer

◆ UniformContainerConstIterator

typedef UniformContainer::const_iterator kanzi::ShaderProgram::UniformContainerConstIterator

◆ UniformLocationContainer

◆ BindingContainer

Container for bindings in the material.

◆ BindingIterator

using kanzi::ShaderProgram::BindingIterator = BindingContainer::const_iterator

Binding iterator type.

Member Enumeration Documentation

◆ FixedUniform

Fixed uniform locations of the shader program.

Enumerator
ProjectionCameraWorldMatrix 

Projection * camera * world matrix.

WorldMatrix 

World matrix.

ProjectionMatrix 

Projection matrix.

CameraMatrix 

Camera matrix.

CameraPosition 

Camera position.

ViewPosition 

Homogeneous position to use for calculating the view direction to world position.

Viewport 

Viewport area.

WindowSize 

Vec2 containing current window size.

NormalMatrix 

Normal matrix.

CameraNormalMatrix 

Camera * normal matrix (screenspace normal)

CameraWorldMatrix 

Camera * world matrix.

NearFarPlane 

Vec2 containing near and far plane.

Time 

Debug timer.

MorphWeights 

Morph weights.

MatrixPalette 

Bone matrices.

Count 

Number of fixed uniforms.

Invalid 

◆ UniformTransformation

How value for uniform should be transformed when setting uniform value.

Enumerator
UniformTransformationPassThrough 

No transformation.

UniformTransformationSRgbToLinear 

Convert from sRGB to linear.

UniformTransformationLinearToSRgb 

Convert from linear to sRGB.

UniformTransformationNotPresent 

Fixed uniform is not present.

UniformTransformationCount 

Number of uniform transformations.

◆ UniformBindingType

Uniform binding association type.

Enumerator
UniformBindingTypeNone 

No binding associated.

UniformBindingTypeDefault 

Default binding associated.

UniformBindingTypeManual 

Manual binding associated.

Constructor & Destructor Documentation

◆ ShaderProgram()

kanzi::ShaderProgram::ShaderProgram ( Domain domain,
const CreateInfo createInfo,
string_view  name 
)
explicit

Constructor.

Parameters
domainDomain to use.
createInfoShader create info.
nameShader name.

Member Function Documentation

◆ createLoadTask()

static ResourceManager::LoadTaskSharedPtr kanzi::ShaderProgram::createLoadTask ( string_view  name,
KzbFile kzbFile,
ReadOnlyMemoryFilePtr  file 
)
static

◆ create()

static ShaderProgramSharedPtr kanzi::ShaderProgram::create ( Domain domain,
const CreateInfo createInfo,
string_view  name 
)
static

Create function.

Parameters
domainDomain to use.
createInfoShader create info.
nameShader name.

◆ getBlendingControl()

bool kanzi::ShaderProgram::getBlendingControl ( ) const
inline

Get shader blending control.

See also
setBlendingControlEnabled()
Returns
Shader blending control. If true, applying materials using this shader will set renderer blend mode.

◆ getPropertyTypeByName()

AbstractPropertyType kanzi::ShaderProgram::getPropertyTypeByName ( string_view  propertyTypeName) const

Gets property type from shader program by name. Returns 0 if not found.

◆ beginFixedUniforms()

UniformContainerConstIterator kanzi::ShaderProgram::beginFixedUniforms ( ) const
inline

Gets a const iterator to the beginning of the fixed uniforms.

This is the same as the beginning of the uniform list.

Returns
Const iterator to the beginning of the fixed uniforms.

◆ endFixedUniforms()

UniformContainerConstIterator kanzi::ShaderProgram::endFixedUniforms ( ) const
inline

Gets a const iterator to the end of the fixed uniforms.

This is the same as the end of the uniform list if there is only fixed uniforms.

Returns
Const iterator to the end of the fixed uniforms.

◆ beginUniforms()

UniformContainerConstIterator kanzi::ShaderProgram::beginUniforms ( ) const
inline

Gets an const iterator to the beginning of the property uniforms.

Returns
Const iterator to the beginning of the property uniforms.

◆ endUniforms()

UniformContainerConstIterator kanzi::ShaderProgram::endUniforms ( ) const
inline

Gets an const iterator to the end of the property uniforms.

Returns
Const iterator to the end of the property uniforms.

◆ beginBindings()

BindingIterator kanzi::ShaderProgram::beginBindings ( ) const
inline

Gets an iterator to the beginning of bindings.

Returns
Iterator to the beginning of binding container.

◆ endBindings()

BindingIterator kanzi::ShaderProgram::endBindings ( ) const
inline

Gets an iterator to the end of bindings.

Returns
Iterator to the end of binding container.

◆ getProgramHandle()

unsigned int kanzi::ShaderProgram::getProgramHandle ( ) const

Get shader program handle.

Returns
Program handle.

◆ getVertexFormat()

const ShaderAttributeCollection& kanzi::ShaderProgram::getVertexFormat ( ) const

◆ bind()

void kanzi::ShaderProgram::bind ( ) const

Binds the shader program for rendering.

◆ hasSamplersWithoutProperties()

bool kanzi::ShaderProgram::hasSamplersWithoutProperties ( ) const

Return true if shader program has samplers that have no corresponding texture property.

◆ getTextureUniformLocation()

ShaderTextureUniform kanzi::ShaderProgram::getTextureUniformLocation ( unsigned int  textureUnit) const

Returns texture size uniform locations from shader program.

◆ getUniformLocation()

int kanzi::ShaderProgram::getUniformLocation ( string_view  name)

Get uniform location from the shader program by name.

Parameters
nameName of the uniform. Compared to the property name.
Returns
Uniform location in shader program, or -1 if uniform was not found in the shader program.

◆ getUniformElementCount()

unsigned int kanzi::ShaderProgram::getUniformElementCount ( string_view  name)

Get uniform element count from the shader program by name.

Parameters
nameName of the uniform. Compared to the property name.
Returns
Element count from the uniform or 0 if uniform was not found in the shader program.

◆ getFixedUniformTransformation()

UniformTransformation kanzi::ShaderProgram::getFixedUniformTransformation ( FixedUniform  fixedUniform) const

Get uniform transformation for a fixed uniform.

Parameters
fixedUniformFixed uniform to query.
Returns
Uniform transformation for requested fixed uniform.

◆ setStrictWarningLogged()

void kanzi::ShaderProgram::setStrictWarningLogged ( )
inline

◆ getStrictWarningLogged()

bool kanzi::ShaderProgram::getStrictWarningLogged ( ) const
inline

◆ reloadFromKzbOverride()

void kanzi::ShaderProgram::reloadFromKzbOverride ( KzbFile kzbFile,
ReadOnlyMemoryFile file,
KzbMemoryParser parser 
)
overridevirtual

Resource::reloadFromKzbOverride() implementation.

Reimplemented from kanzi::Resource.

◆ isDeployedOverride()

bool kanzi::ShaderProgram::isDeployedOverride ( ) const
overridevirtual

GpuResoucre::isDeployedOverride() implementation.

Implements kanzi::GPUResource.

◆ reloadOverride()

void kanzi::ShaderProgram::reloadOverride ( )
overrideprotectedvirtual

Resource::reloadOverride() implementation.

Reimplemented from kanzi::Resource.

◆ invalidateOverride()

void kanzi::ShaderProgram::invalidateOverride ( )
overrideprotectedvirtual

GPUResource::invalidateOverride() implementation.

Reimplemented from kanzi::GPUResource.

Friends And Related Function Documentation

◆ swap

void swap ( ShaderProgram shader1,
ShaderProgram shader2 
)
friend

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