#include <PassMapComponent.hpp>

Inheritance diagram for castor3d::PassMapComponent:

[legend]

Collaboration diagram for castor3d::PassMapComponent:

[legend]

Public Member Functions

Construction / Destruction.
C3D_API	PassMapComponent (Pass &pass, castor::String type, TextureFlags textureFlags, castor::StringArray deps={})
	Constructor.


Getters.
PassComponentTextureFlag	getTextureFlags () const noexcept

C3D_API void	fillConfig (TextureConfiguration &config, ConfigurationVisitorBase &vis) const override
	ConfigurationVisitorBase acceptance function, for a specific texture configuration.

C3D_API void	createDefaultTexture (Pass &pass, castor::String name, TextureConfiguration config, castor::ImageCreateParams imageParams)

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 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

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

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

◆ PassMapComponent()

C3D_API castor3d::PassMapComponent::PassMapComponent	(	Pass &	pass,
		castor::String	type,
		TextureFlags	textureFlags,
		castor::StringArray	deps = {} )

Constructor.

Parameters

[in]	pass	The parent pass.
[in]	type	The component type.
[in]	textureFlags	The texture flags.
[in]	deps	The components this one depends on.

Member Function Documentation

◆ createDefaultTexture()

C3D_API void castor3d::PassMapComponent::createDefaultTexture	(	Pass &	pass,
		castor::String	name,
		TextureConfiguration	config,
		castor::ImageCreateParams	imageParams )

◆ fillConfig()

C3D_API void castor3d::PassMapComponent::fillConfig	(	TextureConfiguration &	config,
		ConfigurationVisitorBase &	vis ) const

overridevirtual

ConfigurationVisitorBase acceptance function, for a specific texture configuration.

Parameters

config	The texture configuration.
vis	The ... visitor.

Reimplemented from castor3d::PassComponent.

◆ getTextureFlags()

PassComponentTextureFlag castor3d::PassMapComponent::getTextureFlags ( ) const

inlinenoexcept

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

Castor3D/Material/Pass/Component/PassMapComponent.hpp