Castor3D 0.16.0
Multiplatform 3D engine
Public Types | Public Member Functions | List of all members
castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits > Class Reference

Light cache. More...

#include <LightCache.hpp>

Inheritance diagram for castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >:
Inheritance graph
[legend]
Collaboration diagram for castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >:
Collaboration graph
[legend]

Public Types

using ElementT = Light
 
using ElementKeyT = castor::String
 
using ElementCacheTraitsT = LightCacheTraits
 
using ElementObjectCacheT = ObjectCacheBaseT< ElementT, ElementKeyT, ElementCacheTraitsT >
 
using ElementPtrT = typename ElementObjectCacheT::ElementPtrT
 
using ElementContT = typename ElementObjectCacheT::ElementContT
 
using ElementInitialiserT = typename ElementObjectCacheT::ElementInitialiserT
 
using ElementCleanerT = typename ElementObjectCacheT::ElementCleanerT
 
using ElementMergerT = typename ElementObjectCacheT::ElementMergerT
 
using ElementAttacherT = typename ElementObjectCacheT::ElementAttacherT
 
using ElementDetacherT = typename ElementObjectCacheT::ElementDetacherT
 
- Public Types inherited from castor3d::ObjectCacheBaseT< Light, castor::String, LightCacheTraits >
using OnChangedFunction
 
using OnChanged
 
- Public Types inherited from castor::ResourceCacheBaseT< ResT, KeyT, TraitsT >
using ElementT = ResT
 
using ElementKeyT = KeyT
 
using ElementCacheTraitsT = TraitsT
 
using ElementCacheBaseT = ResourceCacheBaseT< ElementT, ElementKeyT, ElementCacheTraitsT >
 
using ElementCacheT = typename ElementCacheTraitsT::ElementCacheT
 
using ElementPtrT = typename ElementCacheTraitsT::ElementPtrT
 
using ElementObsT = typename ElementCacheTraitsT::ElementObsT
 
using ElementContT = typename ElementCacheTraitsT::ElementContT
 
using ElementInitialiserT = typename ElementCacheTraitsT::ElementInitialiserT
 
using ElementCleanerT = typename ElementCacheTraitsT::ElementCleanerT
 
using ElementMergerT = typename ElementCacheTraitsT::ElementMergerT
 

Public Member Functions

C3D_API ObjectCacheT (Scene &scene, SceneNodeRPtr rootNode, SceneNodeRPtr rootCameraNode, SceneNodeRPtr rootObjectNode)
 Constructor.
 
C3D_API void initialise (castor3d::RenderDevice const &device)
 Intialises GPU buffer.
 
C3D_API void cleanup ()
 Sets all the elements to be cleaned up.
 
C3D_API void update (CpuUpdater &updater)
 Updates the render pass, CPU wise.
 
C3D_API void upload (UploadData &uploader) const
 Uploads all GPU buffers to VRAM.
 
C3D_API LightsArray getLights (LightType type) const
 Retrieves the lights of given type.
 
C3D_API void createPassBinding (crg::FramePass &pass, uint32_t binding) const
 Creates a frame pass binding.
 
C3D_API VkDescriptorSetLayoutBinding createLayoutBinding (VkShaderStageFlags stages, uint32_t index) const
 Creates the descriptor set layout binding at given point.
 
C3D_API void addLayoutBinding (ashes::VkDescriptorSetLayoutBindingArray &bindings, VkShaderStageFlags stages, uint32_t &index) const
 Adds the descriptor set layout binding at given point.
 
C3D_API ashes::WriteDescriptorSet getBinding (uint32_t binding) const
 Creates the descriptor write for the lights buffer.
 
C3D_API void addBinding (ashes::WriteDescriptorSetArray &writes, uint32_t &binding) const
 Creates the descriptor write for the lights buffer.
 
C3D_API ashes::WriteDescriptorSet getBinding (uint32_t binding, VkDeviceSize offset, VkDeviceSize size) const
 Creates the descriptor write for the lights buffer.
 
C3D_API uint32_t getLightsBufferCount (LightType type) const noexcept
 
uint32_t getLightsCount (LightType type) const
 
bool isDirty () const noexcept
 
bool hasClusteredLights () const noexcept
 
