ne::ShaderUser Class Reference

#include <ShaderUser.h>

Inheritance diagram for ne::ShaderUser:

Public Member Functions
	ShaderUser (const ShaderUser &)=delete
ShaderUser &	operator= (const ShaderUser &)=delete

Protected Member Functions
	ShaderUser (ShaderManager *pShaderManager)
virtual	~ShaderUser ()
bool	addShader (const std::string &sShaderName)
std::optional< ShaderPack * >	getShader (ShaderType shaderType)

Private Member Functions
void	releaseShader (const std::string &sShaderName) const

Private Attributes
std::pair< std::mutex, std::unordered_map< ShaderType, std::shared_ptr< ShaderPack > > >	mtxAssignedShaders
ShaderManager *	pShaderManager

Detailed Description

The only class that is allowed to store shaders (not counting ShaderManager).

Other classes should inherit from this class in order to work with shaders.

Allows storing one shader per shader type.

Constructor & Destructor Documentation

ShaderUser()

ne::ShaderUser::ShaderUser ( ShaderManager *  pShaderManager )

protected

Constructor.

Parameters

pShaderManager

Shader manager to use.

~ShaderUser()

ne::ShaderUser::~ShaderUser ( )

protectedvirtual

Destructor.

Member Function Documentation

addShader()

bool ne::ShaderUser::addShader ( const std::string &  sShaderName )

protected

Adds a shader to be stored (for usage).

Warning

If a shader of this type was already added it will be replaced with the new one.

Remarks

Adding the same shader that was already added is safe as this will do nothing.

Parameters

sShaderName

Name of the compiled shader (see ShaderManager::compileShaders).

Returns

false if shader was added successfully, true if it was not found in ShaderManager.

getShader()

std::optional< ShaderPack * > ne::ShaderUser::getShader ( ShaderType  shaderType )

protected

Returns previously added shader (see addShader) for the specified type.

Warning

Do not delete returned pointer. Returned shader will not be destroyed until this ShaderUser object is not destroyed. Once this ShaderUser object is destroyed there is no guarantee that the shader will be valid.

Parameters

shaderType

Type of the shader to query.

Returns

Empty if a shader of this type was not added before, valid pointer otherwise.

releaseShader()

void ne::ShaderUser::releaseShader ( const std::string &  sShaderName ) const

private

Uses ShaderManager to release shader bytecode if needed and removes shader if it was marked as "to remove".

Parameters

sShaderName

Name of the shader to release.

Member Data Documentation

mtxAssignedShaders

std::pair<std::mutex, std::unordered_map<ShaderType, std::shared_ptr<ShaderPack> > > ne::ShaderUser::mtxAssignedShaders

private

Assigned shaders (see addShader). Must be used with mutex.

pShaderManager

ShaderManager* ne::ShaderUser::pShaderManager

private

Shader manager to work with shaders.

---

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

• src/engine_lib/private/shader/general/ShaderUser.h
• src/engine_lib/private/shader/general/ShaderUser.cpp