From: Eric Anholt <eric@anholt.net>
Date: Fri, 19 Apr 2013 20:57:17 +0000 (-0700)
Subject: mesa: Add a clarifying comment about rowStride of compressed textures.
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=0e8ef74c5f0799f3270654f1e569905a585aa1d4;p=mesa.git

mesa: Add a clarifying comment about rowStride of compressed textures.

I always forget how we do this for compressed textures.

Reviewed-by: Kenneth Graunke <kenneth@whitecape.org>
Reviewed-by: Brian Paul <brianp@vmware.com>
---

diff --git a/src/mesa/main/dd.h b/src/mesa/main/dd.h
index 76411b31e5a..1e5aca13a48 100644
--- a/src/mesa/main/dd.h
+++ b/src/mesa/main/dd.h
@@ -355,7 +355,9 @@ struct dd_function_table {
     * \param mode  bitmask of GL_MAP_READ_BIT, GL_MAP_WRITE_BIT and
     *              GL_MAP_INVALIDATE_RANGE_BIT (if writing)
     * \param mapOut  returns start of mapping of region of interest
-    * \param rowStrideOut  returns row stride (in bytes)
+    * \param rowStrideOut returns row stride (in bytes).  In the case of a
+    * compressed texture, this is the byte stride between one row of blocks
+    * and another.
     */
    void (*MapTextureImage)(struct gl_context *ctx,
 			   struct gl_texture_image *texImage,