Material collection, with additional functions. More...

#include <MaterialCache.hpp>

Inheritance diagram for castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >:

[legend]

Collaboration diagram for castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >:

[legend]

Public Types
using	ElementT = castor3d::Material

using	ElementKeyT = String

using	ElementCacheTraitsT = castor3d::MaterialCacheTraits

using	ElementCacheT = ResourceCacheBaseT< ElementT, ElementKeyT, ElementCacheTraitsT >

using	ElementPtrT = typename ElementCacheT::ElementPtrT

using	ElementContT = typename ElementCacheT::ElementContT

using	ElementInitialiserT = typename ElementCacheT::ElementInitialiserT

using	ElementCleanerT = typename ElementCacheT::ElementCleanerT

using	ElementMergerT = typename ElementCacheT::ElementMergerT

Public Types inherited from castor::ResourceCacheBaseT< castor3d::Material, String, castor3d::MaterialCacheTraits >
using	ElementT

using	ElementKeyT

using	ElementCacheTraitsT

using	ElementCacheBaseT

using	ElementCacheT

using	ElementPtrT

using	ElementObsT

using	ElementContT

using	ElementInitialiserT

using	ElementCleanerT

using	ElementMergerT

Public Member Functions
C3D_API	ResourceCacheT (castor3d::Engine &engine)
	Constructor.

C3D_API void	initialise (castor3d::RenderDevice const &device)
	Intialises the default material.

C3D_API void	cleanup ()
	Sets all the elements to be cleaned up.

C3D_API void	clear () noexcept
	Deletes the default material, flush the collection.

C3D_API void	update (castor3d::CpuUpdater &updater)
	Updates the render pass, CPU wise.

C3D_API void	update (castor3d::GpuUpdater &updater)
	Updates the render pass, GPU wise.

C3D_API void	upload (castor3d::UploadData &uploader) const
	Uploads all GPU buffers to VRAM.

C3D_API void	registerSpecificsBuffer (castor::String const &name, castor3d::SpecificsBuffer buffer)
	Registers a specific data shader buffer.

C3D_API void	unregisterSpecificsBuffer (castor::String const &name) noexcept
	Unregisters a pass' specific data buffer.

C3D_API void	addSpecificsBuffersBindings (ashes::VkDescriptorSetLayoutBindingArray &bindings, VkShaderStageFlags shaderStages, uint32_t &index) const
	Addw the pass' specific data buffer into the given descriptor layout bindings array.

C3D_API void	addSpecificsBuffersDescriptors (ashes::WriteDescriptorSetArray &descriptorWrites, uint32_t &index) const
	Writes the pass' specific data buffer into the given descriptor writes array.

C3D_API void	createSpecificsBuffersPassBindings (crg::FramePass &pass, uint32_t &index) const
	Writes the pass' specific data buffer bindings into given frame pass.

C3D_API void	declareSpecificsShaderBuffers (sdw::ShaderWriter &writer, castor::StringMap< castor3d::shader::BufferBaseUPtr > &buffers, uint32_t &binding, uint32_t set) const
	Declares pass' specific data shader buffers.

C3D_API void	getNames (StringArray &names)
	Puts all the materials names in the given array.

C3D_API uint32_t	getMaxPassTypeCount () const

C3D_API std::tuple< castor3d::PassComponentCombineID, castor3d::TextureCombineID >	getPassTypeDetails (uint32_t passTypeIndex) const

C3D_API uint32_t	getPassTypeIndex (castor3d::PassComponentCombineID passType, castor3d::TextureCombineID textureFlags) const

C3D_API bool	registerPass (castor3d::Pass &pass)

C3D_API void	unregisterPass (castor3d::Pass &pass) noexcept

C3D_API bool	registerUnit (castor3d::TextureUnit &unit)

C3D_API void	unregisterUnit (castor3d::TextureUnit &unit) noexcept

C3D_API bool	registerTexture (castor3d::AnimatedTexture const &texture)

C3D_API void	unregisterTexture (castor3d::AnimatedTexture const &texture) noexcept

C3D_API uint32_t	getCurrentPassTypeCount () const

castor3d::MaterialObs	getDefaultMaterial () const

castor3d::PassBuffer const &	getPassBuffer () const

castor3d::SssProfileBuffer const &	getSssProfileBuffer () const

castor3d::TextureConfigurationBuffer const &	getTexConfigBuffer () const

