#include <OpenFlipper/libs_required/ACG/GL/ShaderGenerator.hh>

Public Member Functions
	ShaderProgGenerator (const ShaderGenDesc *_desc)

	ShaderProgGenerator (const ShaderGenDesc *_desc, const std::vector< unsigned int > &_modifierIDs)

	ShaderProgGenerator (const ShaderGenDesc _desc, const std::vector< unsigned int > _modifierIDs)

	ShaderProgGenerator (const ShaderGenDesc _desc, const unsigned int _modifierIDs, unsigned int _numModifiers)

	ShaderProgGenerator (const ShaderGenDesc _desc, ShaderModifier const *_modifiers, unsigned int _numModifiers)

	ShaderProgGenerator (const ShaderGenDesc _desc, const std::vector< ShaderModifier > &_modifiers)

	ShaderProgGenerator (const ShaderGenDesc _desc, const std::vector< ShaderModifier > *_modifiers)

void	saveVertexShToFile (const char *_fileName)

void	saveGeometryShToFile (const char *_fileName)

void	saveFragmentShToFile (const char *_fileName)

const QStringList &	getVertexShaderCode ()
	Returns generated vertex shader code.

const QStringList &	getTessControlShaderCode ()
	Returns generated vertex shader code.

const QStringList &	getTessEvaluationShaderCode ()
	Returns generated tessellation control shader code.

const QStringList &	getGeometryShaderCode ()
	Returns generated tessellation evaluation shader code.

const QStringList &	getFragmentShaderCode ()
	Returns generated fragment shader code.

int	getNumActiveModifiers () const
	Get the number of active modifiers.

ShaderModifier *	getActiveModifier (int _i)
	Get active modfiers for this program.

bool	hasGeometryShader () const
	check whether there is a geometry shader present

bool	hasTessControlShader () const
	check whether there is a tess-control shader present

bool	hasTessEvaluationShader () const
	check whether there is a tess-evaluation shader present

void	generateShaders ()
	Generates the shader code.

Static Public Member Functions
static void	setShaderDir (QString _dir)

static QString	getShaderDir ()

static unsigned int	registerModifier (ShaderModifier *_modifier)
	Shader modifiers have to be registered before they can be used. They also must remain allocated for the rest of the applications runtime. Use a combination of modifier-IDs in the constructor of ShaderProgGen to active them. More...

static bool	loadStringListFromFile (QString _fileName, QStringList *_out)
	Load a text file as string list. More...

static QString	getAbsFilePath (QString _fileName)
	Convert a filename to an absolute filename. More...

Private Member Functions
void	loadShaderTemplateFromFile ()
	Loads external shader templates.

void	scanShaderTemplate (QStringList &_templateSrc, QString _templateFilename, QStringList *_outLayoutDirectives=0)
	Scans loaded shader template for requested inputs, glsl version or includes.

void	init (const ShaderGenDesc _desc, ShaderModifier const *_modifiers, unsigned int _numActiveMods)
	Called in constructor.

void	init (const ShaderGenDesc _desc, const unsigned int _modifiers, unsigned int _numActiveMods)

void	buildVertexShader ()

void	buildTessControlShader ()

void	buildTessEvalShader ()

void	buildGeometryShader ()

void	buildFragmentShader ()

void	addVertexBeginCode (QStringList *_code)

void	addVertexEndCode (QStringList *_code)

void	addFragmentBeginCode (QStringList *_code)

void	addFragmentEndCode (QStringList *_code)

void	addLightingFunctions (QStringList *_code)
	Adds lighting definition functions. More...

void	addLightingCode (QStringList *_code)
	Adds lighting function calls to code.

void	modifyLightingCode (QStringList _code, ShaderModifier _modifier)
	Calls lighting modifier for each light.

void	addTexGenCode (QStringList *_code, bool _fragmentShader)
	Add texture coordinate generation code.

