The IUniform interface. More...

#include "murl_graph_i_uniform.h"

Inheritance diagram for Murl::Graph::IUniform:

Public Member Functions

virtual SInt32 GetIndex () const =0
 Get the zero-based index of this uniform variable. More...
 
virtual const StringGetName () const =0
 Get the uniform's user-defined variable name. More...
 
virtual IEnums::UniformItem GetItem () const =0
 Get the uniform's predefined item. More...
 
virtual IEnums::UniformType GetType () const =0
 Get the uniform's data type. More...
 
virtual UInt32 GetByteOffset () const =0
 Get the uniform's byte offset. More...
 

Detailed Description

The IUniform interface.

This interface represents a generic shader uniform variable object that exposes properties such as predefined item, variable name or data type. It can also be used to set a uniform variable's value by parsing a given string.

Member Function Documentation

◆ GetIndex()

virtual SInt32 Murl::Graph::IUniform::GetIndex ( ) const
pure virtual

Get the zero-based index of this uniform variable.

Returns
The uniform's index inside the parent container.

◆ GetName()

virtual const String& Murl::Graph::IUniform::GetName ( ) const
pure virtual

Get the uniform's user-defined variable name.

If the uniform is a predefined one, this method always returns an empty string.

Returns
The uniform variable's name.

◆ GetItem()

virtual IEnums::UniformItem Murl::Graph::IUniform::GetItem ( ) const
pure virtual

Get the uniform's predefined item.

If the uniform is a user-defined one, this method always returns IEnums::UNIFORM_ITEM_CUSTOM.

Returns
The uniform item.

◆ GetType()

virtual IEnums::UniformType Murl::Graph::IUniform::GetType ( ) const
pure virtual

Get the uniform's data type.

Returns
The uniform's data type.

◆ GetByteOffset()

virtual UInt32 Murl::Graph::IUniform::GetByteOffset ( ) const
pure virtual

Get the uniform's byte offset.

This method returns the uniform's byte offset relative to the beginning of its container.

Returns
The uniform's byte offset within a constant array.

The documentation for this interface was generated from the following file:
  • murl_graph_i_uniform.h


Copyright © 2011-2018 Spraylight GmbH.