castor3d::ClearcoatComponent Struct Reference

#include <ClearcoatComponent.hpp>

Inheritance diagram for castor3d::ClearcoatComponent:

Collaboration diagram for castor3d::ClearcoatComponent:

Classes
struct	ComponentsShader
struct	MaterialShader
class	Plugin

Public Member Functions
C3D_API	ClearcoatComponent (Pass &pass)
C3D_API void	accept (ConfigurationVisitorBase &vis) override
	ConfigurationVisitorBase acceptance function.
float const &	getClearcoatFactor () const
float const &	getRoughnessFactor () const
void	setClearcoatFactor (float v)
void	setRoughnessFactor (float v)
Public Member Functions inherited from castor3d::BaseDataPassComponentT< ClearcoatData >
	BaseDataPassComponentT (Pass &pass, castor::String type, castor::StringArray deps={}, ParamsT &&... params)
	Constructor.
void	setData (DataU const &data)
void	setData (ParamsT &&... params)
ClearcoatData &	getData ()
ClearcoatData 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	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

Static Public Member Functions
static PassComponentPluginUPtr	createPlugin (PassComponentRegister const &passComponent)

Static Public Attributes
static C3D_API castor::String const	TypeName

Additional Inherited Members
Protected Member Functions inherited from castor::OwnedBy< Pass >
	OwnedBy (Pass &owner)
	Constructor.
Protected Attributes inherited from castor3d::BaseDataPassComponentT< ClearcoatData >
ClearcoatData	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 {}

Constructor & Destructor Documentation

ClearcoatComponent()

C3D_API castor3d::ClearcoatComponent::ClearcoatComponent ( Pass & pass )

explicit

Member Function Documentation

accept()

C3D_API void castor3d::ClearcoatComponent::accept ( ConfigurationVisitorBase & vis )

overridevirtual

ConfigurationVisitorBase acceptance function.

Parameters

vis	The ... visitor.

Reimplemented from castor3d::PassComponent.

createPlugin()

static PassComponentPluginUPtr castor3d::ClearcoatComponent::createPlugin ( PassComponentRegister const & passComponent )

inlinestatic

getClearcoatFactor()

float const & castor3d::ClearcoatComponent::getClearcoatFactor ( ) const

inline

References castor3d::ClearcoatData::factor, and castor3d::BaseDataPassComponentT< ClearcoatData >::m_value.

getRoughnessFactor()

float const & castor3d::ClearcoatComponent::getRoughnessFactor ( ) const

inline

References castor3d::BaseDataPassComponentT< ClearcoatData >::m_value, and castor3d::ClearcoatData::roughness.

setClearcoatFactor()

void castor3d::ClearcoatComponent::setClearcoatFactor ( float v )

inline

References castor3d::ClearcoatData::factor, and castor3d::BaseDataPassComponentT< ClearcoatData >::m_value.

setRoughnessFactor()

void castor3d::ClearcoatComponent::setRoughnessFactor ( float v )

inline

References castor3d::BaseDataPassComponentT< ClearcoatData >::m_value, and castor3d::ClearcoatData::roughness.

Member Data Documentation

TypeName

C3D_API castor::String const castor3d::ClearcoatComponent::TypeName

static

---

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

• Castor3D/Material/Pass/Component/Lighting/ClearcoatComponent.hpp