castor3d::TextureAnimationBuffer const &	getTexAnimBuffer () const

Public Member Functions inherited from castor::ResourceCacheBaseT< castor3d::Material, String, castor3d::MaterialCacheTraits >
	ResourceCacheBaseT (ResourceCacheBaseT const &)=delete

	ResourceCacheBaseT (ResourceCacheBaseT &&) noexcept=delete

ResourceCacheBaseT &	operator= (ResourceCacheBaseT const &)=delete

ResourceCacheBaseT &	operator= (ResourceCacheBaseT &&) noexcept=delete

void	cleanup () noexcept
	Sets all the elements to be cleaned up.

void	clear () noexcept
	Flushes the collection.

ElementPtrT	create (ElementKeyT const &name, ParametersT &&... parameters) const
	Creates an element.

ElementObsT	tryAdd (ElementKeyT const &name, ElementPtrT &element, bool initialise=false)
	Adds an element.

ElementObsT	tryAddNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=false)
	Adds an element.

ElementObsT	add (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)
	Logging version of tryAdd.

ElementObsT	addNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)
	Logging version of tryAdd.

ElementObsT	tryAddNew (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... parameters)
	Add an element, constructed in-place.

ElementObsT	tryAddNewNoLock (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... parameters)
	Add an element, constructed in-place.

ElementObsT	addNew (ElementKeyT const &name, ParametersT &&... parameters)
	Logging version of tryAdd.

ElementObsT	addNewNoLock (ElementKeyT const &name, ParametersT &&... parameters)
	Logging version of tryAdd.

ElementPtrT	tryRemove (ElementKeyT const &name, bool cleanup=false) noexcept
	Removes an element, given a name.

ElementPtrT	tryRemoveNoLock (ElementKeyT const &name, bool cleanup=false) noexcept
	Removes an element, given a name.

ElementPtrT	remove (ElementKeyT const &name, bool cleanup=false) noexcept
	Logging version of tryRemove.

ElementPtrT	removeNoLock (ElementKeyT const &name, bool cleanup=false) noexcept
	Logging version of tryRemove.

void	rename (ElementKeyT const &oldName, ElementKeyT const &newName)
	Renames a resource.

ElementObsT	tryFind (ElementKeyT const &name) const noexcept
	Looks for an element with given name.

ElementObsT	tryFindNoLock (ElementKeyT const &name) const noexcept
	Looks for an element with given name.

ElementObsT	find (ElementKeyT const &name) const
	Logging version of tryRemove.

ElementObsT	findNoLock (ElementKeyT const &name) const
	Logging version of tryRemove.

void	mergeInto (ElementCacheBaseT &destination)
	Merges this cache's elements to the one given.

void	forEach (FuncType func) const

void	forEach (FuncType func)

uint32_t	getObjectCount () const noexcept

uint32_t	getObjectCountNoLock () const noexcept

String const &	getObjectTypeName () const noexcept

bool	has (ElementKeyT const &name) const noexcept

bool	hasNoLock (ElementKeyT const &name) const noexcept

bool	isEmpty () const noexcept

bool	isEmptyNoLock () const noexcept

void	lock () const

void	unlock () const noexcept

auto	begin () noexcept

auto	begin () const noexcept

auto	end () noexcept

auto	end () const noexcept

void	reportCreation (String const &name) const

void	reportAdded (String const &name) const

void	reportDuplicate (String const &name) const

void	reportNull () const

void	reportUnknown (String const &name) const

Additional Inherited Members
Protected Types inherited from castor::ResourceCacheBaseT< castor3d::Material, String, castor3d::MaterialCacheTraits >
using	MutexT

Protected Member Functions inherited from castor::ResourceCacheBaseT< castor3d::Material, String, castor3d::MaterialCacheTraits >
void	doCleanupNoLock () const noexcept

void	doClearNoLock () noexcept

ElementPtrT	doCreateT (ElementKeyT const &name, ParametersT &&... parameters) const

ElementObsT	doTryAddNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)

ElementObsT	doAddNoLock (ElementKeyT const &name, ElementPtrT &element, bool initialise=true)

ElementObsT	doTryAddNewNoLockT (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... parameters)

ElementObsT	doAddNewNoLockT (ElementKeyT const &name, ParametersT &&... parameters)

ElementPtrT	doTryRemoveNoLock (ElementKeyT const &name, bool cleanup=false) noexcept

