Castor3D 0.16.0
Multiplatform 3D engine
Types publics | Fonctions membres publiques | Fonctions membres publiques statiques | Attributs publics statiques | Amis | Liste de tous les membres
Référence de la classe castor3d::DirectionalLight

#include <DirectionalLight.hpp>

Graphe d'héritage de castor3d::DirectionalLight:
Inheritance graph
[légende]
Graphe de collaboration de castor3d::DirectionalLight:
Collaboration graph
[légende]

Types publics

using Cascade = DirectionalLightCascade
 
using ShadowData = DirectionalShadowData
 
using LightData = LightCategory::LightData
 

Fonctions membres publiques

C3D_API void update () override
 Met la source à jour.
 
C3D_API bool updateShadow (Camera const &sceneCamera)
 Met à jour les information de shadow cascades.
 
C3D_API void fillShadowBuffer (AllShadowData &data) const override
 Met les données d'ombre dans le buffer donné.
 
castor::Point3f const & getDirection () const
 
float getSplitDepth (uint32_t cascadeIndex) const
 
float getSplitScale (uint32_t cascadeIndex) const
 
castor::Matrix4x4f const & getProjMatrix (uint32_t cascadeIndex) const
 
castor::Matrix4x4f const & getViewMatrix (uint32_t cascadeIndex) const
 
castor::Matrix4x4f const & getLightSpaceTransform (uint32_t cascadeIndex) const
 
- Fonctions membres publiques hérités de castor3d::LightCategory
virtual C3D_API ~LightCategory () noexcept=default
 Destructeur.
 
C3D_API void fillLightBuffer (castor::Point4f *data) const
 Met la lumière dans le buffer donné.
 
C3D_API void accept (ConfigurationVisitorBase &vis)
 Fonction d'acceptation de ConfigurationVisitorBase.
 
C3D_API uint32_t getVolumetricSteps () const
 
C3D_API float getVolumetricScatteringFactor () const
 
C3D_API castor::Point2f const & getShadowRawOffsets () const
 
C3D_API castor::Point2f const & getShadowPcfOffsets () const
 
C3D_API float getVsmMinVariance () const
 
C3D_API float getVsmLightBleedingReduction () const
 
C3D_API castor::RangedValue< uint32_t > getShadowPcfFilterSize () const
 
C3D_API castor::RangedValue< uint32_t > getShadowPcfSampleCount () const
 
C3D_API ShadowConfig const & getShadowConfig () const
 
C3D_API LpvConfig const & getLpvConfig () const
 
LightType getLightType () const
 
uint32_t getLightComponentCount () const
 
uint32_t getShadowComponentCount () const
 
float getDiffuseIntensity () const
 
float getSpecularIntensity () const
 
castor::Point2f const & getIntensity () const
 
float getFarPlane () const
 
castor::Point3f const & getColour () const
 
Light const & getLight () const
 
castor::BoundingBox const & getBoundingBox () const
 
C3D_API void setVolumetricSteps (uint32_t value)
 
C3D_API void setVolumetricScatteringFactor (float value)
 
C3D_API void setRawMinOffset (float value)
 
C3D_API void setRawMaxSlopeOffset (float value)
 
C3D_API void setPcfMinOffset (float value)
 
C3D_API void setPcfMaxSlopeOffset (float value)
 
C3D_API void setPcfFilterSize (uint32_t value)
 
C3D_API void setPcfSampleCount (uint32_t value)
 
C3D_API void setVsmMinVariance (float value)
 
C3D_API void setVsmLightBleedingReduction (float value)
 
C3D_API void setColour (castor::Point3f const &value)
 
C3D_API void setIntensity (castor::Point2f const &value)
 
C3D_API void setDiffuseIntensity (float value)
 
C3D_API void setSpecularIntensity (float value)
 
LightgetLight ()
 
castor::Point3f & getColour ()
 
castor::Point2f & getIntensity ()
 

Fonctions membres publiques statiques

static C3D_API LightCategoryUPtr create (Light &light)
 Fonction de création utilisée par Factory.
 

Attributs publics statiques

