C++ Coding Guidelines - Revision history

Howetuft: /* Dependencies */

2026-03-14T10:26:34Z

Dependencies

← Older revision		Revision as of 12:26, 14 March 2026
Line 35:		Line 35:
	* do not rely on precompiled binaries		* do not rely on precompiled binaries
	Etc.		Etc.
	<code> LuxCoreDeps</code> builds dependencies for sources, for all platforms, based on Conan database of build recipes.It guarantees reliability, portability and sustainability.
			<code> LuxCoreDeps</code> builds dependencies for sources, for all platforms, based on Conan database of build recipes.
			It guarantees reliability, portability and sustainability.
	If you need to add a new dependency, please contact admin/dev team (on Discord, for instance, but also on Git or Forum).		If you need to add a new dependency, please contact admin/dev team (on Discord, for instance, but also on Git or Forum).

2026-03-14T10:25:44Z

Dependencies

← Older revision		Revision as of 12:25, 14 March 2026
Line 31:		Line 31:
	= Dependencies =		= Dependencies =
	Since version 2.10, a new dependency manager has been added (<code> LuxCoreDeps</code>). Other means to add dependencies are deprecated. In particular:		Since version 2.10, a new dependency manager has been added (<code> LuxCoreDeps</code>). Other means to add dependencies are deprecated. In particular:
	- do not embed external dependency source code		* do not embed external dependency source code
	- do not use git submodules		* do not use git submodules
	- do not rely on precompiled binaries		* do not rely on precompiled binaries
	Etc.		Etc.
	<code> LuxCoreDeps</code> builds dependencies for sources, for all platforms, based on Conan database of build recipes.It guarantees reliability, portability and sustainability.		<code> LuxCoreDeps</code> builds dependencies for sources, for all platforms, based on Conan database of build recipes.It guarantees reliability, portability and sustainability.

2025-05-30T11:54:41Z

Modern C++

← Older revision		Revision as of 13:54, 30 May 2025
Line 2:		Line 2:

	= Modern C++ =		= Modern C++ =
	~~In general, we thank~~ you ~~for applying~~ the best practices of "modern" C++ programming, as defined by best experts:		We ask you to enforce the best practices of "modern" C++ programming, as defined by best experts:
	https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines		https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines


			True it is that legacy code may not always comply to those recommendations, but this is no reason for new code not to enforce them.

	= Indentation =		= Indentation =

2025-05-30T11:51:51Z

← Older revision		Revision as of 13:51, 30 May 2025
Line 26:		Line 26:
	LuxCore development was started before the advent of modern C++ (C++11 and higher) and logically conceals numerous raw pointers. However, raw pointers are quite risky, particularly in terms of memory leaks, dangling pointers, pointer aliasing etc., and should be avoided now, to the benefit of smart pointers.		LuxCore development was started before the advent of modern C++ (C++11 and higher) and logically conceals numerous raw pointers. However, raw pointers are quite risky, particularly in terms of memory leaks, dangling pointers, pointer aliasing etc., and should be avoided now, to the benefit of smart pointers.

			= Dependencies =
			Since version 2.10, a new dependency manager has been added (<code> LuxCoreDeps</code>). Other means to add dependencies are deprecated. In particular:
			- do not embed external dependency source code
			- do not use git submodules
			- do not rely on precompiled binaries
			Etc.
			<code> LuxCoreDeps</code> builds dependencies for sources, for all platforms, based on Conan database of build recipes.It guarantees reliability, portability and sustainability.
			If you need to add a new dependency, please contact admin/dev team (on Discord, for instance, but also on Git or Forum).

	= Code Documentation =		= Code Documentation =

2025-05-30T11:44:10Z

← Older revision		Revision as of 13:44, 30 May 2025
Line 10:		Line 10:
	On a different note, please avoid trailing spaces.		On a different note, please avoid trailing spaces.

	== Object naming ==		= Object naming =
	LuxCore uses camelCase/CamelCase style.		LuxCore uses camelCase/CamelCase style.

2025-05-30T11:43:55Z

← Older revision		Revision as of 13:43, 30 May 2025
Line 9:		Line 9:

	On a different note, please avoid trailing spaces.		On a different note, please avoid trailing spaces.

			== Object naming ==
			LuxCore uses camelCase/CamelCase style.

			Local symbols are named with camelCase
			Global symbols are named with CamelCase.

	= Boost =		= Boost =

2025-05-30T11:40:46Z

Code Documentation

← Older revision		Revision as of 13:40, 30 May 2025
Line 22:		Line 22:

	= Code Documentation =		= Code Documentation =
	Please document your code: insert necessary information, comments etc., in order for your peers to understand what you intend to do. Your peers encompass reviewers, other developers now and in the future etc.		Please document your code: insert necessary information, comments etc., in the code in order for your peers to understand what you intend to do. "Your peers" encompass reviewers, other developers now and in the future etc.

	LuxCore relies on Doxygen to generate code documentation: use Doxygen syntax to add the necessary information in your code.		LuxCore relies on Doxygen to generate code documentation: use Doxygen syntax to add the necessary information in your code.
	Doxygen documentation can be built with <code> make doc </code>. After building, you'll find the documentation in <code> out/doc </code>.		Doxygen documentation can be built with <code> make doc </code>. After building, you'll find the documentation in <code> out/doc </code>.

2025-05-10T15:37:29Z

Modern C++

← Older revision		Revision as of 17:37, 10 May 2025
Line 2:		Line 2:

	= Modern C++ =		= Modern C++ =
	In general, we thank you for applying the best practices of "modern" C++ programming, as defined by experts:		In general, we thank you for applying the best practices of "modern" C++ programming, as defined by best experts:
	https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines		https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines

2025-05-10T15:37:00Z

Modern C++

← Older revision		Revision as of 17:37, 10 May 2025
Line 2:		Line 2:

	= Modern C++ =		= Modern C++ =
	In general, we thank you for applying the best practices of modern C++ programming, as defined by experts:		In general, we thank you for applying the best practices of "modern" C++ programming, as defined by experts:
	https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines		https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines

2025-05-10T15:35:41Z

Boost

← Older revision		Revision as of 17:35, 10 May 2025
Line 15:		Line 15:
	Since v2.10, however, this is no longer the case, as LuxCore has been ported to C++20, which offers a standard library that can largely replace Boost, with a few exceptions.		Since v2.10, however, this is no longer the case, as LuxCore has been ported to C++20, which offers a standard library that can largely replace Boost, with a few exceptions.

	~~Please~~ systematically prefer C++20 standard library over Boost whenever possible and limit Boost to cases where there is no other solution.		Therefore <i>please systematically prefer C++20 standard library over Boost whenever possible</i> and limit Boost to cases where there is no other solution.

	= Raw pointers =		= Raw pointers =