From: Brian Paul <brianp@vmware.com>
Date: Mon, 3 May 2010 21:47:29 +0000 (-0600)
Subject: st/mesa: updated comments for st_texture_image_map()
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=fe3332da788fa3b17619b0ca9e368b2d5e77ffae;p=mesa.git

st/mesa: updated comments for st_texture_image_map()
---

diff --git a/src/mesa/state_tracker/st_texture.c b/src/mesa/state_tracker/st_texture.c
index be450084ed8..6a42789b824 100644
--- a/src/mesa/state_tracker/st_texture.c
+++ b/src/mesa/state_tracker/st_texture.c
@@ -125,10 +125,12 @@ st_texture_match_image(const struct pipe_resource *pt,
 
 
 /**
- * Map a teximage in a mipmap texture.
- * \param row_stride  returns row stride in bytes
- * \param image_stride  returns image stride in bytes (for 3D textures).
- * \return address of mapping
+ * Map a texture image and return the address for a particular 2D face/slice/
+ * layer.  The stImage indicates the cube face and mipmap level.  The slice
+ * of the 3D texture is passed in 'zoffset'.
+ * \param usage  one of the PIPE_TRANSFER_x values
+ * \param x, y, w, h  the region of interest of the 2D image.
+ * \return address of mapping or NULL if any error
  */
 GLubyte *
 st_texture_image_map(struct st_context *st, struct st_texture_image *stImage,