Updated version numbers, reviewed documentation

DragonJoker · Jan 17, 2025 · 32d9343 · 32d9343
1 parent 7d22771
commit 32d9343
Show file tree

Hide file tree

Showing 47 changed files with 138 additions and 70 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -19,9 +19,9 @@ endif ()
 set( MAIN_PROJECT_NAME "Castor3D" )
 
 set( VERSION_MAJOR 0 )
-set( VERSION_MINOR 16 )
+set( VERSION_MINOR 17 )
 set( VERSION_BUILD 0 )
-set( VERSION_YEAR 2024 )
+set( VERSION_YEAR 2025 )
 
 if ( NOT CMAKE_MODULE_PATH )
 	# Setup lookup for external modules

diff --git a/doc/Castor3D-English.chm b/doc/Castor3D-English.chm
diff --git a/doc/Castor3D-French.chm b/doc/Castor3D-French.chm
diff --git a/doc/Castor3D/ChangeLog-English.md b/doc/Castor3D/ChangeLog-English.md
@@ -1,8 +1,45 @@
-Change log	{#changelog}
+Change log	{#changelog}
 ==========
 
 This page is here to inform about the changes since the earliest versions of the engine.
 
+## Version 0.17.0
+
+### Important Changes
+- Introduced LuminousIntensity (expressed in candela) and Illumination (expressed in lux) classes.
+- Replaced Spot/Point lights specular and diffuse intensities with a single LuminousIntensity value.
+- Replaced Directional lights specular and diffuse intensities with a single Illumination value.
+- The specular, diffuse, sheen, clearcoat, and scattering models are now fully replaceable.
+- The default lighting model is now glTF's.
+
+### New Features
+- Implemented a debug drawer, which allowed for displaying clustered lighting AABBs and BVH.
+- Implemented default textures, to prevent pipelines explosion.
+- Added support for MSDF fonts.
+- Added support for diffuse transmission.
+- Added support for dispersion (chromatic aberration).
+- Implemented anisotropic specular BRDF as a plugin.
+- Implemented Disney BRDF as a plugin.
+- Added support for webp images.
+- Added support for basisu images.
+- Added support for image inversion along X and Z axes (Y axis was already supported).
+- CastorViewer can now directly open files from an external 3D file format.
+
+### General
+- Implemented reflections from procedural sky
+- Implemented vertex pulling for rasteriser passes.
+- castor::Angle, castor::Length, castor::Speed are now constexpr friendly.
+- Added a way to disable far plane blur, in depth of field plugin.
+- Added a way to display the irradiance map instead of the skybox (for showcase purposes).
+- Improved smoothness for mouse nodes control, in CastorViewer.
+
+### Bug fixes
+- Fixed tree view limits.
+- Many fixes to glTF importer plugin.
+- Fixed dots issue in prefiltered environment map.
+- Added display topology to pipeline flags, to prevent some issues when multiple topologies are mixed.
+- Fixed a crash on CastorViewer application shutdown with an object selected.
+
 ## Version 0.16.0
 
 ### Important Changes

diff --git a/doc/Castor3D/ChangeLog-French.md b/doc/Castor3D/ChangeLog-French.md
@@ -1,8 +1,45 @@
-Suivi de versions	{#changelog}
+Suivi de versions	{#changelog}
 =================
 
 Cette page sert à informer des évolutions du moteur depuis les premières versions.
 
+## Version 0.17.0
+
+### Important Changes
+- Introduction des classes LuminousIntensity (exprimée en candela) et Illumination (exprimée en lux).
+- Remplacement des intensités spéculaire et diffuse des sources lumineuses spot/point par une valeur de LuminousIntensity.
+- Remplacement des intensités spéculaire et diffuse des sources lumineuses directionnelles par une valeur d'Illumination.
+- Les modèles d'éclairage specular, diffuse, sheen, clearcoat et scattering sont maintenant entièrement remplaçables.
+- Le modèle d'éclairage par défaut est maintenant celui issu de glTF.
+
+### New Features
+- Implémenté un debug drawer, ce qui a permis d'afficher les AABB et BCH du clustered lighting.
+- Implémentation de textures par défaut, pour éviter l'explosion du nombre de pipelines.
+- Ajout du support des fonts MSDF.
+- Ajout du support de la diffuse transmission.
+- Ajout du support de la dispersion (chromatic aberration).
+- Implémenté un BRDF d'anisotropic specular, en tant que plugin.
+- Implémenté les BRDF Disney, en tant que plugin.
+- Ajout du support des images webp.
+- Ajout du support des images basisu.
+- Ajout du support de l'inversion d'image le long des axes X et Z (l'axe Y était déjà supporté).
+- CastorViewer peut maintenant directement ouvrir les fichiers 3D externes.
+
+### General
+- Implémenté les réflections du ciel procéduraly
+- Implémenté le vertex pulling pour les passes de rastérisation.
+- castor::Angle, castor::Length, castor::Speed sont maintenant utilisables en constexpr.
+- Ajout de la possibilité de désactiver le blur du plan éloigné, dans le plugin de depth of field.
+- Ajout de la possibilité d'afficher l a texture d'irradiance au lieu de la skybox (pour les scènes de démonstration).
+- Amélioration de la fluidité des contrôles à la souris, dans CastorViewer.
+
+### Bug fixes
+- Correction des limites des tree views, dans CastorViewer.
+- Nombreuses corrections dans le plugin d'import glTF.
+- Correction des papillons dans la prefiltered environment map.
+- Ajout de la topologie d'affichage dans les flags de pipeline, pour éviter des soucis d'affichage quand diverses topologies sont utilisées.
+- Correction d'un crash lors de la fermeture de l'application CastorViewer, en ayant un objet sélectionné.
+
 ## Version 0.16.0
 
 ### Important Changes

diff --git a/include/Core/Castor3D/Animation/AnimationImporter.hpp b/include/Core/Castor3D/Animation/AnimationImporter.hpp
@@ -212,14 +212,14 @@ namespace castor3d
 		/**
 		 *\~english
 		 *\brief		TextureAnimation import Function.
-		 *\param[out]	node	Receives the imported data.
+		 *\param[out]	texture	Receives the imported data.
 		 *\return		\p false if any problem occured.
 		 *\~french
 		 *\brief		Fonction d'import de TextureAnimation.
-		 *\param[out]	node	Reçoit les données importées.
+		 *\param[out]	texture	Reçoit les données importées.
 		 *\return		\p false si un problème quelconque est survenu.
 		 */
-		C3D_API virtual bool doImportTexture( TextureAnimation & node ) = 0;
+		C3D_API virtual bool doImportTexture( TextureAnimation & texture ) = 0;
 
 	protected:
 		castor::String m_prefix;

diff --git a/include/Core/Castor3D/Binary/CmshImporter.hpp b/include/Core/Castor3D/Binary/CmshImporter.hpp
@@ -164,7 +164,7 @@ namespace castor3d
 		/**
 		 *\copydoc		castor3d::AnimationImporter::doImportTexture
 		 */
-		bool doImportTexture( TextureAnimation & animation )override;
+		bool doImportTexture( TextureAnimation & texture )override;
 
 	public:
 		static castor::String const MeshAnimType;

diff --git a/include/Core/Castor3D/Buffer/GpuBufferPool.hpp b/include/Core/Castor3D/Buffer/GpuBufferPool.hpp
@@ -46,9 +46,9 @@ namespace castor3d
 		 */
 		C3D_API void upload( UploadData & uploader )const;
 		/**
-		 *\english
+		 *\~english
 		 *\return		The allocation statistics.
-		 *\french
+		 *\~french
 		 *\return		Les statistiques d'allocation.
 		 */
 		C3D_API AllocationStats getAllocationStats()const noexcept;

diff --git a/include/Core/Castor3D/Buffer/ObjectBufferPool.hpp b/include/Core/Castor3D/Buffer/ObjectBufferPool.hpp
@@ -50,9 +50,9 @@ namespace castor3d
 		 */
 		C3D_API void cleanup();
 		/**
-		 *\english
+		 *\~english
 		 *\return		The allocation statistics.
-		 *\french
+		 *\~french
 		 *\return		Les statistiques d'allocation.
 		 */
 		C3D_API AllocationStats getAllocationStats()const noexcept;
@@ -127,9 +127,9 @@ namespace castor3d
 		 */
 		C3D_API void cleanup();
 		/**
-		 *\english
+		 *\~english
 		 *\return		The allocation statistics.
-		 *\french
+		 *\~french
 		 *\return		Les statistiques d'allocation.
 		 */
 		C3D_API AllocationStats getAllocationStats()const noexcept;
@@ -201,9 +201,9 @@ namespace castor3d
 		 */
 		C3D_API void cleanup();
 		/**
-		 *\english
+		 *\~english
 		 *\return		The allocation statistics.
-		 *\french
+		 *\~french
 		 *\return		Les statistiques d'allocation.
 		 */
 		C3D_API AllocationStats getAllocationStats()const noexcept;

diff --git a/include/Core/Castor3D/Buffer/PoolUniformBuffer.hpp b/include/Core/Castor3D/Buffer/PoolUniformBuffer.hpp
@@ -74,9 +74,9 @@ namespace castor3d
 		 */
 		C3D_API VkDeviceSize getAvailable()const noexcept;
 		/**
-		 *\english
+		 *\~english
 		 *\return		The allocation statistics.
-		 *\french
+		 *\~french
 		 *\return		Les statistiques d'allocation.
 		 */
 		C3D_API castor::Vector< castor::Pair< MemChunk, castor::String > > listAllocations()const;

diff --git a/include/Core/Castor3D/Buffer/UniformBufferPool.hpp b/include/Core/Castor3D/Buffer/UniformBufferPool.hpp
@@ -48,16 +48,16 @@ namespace castor3d
 		 */
 		C3D_API void cleanup();
 		/**
-		 *\english
+		 *\~english
 		 *\return		The allocation statistics.
-		 *\french
+		 *\~french
 		 *\return		Les statistiques d'allocation.
 		 */
 		C3D_API AllocationStats getAllocationStats()const noexcept;
 		/**
-		 *\english
+		 *\~english
 		 *\return		The allocation statistics.
-		 *\french
+		 *\~french
 		 *\return		Les statistiques d'allocation.
 		 */
 		C3D_API castor::Vector< castor::Pair< MemChunk, castor::String > > listAllocations()const;

diff --git a/include/Core/Castor3D/Material/Pass/Component/PassComponent.hpp b/include/Core/Castor3D/Material/Pass/Component/PassComponent.hpp
@@ -229,6 +229,8 @@ namespace castor3d
 			*	The surface.
 			*\param[in] camera
 			*	The camera data.
+			*\param[in] model
+			*	The model data.
 			*\param[in] utils
 			*	The utility functions.
 			*\param[in,out] components
@@ -239,6 +241,8 @@ namespace castor3d
 			*	La surface.
 			*\param[in] camera
 			*	Les données de la caméra.
+			*\param[in] model
+			*	Les données du modèle.
 			*\param[in] utils
 			*	Les fonctions utilitaires.
 			*\param[in,out] components

diff --git a/include/Core/Castor3D/Scene/SceneNode.hpp b/include/Core/Castor3D/Scene/SceneNode.hpp
@@ -33,21 +33,11 @@ namespace castor3d
 		 *\~english
 		 *\brief		Constructor
 		 *\param[in]	name		The node's name.
-		 *\param[in]	scene		The parent scene.
-		 *\param[in]	parent		The parent node.
-		 *\param[in]	position	The initial position.
-		 *\param[in]	orientation	The initial orientation.
-		 *\param[in]	scale		The initial scale.
-		 *\param[in]	isStatic	\p true for a static node.
+		 *\param[in]	createInfo	The creation data.
 		 *\~french
 		 *\brief		Constructeur
 		 *\param[in]	name		Le nom du noeud.
-		 *\param[in]	scene		La scène parente.
-		 *\param[in]	parent		Le noeud parent.
-		 *\param[in]	position	La position initiale.
-		 *\param[in]	orientation	L'orientation initiale.
-		 *\param[in]	scale		L'échelle initiale.
-		 *\param[in]	isStatic	\p true pour un noeud statique.
+		 *\param[in]	createInfo	Les données de création.
 		 */
 		C3D_API SceneNode( castor::String const & name
 			, SceneNodeCreateInfo const & createInfo );

diff --git a/source/Core/Castor3D/CMakeLists.txt b/source/Core/Castor3D/CMakeLists.txt
@@ -4,7 +4,7 @@ set( ${PROJECT_NAME}_DESCRIPTION "Castor3D Core engine" )
 set( ${PROJECT_NAME}_BRIEF "Multiplatform 3D engine" )
 set( ${PROJECT_NAME}_ICON "${CMAKE_SOURCE_DIR}/data/Images/castor-small.png" )
 set( ${PROJECT_NAME}_VERSION_MAJOR 0 )
-set( ${PROJECT_NAME}_VERSION_MINOR 16 )
+set( ${PROJECT_NAME}_VERSION_MINOR 17 )
 set( ${PROJECT_NAME}_VERSION_BUILD 0 )
 
 if ( NOT DEFINED CASTOR_USE_WEIGHED_BLENDED_OIT )

diff --git a/source/Core/CastorUtils/CMakeLists.txt b/source/Core/CastorUtils/CMakeLists.txt
@@ -37,7 +37,7 @@ set( ${PROJECT_NAME}_DESCRIPTION "${MAIN_PROJECT_NAME} Utils" )
 set( ${PROJECT_NAME}_BRIEF "Multiplatform utilities library" )
 set( ${PROJECT_NAME}_ICON "${CMAKE_SOURCE_DIR}/data/Images/castor-dark-small.png" )
 set( ${PROJECT_NAME}_VERSION_MAJOR 0 )
-set( ${PROJECT_NAME}_VERSION_MINOR 16 )
+set( ${PROJECT_NAME}_VERSION_MINOR 17 )
 set( ${PROJECT_NAME}_VERSION_BUILD 0 )
 
 if ( ZLIB_FOUND AND FreeType_FOUND )

diff --git a/source/Core/SceneExporter/CMakeLists.txt b/source/Core/SceneExporter/CMakeLists.txt
@@ -9,7 +9,7 @@ set( ${PROJECT_NAME}_DESCRIPTION "${MAIN_PROJECT_NAME} scene exporter" )
 set( ${PROJECT_NAME}_BRIEF "Scene exporter for Castor3D" )
 set( ${PROJECT_NAME}_ICON "${CMAKE_SOURCE_DIR}/data/Images/castor-dark-small.png" )
 set( ${PROJECT_NAME}_VERSION_MAJOR 0 )
-set( ${PROJECT_NAME}_VERSION_MINOR 7 )
+set( ${PROJECT_NAME}_VERSION_MINOR 8 )
 set( ${PROJECT_NAME}_VERSION_BUILD 0 )
 
 set( ${PROJECT_NAME}_HDR_FILES

diff --git a/source/Plugins/Generators/DiamondSquareTerrain/CMakeLists.txt b/source/Plugins/Generators/DiamondSquareTerrain/CMakeLists.txt
@@ -9,7 +9,7 @@ set( Castor3DBinsDependencies
 
 set( ${PROJECT_NAME}_DESCRIPTION "Castor3D diamond-square terrain generation" )
 set( ${PROJECT_NAME}_VERSION_MAJOR 0 )
-set( ${PROJECT_NAME}_VERSION_MINOR 6 )
+set( ${PROJECT_NAME}_VERSION_MINOR 7 )
 set( ${PROJECT_NAME}_VERSION_BUILD 0 )
 
 set( PROJECT_VERSION "${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}" )

diff --git a/source/Plugins/Generic/AnisotropicMaterial/CMakeLists.txt b/source/Plugins/Generic/AnisotropicMaterial/CMakeLists.txt
@@ -9,7 +9,7 @@ set( Castor3DBinsDependencies
 
 set( ${PROJECT_NAME}_DESCRIPTION "Anisotropic material for Castor3D" )
 set( ${PROJECT_NAME}_VERSION_MAJOR 0 )
-set( ${PROJECT_NAME}_VERSION_MINOR 1 )
+set( ${PROJECT_NAME}_VERSION_MINOR 2 )
 set( ${PROJECT_NAME}_VERSION_BUILD 0 )
 
 set( PROJECT_VERSION "${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}" )

diff --git a/source/Plugins/Generic/AtmosphereScattering/CMakeLists.txt b/source/Plugins/Generic/AtmosphereScattering/CMakeLists.txt
@@ -9,7 +9,7 @@ set( Castor3DBinsDependencies
 
 set( ${PROJECT_NAME}_DESCRIPTION "Atmosphere scattering" )
 set( ${PROJECT_NAME}_VERSION_MAJOR 0 )
-set( ${PROJECT_NAME}_VERSION_MINOR 4 )
+set( ${PROJECT_NAME}_VERSION_MINOR 5 )
 set( ${PROJECT_NAME}_VERSION_BUILD 0 )
 
 set( PROJECT_VERSION "${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}" )

diff --git a/source/Plugins/Generic/FFTOceanRendering/CMakeLists.txt b/source/Plugins/Generic/FFTOceanRendering/CMakeLists.txt
@@ -17,7 +17,7 @@ if ( CASTOR_USE_GLSLANG AND VKFFT_INCLUDE_DIRS )
 
 	set( ${PROJECT_NAME}_DESCRIPTION "FFT Ocean rendering for Castor3D" )
 	set( ${PROJECT_NAME}_VERSION_MAJOR 0 )
-	set( ${PROJECT_NAME}_VERSION_MINOR 5 )
+	set( ${PROJECT_NAME}_VERSION_MINOR 6 )
 	set( ${PROJECT_NAME}_VERSION_BUILD 0 )
 
 	set( PROJECT_VERSION "${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}" )

diff --git a/source/Plugins/Generic/ToonMaterial/CMakeLists.txt b/source/Plugins/Generic/ToonMaterial/CMakeLists.txt
@@ -9,7 +9,7 @@ set( Castor3DBinsDependencies
 
 set( ${PROJECT_NAME}_DESCRIPTION "Toon material for Castor3D" )
 set( ${PROJECT_NAME}_VERSION_MAJOR 0 )
-set( ${PROJECT_NAME}_VERSION_MINOR 5 )
+set( ${PROJECT_NAME}_VERSION_MINOR 6 )
 set( ${PROJECT_NAME}_VERSION_BUILD 0 )
 
 set( PROJECT_VERSION "${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}" )

diff --git a/source/Plugins/Generic/WaterMaterial/CMakeLists.txt b/source/Plugins/Generic/WaterMaterial/CMakeLists.txt
@@ -9,7 +9,7 @@ set( Castor3DBinsDependencies
 
 set( ${PROJECT_NAME}_DESCRIPTION "Water rendering for Castor3D" )
 set( ${PROJECT_NAME}_VERSION_MAJOR 0 )
-set( ${PROJECT_NAME}_VERSION_MINOR 1 )
+set( ${PROJECT_NAME}_VERSION_MINOR 2 )
 set( ${PROJECT_NAME}_VERSION_BUILD 0 )
 
 set( PROJECT_VERSION "${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}" )

diff --git a/source/Plugins/Generic/WavesRendering/CMakeLists.txt b/source/Plugins/Generic/WavesRendering/CMakeLists.txt
@@ -9,7 +9,7 @@ set( Castor3DBinsDependencies
 
 set( ${PROJECT_NAME}_DESCRIPTION "Waves rendering for Castor3D" )
 set( ${PROJECT_NAME}_VERSION_MAJOR 0 )
-set( ${PROJECT_NAME}_VERSION_MINOR 1 )
+set( ${PROJECT_NAME}_VERSION_MINOR 2 )
 set( ${PROJECT_NAME}_VERSION_BUILD 0 )
 
 set( PROJECT_VERSION "${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}" )

diff --git a/source/Plugins/Importers/AssimpImporter/CMakeLists.txt b/source/Plugins/Importers/AssimpImporter/CMakeLists.txt
@@ -45,7 +45,7 @@ if( assimp_FOUND )
 
 	set( ${PROJECT_NAME}_DESCRIPTION "Assimp powered importer" )
 	set( ${PROJECT_NAME}_VERSION_MAJOR 0 )
-	set( ${PROJECT_NAME}_VERSION_MINOR 10 )
+	set( ${PROJECT_NAME}_VERSION_MINOR 11 )
 	set( ${PROJECT_NAME}_VERSION_BUILD 0 )
 
 	set( PROJECT_VERSION "${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}" )

diff --git a/source/Plugins/Importers/GltfImporter/CMakeLists.txt b/source/Plugins/Importers/GltfImporter/CMakeLists.txt
@@ -19,7 +19,7 @@ if( fastgltf_FOUND )
 
 	set( ${PROJECT_NAME}_DESCRIPTION "fastgltf powered importer" )
 	set( ${PROJECT_NAME}_VERSION_MAJOR 0 )
-	set( ${PROJECT_NAME}_VERSION_MINOR 1 )
+	set( ${PROJECT_NAME}_VERSION_MINOR 2 )
 	set( ${PROJECT_NAME}_VERSION_BUILD 0 )
 
 	set( PROJECT_VERSION "${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}" )

diff --git a/source/Plugins/Particles/FireworksParticle/CMakeLists.txt b/source/Plugins/Particles/FireworksParticle/CMakeLists.txt
@@ -9,8 +9,8 @@ set( Castor3DBinsDependencies
 
 set( ${PROJECT_NAME}_DESCRIPTION "Fireworks Particle" )
 set( ${PROJECT_NAME}_VERSION_MAJOR 0 )
-set( ${PROJECT_NAME}_VERSION_MINOR 4 )
-set( ${PROJECT_NAME}_VERSION_BUILD 1 )
+set( ${PROJECT_NAME}_VERSION_MINOR 5 )
+set( ${PROJECT_NAME}_VERSION_BUILD 0 )
 
 set( PROJECT_VERSION "${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}" )
 set( PROJECT_SOVERSION "${${PROJECT_NAME}_VERSION_BUILD}" )

diff --git a/source/Plugins/PostEffects/BloomPostEffect/CMakeLists.txt b/source/Plugins/PostEffects/BloomPostEffect/CMakeLists.txt
@@ -9,7 +9,7 @@ set( Castor3DBinsDependencies
 
 set( ${PROJECT_NAME}_DESCRIPTION "HDR Bloom Post Effect" )
 set( ${PROJECT_NAME}_VERSION_MAJOR 0 )
-set( ${PROJECT_NAME}_VERSION_MINOR 8 )
+set( ${PROJECT_NAME}_VERSION_MINOR 9 )
 set( ${PROJECT_NAME}_VERSION_BUILD 0 )
 
 set( PROJECT_VERSION "${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}" )

diff --git a/source/Plugins/PostEffects/DepthOfFieldPostEffect/CMakeLists.txt b/source/Plugins/PostEffects/DepthOfFieldPostEffect/CMakeLists.txt
@@ -9,7 +9,7 @@ set( Castor3DBinsDependencies
 
 set( ${PROJECT_NAME}_DESCRIPTION "Depth Of Field Post Effect" )
 set( ${PROJECT_NAME}_VERSION_MAJOR 0 )
-set( ${PROJECT_NAME}_VERSION_MINOR 1 )
+set( ${PROJECT_NAME}_VERSION_MINOR 2 )
 set( ${PROJECT_NAME}_VERSION_BUILD 0 )
 
 set( PROJECT_VERSION "${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}" )