Documentation for module: Graphics

Former-commit-id: 1757c33318443aade1dc38e16d053240d7dc885c

src/Nazara/Graphics/DeferredForwardPass.cpp

@@ -13,9 +13,21 @@
 
 namespace Nz
 {
+	/*!
+	* \ingroup graphics
+	* \class Nz::DeferredForwardPass
+	* \brief Graphics class that represents the forward pass in deferred rendering
+	*/
+
 	DeferredForwardPass::DeferredForwardPass() = default;
 	DeferredForwardPass::~DeferredForwardPass() = default;
 
+	/*!
+	* \brief Initializes the deferred forward pass which needs the forward technique
+	*
+	* \param technique Rendering technique
+	*/
+
 	void DeferredForwardPass::Initialize(DeferredRenderTechnique* technique)
 	{
 		DeferredRenderPass::Initialize(technique);
@@ -23,7 +35,16 @@ namespace Nz
 		m_forwardTechnique = technique->GetForwardTechnique();
 	}
 
-	bool DeferredForwardPass::Process(const SceneData& sceneData, unsigned int workTexture, unsigned sceneTexture) const
+	/*!
+	* \brief Processes the work on the data while working with textures
+	* \return true
+	*
+	* \param sceneData Data for the scene
+	* \param firstWorkTexture Index of the first texture to work with
+	* \param firstWorkTexture Index of the second texture to work with
+	*/
+
+	bool DeferredForwardPass::Process(const SceneData& sceneData, unsigned int workTexture, unsigned int sceneTexture) const
 	{
 		NazaraAssert(sceneData.viewer, "Invalid viewer");
 		NazaraUnused(workTexture);