#include <Light.hpp>

Inheritance diagram for castor3d::Light:

[legend]

Collaboration diagram for castor3d::Light:

[legend]

Public Member Functions
C3D_API	Light (castor::String const &name, LightCreateInfo const &createInfo)
	Constructor.

C3D_API	Light (castor::String const &name, Scene &scene, SceneNode &node, LightFactory &factory, LightType lightType)
	Constructor.

C3D_API void	update (CpuUpdater &updater)
	CPU Update.

C3D_API void	fillLightBuffer (uint32_t index, VkDeviceSize offset, castor::Point4f *data)
	Records the light data into given buffer.

C3D_API void	fillShadowBuffer (AllShadowData &data)
	Records the light data into given buffer.

C3D_API void	accept (ConfigurationVisitorBase &vis)
	ConfigurationVisitorBase acceptance function.

C3D_API void	cloneInto (Light &output) const
	Clones this object into the given one.


C3D_API DirectionalLightRPtr	getDirectionalLight () const

C3D_API PointLightRPtr	getPointLight () const

C3D_API SpotLightRPtr	getSpotLight () const

LightType	getLightType () const

uint32_t	getLightComponentCount () const

uint32_t	getShadowComponentCount () const

bool	isEnabled () const

castor::Point3f const &	getColour () const

float	getFarPlane () const

castor::BoundingBox const &	getBoundingBox () const

LightCategoryRPtr	getCategory () const

bool	isShadowProducer () const

bool	isExpectedShadowProducer () const

ShadowType	getShadowType () const

ShadowMapRPtr	getShadowMap () const

int32_t	getShadowMapIndex () const

uint32_t	getBufferIndex () const

VkDeviceSize	getBufferOffset () const

bool	needsRsmShadowMaps () const

GlobalIlluminationType	getGlobalIlluminationType () const

GlobalIlluminationType	getExpectedGlobalIlluminationType () const

RsmConfig const &	getRsmConfig () const

LpvConfig const &	getLpvConfig () const

LpvConfig &	getLpvConfig ()

uint32_t	getVolumetricSteps () const

float	getVolumetricScatteringFactor () const

castor::Point2f const &	getShadowRawOffsets () const

castor::Point2f const &	getShadowPcfOffsets () const

float	getVsmMinVariance () const

float	getVsmLightBleedingReduction () const

castor::RangedValue< uint32_t >	getShadowPcfFilterSize () const

castor::RangedValue< uint32_t >	getShadowPcfSampleCount () const

ShadowConfig const &	getShadowConfig () const

ShadowConfig &	getShadowConfig ()


void	setColour (float const *values)

void	setColour (float r, float g, float b)

void	setColour (castor::Point3f const &value)

void	setColour (castor::RgbColour const &value)

void	setEnabled (bool value)

void	enable ()

void	disable ()

void	setShadowConfig (ShadowConfig config)

void	setShadowMapIndex (int32_t index)

void	setShadowMap (ShadowMapRPtr value, int32_t index=-1)

void	setGlobalIlluminationType (GlobalIlluminationType value)

void	setShadowType (ShadowType value)

void	setVolumetricSteps (uint32_t value)

void	setVolumetricScatteringFactor (float value)

void	setRawMinOffset (float value)

void	setRawMaxSlopeOffset (float value)

void	setPcfMinOffset (float value)

void	setPcfMaxSlopeOffset (float value)

void	setPcfFilterSize (uint32_t value)

void	setPcfSampleCount (uint32_t value)

void	setVsmMinVariance (float value)

void	setVsmLightBleedingReduction (float value)

Public Member Functions inherited from castor3d::MovableObject
C3D_API	MovableObject (castor::String const &name, Scene &scene, MovableType type, SceneNode &node)
	Constructor.

C3D_API	MovableObject (castor::String const &name, Scene &scene, MovableType type)
	Constructor.

virtual C3D_API	~MovableObject () noexcept
	Destructor.

C3D_API void	detach ()
	Detaches the movable object from it's parent.

virtual C3D_API void	attachTo (SceneNode &node)
	Attaches the movable object to a node.

C3D_API void	markDirty ()
	Adds the object to dirty object list in the scene.

C3D_API EngineRPtr	getEngine () const noexcept

SceneNode *	getParent () const noexcept

MovableType	getMovableType () const noexcept

Public Member Functions inherited from castor::OwnedBy< Scene >
Scene *	getOwner () const noexcept

void	setOwner (Scene &owner) noexcept

