Changeset 8370 in orxonox.OLD for trunk/src/lib

Timestamp:

Jun 14, 2006, 11:12:52 AM (19 years ago)

Author:

bensch

Message:

doxy

Location:

trunk/src/lib/graphics/importer

Files:

• material.cc (modified) (13 diffs)
• material.h (modified) (1 diff)

trunk/src/lib/graphics/importer/material.cc

@@ -173 +173 @@
   return true;
 }
-
+/**
+ * @brief Deselect Material (if one is selected).
+ */
 void Material::unselect()
 {
@@ -186 +188 @@
 
 /**
- *  Sets the Material Illumination Model.
- *  illu illumination Model in int form
+ * @brief Sets the Material Illumination Model.
+ * @param illu illumination Model in int form
  */
 void Material::setIllum (int illum)
@@ -196 +198 @@
 
 /**
- *  Sets the Material Diffuse Color.
+ * @brief Sets the Material Diffuse Color.
  * @param r Red Color Channel.a
  * @param g Green Color Channel.
@@ -213 +215 @@
 
 /**
- *  Sets the Material Ambient Color.
+ * @brief Sets the Material Ambient Color.
  * @param r Red Color Channel.
  * @param g Green Color Channel.
@@ -228 +230 @@
 
 /**
- *  Sets the Material Specular Color.
+ * @brief Sets the Material Specular Color.
  * @param r Red Color Channel.
  * @param g Green Color Channel.
@@ -243 +245 @@
 
 /**
- *  Sets the Material Shininess.
+ * @brief Sets the Material Shininess.
  * @param shini stes the Shininess from float.
 */
@@ -252 +254 @@
 
 /**
- *  Sets the Material Transparency.
+ * @brief Sets the Material Transparency.
  * @param trans stes the Transparency from int.
 */
@@ -262 +264 @@
 
 /**
- *  Adds a Texture Path to the List of already existing Paths
+ * @brief Adds a Texture Path to the List of already existing Paths
  * @param pathName The Path to add.
 */
@@ -272 +274 @@
 // MAPPING //
 
+
+/**
+ * @brief Sets the Diffuse map of this Texture.
+ * @param texture The Texture to load
+ * @param textureNumber The Texture-Number from 0 to GL_MAX_TEXTURE_UNITS
+ */
 void Material::setDiffuseMap(const Texture& texture, unsigned int textureNumber)
 {
@@ -287 +295 @@
  * @brief Sets the Materials Diffuse Map
  * @param dMap the Name of the Image to Use
-*/
+ * @param textureNumber The Texture-Number from 0 to GL_MAX_TEXTURE_UNITS
+ */
 void Material::setDiffuseMap(const std::string& dMap, GLenum target, unsigned int textureNumber)
 {
@@ -313 +322 @@
 /**
  * @brief Sets the Materials Diffuse Map
- * @param surface pointer to SDL_Surface which shall be used as texture
-*/
+ * @param surface pointer to SDL_Surface which shall be used as texture.
+ * @param target the GL-Target to load the Surface to.
+ * @param textureNumber The Texture-Number from 0 to GL_MAX_TEXTURE_UNITS.
+ */
 void Material::setSDLDiffuseMap(SDL_Surface *surface, GLenum target, unsigned int textureNumber)
 {
@@ -335 +346 @@
 
 /**
- * @brief renders viewport buffer (?? or another buffer ;-)) to a texture
- * @param textureNumber select the texture unit that will be overwritten
-*/
+ * @brief Renders to a Texture.
+ * @param textureNumber The Texture-Number from 0 to GL_MAX_TEXTURE_UNITS.
+ * @param target The GL-Target.
+ * @param level the MipMap-Level to render to.
+ * @param xoffset The offset in the Source from the left.
+ * @param yoffset The offset in the Source from the top (or bottom).
+ * @param x The Offset in the Destination from the left.
+ * @param y The Offset in the Destination from the top (or bottom).
+ * @param width The width of the region to copy.
+ * @param height The height of the region to copy.
+ */
 void Material::renderToTexture(unsigned int textureNumber, GLenum target, GLint level, GLint xoffset, GLint yoffset, GLint x, GLint y, GLsizei width, GLsizei height)
 {
@@ -382 +401 @@
 
 
-
+/**
+ * @returns the Maximim Texture Unit the users OpenGL-Implementation supports.
+ */
 unsigned int Material::getMaxTextureUnits()
 {

trunk/src/lib/graphics/importer/material.h

@@ -71 +71 @@
     float            shininess;        //!< The shininess of the Material.
     float            transparency;     //!< The transperency of the Material.
-    GLenum           sFactor;
-    GLenum           tFactor;
+    GLenum           sFactor;          //!< The Blending Factor for the Source.
+    GLenum           tFactor;          //!< The Blending Factor for the Destination.
 
-    std::vector<Texture> textures;    //!< An Array of Textures.
+    std::vector<Texture> textures;     //!< An Array of Textures.
 
     Texture*         ambientTexture;   //!< The ambient texture of the Material.
     Texture*         specularTexture;  //!< The specular texture of the Material.
+};
 
-
-};
 #endif