Ogre::Hlms Class Reference

HLMS stands for "High Level Material System". More...

#include <OgreHlms.h>

Inheritance diagram for Ogre::Hlms:

Classes
struct	DatablockEntry
struct	Library

Public Types
typedef std::map< IdString, DatablockEntry >	HlmsDatablockMap
typedef vector< Library >::type	LibraryVec
enum	LightGatheringMode { LightGatherForward , LightGatherForwardPlus , LightGatherDeferred , LightGatherNone }

Public Member Functions
	Hlms (HlmsTypes type, const String &typeName, Archive *dataFolder, ArchiveVec *libraryFolders)
virtual	~Hlms ()
virtual void	_changeRenderSystem (RenderSystem *newRs)
void	_clearShaderCache (void)
virtual void	_collectSamplerblocks (set< const HlmsSamplerblock * >::type &outSamplerblocks, const HlmsDatablock *datablock) const
void	_compileShaderFromPreprocessedSource (const RenderableCache &mergedCache, const String source[NumShaderTypes])
int32	_getProperty (IdString key, int32 defaultVal=0) const
virtual void	_loadJson (const rapidjson::Value &jsonValue, const HlmsJson::NamedBlocks &blocks, HlmsDatablock *datablock, HlmsJsonListener *listener, const String &additionalTextureExtension) const
	Loads datablock values from a JSON value.
void	_notifyManager (HlmsManager *manager)
void	_notifyShadowMappingBackFaceSetting (void)
	Internal use.
virtual void	_saveJson (const HlmsDatablock *datablock, String &outString, HlmsJsonListener *listener, const String &additionalTextureExtension) const
void	_setProperty (IdString key, int32 value)
	For debugging stuff. I.e. the Command line uses it for testing manually set properties.