Public Member Functions inherited from castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructor.

T const &	getName () const noexcept
	Retrieves the name.

void	rename (T name) noexcept

Static Public Member Functions
static C3D_API void	addParsers (castor::AttributeParsers &result)

Public Attributes
OnLightChanged	onGPUChanged

Friends
class	LightCategory

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

Protected Attributes inherited from castor3d::MovableObject
MovableType	m_type

SceneNode *	m_sceneNode {}

OnSceneNodeChangedConnection	m_notifyIndex

bool	m_dirty { true }

Protected Attributes inherited from castor::NamedBaseT< T >
T	m_name

Constructor & Destructor Documentation

◆ Light() [1/2]

C3D_API castor3d::Light::Light	(	castor::String const &	name,
		LightCreateInfo const &	createInfo )

Constructor.

Parameters

[in]	name	The light name.
[in]	createInfo	The creation informations.

◆ Light() [2/2]

C3D_API castor3d::Light::Light	(	castor::String const &	name,
		Scene &	scene,
		SceneNode &	node,
		LightFactory &	factory,
		LightType	lightType )

Constructor.

Parameters

[in]	name	The light name.
[in]	scene	Parent scene.
[in]	node	The parent scene node.
[in]	factory	Factory used to create the LightCategory.
[in]	lightType	The light type.

Member Function Documentation

◆ accept()

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

ConfigurationVisitorBase acceptance function.

Parameters

vis	The ... visitor.

◆ addParsers()

static C3D_API void castor3d::Light::addParsers ( castor::AttributeParsers & result )

static

◆ cloneInto()

C3D_API void castor3d::Light::cloneInto ( Light & output ) const

Clones this object into the given one.

Parameters

[in,out] output Receives this object's data.

◆ disable()

void castor3d::Light::disable ( )

inline

References setEnabled().

Here is the call graph for this function:

◆ enable()

void castor3d::Light::enable ( )

inline

References setEnabled().

Here is the call graph for this function:

◆ fillLightBuffer()

C3D_API void castor3d::Light::fillLightBuffer	(	uint32_t	index,
		VkDeviceSize	offset,
		castor::Point4f *	data )

Records the light data into given buffer.

Parameters

[in]	index	The light index in the buffer.
[in]	offset	The light data offset in the buffer.
[out]	data	Receives the informations.

◆ fillShadowBuffer()

C3D_API void castor3d::Light::fillShadowBuffer ( AllShadowData & data )

Records the light data into given buffer.

Parameters

[out] data Receives the informations.

◆ getBoundingBox()

castor::BoundingBox const & castor3d::Light::getBoundingBox ( ) const

inline

◆ getBufferIndex()

uint32_t castor3d::Light::getBufferIndex ( ) const

inline

◆ getBufferOffset()

VkDeviceSize castor3d::Light::getBufferOffset ( ) const

inline

◆ getCategory()

LightCategoryRPtr castor3d::Light::getCategory ( ) const

inline

◆ getColour()

castor::Point3f const & castor3d::Light::getColour ( ) const

inline

◆ getDirectionalLight()

C3D_API DirectionalLightRPtr castor3d::Light::getDirectionalLight ( ) const

name Getters.

◆ getExpectedGlobalIlluminationType()

GlobalIlluminationType castor3d::Light::getExpectedGlobalIlluminationType ( ) const

inline

References castor3d::ShadowConfig::globalIllumination.

◆ getFarPlane()

float castor3d::Light::getFarPlane ( ) const

inline

◆ getGlobalIlluminationType()

GlobalIlluminationType castor3d::Light::getGlobalIlluminationType ( ) const

inline

Referenced by needsRsmShadowMaps().

Here is the caller graph for this function:

◆ getLightComponentCount()

uint32_t castor3d::Light::getLightComponentCount ( ) const

inline

◆ getLightType()

LightType castor3d::Light::getLightType ( ) const

inline

◆ getLpvConfig() [1/2]

LpvConfig & castor3d::Light::getLpvConfig ( )

inline

References castor3d::ShadowConfig::lpvConfig.

◆ getLpvConfig() [2/2]

LpvConfig const & castor3d::Light::getLpvConfig ( ) const

inline

References castor3d::ShadowConfig::lpvConfig.

◆ getPointLight()

C3D_API PointLightRPtr castor3d::Light::getPointLight ( ) const

◆ getRsmConfig()

RsmConfig const & castor3d::Light::getRsmConfig ( ) const

