Mesa (master): mesa: add some comments about mipmap generation

[Brian Paul]

Module: Mesa
Branch: master
Commit: c55e3e6811413ce5c3aabfcf8dfcf5eb8a53499e
URL:    http://cgit.freedesktop.org/mesa/mesa/commit/?id=c55e3e6811413ce5c3aabfcf8dfcf5eb8a53499e

Author: Brian Paul <brianp at vmware.com>
Date:   Fri Jan 31 17:38:35 2014 -0700

mesa: add some comments about mipmap generation

Trivial.

---

 src/mesa/main/dd.h       |    4 ++++
 src/mesa/main/fbobject.c |    5 +++++
 2 files changed, 9 insertions(+)

diff --git a/src/mesa/main/dd.h b/src/mesa/main/dd.h
index e96cf3a..0b2b84a 100644
--- a/src/mesa/main/dd.h
+++ b/src/mesa/main/dd.h
@@ -256,6 +256,10 @@ struct dd_function_table {
 
    /**
     * Called by glGenerateMipmap() or when GL_GENERATE_MIPMAP_SGIS is enabled.
+    * Note that if the texture is a cube map, the <target> parameter will
+    * indicate which cube face to generate (GL_POSITIVE/NEGATIVE_X/Y/Z).
+    * texObj->BaseLevel is the level from which to generate the remaining
+    * mipmap levels.
     */
    void (*GenerateMipmap)(struct gl_context *ctx, GLenum target,
                           struct gl_texture_object *texObj);
diff --git a/src/mesa/main/fbobject.c b/src/mesa/main/fbobject.c
index f63ed8c..b5b55fc 100644
--- a/src/mesa/main/fbobject.c
+++ b/src/mesa/main/fbobject.c
@@ -2977,6 +2977,11 @@ invalid_pname_enum:
 }
 
 
+/**
+ * Generate all the mipmap levels below the base level.
+ * Note: this GL function would be more useful if one could specify a
+ * cube face, a set of array slices, etc.
+ */
 void GLAPIENTRY
 _mesa_GenerateMipmap(GLenum target)
 {