virtual void	calculateHashFor (Renderable *renderable, uint32 &outHash, uint32 &outCasterHash)
	Called by the renderable when either it changes the material, or its properties change (e.g.
void	compileShaderCode (ShaderCodeCache &codeCache)
	Compiles input properties and adds it to the shader code cache.
HlmsDatablock *	createDatablock (IdString name, const String &refName, const HlmsMacroblock &macroblockRef, const HlmsBlendblock &blendblockRef, const HlmsParamVec &paramVec, bool visibleToManager=true, const String &filename=BLANKSTRING, const String &resourceGroup=BLANKSTRING)
	Creates a unique datablock that can be shared by multiple renderables.
void	destroyAllDatablocks (void)
	Destroys all datablocks created with @createDatablock.
void	destroyDatablock (IdString name)
	Destroys a datablocks given its name.
virtual uint32	fillBuffersFor (const HlmsCache *cache, const QueuedRenderable &queuedRenderable, bool casterPass, uint32 lastCacheHash, uint32 lastTextureHash)=0
	Fills the constant buffers.
virtual uint32	fillBuffersForV1 (const HlmsCache *cache, const QueuedRenderable &queuedRenderable, bool casterPass, uint32 lastCacheHash, CommandBuffer *commandBuffer)=0
virtual uint32	fillBuffersForV2 (const HlmsCache *cache, const QueuedRenderable &queuedRenderable, bool casterPass, uint32 lastCacheHash, CommandBuffer *commandBuffer)=0
virtual void	frameEnded (void)
	Called when the frame has fully ended (ALL passes have been executed to all RTTs)
uint16	getAreaLightsLimit (void) const
uint8	getAreaLightsRoundMultiple (void) const
HlmsDatablock *	getDatablock (IdString name) const
	Finds an existing datablock based on its name (.
const HlmsDatablockMap &	getDatablockMap (void) const
	Returns all datablocks owned by this Hlms, including the default one.
Archive *	getDataFolder (void)
HlmsDatablock *	getDefaultDatablock (void) const
	Datablock to use when another datablock failed or none was specified.
void	getFilenameAndResourceGroup (IdString name, String const **outFilename, String const **outResourceGroup) const
	Returns the filaname & resource group a datablock was created from, and is associated with its hashed name (this was passed as in @createDatablock).
bool	getHighQuality (void) const
HlmsManager *	getHlmsManager (void) const
HlmsListener *	getListener (void) const
	Returns the current listener.
const HlmsCache *	getMaterial (HlmsCache const *lastReturnedValue, const HlmsCache &passCache, const QueuedRenderable &queuedRenderable, bool casterPass)
	Retrieves an HlmsCache filled with the GPU programs to be used by the given renderable.
const String *	getNameStr (IdString name) const
	Returns the string name associated with its hashed name (this was passed as refName in @createDatablock).
const LibraryVec &	getPiecesLibrary (void) const
ArchiveVec	getPiecesLibraryAsArchiveVec (void) const
RenderSystem *	getRenderSystem (void) const
const ShaderCodeCacheVec &	getShaderCodeCache (void) const
const String &	getShaderProfile (void) const
void	getTemplateChecksum (uint64 outHash[2]) const
HlmsTypes	getType (void) const
IdString	getTypeName (void) const
const String &	getTypeNameStr (void) const
void	operator delete (void *ptr)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete (void *ptr, void *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
void *	operator new (size_t sz)
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info
virtual void	postCommandBufferExecution (CommandBuffer *commandBuffer)
	This gets called after executing the command buffer.
virtual void	preCommandBufferExecution (CommandBuffer *commandBuffer)
	This gets called right before executing the command buffer.
virtual HlmsCache	preparePassHash (const Ogre::CompositorShadowNode *shadowNode, bool casterPass, bool dualParaboloid, SceneManager *sceneManager)
	Called every frame by the Render Queue to cache the properties needed by this pass.
virtual void	reloadFrom (Archive *newDataFolder, ArchiveVec *libraryFolders=0)
	Destroys all the cached shaders and in the next opportunity will recreate them from the new location.
void	saveAllTexturesFromDatablocks (const String &folderPath, set< String >::type &savedTextures, bool saveOitd, bool saveOriginal, HlmsTextureExportListener *listener)
void	setAreaLightForwardSettings (uint16 areaLightsLimit, uint8 areaLightsRoundMultiple)
	Area lights use regular Forward.
void	setDebugOutputPath (bool enableDebugOutput, bool outputProperties, const String &path=BLANKSTRING)
	Call to output the automatically generated shaders (which are usually made from templates) on the given folder for inspection, analyzing, debugging, etc.
void	setHighQuality (bool highQuality)
	Sets the quality of the Hlms.
void	setListener (HlmsListener *listener)
	Sets a listener to extend an existing Hlms implementation's with custom code, without having to rewrite it or modify the source code directly.

Static Public Member Functions
static bool	findParamInVec (const HlmsParamVec &paramVec, IdString key, String &inOut)
	Finds the parameter with key 'key' in the given 'paramVec'.
static int32	getProperty (const HlmsPropertyVec &properties, IdString key, int32 defaultVal=0)
	Utility helper, mostly useful to HlmsListener implementations.
static void	setProperty (HlmsPropertyVec &properties, IdString key, int32 value)
	Utility helper, mostly useful to HlmsListener implementations.

Friends
class	HlmsDiskCache

Detailed Description

HLMS stands for "High Level Material System".

The Hlms has multiple caches:

mRenderableCache This cache contains all the properties set to a Renderable class and can be evaluated early, when a Renderable is assigned a datablock i.e. inside Renderable::setDatablock. Contains properties such as whether the material has normal mapping, if the mesh has UV sets, evaluates if the material requires tangents for normal mapping, etc. The main function in charge of filling this cache is Hlms::calculateHashFor

mPassCache This cache contains per-pass information, such as how many lights are in the scene, whether this is a shadow mapping pass, etc. The main function in charge of filling this cache is Hlms::preparePassHash

mShaderCodeCache Contains a cache of unique shaders (from Hlms templates -> actual valid shader code) based on the properties merged from mRenderableCache & mPassCache. However it is possible that two shaders are exactly the same and thus be duplicated, this can happen if two combinations of properties end up producing the exact same code. The Microcode cache (GpuProgramManager::setSaveMicrocodesToCache) can help with that issue.

mShaderCache Contains a cache of the PSOs. The difference between this and mShaderCodeCache is that PSOs require additional information, such as HlmsMacroblock. HlmsBlendblock. For more information of all that is required, see HlmsPso

Member Typedef Documentation

HlmsDatablockMap

typedef std::map<IdString, DatablockEntry> Ogre::Hlms::HlmsDatablockMap

LibraryVec

typedef vector<Library>::type Ogre::Hlms::LibraryVec

Member Enumeration Documentation

LightGatheringMode

enum Ogre::Hlms::LightGatheringMode

Enumerator
LightGatherForward
LightGatherForwardPlus
LightGatherDeferred
LightGatherNone

Constructor & Destructor Documentation

Hlms()

Ogre::Hlms::Hlms	(	HlmsTypes	type,
		const String &	typeName,
		Archive *	dataFolder,
		ArchiveVec *	libraryFolders
	)

Parameters

libraryFolders

Path to folders to be processed first for collecting pieces. Will be processed in order. Pointer can be null.

~Hlms()

virtual Ogre::Hlms::~Hlms ( )

virtual

Member Function Documentation

_changeRenderSystem()

virtual void Ogre::Hlms::_changeRenderSystem ( RenderSystem *  newRs )

virtual

Reimplemented in Ogre::HlmsBufferManager, Ogre::HlmsPbs, Ogre::HlmsUnlit, and Ogre::HlmsCompute.

_clearShaderCache()

void Ogre::Hlms::_clearShaderCache

(

void

)

_collectSamplerblocks()

virtual void Ogre::Hlms::_collectSamplerblocks ( set< const HlmsSamplerblock * >::type &  outSamplerblocks, const HlmsDatablock *  datablock  ) const

inlinevirtual

Reimplemented in Ogre::HlmsPbs, and Ogre::HlmsUnlit.

_compileShaderFromPreprocessedSource()

void Ogre::Hlms::_compileShaderFromPreprocessedSource	(	const RenderableCache &	mergedCache,
		const String	source[NumShaderTypes]
	)

_getProperty()

int32 Ogre::Hlms::_getProperty ( IdString  key, int32  defaultVal = 0  ) const

inline

_loadJson()

virtual void Ogre::Hlms::_loadJson ( const rapidjson::Value &  jsonValue, const HlmsJson::NamedBlocks &  blocks, HlmsDatablock *  datablock, HlmsJsonListener *  listener, const String &  additionalTextureExtension  ) const

inlinevirtual

Loads datablock values from a JSON value.

See also

HlmsJson.

Parameters

jsonValue	JSON Object containing the definition of this datablock.
blocks	All the loaded Macro-, Blend- & Samplerblocks the JSON has defined and may be referenced by the datablock declaration.
datablock	Datablock to fill the values.

Reimplemented in Ogre::HlmsPbs, and Ogre::HlmsUnlit.

_notifyManager()

void Ogre::Hlms::_notifyManager ( HlmsManager *  manager )

inline

_notifyShadowMappingBackFaceSetting()

void Ogre::Hlms::_notifyShadowMappingBackFaceSetting

(

void

)

Internal use.

See also

HlmsManager::setShadowMappingUseBackFaces

_saveJson()

virtual void Ogre::Hlms::_saveJson ( const HlmsDatablock *  datablock, String &  outString, HlmsJsonListener *  listener, const String &  additionalTextureExtension  ) const

inlinevirtual

Reimplemented in Ogre::HlmsPbs, and Ogre::HlmsUnlit.

_setProperty()

void Ogre::Hlms::_setProperty ( IdString  key, int32  value  )

inline

For debugging stuff. I.e. the Command line uses it for testing manually set properties.

calculateHashFor()

virtual void Ogre::Hlms::calculateHashFor ( Renderable *  renderable, uint32 &  outHash, uint32 &  outCasterHash  )

virtual

Called by the renderable when either it changes the material, or its properties change (e.g.

the mesh' uvs are stripped)

Parameters

renderable	The renderable the material will be used on.
movableObject	The MovableObject the material will be used on (usually the parent of renderable)

Returns

A hash. This hash references property parameters that are already cached.

Reimplemented in Ogre::HlmsUnlitMobile, and Ogre::HlmsLowLevel.

compileShaderCode()

void Ogre::Hlms::compileShaderCode

(

ShaderCodeCache &

codeCache

)

Compiles input properties and adds it to the shader code cache.

Parameters

codeCache

[in/out] All variables must be filled except for ShaderCodeCache::shaders which is the output

createDatablock()

HlmsDatablock * Ogre::Hlms::createDatablock	(	IdString	name,
		const String &	refName,
		const HlmsMacroblock &	macroblockRef,
		const HlmsBlendblock &	blendblockRef,
		const HlmsParamVec &	paramVec,
		bool	visibleToManager = true,
		const String &	filename = BLANKSTRING,
		const String &	resourceGroup = BLANKSTRING
	)

Creates a unique datablock that can be shared by multiple renderables.

Remarks

The name of the datablock must be in paramVec["name"] and must be unique Throws if a datablock with the same name paramVec["name"] already exists

Parameters

name	Name of the Datablock, must be unique within all Hlms types, not just this one. 99% you want this to be IdString( refName ); however this is not enforced.
refName	Name of the Datablock. The engine doesn't use this value at all. It is only useful for UI editors which want to enumerate all existing datablocks and display its name to the user.
macroblockRef	@See HlmsManager::getMacroblock
blendblockRef	@See HlmsManager::getBlendblock
paramVec	Key - String Value list of paramters. MUST BE SORTED.
visibleToManager	When false, HlmsManager::getDatablock won't find this datablock. True by default
filename	Filename in which it was defined, so that this information can be retrieved later by the user if needed. This is only for informational purposes.
resourceGroup	ResourceGroup. See filename param.

Returns

Pointer to created Datablock

destroyAllDatablocks()

void Ogre::Hlms::destroyAllDatablocks

(

void

)

Destroys all datablocks created with @createDatablock.

Caller is responsible for ensuring those pointers aren't still in use (i.e. dangling pointers) The default datablock will be recreated.

destroyDatablock()

void Ogre::Hlms::destroyDatablock

(

IdString

name

)

Destroys a datablocks given its name.

Caller is responsible for ensuring those pointers aren't still in use (i.e. dangling pointers)

Remarks

Throws if no datablock with the given name exists.

fillBuffersFor()

virtual uint32 Ogre::Hlms::fillBuffersFor ( const HlmsCache *  cache, const QueuedRenderable &  queuedRenderable, bool  casterPass, uint32  lastCacheHash, uint32  lastTextureHash  )

pure virtual

Fills the constant buffers.

Gets executed right before drawing the mesh.

Parameters

cache	Current cache of Shaders to be used.
queuedRenderable	The Renderable-MovableObject pair about to be rendered.
casterPass	Whether this is a shadow mapping caster pass.
lastCacheHash	The hash of the cache of shaders that was the used by the previous renderable.
lastTextureHash	Last Texture Hash, used to let the Hlms know whether the textures should be changed again

Returns

New Texture hash (may be equal or different to lastTextureHash).

Implemented in Ogre::HlmsPbs, Ogre::HlmsPbsMobile, Ogre::HlmsUnlit, Ogre::HlmsUnlitMobile, Ogre::HlmsCompute, and Ogre::HlmsLowLevel.

fillBuffersForV1()

virtual uint32 Ogre::Hlms::fillBuffersForV1 ( const HlmsCache *  cache, const QueuedRenderable &  queuedRenderable, bool  casterPass, uint32  lastCacheHash, CommandBuffer *  commandBuffer  )

pure virtual

Implemented in Ogre::HlmsPbs, Ogre::HlmsUnlit, Ogre::HlmsCompute, and Ogre::HlmsLowLevel.

fillBuffersForV2()

virtual uint32 Ogre::Hlms::fillBuffersForV2 ( const HlmsCache *  cache, const QueuedRenderable &  queuedRenderable, bool  casterPass, uint32  lastCacheHash, CommandBuffer *  commandBuffer  )

pure virtual

Implemented in Ogre::HlmsPbs, Ogre::HlmsUnlit, Ogre::HlmsCompute, and Ogre::HlmsLowLevel.

findParamInVec()

static bool Ogre::Hlms::findParamInVec ( const HlmsParamVec &  paramVec, IdString  key, String &  inOut  )

static

Finds the parameter with key 'key' in the given 'paramVec'.

If found, outputs the value to 'inOut', otherwise leaves 'inOut' as is.

Returns

True if the key was found (inOut was modified), false otherwise

Remarks

Assumes paramVec is sorted by key.

frameEnded()

virtual void Ogre::Hlms::frameEnded ( void  )

inlinevirtual

Called when the frame has fully ended (ALL passes have been executed to all RTTs)

Reimplemented in Ogre::HlmsBufferManager, Ogre::HlmsPbs, and Ogre::HlmsUnlit.

getAreaLightsLimit()

uint16 Ogre::Hlms::getAreaLightsLimit ( void  ) const

inline

getAreaLightsRoundMultiple()

uint8 Ogre::Hlms::getAreaLightsRoundMultiple ( void  ) const

inline

getDatablock()

HlmsDatablock * Ogre::Hlms::getDatablock

(

IdString

name

)

const

Finds an existing datablock based on its name (.

See also

createDatablock)

Returns

The datablock associated with that name. Null pointer if not found. Doesn't throw.

getDatablockMap()

const HlmsDatablockMap & Ogre::Hlms::getDatablockMap ( void  ) const

inline

Returns all datablocks owned by this Hlms, including the default one.

getDataFolder()

Archive * Ogre::Hlms::getDataFolder ( void  )

inline

getDefaultDatablock()

HlmsDatablock * Ogre::Hlms::getDefaultDatablock

(

void

)

const

Datablock to use when another datablock failed or none was specified.

getFilenameAndResourceGroup()

void Ogre::Hlms::getFilenameAndResourceGroup	(	IdString	name,
		String const **	outFilename,
		String const **	outResourceGroup
	)		const

Returns the filaname & resource group a datablock was created from, and is associated with its hashed name (this was passed as in @createDatablock).

Returns null ptr if not found. Note that it may also be a valid pointer but contain an empty string. The reason this String doesn't live in HlmsDatablock is to prevent cache trashing (datablocks are hot iterated every frame, and the filename & resource groups are rarely ever used) Usage: String const *filename; String const *resourceGroup; datablock->getFilenameAndResourceGroup( &filename, &resourceGroup ); if( filename && resourceGroup && !filename->empty() && !resourceGroup->empty() ) { //Valid filename & resource group. }

getHighQuality()

bool Ogre::Hlms::getHighQuality ( void  ) const

inline

getHlmsManager()

HlmsManager * Ogre::Hlms::getHlmsManager ( void  ) const

inline

getListener()

HlmsListener * Ogre::Hlms::getListener

(

void

)

const

Returns the current listener.

See also

setListener();

Remarks

If the default listener is being used (that does nothing) then null is returned.

getMaterial()

const HlmsCache * Ogre::Hlms::getMaterial	(	HlmsCache const *	lastReturnedValue,
		const HlmsCache &	passCache,
		const QueuedRenderable &	queuedRenderable,
		bool	casterPass
	)

Retrieves an HlmsCache filled with the GPU programs to be used by the given renderable.

If the shaders have already been created (i.e. whether for this renderable, or another one) it gets them from a cache. Otherwise we create it. It assumes that renderable->setHlms( this, parameters ) has already called.

Parameters

lastReturnedValue	The last value returned by getMaterial.
passCache	The cache returned by @preparePassHash.
renderable	The renderable the caller wants us to give the shaders.
movableObject	The MovableObject owner of the renderable (we need it to know if renderable should cast shadows)
casterPass	True if this pass is the shadow mapping caster pass, false otherwise

Returns

Structure containing all necessary shaders

getNameStr()

const String * Ogre::Hlms::getNameStr

(

IdString

name

)

const

Returns the string name associated with its hashed name (this was passed as refName in @createDatablock).

Returns null ptr if not found. The reason this String doesn't live in HlmsDatablock is to prevent cache trashing (datablocks are hot iterated every frame, and the full name is rarely ever used)

getPiecesLibrary()

const LibraryVec & Ogre::Hlms::getPiecesLibrary ( void  ) const

inline

getPiecesLibraryAsArchiveVec()

ArchiveVec Ogre::Hlms::getPiecesLibraryAsArchiveVec

(

void

)

const

getProperty()

static int32 Ogre::Hlms::getProperty ( const HlmsPropertyVec &  properties, IdString  key, int32  defaultVal = 0  )

static

Utility helper, mostly useful to HlmsListener implementations.

getRenderSystem()

RenderSystem * Ogre::Hlms::getRenderSystem ( void  ) const

inline

getShaderCodeCache()

const ShaderCodeCacheVec & Ogre::Hlms::getShaderCodeCache ( void  ) const

inline

getShaderProfile()

const String & Ogre::Hlms::getShaderProfile ( void  ) const

inline

getTemplateChecksum()

void Ogre::Hlms::getTemplateChecksum

(

uint64

outHash[2]

)

const

getType()

HlmsTypes Ogre::Hlms::getType ( void  ) const

inline

getTypeName()

IdString Ogre::Hlms::getTypeName ( void  ) const

inline

getTypeNameStr()

const String & Ogre::Hlms::getTypeNameStr ( void  ) const

inline

operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr )

inlineinherited

operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr, const char *  , int  , const char *    )

inlineinherited

operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr, void *    )

inlineinherited

operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr )

