mesa: add a few comments for the z unpacking functions
authorBrian Paul <brianp@vmware.com>
Fri, 16 Dec 2011 15:44:42 +0000 (08:44 -0700)
committerBrian Paul <brianp@vmware.com>
Fri, 16 Dec 2011 15:44:42 +0000 (08:44 -0700)
src/mesa/main/format_unpack.c

index 4f23f3d..32d198c 100644 (file)
@@ -1822,6 +1822,10 @@ unpack_float_z_Z32X24S8(GLuint n, const void *src, GLfloat *dst)
 
 
 
+/**
+ * Unpack Z values.
+ * The returned values will always be in the range [0.0, 1.0].
+ */
 void
 _mesa_unpack_float_z_row(gl_format format, GLuint n,
                          const void *src, GLfloat *dst)
@@ -1901,6 +1905,10 @@ unpack_uint_z_Z32(const void *src, GLuint *dst, GLuint n)
 }
 
 
+/**
+ * Unpack Z values.
+ * The returned values will always be in the range [0, 0xffffffff].
+ */
 void
 _mesa_unpack_uint_z_row(gl_format format, GLuint n,
                         const void *src, GLuint *dst)