castor3d::RoughnessComponent Struct Reference

#include <RoughnessComponent.hpp>

Inheritance diagram for castor3d::RoughnessComponent:

Collaboration diagram for castor3d::RoughnessComponent:

Classes
struct	ComponentsShader
struct	MaterialShader
class	Plugin

Public Member Functions
C3D_API	RoughnessComponent (Pass &pass, float defaultValue=Default)
C3D_API void	accept (ConfigurationVisitorBase &vis) override
	ConfigurationVisitorBase acceptance function.
float	getRoughness () const
float	getGlossiness () const
float	getShininess () const
bool	isGlossiness () const
bool	isShininess () const
void	setRoughness (float v)
void	setGlossiness (float v)
void	setShininess (float v)
Public Member Functions inherited from castor3d::BaseDataPassComponentT< RoughnessData >
	BaseDataPassComponentT (Pass &pass, castor::String type, castor::StringArray deps={}, ParamsT &&... params)
	Constructor.
void	setData (DataU const &data)
void	setData (ParamsT &&... params)
RoughnessData &	getData ()
RoughnessData 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 noexcept
void	setOwner (Pass &owner) noexcept

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

Static Public Attributes
static C3D_API castor::String const	TypeName
static C3D_API float constexpr	Default { 1.0f }

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

RoughnessComponent()

C3D_API castor3d::RoughnessComponent::RoughnessComponent ( Pass & pass, float defaultValue = Default )

explicit

Member Function Documentation

accept()

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

overridevirtual

ConfigurationVisitorBase acceptance function.

Parameters

vis	The ... visitor.

Reimplemented from castor3d::PassComponent.

createPlugin()

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

inlinestatic

getGlossiness()

float castor3d::RoughnessComponent::getGlossiness ( ) const

inline

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

Referenced by getShininess().

Here is the caller graph for this function:

getRoughness()

float castor3d::RoughnessComponent::getRoughness ( ) const

inline

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

getShininess()

float castor3d::RoughnessComponent::getShininess ( ) const

inline

References getGlossiness(), and castor3d::MaxPhongShininess.

Here is the call graph for this function:

isGlossiness()

bool castor3d::RoughnessComponent::isGlossiness ( ) const

inline

References castor3d::eGlossiness, castor3d::BaseDataPassComponentT< RoughnessData >::m_value, and castor3d::RoughnessData::mode.

isShininess()

bool castor3d::RoughnessComponent::isShininess ( ) const

inline

References castor3d::eShininess, castor3d::BaseDataPassComponentT< RoughnessData >::m_value, and castor3d::RoughnessData::mode.

setGlossiness()

void castor3d::RoughnessComponent::setGlossiness ( float v )

inline

References castor3d::eGlossiness, castor3d::RoughnessData::factor, castor3d::BaseDataPassComponentT< RoughnessData >::m_value, and castor3d::RoughnessData::mode.

setRoughness()

void castor3d::RoughnessComponent::setRoughness ( float v )

inline

References castor3d::eRoughness, castor3d::RoughnessData::factor, castor3d::BaseDataPassComponentT< RoughnessData >::m_value, and castor3d::RoughnessData::mode.

setShininess()

void castor3d::RoughnessComponent::setShininess ( float v )

inline

References castor3d::eShininess, castor3d::RoughnessData::factor, castor3d::BaseDataPassComponentT< RoughnessData >::m_value, castor3d::MaxPhongShininess, and castor3d::RoughnessData::mode.

Member Data Documentation

Default

C3D_API float constexpr castor3d::RoughnessComponent::Default { 1.0f }

staticconstexpr

TypeName

C3D_API castor::String const castor3d::RoughnessComponent::TypeName

static

---

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

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