ElementObsT	doTryFindNoLock (ElementKeyT const &name) const noexcept

	ResourceCacheBaseT (LoggerInstance &logger, ElementInitialiserT initialise=ElementInitialiserT{}, ElementCleanerT clean=ElementCleanerT{}, ElementMergerT merge=ElementMergerT{})

virtual	~ResourceCacheBaseT () noexcept=default

Protected Attributes inherited from castor::ResourceCacheBaseT< castor3d::Material, String, castor3d::MaterialCacheTraits >
LoggerInstance &	m_logger

CheckedMutexT< MutexT >	m_mutex

ElementContT	m_resources

ElementInitialiserT	m_initialise

ElementCleanerT	m_clean

ElementMergerT	m_merge

Detailed Description

Material collection, with additional functions.

Member Typedef Documentation

◆ ElementCacheT

using castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::ElementCacheT = ResourceCacheBaseT< ElementT, ElementKeyT, ElementCacheTraitsT >

◆ ElementCacheTraitsT

using castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::ElementCacheTraitsT = castor3d::MaterialCacheTraits

◆ ElementCleanerT

using castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::ElementCleanerT = typename ElementCacheT::ElementCleanerT

◆ ElementContT

using castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::ElementContT = typename ElementCacheT::ElementContT

◆ ElementInitialiserT

using castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::ElementInitialiserT = typename ElementCacheT::ElementInitialiserT

◆ ElementKeyT

using castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::ElementKeyT = String

◆ ElementMergerT

using castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::ElementMergerT = typename ElementCacheT::ElementMergerT

◆ ElementPtrT

using castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::ElementPtrT = typename ElementCacheT::ElementPtrT

◆ ElementT

using castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::ElementT = castor3d::Material

Constructor & Destructor Documentation

◆ ResourceCacheT()

C3D_API castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::ResourceCacheT ( castor3d::Engine & engine )

explicit

Constructor.

Parameters

[in] engine The engine.

Member Function Documentation

◆ addSpecificsBuffersBindings()

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::addSpecificsBuffersBindings	(	ashes::VkDescriptorSetLayoutBindingArray &	bindings,
		VkShaderStageFlags	shaderStages,
		uint32_t &	index ) const

Addw the pass' specific data buffer into the given descriptor layout bindings array.

Parameters

[in,out]	bindings	Receives the buffers descriptor layout bindings.
[in]	shaderStages	The shader stage flags.
[in,out]	index	The binding index.

◆ addSpecificsBuffersDescriptors()

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::addSpecificsBuffersDescriptors	(	ashes::WriteDescriptorSetArray &	descriptorWrites,
		uint32_t &	index ) const

Writes the pass' specific data buffer into the given descriptor writes array.

Parameters

[in,out]	descriptorWrites	Receives the buffers descriptor writes.
[in,out]	index	The binding index.

◆ cleanup()

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::cleanup ( )

Sets all the elements to be cleaned up.

◆ clear()

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::clear ( )

noexcept

Deletes the default material, flush the collection.

◆ createSpecificsBuffersPassBindings()

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::createSpecificsBuffersPassBindings	(	crg::FramePass &	pass,
		uint32_t &	index ) const

Writes the pass' specific data buffer bindings into given frame pass.

Parameters

[in,out]	pass	The target frame pass.
[in,out]	index	The binding index.

◆ declareSpecificsShaderBuffers()

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::declareSpecificsShaderBuffers	(	sdw::ShaderWriter &	writer,
		castor::StringMap< castor3d::shader::BufferBaseUPtr > &	buffers,
		uint32_t &	binding,
		uint32_t	set ) const

Declares pass' specific data shader buffers.

Parameters

[in,out]	writer	The shader writer.
[out]	buffers	Receives the registered shader buffers.
[in,out]	binding	The descriptor binding index.
[in]	set	The descriptor set index.

◆ getCurrentPassTypeCount()

C3D_API uint32_t castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::getCurrentPassTypeCount ( ) const

◆ getDefaultMaterial()

castor3d::MaterialObs castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::getDefaultMaterial ( ) const

inline

◆ getMaxPassTypeCount()

C3D_API uint32_t castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::getMaxPassTypeCount ( ) const

Returns: The maximum pass types count (for visibility buffer use).

◆ getNames()

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::getNames ( StringArray & names )

Puts all the materials names in the given array.

Parameters