static constexpr uint32_t ShadowDataSize = uint32_t( ashes::getAlignedSize( sizeof( ShadowData ), LightMbrAlign ) )
 
static constexpr uint32_t ShadowDataComponents = ShadowDataSize / LightMbrAlign
 
static constexpr uint32_t LightDataSize = uint32_t( ashes::getAlignedSize( sizeof( LightData ), LightMbrAlign ) )
 
static constexpr uint32_t LightDataComponents = LightDataSize / LightMbrAlign
 
- Attributs publics statiques hérités de castor3d::LightCategory
static uint32_t constexpr LightMbrAlign = 4u * sizeof( float )
 

Amis

class Scene
 

Membres hérités additionnels

- Fonctions membres protégées hérités de castor3d::LightCategory
C3D_API LightCategory (LightType lightType, Light &light, uint32_t lightComponentCount, uint32_t shadowComponentCount)
 Constructeur.
 
C3D_API void doFillBaseShadowData (BaseShadowData &data) const
 Met les données d'ombre dans le buffer donné.
 
- Attributs protégés hérités de castor3d::LightCategory
castor::BoundingBox m_cubeBox
 
float m_farPlane { 1.0f }
 

Documentation des définitions de type membres

◆ Cascade

◆ LightData

◆ ShadowData

Documentation des fonctions membres

◆ create()

static C3D_API LightCategoryUPtr castor3d::DirectionalLight::create ( Light & light)
static

Fonction de création utilisée par Factory.

Paramètres
[in]lightLa Light parente.
Renvoie
Une source lumineuse.

◆ fillShadowBuffer()

C3D_API void castor3d::DirectionalLight::fillShadowBuffer ( AllShadowData & data) const
overridevirtual

Met les données d'ombre dans le buffer donné.

Paramètres
[out]dataReçoit les données d'ombres de la source lumineuse.

Implémente castor3d::LightCategory.

◆ getDirection()

castor::Point3f const & castor3d::DirectionalLight::getDirection ( ) const
inline

name Accesseurs.

◆ getLightSpaceTransform()

castor::Matrix4x4f const & castor3d::DirectionalLight::getLightSpaceTransform ( uint32_t cascadeIndex) const
inline

◆ getProjMatrix()

castor::Matrix4x4f const & castor3d::DirectionalLight::getProjMatrix ( uint32_t cascadeIndex) const
inline

◆ getSplitDepth()

float castor3d::DirectionalLight::getSplitDepth ( uint32_t cascadeIndex) const
inline

◆ getSplitScale()

float castor3d::DirectionalLight::getSplitScale ( uint32_t cascadeIndex) const
inline

◆ getViewMatrix()

castor::Matrix4x4f const & castor3d::DirectionalLight::getViewMatrix ( uint32_t cascadeIndex) const
inline

◆ update()

C3D_API void castor3d::DirectionalLight::update ( )
overridevirtual

Met la source à jour.

Implémente castor3d::LightCategory.

◆ updateShadow()

C3D_API bool castor3d::DirectionalLight::updateShadow ( Camera const & sceneCamera)

Met à jour les information de shadow cascades.

Paramètres
[in]sceneCameraLa caméra de la scène.
Renvoie
false si rien n'a changé.

Documentation des fonctions amies et associées

◆ Scene

friend class Scene
friend

Documentation des données membres

◆ LightDataComponents

constexpr uint32_t castor3d::DirectionalLight::LightDataComponents = LightDataSize / LightMbrAlign
staticconstexpr

◆ LightDataSize

constexpr uint32_t castor3d::DirectionalLight::LightDataSize = uint32_t( ashes::getAlignedSize( sizeof( LightData ), LightMbrAlign ) )
staticconstexpr

◆ ShadowDataComponents

constexpr uint32_t castor3d::DirectionalLight::ShadowDataComponents = ShadowDataSize / LightMbrAlign
staticconstexpr

◆ ShadowDataSize

constexpr uint32_t castor3d::DirectionalLight::ShadowDataSize = uint32_t( ashes::getAlignedSize( sizeof( ShadowData ), LightMbrAlign ) )
staticconstexpr

La documentation de cette classe a été générée à partir du fichier suivant :