- Public Member Functions inherited from castor3d::ObjectCacheBaseT< Light, castor::String, LightCacheTraits >
void mergeInto (ElementObjectCacheT &destination)
 Merges this cache's elements to the one given.
 
EnginegetEngine () const noexcept
 
castor::String const & getObjectTypeName () const noexcept
 
- Public Member Functions inherited from castor::OwnedBy< Scene >
Scene * getOwner () const
 
- Public Member Functions inherited from castor::ResourceCacheBaseT< ResT, KeyT, TraitsT >
 ResourceCacheBaseT (ResourceCacheBaseT const &)=delete
 
ResourceCacheBaseToperator= (ResourceCacheBaseT const &)=delete
 
 ResourceCacheBaseT (ResourceCacheBaseT &&) noexcept=delete
 
ResourceCacheBaseToperator= (ResourceCacheBaseT &&) noexcept=delete
 
void cleanup () noexcept
 Sets all the elements to be cleaned up.
 
void clear () noexcept
 Flushes the collection.
 
template<typename ... ParametersT>
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.
 
template<typename ... ParametersT>
ElementObsT tryAdd (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... parameters)
 Add an element, constructed in-place.
 
template<typename ... ParametersT>
ElementObsT tryAddNoLock (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... parameters)
 Add an element, constructed in-place.
 
template<typename ... ParametersT>
ElementObsT add (ElementKeyT const &name, ParametersT &&... parameters)
 Logging version of tryAdd.
 
template<typename ... ParametersT>
ElementObsT addNoLock (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.
 
template<typename FuncType >
void forEach (FuncType func) const
 
template<typename FuncType >
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

- Public Attributes inherited from castor3d::ObjectCacheBaseT< Light, castor::String, LightCacheTraits >
OnChanged onChanged
 
- Protected Types inherited from castor3d::ObjectCacheBaseT< Light, castor::String, LightCacheTraits >
using ElementT
 
using ElementKeyT
 
using ElementCacheTraitsT
 
using ElementCacheT
 
using ElementCacheBaseT
 
using ElementObjectCacheT
 
using ElementPtrT
 
using ElementObsT
 
using ElementContT
 
using ElementInitialiserT
 
using ElementCleanerT
 
using ElementMergerT
 
using ElementAttacherT
 
using ElementDetacherT
 
- Protected Types inherited from castor::ResourceCacheBaseT< ResT, KeyT, TraitsT >
using MutexT = castor::RecursiveMutex
 
- Protected Member Functions inherited from castor3d::ObjectCacheBaseT< Light, castor::String, LightCacheTraits >
 ObjectCacheBaseT (Scene &scene, SceneNodeRPtr rootNode, SceneNodeRPtr rootCameraNode, SceneNodeRPtr rootObjectNode, ElementInitialiserT initialise=ElementInitialiserT{}, ElementCleanerT clean=ElementCleanerT{}, ElementMergerT merge=ElementMergerT{}, ElementAttacherT attach=ElementAttacherT{}, ElementDetacherT detach=ElementDetacherT{})
 Constructor.
 
- Protected Member Functions inherited from castor::OwnedBy< Scene >
 OwnedBy (Scene &owner)
 Constructor.
 
- Protected Member Functions inherited from castor::ResourceCacheBaseT< ResT, KeyT, TraitsT >
void doCleanupNoLock () const noexcept
 
void doClearNoLock () noexcept
 
template<typename ... ParametersT>
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)
 
template<typename ... ParametersT>
ElementObsT doTryAddNoLockT (ElementKeyT const &name, bool initialise, ElementObsT &created, ParametersT &&... parameters)
 