inlineinherited

operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr, const char *  , int  , const char *    )

inlineinherited

operator new() [1/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz )

inlineinherited

operator new() [2/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz, const char *  file, int  line, const char *  func  )

inlineinherited

operator new, with debug line info

operator new() [3/3]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz, void *  ptr  )

inlineinherited

placement operator new

operator new[]() [1/2]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz )

inlineinherited

operator new[]() [2/2]

template<class Alloc >

void * Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz, const char *  file, int  line, const char *  func  )

inlineinherited

array operator new, with debug line info

postCommandBufferExecution()

virtual void Ogre::Hlms::postCommandBufferExecution ( CommandBuffer *  commandBuffer )

inlinevirtual

This gets called after executing the command buffer.

Reimplemented in Ogre::HlmsBufferManager, and Ogre::HlmsPbs.

preCommandBufferExecution()

virtual void Ogre::Hlms::preCommandBufferExecution ( CommandBuffer *  commandBuffer )

inlinevirtual

This gets called right before executing the command buffer.

Reimplemented in Ogre::HlmsBufferManager.

preparePassHash()

virtual HlmsCache Ogre::Hlms::preparePassHash ( const Ogre::CompositorShadowNode *  shadowNode, bool  casterPass, bool  dualParaboloid, SceneManager *  sceneManager  )

