Documentation for module: Graphics

Former-commit-id: 1757c33318443aade1dc38e16d053240d7dc885c

src/Nazara/Graphics/DeferredRenderPass.cpp

@@ -9,6 +9,16 @@
 
 namespace Nz
 {
+	/*!
+	* \ingroup graphics
+	* \class Nz::DeferredRenderPass
+	* \brief Graphics class that represents the pass for rendering in deferred rendering
+	*/
+
+	/*!
+	* \brief Constructs a DeferredRenderPass object by default
+	*/
+
 	DeferredRenderPass::DeferredRenderPass() :
 	m_enabled(true)
 	{
@@ -16,11 +26,23 @@ namespace Nz
 
 	DeferredRenderPass::~DeferredRenderPass() = default;
 
+	/*!
+	* \brief Enables the deferred rendering
+	*
+	* \param enable Should deferred rendering be activated
+	*/
+
 	void DeferredRenderPass::Enable(bool enable)
 	{
 		m_enabled = enable;
 	}
 
+	/*!
+	* \brief Initializes the deferred forward pass which needs the deferred technique
+	*
+	* \param technique Rendering technique
+	*/
+
 	void DeferredRenderPass::Initialize(DeferredRenderTechnique* technique)
 	{
 		m_deferredTechnique = technique;
@@ -37,11 +59,23 @@ namespace Nz
 			m_workTextures[i] = technique->GetWorkTexture(i);
 	}
 
+	/*!
+	* \brief Checks whether the deferred rendering is enabled
+	* \return true If it the case
+	*/
+
 	bool DeferredRenderPass::IsEnabled() const
 	{
 		return m_enabled;
 	}
 
+	/*!
+	* \brief Resizes the texture sizes
+	* \return true If successful
+	*
+	* \param dimensions Dimensions for the compute texture
+	*/
+
 	bool DeferredRenderPass::Resize(const Vector2ui& dimensions)
 	{
 		m_dimensions = dimensions;