Documentation for module: Graphics

Former-commit-id: 1757c33318443aade1dc38e16d053240d7dc885c

src/Nazara/Graphics/TextureBackground.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::TextureBackground
+	* \brief Graphics class that represents a background with a texture
+	*/
+
+	/*!
+	* \brief Constructs a TextureBackground object with a texture
+	*
+	* \param texture Texture
+	*/
+
 	TextureBackground::TextureBackground(TextureRef texture)
 	{
 		m_uberShader = UberShaderLibrary::Get("Basic");
@@ -43,6 +60,12 @@ namespace Nz
 		SetTexture(std::move(texture));
 	}
 
+	/*!
+	* \brief Draws this relatively to the viewer
+	*
+	* \param viewer Viewer for the background
+	*/
+
 	void TextureBackground::Draw(const AbstractViewer* viewer) const
 	{
 		NazaraUnused(viewer);
@@ -62,6 +85,11 @@ namespace Nz
 		Renderer::DrawFullscreenQuad();
 	}
 
+	/*!
+	* \brief Gets the background type
+	* \return Type of background
+	*/
+
 	BackgroundType TextureBackground::GetBackgroundType() const
 	{
 		return BackgroundType_Texture;