virtual

Called every frame by the Render Queue to cache the properties needed by this pass.

i.e. Number of PSSM splits, number of shadow casting lights, etc

Parameters

shadowNode

The shadow node currently in effect. Can be null.

Returns

A hash and cached property parameters. Unlike @calculateHashFor, the cache must be kept by the caller and not by us (because it may change every frame and is one for the whole pass, but Mesh' properties usually stay consistent through its lifetime but may differ per mesh)

Reimplemented in Ogre::HlmsBufferManager, Ogre::HlmsPbs, Ogre::HlmsPbsMobile, Ogre::HlmsUnlit, Ogre::HlmsUnlitMobile, and Ogre::HlmsLowLevel.

reloadFrom()

virtual void Ogre::Hlms::reloadFrom ( Archive *  newDataFolder, ArchiveVec *  libraryFolders = 0  )

virtual

Destroys all the cached shaders and in the next opportunity will recreate them from the new location.

This is very useful for fast iteration and real-time editing of Hlms shader templates.

Remarks

Calling with null pointer is possible and will only invalidate existing shaders but you should provide a valid pointer before we start generating the first shader (or else crash).

Existing datablock materials won't be reloaded from files, so their properties won't change (i.e. changed from blue to red), but the shaders will.

Parameters

libraryFolders

When null pointer, the library folders paths won't be changed at all (but still will be reloaded). When non-null pointer, the library folders will be overwriten. Pass an empty container if you want to stop using libraries.

Reimplemented in Ogre::HlmsCompute.

saveAllTexturesFromDatablocks()

void Ogre::Hlms::saveAllTexturesFromDatablocks	(	const String &	folderPath,
		set< String >::type &	savedTextures,
		bool	saveOitd,
		bool	saveOriginal,
		HlmsTextureExportListener *	listener
	)

setAreaLightForwardSettings()

void Ogre::Hlms::setAreaLightForwardSettings	(	uint16	areaLightsLimit,
		uint8	areaLightsRoundMultiple
	)

Area lights use regular Forward.

Parameters

areaLightsLimit	Maximum number of area lights that will be considered by the shader. Default value is 1. Use 0 to disable area lights.
areaLightsRoundMultiple	To prevent frequent shader recompiles, you can round the number of area lights to the next multiple.

For example when areaLightsRoundMultiple = 1, if there are two area lights in the frustum, shader 'A' will be used. If the camera moves and now only one are light is in the frustum, shader 'B' will be used.

This maximizes GPU performance, but if the number of area lights is constantly jumping, you may see a lot of recompiles until all variations are cached, which can be very slow.

By setting for example, areaLightsRoundMultiple = 2, we will always generate shader variations that use 2 area lights, even if there's only 1 area light in the camera (if there's none, we use a different variation). The unused slot will just output black. If there's 3 area lights, the shader variation will be compiled to use 4. This sacrifices some pixel shader GPU performance, but prevents permutation explosion.

