VkSyntax Class Reference

Syntax class for Vulkan GLSL. More...

#include <VkSyntax.h>

Inheritance diagram for VkSyntax:

Public Member Functions
	VkSyntax ()
const string &	getInputQualifier () const override
Public Member Functions inherited from GlslSyntax
	GlslSyntax ()
const string &	getOutputQualifier () const override
const string &	getConstantQualifier () const override
const string &	getUniformQualifier () const override
const string &	getSourceFileExtension () const override
	Return the file extension used for source code files in this language. More...
bool	typeSupported (const TypeDesc *type) const override
bool	remapEnumeration (const string &value, const TypeDesc *type, const string &enumNames, std::pair< const TypeDesc *, ValuePtr > &result) const override
Public Member Functions inherited from Syntax
virtual	~Syntax ()
void	registerTypeSyntax (const TypeDesc *type, TypeSyntaxPtr syntax)
void	registerReservedWords (const StringSet &names)
void	registerInvalidTokens (const StringMap &tokens)
const StringSet &	getReservedWords () const
	Returns a set of names that are reserved words for this language syntax. More...
const StringMap &	getInvalidTokens () const
	Returns a mapping from disallowed tokens to replacement strings for this language syntax. More...
const TypeSyntax &	getTypeSyntax (const TypeDesc *type) const
const vector< TypeSyntaxPtr > &	getTypeSyntaxes () const
	Returns an array of all registered type syntax objects. More...
const TypeDesc *	getTypeDescription (const TypeSyntaxPtr &typeSyntax) const
const string &	getTypeName (const TypeDesc *type) const
	Returns the name syntax of the given type. More...
virtual string	getOutputTypeName (const TypeDesc *type) const
	Returns the type name in an output context. More...
const string &	getTypeAlias (const TypeDesc *type) const
const string &	getTypeDefinition (const TypeDesc *type) const
const string &	getDefaultValue (const TypeDesc *type, bool uniform=false) const
	Returns the default value string for the given type. More...
virtual string	getValue (const TypeDesc *type, const Value &value, bool uniform=false) const
	Returns the value string for a given type and value object. More...
virtual string	getValue (const ShaderPort *port, bool uniform=false) const
	Returns the value string for a given shader port object. More...
virtual string	getSwizzledVariable (const string &srcName, const TypeDesc *srcType, const string &channels, const TypeDesc *dstType) const
	Get syntax for a swizzled variable. More...
virtual ValuePtr	getSwizzledValue (ValuePtr value, const TypeDesc *srcType, const string &channels, const TypeDesc *dstType) const
	Get swizzled value. More...
virtual const string &	getNewline () const
	Return the characters used for a newline. More...
virtual const string &	getIndentation () const
	Return the characters used for a single indentation level. More...
virtual const string &	getStringQuote () const
	Return the characters used to begin/end a string definition. More...
virtual const string &	getIncludeStatement () const
	Return the string pattern used for a file include statement. More...
virtual const string &	getSingleLineComment () const
	Return the characters used for single line comment. More...
virtual const string &	getBeginMultiLineComment () const
	Return the characters used to begin a multi line comments block. More...
virtual const string &	getEndMultiLineComment () const
	Return the characters used to end a multi line comments block. More...
virtual string	getArrayTypeSuffix (const TypeDesc *, const Value &) const
	Return the array suffix to use for declaring an array type. More...
virtual string	getArrayVariableSuffix (const TypeDesc *type, const Value &value) const
	Return the array suffix to use for declaring an array variable. More...
virtual void	makeValidName (string &name) const
	Modify the given name string to remove any invalid characters or tokens. More...
virtual void	makeIdentifier (string &name, IdentifierMap &identifiers) const
virtual string	getVariableName (const string &name, const TypeDesc *type, IdentifierMap &identifiers) const

Static Public Member Functions
static SyntaxPtr	create ()
Static Public Member Functions inherited from GlslSyntax
static SyntaxPtr	create ()

Additional Inherited Members
Public Types inherited from Syntax
enum	Punctuation { PARENTHESES, CURLY_BRACKETS, SQUARE_BRACKETS, DOUBLE_SQUARE_BRACKETS }
	Punctuation types. More...
Static Public Attributes inherited from GlslSyntax
static const string	INPUT_QUALIFIER
static const string	OUTPUT_QUALIFIER
static const string	UNIFORM_QUALIFIER
static const string	CONSTANT_QUALIFIER
static const string	FLAT_QUALIFIER
static const string	SOURCE_FILE_EXTENSION
static const StringVec	VEC2_MEMBERS
static const StringVec	VEC3_MEMBERS
static const StringVec	VEC4_MEMBERS
Static Public Attributes inherited from Syntax
static const string	NEWLINE
	Constants with commonly used strings. More...
static const string	SEMICOLON
static const string	COMMA
Protected Member Functions inherited from Syntax
	Syntax ()
	Protected constructor. More...
Protected Attributes inherited from Syntax
vector< TypeSyntaxPtr >	_typeSyntaxes
std::unordered_map< const TypeDesc *, size_t >	_typeSyntaxByType
StringSet	_reservedWords
StringMap	_invalidTokens
Static Protected Attributes inherited from Syntax
static const string	INDENTATION
static const string	STRING_QUOTE
static const string	INCLUDE_STATEMENT
static const string	SINGLE_LINE_COMMENT
static const string	BEGIN_MULTI_LINE_COMMENT
static const string	END_MULTI_LINE_COMMENT
static const std::unordered_map< char, size_t >	CHANNELS_MAPPING

Detailed Description

Syntax class for Vulkan GLSL.

Definition at line 17 of file VkSyntax.h.

Constructor & Destructor Documentation

VkSyntax::VkSyntax

(

)

Member Function Documentation

static SyntaxPtr VkSyntax::create ( )

inlinestatic

Definition at line 22 of file VkSyntax.h.

const string& VkSyntax::getInputQualifier ( ) const

inlineoverridevirtual

Returns a type qualifier to be used when declaring types for input variables. Default implementation returns empty string and derived syntax classes should override this method.

Reimplemented from GlslSyntax.

Definition at line 24 of file VkSyntax.h.

---

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

• MaterialXGenGlsl/VkSyntax.h