inline

References castor3d::ShadowConfig::rsmConfig.

◆ getShadowComponentCount()

uint32_t castor3d::Light::getShadowComponentCount ( ) const

inline

◆ getShadowConfig() [1/2]

ShadowConfig & castor3d::Light::getShadowConfig ( )

inline

◆ getShadowConfig() [2/2]

ShadowConfig const & castor3d::Light::getShadowConfig ( ) const

inline

◆ getShadowMap()

ShadowMapRPtr castor3d::Light::getShadowMap ( ) const

inline

◆ getShadowMapIndex()

int32_t castor3d::Light::getShadowMapIndex ( ) const

inline

◆ getShadowPcfFilterSize()

castor::RangedValue< uint32_t > castor3d::Light::getShadowPcfFilterSize ( ) const

inline

References castor3d::ShadowConfig::pcfFilterSize.

◆ getShadowPcfOffsets()

castor::Point2f const & castor3d::Light::getShadowPcfOffsets ( ) const

inline

References castor3d::ShadowConfig::pcfOffsets.

◆ getShadowPcfSampleCount()

castor::RangedValue< uint32_t > castor3d::Light::getShadowPcfSampleCount ( ) const

inline

References castor3d::ShadowConfig::pcfSampleCount.

◆ getShadowRawOffsets()

castor::Point2f const & castor3d::Light::getShadowRawOffsets ( ) const

inline

References castor3d::ShadowConfig::rawOffsets.

◆ getShadowType()

ShadowType castor3d::Light::getShadowType ( ) const

inline

References castor3d::ShadowConfig::filterType.

◆ getSpotLight()

C3D_API SpotLightRPtr castor3d::Light::getSpotLight ( ) const

◆ getVolumetricScatteringFactor()

float castor3d::Light::getVolumetricScatteringFactor ( ) const

inline

References castor3d::ShadowConfig::volumetricScattering.

◆ getVolumetricSteps()

uint32_t castor3d::Light::getVolumetricSteps ( ) const

inline

References castor3d::ShadowConfig::volumetricSteps.

◆ getVsmLightBleedingReduction()

float castor3d::Light::getVsmLightBleedingReduction ( ) const

inline

References castor3d::ShadowConfig::vsmLightBleedingReduction.

◆ getVsmMinVariance()

float castor3d::Light::getVsmMinVariance ( ) const

inline

References castor3d::ShadowConfig::vsmMinVariance.

◆ isEnabled()

bool castor3d::Light::isEnabled ( ) const

inline

◆ isExpectedShadowProducer()

bool castor3d::Light::isExpectedShadowProducer ( ) const

inline

References castor3d::ShadowConfig::enabled.

◆ isShadowProducer()

bool castor3d::Light::isShadowProducer ( ) const

inline

◆ needsRsmShadowMaps()

bool castor3d::Light::needsRsmShadowMaps ( ) const

inline

References castor3d::eNone, and getGlobalIlluminationType().

Here is the call graph for this function:

◆ setColour() [1/4]

void castor3d::Light::setColour ( castor::Point3f const & value )

inline

◆ setColour() [2/4]

void castor3d::Light::setColour ( castor::RgbColour const & value )

inline

◆ setColour() [3/4]

void castor3d::Light::setColour ( float const * values )

inline

name Mutators.

◆ setColour() [4/4]

void castor3d::Light::setColour	(	float	r,
		float	g,
		float	b )

inline

◆ setEnabled()

void castor3d::Light::setEnabled ( bool value )

inline

References castor3d::MovableObject::markDirty().

Referenced by disable(), and enable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setGlobalIlluminationType()

void castor3d::Light::setGlobalIlluminationType ( GlobalIlluminationType value )

inline

References castor3d::ShadowConfig::globalIllumination, and castor3d::MovableObject::markDirty().

Here is the call graph for this function:

◆ setPcfFilterSize()

void castor3d::Light::setPcfFilterSize ( uint32_t value )

inline

References castor3d::ShadowConfig::pcfFilterSize.

◆ setPcfMaxSlopeOffset()

void castor3d::Light::setPcfMaxSlopeOffset ( float value )

inline

References castor3d::ShadowConfig::pcfOffsets.

◆ setPcfMinOffset()

void castor3d::Light::setPcfMinOffset ( float value )

inline

References castor3d::ShadowConfig::pcfOffsets.

◆ setPcfSampleCount()

void castor3d::Light::setPcfSampleCount ( uint32_t value )