[out] names The array of names to be filled

◆ getPassBuffer()

castor3d::PassBuffer const & castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::getPassBuffer ( ) const

inline

References CU_Require.

◆ getPassTypeDetails()

C3D_API std::tuple< castor3d::PassComponentCombineID, castor3d::TextureCombineID > castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::getPassTypeDetails ( uint32_t passTypeIndex ) const

Returns: The pass type details for given pass type index (for visibility buffer use).

◆ getPassTypeIndex()

C3D_API uint32_t castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::getPassTypeIndex	(	castor3d::PassComponentCombineID	passType,
		castor3d::TextureCombineID	textureFlags ) const

Returns: The pass type index (for visibility buffer use).

◆ getSssProfileBuffer()

castor3d::SssProfileBuffer const & castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::getSssProfileBuffer ( ) const

inline

References CU_Require.

◆ getTexAnimBuffer()

castor3d::TextureAnimationBuffer const & castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::getTexAnimBuffer ( ) const

inline

References CU_Require.

◆ getTexConfigBuffer()

castor3d::TextureConfigurationBuffer const & castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::getTexConfigBuffer ( ) const

inline

References CU_Require.

◆ initialise()

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::initialise ( castor3d::RenderDevice const & device )

Intialises the default material.

Parameters

[in] device The GPU device.

◆ registerPass()

C3D_API bool castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::registerPass ( castor3d::Pass & pass )

◆ registerSpecificsBuffer()

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::registerSpecificsBuffer	(	castor::String const &	name,
		castor3d::SpecificsBuffer	buffer )

Registers a specific data shader buffer.

Parameters

[in,out]	name	The shader buffer name.
[out]	buffer	The shader buffer.

◆ registerTexture()

C3D_API bool castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::registerTexture ( castor3d::AnimatedTexture const & texture )

◆ registerUnit()

C3D_API bool castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::registerUnit ( castor3d::TextureUnit & unit )

◆ unregisterPass()

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::unregisterPass ( castor3d::Pass & pass )

noexcept

◆ unregisterSpecificsBuffer()

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::unregisterSpecificsBuffer ( castor::String const & name )

noexcept

Unregisters a pass' specific data buffer.

Parameters

[in,out] name The shader buffer name.

◆ unregisterTexture()

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::unregisterTexture ( castor3d::AnimatedTexture const & texture )

noexcept

◆ unregisterUnit()

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::unregisterUnit ( castor3d::TextureUnit & unit )

noexcept

◆ update() [1/2]

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::update ( castor3d::CpuUpdater & updater )

Updates the render pass, CPU wise.

Parameters

[in,out] updater The update data.

◆ update() [2/2]

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::update ( castor3d::GpuUpdater & updater )

Updates the render pass, GPU wise.

Parameters

[in,out] updater The update data.

◆ upload()

C3D_API void castor::ResourceCacheT< castor3d::Material, String, castor3d::MaterialCacheTraits >::upload ( castor3d::UploadData & uploader ) const

Uploads all GPU buffers to VRAM.

Parameters

[in] uploader Receives the upload requests.

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

Castor3D/Cache/MaterialCache.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ElementCacheT

◆ ElementCacheTraitsT

◆ ElementCleanerT

◆ ElementContT

◆ ElementInitialiserT

◆ ElementKeyT

◆ ElementMergerT

◆ ElementPtrT

◆ ElementT

Constructor & Destructor Documentation

◆ ResourceCacheT()

Member Function Documentation

◆ addSpecificsBuffersBindings()

◆ addSpecificsBuffersDescriptors()

◆ cleanup()

◆ clear()

◆ createSpecificsBuffersPassBindings()

◆ declareSpecificsShaderBuffers()

◆ getCurrentPassTypeCount()

◆ getDefaultMaterial()

◆ getMaxPassTypeCount()

◆ getNames()

◆ getPassBuffer()

◆ getPassTypeDetails()

◆ getPassTypeIndex()

◆ getSssProfileBuffer()

◆ getTexAnimBuffer()

◆ getTexConfigBuffer()

◆ initialise()

◆ registerPass()

◆ registerSpecificsBuffer()

◆ registerTexture()

◆ registerUnit()

◆ unregisterPass()

◆ unregisterSpecificsBuffer()

◆ unregisterTexture()

◆ unregisterUnit()

◆ update() [1/2]

◆ update() [2/2]

◆ upload()