Documentation for module: Graphics

Former-commit-id: 1757c33318443aade1dc38e16d053240d7dc885c

src/Nazara/Graphics/ColorBackground.cpp

@@ -11,6 +11,11 @@ namespace Nz
 {
 	namespace
 	{
+		/*!
+		* \brief Defines render states
+		* \return RenderStates for the color background
+		*/
+
 		RenderStates BuildRenderStates()
 		{
 			RenderStates states;
@@ -24,6 +29,18 @@ namespace Nz
 		}
 	}
 
+	/*!
+	* \ingroup graphics
+	* \class Nz::ColorBackground
+	* \brief Graphics class that represents a background with uniform color
+	*/
+
+	/*!
+	* \brief Constructs a ColorBackground object with a color
+	*
+	* \param color Uniform color (by default Black)
+	*/
+
 	ColorBackground::ColorBackground(const Color& color) :
 	m_color(color)
 	{
@@ -38,6 +55,12 @@ namespace Nz
 		m_vertexDepthUniform = shader->GetUniformLocation("VertexDepth");
 	}
 
+	/*!
+	* \brief Draws this relatively to the viewer
+	*
+	* \param viewer Viewer for the background
+	*/
+
 	void ColorBackground::Draw(const AbstractViewer* viewer) const
 	{
 		NazaraUnused(viewer);
@@ -55,16 +78,32 @@ namespace Nz
 		Renderer::DrawFullscreenQuad();
 	}
 
+	/*!
+	* \brief Gets the background type
+	* \return Type of background
+	*/
+
 	BackgroundType ColorBackground::GetBackgroundType() const
 	{
 		return BackgroundType_Color;
 	}
 
+	/*!
+	* \brief Gets the color of the background
+	* \return Background color
+	*/
+
 	Color ColorBackground::GetColor() const
 	{
 		return m_color;
 	}
 
+	/*!
+	* \brief Sets the color of the background
+	*
+	* \param color Background color
+	*/
+
 	void ColorBackground::SetColor(const Color& color)
 	{
 		m_color = color;