HioGlslfxConfig Class Reference

#include <glslfxConfig.h>

Classes
class	Attribute
class	Parameter
class	Texture

Public Types
enum	Role { RoleNone = 0, RoleColor = 1 }
typedef std::vector< Parameter >	Parameters
typedef std::vector< Texture >	Textures
typedef std::vector< Attribute >	Attributes
typedef std::vector< std::string >	SourceKeys
typedef VtDictionary	MetadataDictionary

Public Member Functions
HIO_API SourceKeys	GetSourceKeys (TfToken const &shaderStageKey) const
	Return the set of source keys for a particular shader stage. More...
HIO_API Parameters	GetParameters () const
	Return the parameters specified in the configuration. More...
HIO_API Textures	GetTextures () const
	Return the textures specified in the configuration. More...
HIO_API Attributes	GetAttributes () const
	Returns the attributes specified in the configuration. More...
HIO_API MetadataDictionary	GetMetadata () const
	Returns the metadata specified in the configuration. More...

Static Public Member Functions
static HIO_API HioGlslfxConfig *	Read (TfToken const &technique, std::string const &input, std::string const &filename, std::string *errorStr)

Detailed Description

A class representing the configuration of a glslfx file.

HioGlslfxConfig provides an API for querying the configuration of a glslfx file

Definition at line 45 of file glslfxConfig.h.

Member Typedef Documentation

typedef std::vector<Attribute> HioGlslfxConfig::Attributes

Definition at line 122 of file glslfxConfig.h.

typedef VtDictionary HioGlslfxConfig::MetadataDictionary

Definition at line 136 of file glslfxConfig.h.

typedef std::vector<Parameter> HioGlslfxConfig::Parameters

Definition at line 82 of file glslfxConfig.h.

typedef std::vector<std::string> HioGlslfxConfig::SourceKeys

Definition at line 134 of file glslfxConfig.h.

typedef std::vector<Texture> HioGlslfxConfig::Textures

Definition at line 102 of file glslfxConfig.h.

Member Enumeration Documentation

enum HioGlslfxConfig::Role

Enumerates Roles that parameters can have.

enum Role:

• RoleNone = 0 None: the default role
• RoleColor = 1 Color: the role of a color

Enumerator
RoleNone
RoleColor

Definition at line 56 of file glslfxConfig.h.

Member Function Documentation

HIO_API Attributes HioGlslfxConfig::GetAttributes

(

)

const

Returns the attributes specified in the configuration.

HIO_API MetadataDictionary HioGlslfxConfig::GetMetadata

(

)

const

Returns the metadata specified in the configuration.

HIO_API Parameters HioGlslfxConfig::GetParameters

(

)

const

Return the parameters specified in the configuration.

HIO_API SourceKeys HioGlslfxConfig::GetSourceKeys

(

TfToken const &

shaderStageKey

)

const

Return the set of source keys for a particular shader stage.

HIO_API Textures HioGlslfxConfig::GetTextures

(

)

const

Return the textures specified in the configuration.

static HIO_API HioGlslfxConfig* HioGlslfxConfig::Read ( TfToken const &  technique, std::string const &  input, std::string const &  filename, std::string *  errorStr  )

static

Create a new HioGlslfxConfig from an input string

The filename parameter is only used for error reporting.

---

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

• pxr/imaging/hio/glslfxConfig.h