Documentation for module: Graphics

Former-commit-id: 1757c33318443aade1dc38e16d053240d7dc885c

include/Nazara/Graphics/InstancedRenderable.inl

@@ -4,6 +4,12 @@
 
 namespace Nz
 {
+	/*!
+	* \brief Constructs a InstancedRenderable object by assignation
+	*
+	* \param renderable InstancedRenderable to copy into this
+	*/
+
 	inline InstancedRenderable::InstancedRenderable(const InstancedRenderable& renderable) :
 	RefCounted(),
 	m_boundingVolume(renderable.m_boundingVolume),
@@ -11,22 +17,43 @@ namespace Nz
 	{
 	}
 
+	/*!
+	* \brief Ensures that the bounding volume is up to date
+	*/
+
 	inline void InstancedRenderable::EnsureBoundingVolumeUpdated() const
 	{
 		if (!m_boundingVolumeUpdated)
 			UpdateBoundingVolume();
 	}
 
+	/*!
+	* \brief Invalidates the bounding volume
+	*/
+
 	inline void InstancedRenderable::InvalidateBoundingVolume()
 	{
 		m_boundingVolumeUpdated = false;
 	}
 
+	/*!
+	* \brief Invalidates the instance data based on flags
+	*
+	* \param flags Flags to invalidate
+	*/
+
 	inline void InstancedRenderable::InvalidateInstanceData(UInt32 flags)
 	{
 		OnInstancedRenderableInvalidateData(this, flags);
 	}
 
+	/*!
+	* \brief Sets the current instanced renderable with the content of the other one
+	* \return A reference to this
+	*
+	* \param renderable The other InstancedRenderable
+	*/
+
 	inline InstancedRenderable& InstancedRenderable::operator=(const InstancedRenderable& renderable)
 	{
 		m_boundingVolume = renderable.m_boundingVolume;
@@ -35,6 +62,10 @@ namespace Nz
 		return *this;
 	}
 
+	/*!
+	* \brief Updates the bounding volume
+	*/
+
 	inline void InstancedRenderable::UpdateBoundingVolume() const
 	{
 		MakeBoundingVolume();