castor3d::BaseDataPassComponentT< DataT > Struct Template Reference

Pass component holding base pass data. More...

#include <BaseDataPassComponent.hpp>

Inheritance diagram for castor3d::BaseDataPassComponentT< DataT >:

Collaboration diagram for castor3d::BaseDataPassComponentT< DataT >:

Public Member Functions
Construction / Destruction.
template<typename ... ParamsT>
	BaseDataPassComponentT (Pass &pass, castor::String type, castor::StringArray deps={}, ParamsT &&... params)
	Constructor.
Mutators.
template<typename DataU >
void	setData (DataU const &data)
template<typename ... ParamsT>
void	setData (ParamsT &&... params)
Getters.
DataT &	getData ()
DataT const &	getData () const
Public Member Functions inherited from castor3d::PassComponent
C3D_API	PassComponent (Pass &pass, castor::String type, castor::StringArray deps={})
	Constructor.
virtual C3D_API	~PassComponent () noexcept=default
C3D_API PassComponentUPtr	clone (Pass &pass) const
virtual C3D_API void	onAddToPass () const
	Called when the component is added to the pass.
C3D_API bool	writeText (castor::String const &tabs, castor::Path const &folder, castor::String const &subfolder, castor::StringStream &file) const
	Writes the component content to text.
C3D_API void	fillBuffer (PassBuffer &buffer) const
	Fills the pass buffer with this pass data.
virtual C3D_API void	accept (ConfigurationVisitorBase &vis)
	ConfigurationVisitorBase acceptance function.
virtual C3D_API void	update ()
C3D_API void	fillChannel (TextureConfiguration &configuration, uint32_t mask) const
	Fills the texture configuration for use with this component.
virtual C3D_API void	fillConfig (TextureConfiguration &config, ConfigurationVisitorBase &vis) const
	ConfigurationVisitorBase acceptance function, for a specific texture configuration.
virtual C3D_API bool	hasColour () const
virtual C3D_API castor::HdrRgbColour const &	getColour () const
virtual C3D_API void	setColour (castor::HdrRgbColour v)
virtual C3D_API PassComponentFlag	getPassFlags () const
castor::String const &	getType () const
castor::StringArray const &	getDependencies () const
PassComponentPlugin const &	getPlugin () const
PassComponentID	getId () const
void	setColour (castor::RgbColour const &v, float gamma=2.2f)
void	setColour (castor::Coords3f const &v)
void	setColour (castor::Point3f const &v)
Public Member Functions inherited from castor::OwnedBy< Pass >
Pass *	getOwner () const

Protected Attributes
DataT	m_value
Protected Attributes inherited from castor3d::PassComponent
castor::String	m_type
castor::StringArray	m_dependencies
PassComponentID	m_id
PassComponentPlugin const &	m_plugin
std::atomic_bool &	m_dirty
shader::PassMaterialShader *	m_materialShader {}

Additional Inherited Members
Protected Member Functions inherited from castor::OwnedBy< Pass >
	OwnedBy (Pass &owner)
	Constructor.

Detailed Description

template<typename DataT>
struct castor3d::BaseDataPassComponentT< DataT >

Pass component holding base pass data.

Constructor & Destructor Documentation

BaseDataPassComponentT()

template<typename DataT >

template<typename ... ParamsT>

castor3d::BaseDataPassComponentT< DataT >::BaseDataPassComponentT ( Pass & pass, castor::String type, castor::StringArray deps = {}, ParamsT &&... params )

inline

Constructor.

Parameters

[in]	pass	The parent pass.
[in]	type	The component type.
[in]	deps	The components this one depends on.
[in]	params	The component data construction params.

Member Function Documentation

getData() [1/2]

template<typename DataT >

DataT & castor3d::BaseDataPassComponentT< DataT >::getData ( )

inline

References castor3d::BaseDataPassComponentT< DataT >::m_value.

getData() [2/2]

template<typename DataT >

DataT const & castor3d::BaseDataPassComponentT< DataT >::getData ( ) const

inline

References castor3d::BaseDataPassComponentT< DataT >::m_value.

setData() [1/2]

template<typename DataT >

template<typename DataU >

void castor3d::BaseDataPassComponentT< DataT >::setData ( DataU const & data )

inline

References castor3d::BaseDataPassComponentT< DataT >::m_value.

setData() [2/2]

template<typename DataT >

template<typename ... ParamsT>

void castor3d::BaseDataPassComponentT< DataT >::setData ( ParamsT &&... params )

inline

References castor3d::PassComponent::m_dirty, and castor3d::BaseDataPassComponentT< DataT >::m_value.

Member Data Documentation

m_value

template<typename DataT >

DataT castor3d::BaseDataPassComponentT< DataT >::m_value

protected

Referenced by castor3d::BaseDataPassComponentT< DataT >::getData(), castor3d::BaseDataPassComponentT< DataT >::getData(), castor3d::BaseDataPassComponentT< DataT >::setData(), and castor3d::BaseDataPassComponentT< DataT >::setData().

---

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

• Castor3D/Material/Pass/Component/BaseDataPassComponent.hpp