template<typename ... ParametersT>
ElementObsT doAddNoLockT (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 castor3d::ObjectCacheBaseT< Light, castor::String, LightCacheTraits >
Enginem_engine
 
SceneNodeRPtr m_rootNode
 
SceneNodeRPtr m_rootCameraNode
 
SceneNodeRPtr m_rootObjectNode
 
ElementMergerT m_merge
 
ElementAttacherT m_attach
 
ElementDetacherT m_detach
 
- Protected Attributes inherited from castor::ResourceCacheBaseT< ResT, KeyT, TraitsT >
LoggerInstancem_logger
 
CheckedMutexT< MutexTm_mutex
 
ElementContT m_resources
 
ElementInitialiserT m_initialise
 
ElementCleanerT m_clean
 
ElementMergerT m_merge
 

Detailed Description

Light cache.

Member Typedef Documentation

◆ ElementAttacherT

using castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::ElementAttacherT = typename ElementObjectCacheT::ElementAttacherT

◆ ElementCacheTraitsT

◆ ElementCleanerT

using castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::ElementCleanerT = typename ElementObjectCacheT::ElementCleanerT

◆ ElementContT

using castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::ElementContT = typename ElementObjectCacheT::ElementContT

◆ ElementDetacherT

using castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::ElementDetacherT = typename ElementObjectCacheT::ElementDetacherT

◆ ElementInitialiserT

using castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::ElementInitialiserT = typename ElementObjectCacheT::ElementInitialiserT

◆ ElementKeyT

◆ ElementMergerT

using castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::ElementMergerT = typename ElementObjectCacheT::ElementMergerT

◆ ElementObjectCacheT

◆ ElementPtrT

using castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::ElementPtrT = typename ElementObjectCacheT::ElementPtrT

◆ ElementT

Constructor & Destructor Documentation

◆ ObjectCacheT()

C3D_API castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::ObjectCacheT ( Scene & scene,
SceneNodeRPtr rootNode,
SceneNodeRPtr rootCameraNode,
SceneNodeRPtr rootObjectNode )

Constructor.

Parameters
[in]sceneThe scene.
[in]rootNodeThe root node.
[in]rootCameraNodeThe cameras root node.
[in]rootObjectNodeThe objects root node.

Member Function Documentation

◆ addBinding()

C3D_API void castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::addBinding ( ashes::WriteDescriptorSetArray & writes,
uint32_t & binding ) const

Creates the descriptor write for the lights buffer.

◆ addLayoutBinding()

C3D_API void castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::addLayoutBinding ( ashes::VkDescriptorSetLayoutBindingArray & bindings,
VkShaderStageFlags stages,
uint32_t & index ) const

Adds the descriptor set layout binding at given point.

Parameters
[in,out]bindingsReceives the binding.
[in]stagesThe impacted shader stages.
[in,out]indexThe binding index.

◆ cleanup()

Sets all the elements to be cleaned up.

◆ createLayoutBinding()

C3D_API VkDescriptorSetLayoutBinding castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::createLayoutBinding ( VkShaderStageFlags stages,
uint32_t index ) const

Creates the descriptor set layout binding at given point.

Parameters
[in]stagesThe impacted shader stages.
[in]indexThe binding point index.

◆ createPassBinding()

C3D_API void castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::createPassBinding ( crg::FramePass & pass,
uint32_t binding ) const

Creates a frame pass binding.

◆ getBinding() [1/2]

C3D_API ashes::WriteDescriptorSet castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::getBinding ( uint32_t binding) const

Creates the descriptor write for the lights buffer.

◆ getBinding() [2/2]

C3D_API ashes::WriteDescriptorSet castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::getBinding ( uint32_t binding,
VkDeviceSize offset,
VkDeviceSize size ) const

Creates the descriptor write for the lights buffer.

◆ getLights()

C3D_API LightsArray castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::getLights ( LightType type) const

Retrieves the lights of given type.

Parameters
[in]typeThe light type.
Returns
The lights.

◆ getLightsBufferCount()

C3D_API uint32_t castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::getLightsBufferCount ( LightType type) const
noexcept
Parameters
[in]typeThe light type.
Returns
The number of light sources of the given type, in the buffer.

◆ getLightsCount()

uint32_t castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::getLightsCount ( LightType type) const
inline

◆ hasClusteredLights()

bool castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::hasClusteredLights ( ) const
inlinenoexcept

◆ initialise()

Intialises GPU buffer.

Parameters
[in]deviceThe GPU device.

◆ isDirty()

bool castor3d::ObjectCacheT< Light, castor::String, LightCacheTraits >::isDirty ( ) const
inlinenoexcept

◆ update()

Updates the render pass, CPU wise.

Parameters
[in,out]updaterThe update data.

◆ upload()

Uploads all GPU buffers to VRAM.

Parameters
[in,out]uploaderReceives the upload requests.

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