A class representing the configuration of a glslfx file. More...

#include <glslfxConfig.h>

Classes
class	Attribute
	A class representing an attribute. More...

class	Parameter
	A class representing a parameter. More...

class	Texture
	A class representing a texture. More...

Public Types
enum	Role { RoleNone = 0 , RoleColor = 1 }
	Enumerates Roles that parameters can have. More...

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.

HIO_API Parameters	GetParameters () const
	Return the parameters specified in the configuration.

HIO_API Textures	GetTextures () const
	Return the textures specified in the configuration.

HIO_API Attributes	GetAttributes () const
	Returns the attributes specified in the configuration.

HIO_API MetadataDictionary	GetMetadata () const
	Returns the metadata specified in the configuration.

Static Public Member Functions
static HIO_API HioGlslfxConfig *	Read (TfToken const &technique, std::string const &input, std::string const &filename, std::string *errorStr)
	Create a new HioGlslfxConfig from an input string.

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

◆ Attributes

typedef std::vector<Attribute> Attributes

Definition at line 122 of file glslfxConfig.h.

◆ MetadataDictionary

typedef VtDictionary MetadataDictionary

Definition at line 136 of file glslfxConfig.h.

◆ Parameters

typedef std::vector<Parameter> Parameters

Definition at line 82 of file glslfxConfig.h.

◆ SourceKeys

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

Definition at line 134 of file glslfxConfig.h.

◆ Textures

typedef std::vector<Texture> Textures

Definition at line 102 of file glslfxConfig.h.

Member Enumeration Documentation

◆ Role

enum Role

Enumerates Roles that parameters can have.

enum Role:

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

Definition at line 56 of file glslfxConfig.h.

Member Function Documentation

◆ GetAttributes()

HIO_API Attributes GetAttributes ( ) const

Returns the attributes specified in the configuration.

◆ GetMetadata()

HIO_API MetadataDictionary GetMetadata ( ) const

Returns the metadata specified in the configuration.

◆ GetParameters()

HIO_API Parameters GetParameters ( ) const

Return the parameters specified in the configuration.

◆ GetSourceKeys()

HIO_API SourceKeys GetSourceKeys ( TfToken const & shaderStageKey ) const

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

◆ GetTextures()

HIO_API Textures GetTextures ( ) const

Return the textures specified in the configuration.

◆ Read()

static HIO_API 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

Classes

Public Types

Public Member Functions

Static Public Member Functions