shaderMetadataHelpers.h File Reference

Include dependency graph for shaderMetadataHelpers.h:

Go to the source code of this file.

Namespaces
namespace	ShaderMetadataHelpers
	Various utilities for parsing metadata contained within shaders.

Functions
SDR_API bool	IsTruthy (const TfToken &key, const SdrTokenMap &metadata)
	Determines if the given metadatum in the metadata dictionary has a truthy value.
SDR_API std::string	StringVal (const TfToken &key, const SdrTokenMap &metadata, const std::string &defaultValue=std::string())
	Extracts the string value from the given metadatum if it exists, otherwise returns defaultValue.
SDR_API TfToken	TokenVal (const TfToken &key, const SdrTokenMap &metadata, const TfToken &defaultValue=TfToken())
	Extracts the tokenized value from the given metadatum if it exists, otherwise returns defaultValue.
SDR_API int	IntVal (const TfToken &key, const SdrTokenMap &metadata, int defaultValue=std::numeric_limits< int >::max())
	Extracts the int value from the given metadatum if it exists and is a valid integer value, otherwise returns default value.
SDR_API SdrStringVec	StringVecVal (const TfToken &key, const SdrTokenMap &metadata)
	Extracts a vector of strings from the given metadatum.
SDR_API SdrTokenVec	TokenVecVal (const TfToken &key, const SdrTokenMap &metadata)
	Extracts a vector of tokenized values from the given metadatum.
SDR_API SdrOptionVec	OptionVecVal (const std::string &optionStr)
	Extracts an "options" vector from the given string.
SDR_API std::string	CreateStringFromStringVec (const SdrStringVec &stringVec)
	Serializes a vector of strings into a string using the pipe character as the delimiter.
SDR_API bool	IsPropertyAnAssetIdentifier (const SdrTokenMap &metadata)
	Determines if the specified property metadata has a widget that indicates the property is an asset identifier.
SDR_API bool	IsPropertyATerminal (const SdrTokenMap &metadata)
	Determines if the specified property metadata has a 'renderType' that indicates the property should be a SdrPropertyTypes->Terminal.
SDR_API TfToken	GetRoleFromMetadata (const SdrTokenMap &metadata)
	Gets the "role" from metadata if one is provided.
SDR_API VtValue	ParseSdfValue (const std::string &valueStr, const SdrShaderPropertyConstPtr &property, std::string *err)
	Parses the VtValue from the given valueStr according to the sdf type expressed by the given property via two steps.
SDR_API std::string	ComputeShownIfFromMetadata (SdrShaderPropertyConstPtr property, const SdrShaderPropertyUniquePtrVec &allProperties, SdrShaderNodeConstPtr shader)
	Synthesizes a "shownIf" expression from conditional visibility metadata in property, expressed according to Katana's "args" format.
SDR_API std::string	ComputeShownIfFromMetadata (const SdrTokenMap &metadata, const std::string &pageName, const SdrShaderPropertyUniquePtrVec &properties, const std::string &shaderUri)
	Synthesizes a "shownIf" expression from conditional visibility metadata associated with pageName, expressed according to Katana's "args" format.