int	checkForIncludes (QString _str, ShaderGenerator *_gen, QString _includePath)

int	checkForIncludes (QString _str, QStringList *_outImport, QString _includePath)

void	initGenDefines (ShaderGenerator *_gen)
	provide generated defines to shader

Static Private Member Functions
static QString	getPathName (QString _strFileName)
	returns path to _strFileName without last slash

static void	loadLightingFunctions ()

Private Attributes
ShaderGenerator *	vertex_

ShaderGenerator *	tessControl_

ShaderGenerator *	tessEval_

ShaderGenerator *	geometry_

ShaderGenerator *	fragment_

QStringList	vertexTemplate_

QStringList	tessControlTemplate_

QStringList	tessEvalTemplate_

QStringList	geometryTemplate_

QStringList	fragmentTemplate_

ShaderGenDesc	desc_

std::vector< ShaderModifier * >	activeMods_

QString	vertexShaderFile_
	path + filename to shader templates

QString	tessControlShaderFile_

QString	tessEvalShaderFile_

QString	geometryShaderFile_

QString	fragmentShaderFile_

QStringList	tessControlLayout_
	layout() directives scanned from loaded templates

QStringList	tessEvalLayout_

ShaderGenerator::DefaultIODesc	ioDesc_
	default IO descriptor for the vertex shader

Static Private Attributes
static int	numRegisteredModifiers_ = 0
	registered shader modifier

static std::vector< ShaderModifier * >	registeredModifiers_

static QString	shaderDir_

static QStringList	lightingCode_

Detailed Description

ShaderProgGenerator is responsible for generating a matching pair of vertex and fragment shaders.

Definition at line 1189 of file ShaderGenerator.hh.

Constructor & Destructor Documentation

◆ ShaderProgGenerator() [1/7]

ACG::ShaderProgGenerator::ShaderProgGenerator ( const ShaderGenDesc * _desc )

explicit

Parameters

_desc description-set of shader properties.

Definition at line 826 of file ShaderGenerator.cc.

◆ ShaderProgGenerator() [2/7]

ACG::ShaderProgGenerator::ShaderProgGenerator	(	const ShaderGenDesc *	_desc,
		const std::vector< unsigned int > &	_modifierIDs
	)

Parameters

_desc	description-set of shader properties.
_modifierIDs	array of modifier-IDs that should be used for the generation.

Definition at line 838 of file ShaderGenerator.cc.

◆ ShaderProgGenerator() [3/7]

ACG::ShaderProgGenerator::ShaderProgGenerator	(	const ShaderGenDesc *	_desc,
		const std::vector< unsigned int > *	_modifierIDs
	)

Parameters

_desc	description-set of shader properties.
_modifierIDs	array of modifier-IDs that should be used for the generation.

Definition at line 844 of file ShaderGenerator.cc.

◆ ShaderProgGenerator() [4/7]

ACG::ShaderProgGenerator::ShaderProgGenerator	(	const ShaderGenDesc *	_desc,
		const unsigned int *	_modifierIDs,
		unsigned int	_numModifiers
	)

Parameters

_desc	description-set of shader properties.
_modifierIDs	array of modifier-IDs that should be used for the generation.
_numModifiers	number of modifiers in _modifierIDs

Definition at line 832 of file ShaderGenerator.cc.

◆ ShaderProgGenerator() [5/7]

ACG::ShaderProgGenerator::ShaderProgGenerator	(	const ShaderGenDesc *	_desc,
		ShaderModifier const	_modifiers,
		unsigned int	_numModifiers
	)

Parameters

_desc	description-set of shader properties.
_modifiers	array of modifiers that should be used for the generation.
_numModifiers	number of modifiers in _modifierIDs

Definition at line 851 of file ShaderGenerator.cc.

◆ ShaderProgGenerator() [6/7]

ACG::ShaderProgGenerator::ShaderProgGenerator	(	const ShaderGenDesc *	_desc,
		const std::vector< ShaderModifier *> &	_modifiers
	)