By setting areaLightsLimit = areaLightsRoundMultiple, you will minimize the number of permutations and stabilize frame rates; but average framerate may be lower if there are less area lights.

Default value is 1. This value cannot be 0. This value must be <= areaLightsLimit, unless areaLightsLimit is 0.

setDebugOutputPath()

void Ogre::Hlms::setDebugOutputPath	(	bool	enableDebugOutput,
		bool	outputProperties,
		const String &	path = BLANKSTRING
	)

Call to output the automatically generated shaders (which are usually made from templates) on the given folder for inspection, analyzing, debugging, etc.

Remarks

The shader will be dumped when it is generated, not when this function gets called. You should call this function at start up

Parameters

enableDebugOutput	Whether to enable or disable dumping the shaders into a folder
outputProperties	Whether to dump properties and pieces at the beginning of the shader file. This is very useful for determining what caused Ogre to compile a new variation. Note that this setting may not always produce valid shader code in the dumped files (but it we'll still produce valid shader code while at runtime) If you want to compile the dumped file and it is invalid, just strip this info.
path	Path location on where to dump it. Should end with slash for proper concatenation (i.e. C:/path/ instead of C:/path; or /home/user/ instead of /home/user)

setHighQuality()

void Ogre::Hlms::setHighQuality

(

bool

highQuality

)

Sets the quality of the Hlms.

This function is most relevant for mobile and almost or completely ignored by Desktop. The default value is false.

On mobile, high quality will use "highp" quality precision qualifier for all its variables and functions. When not in HQ, mobile users may see aliasing artifacts, gradients; but the performance impact can be quite high. Some GPU drivers might even refuse to execute the shader as they cannot handle it.

Unless you absolutely require high quality rendering on Mobile devices and/or to get it to look as closely as possible as it looks in a Desktop device, the recommended option is to have this off.

setListener()

void Ogre::Hlms::setListener

(

HlmsListener *

listener

)

Sets a listener to extend an existing Hlms implementation's with custom code, without having to rewrite it or modify the source code directly.

Remarks

Other alternatives for extending an existing implementation is to derive from the class and override particular virtual functions. For performance reasons, listeners are never called on a per-object basis. Consult the section "Customizing an existing implementation" from the manual in the Docs/2.0 folder.

Parameters

listener

Listener pointer. Use null to disable.

setProperty()

static void Ogre::Hlms::setProperty ( HlmsPropertyVec &  properties, IdString  key, int32  value  )

static

Utility helper, mostly useful to HlmsListener implementations.

Friends And Related Symbol Documentation

HlmsDiskCache

friend class HlmsDiskCache

friend

---

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

• OgreHlms.h