inline

References castor3d::ShadowConfig::pcfSampleCount.

◆ setRawMaxSlopeOffset()

void castor3d::Light::setRawMaxSlopeOffset ( float value )

inline

References castor3d::ShadowConfig::rawOffsets.

◆ setRawMinOffset()

void castor3d::Light::setRawMinOffset ( float value )

inline

References castor3d::ShadowConfig::rawOffsets.

◆ setShadowConfig()

void castor3d::Light::setShadowConfig ( ShadowConfig config )

inline

References castor3d::MovableObject::markDirty().

Here is the call graph for this function:

◆ setShadowMap()

void castor3d::Light::setShadowMap	(	ShadowMapRPtr	value,
		int32_t	index = -1 )

inline

References onGPUChanged.

◆ setShadowMapIndex()

void castor3d::Light::setShadowMapIndex ( int32_t index )

inline

References onGPUChanged.

◆ setShadowType()

void castor3d::Light::setShadowType ( ShadowType value )

inline

References castor3d::ShadowConfig::filterType.

◆ setVolumetricScatteringFactor()

void castor3d::Light::setVolumetricScatteringFactor ( float value )

inline

References castor3d::ShadowConfig::volumetricScattering.

◆ setVolumetricSteps()

void castor3d::Light::setVolumetricSteps ( uint32_t value )

inline

References castor3d::ShadowConfig::volumetricSteps.

◆ setVsmLightBleedingReduction()

void castor3d::Light::setVsmLightBleedingReduction ( float value )

inline

References castor3d::ShadowConfig::vsmLightBleedingReduction.

◆ setVsmMinVariance()

void castor3d::Light::setVsmMinVariance ( float value )

inline

References castor3d::ShadowConfig::vsmMinVariance.

◆ update()

C3D_API void castor3d::Light::update ( CpuUpdater & updater )

CPU Update.

Parameters

[in,out] updater The update data.

Friends And Related Symbol Documentation

◆ LightCategory

friend class LightCategory

friend

Member Data Documentation

◆ onGPUChanged

OnLightChanged castor3d::Light::onGPUChanged

Referenced by setShadowMap(), and setShadowMapIndex().

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

Castor3D/Scene/Light/Light.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ Light() [1/2]

◆ Light() [2/2]

Member Function Documentation

◆ accept()

◆ addParsers()

◆ cloneInto()

◆ disable()

◆ enable()

◆ fillLightBuffer()

◆ fillShadowBuffer()

◆ getBoundingBox()

◆ getBufferIndex()

◆ getBufferOffset()

◆ getCategory()

◆ getColour()

◆ getDirectionalLight()

◆ getExpectedGlobalIlluminationType()

◆ getFarPlane()

◆ getGlobalIlluminationType()

◆ getLightComponentCount()

◆ getLightType()

◆ getLpvConfig() [1/2]

◆ getLpvConfig() [2/2]

◆ getPointLight()

◆ getRsmConfig()

◆ getShadowComponentCount()

◆ getShadowConfig() [1/2]

◆ getShadowConfig() [2/2]

◆ getShadowMap()

◆ getShadowMapIndex()

◆ getShadowPcfFilterSize()

◆ getShadowPcfOffsets()

◆ getShadowPcfSampleCount()

◆ getShadowRawOffsets()

◆ getShadowType()

◆ getSpotLight()

◆ getVolumetricScatteringFactor()

◆ getVolumetricSteps()

◆ getVsmLightBleedingReduction()

◆ getVsmMinVariance()

◆ isEnabled()

◆ isExpectedShadowProducer()

◆ isShadowProducer()

◆ needsRsmShadowMaps()

◆ setColour() [1/4]

◆ setColour() [2/4]

◆ setColour() [3/4]

◆ setColour() [4/4]

◆ setEnabled()

◆ setGlobalIlluminationType()

◆ setPcfFilterSize()

◆ setPcfMaxSlopeOffset()

◆ setPcfMinOffset()

◆ setPcfSampleCount()

◆ setRawMaxSlopeOffset()

◆ setRawMinOffset()

◆ setShadowConfig()

◆ setShadowMap()

◆ setShadowMapIndex()

◆ setShadowType()

◆ setVolumetricScatteringFactor()

◆ setVolumetricSteps()

◆ setVsmLightBleedingReduction()

◆ setVsmMinVariance()

◆ update()

Friends And Related Symbol Documentation

◆ LightCategory

Member Data Documentation

◆ onGPUChanged