st/mesa: updated comments for st_texture_image_map()

This commit is contained in:
Brian Paul 2010-05-03 15:47:29 -06:00
parent 41b8a2e939
commit fe3332da78

View file

@ -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,