Parameters

_desc	description-set of shader properties.
_modifiers	array of modifiers that should be used for the generation.

Definition at line 857 of file ShaderGenerator.cc.

◆ ShaderProgGenerator() [7/7]

ACG::ShaderProgGenerator::ShaderProgGenerator	(	const ShaderGenDesc *	_desc,
		const std::vector< ShaderModifier >	_modifiers
	)

Parameters

_desc	description-set of shader properties.
_modifiers	array of modifiers that should be used for the generation.

Definition at line 863 of file ShaderGenerator.cc.

Member Function Documentation

◆ addLightingFunctions()

void ACG::ShaderProgGenerator::addLightingFunctions ( QStringList * _code )

private

Adds lighting definition functions.

LitPointLight() ...

Definition at line 1964 of file ShaderGenerator.cc.

◆ checkForIncludes() [1/2]

int ACG::ShaderProgGenerator::checkForIncludes	(	QString	_str,
		ShaderGenerator *	_gen,
		QString	_includePath
	)

private

checks if _str is an include directive eventually imports the included file to the specified generator

Definition at line 1252 of file ShaderGenerator.cc.

◆ checkForIncludes() [2/2]

int ACG::ShaderProgGenerator::checkForIncludes	(	QString	_str,
		QStringList *	_outImport,
		QString	_includePath
	)

private

checks if _str is an include directive eventually imports the included file to the specified stringlist

Definition at line 1273 of file ShaderGenerator.cc.

◆ getAbsFilePath()

QString ACG::ShaderProgGenerator::getAbsFilePath ( QString _fileName )

static

Convert a filename to an absolute filename.

Parameters

_fileName relative (from shader dir) or absolute file name

Definition at line 2435 of file ShaderGenerator.cc.

◆ getShaderDir()

QString ACG::ShaderProgGenerator::getShaderDir ( )

static

Return shader directory path as previosly specified by user

Definition at line 2451 of file ShaderGenerator.cc.

◆ loadStringListFromFile()

bool ACG::ShaderProgGenerator::loadStringListFromFile	(	QString	_fileName,
		QStringList *	_out
	)

static

Load a text file as string list.

Parameters

_fileName	relative (from shader dir) or absolute file name
_out	lines from text file

Returns: true on success, false otherwise

Definition at line 963 of file ShaderGenerator.cc.

◆ registerModifier()

unsigned int ACG::ShaderProgGenerator::registerModifier ( ShaderModifier * _modifier )

static

Shader modifiers have to be registered before they can be used. They also must remain allocated for the rest of the applications runtime. Use a combination of modifier-IDs in the constructor of ShaderProgGen to active them.

Parameters

_modifier address of a modifier implementation

Returns: modifier ID

Definition at line 2457 of file ShaderGenerator.cc.

◆ setShaderDir()

void ACG::ShaderProgGenerator::setShaderDir ( QString _dir )

static

The shader directory has to be defined first before making use of the generator! For example: setShaderDir(OpenFlipper::Options::shaderDirStr())

Definition at line 2446 of file ShaderGenerator.cc.

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

OpenFlipper/libs_required/ACG/GL/ShaderGenerator.hh
OpenFlipper/libs_required/ACG/GL/ShaderGenerator.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ShaderProgGenerator() [1/7]

◆ ShaderProgGenerator() [2/7]

◆ ShaderProgGenerator() [3/7]

◆ ShaderProgGenerator() [4/7]

◆ ShaderProgGenerator() [5/7]

◆ ShaderProgGenerator() [6/7]

◆ ShaderProgGenerator() [7/7]

Member Function Documentation

◆ addLightingFunctions()

◆ checkForIncludes() [1/2]

◆ checkForIncludes() [2/2]

◆ getAbsFilePath()

◆ getShaderDir()

◆ loadStringListFromFile()

◆ registerModifier()

◆ setShaderDir()