ArcGIS Procedural Runtime  3.1.9666
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions
prtx::Shader Class Referenceabstract

#include <Shader.h>

Inheritance diagram for prtx::Shader:
[legend]

Public Types

enum  KeyType {
  KT_INT,
  KT_BOOL,
  KT_FLOAT,
  KT_STRING,
  KT_TEXTURE
}
 

Public Member Functions

virtual size_t getKey (const std::wstring &name) const =0
 
virtual WStringVector getKeys () const =0
 
virtual const std::wstring & getName () const =0
 
virtual bool hasKey (const std::wstring &name) const =0
 
- Public Member Functions inherited from prtx::ComparableContent
virtual bool compare (const ComparableContent &rhs) const =0
 
virtual bool operator!= (const ComparableContent &rhs) const =0
 
virtual bool operator< (const ComparableContent &rhs) const =0
 
virtual bool operator== (const ComparableContent &rhs) const =0
 
- Public Member Functions inherited from prtx::Content
 Content (const Content &)=delete
 
Contentoperator= (const Content &)=delete
 

Static Public Member Functions

static ShaderPtr getDefault ()
 

Detailed Description

A Shader defines the names and types of the attributes for a Material. There is a default Shader called which can be extended using the ShaderBuilder class.

Default shader keys:

See Also
Material, MaterialBuilder, ShaderBuilder

Member Enumeration Documentation

The types supported by the Shader and Material class.

Enumerator
KT_INT 

Integer type.

KT_BOOL 

Boolean type.

KT_FLOAT 

Float type.

KT_STRING 

String type.

KT_TEXTURE 

Texture type.

Member Function Documentation

static ShaderPtr prtx::Shader::getDefault ( )
static

Convenience member function to get default shader

Returns
The default shader.
virtual size_t prtx::Shader::getKey ( const std::wstring &  name) const
pure virtual
Returns
The index of the shader attribute key.
Exceptions
std::invalid_argumentif key is not found
virtual WStringVector prtx::Shader::getKeys ( ) const
pure virtual
Returns
a vector with all defined keys.
virtual const std::wstring& prtx::Shader::getName ( ) const
pure virtual
Returns
the name of the shader.
virtual bool prtx::Shader::hasKey ( const std::wstring &  name) const
pure virtual
Returns
true if a key 'name' is present.

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