gallium/docs: fix up transfer description for 1d arrays, add cube map arrays
authorRoland Scheidegger <sroland@vmware.com>
Fri, 7 Jun 2013 18:54:54 +0000 (20:54 +0200)
committerRoland Scheidegger <sroland@vmware.com>
Fri, 7 Jun 2013 19:15:01 +0000 (21:15 +0200)
Transfers always use z/depth for layers no matter if it's a 1d or 2d array
texture, we don't follow OpenGL's crazyness there. Luckily this appears to
only be a doc bug, everyone doing the right thing already.
While here also document z/depth parameter for cube map arrays.

v2: fix typo spotted by Eric Anholt

Reviewed-by: Jose Fonseca <jfonseca@vmware.com>
src/gallium/docs/source/context.rst

index 679772fae817017908313ad6261ad44820d9550f..6a8238e77799a450e863f366013b73b910de3bd6 100644 (file)
@@ -472,15 +472,14 @@ The box parameter to some of these functions defines a 1D, 2D or 3D
 region of pixels.  This is self-explanatory for 1D, 2D and 3D texture
 targets.
 
-For PIPE_TEXTURE_1D_ARRAY, the box::y and box::height fields refer to the
-array dimension of the texture.
-
-For PIPE_TEXTURE_2D_ARRAY, the box::z and box::depth fields refer to the
-array dimension of the texture.
+For PIPE_TEXTURE_1D_ARRAY and PIPE_TEXTURE_2D_ARRAY, the box::z and box::depth
+fields refer to the array dimension of the texture.
 
 For PIPE_TEXTURE_CUBE, the box:z and box::depth fields refer to the
 faces of the cube map (z + depth <= 6).
 
+For PIPE_TEXTURE_CUBE_ARRAY, the box:z and box::depth fields refer to both
+the face and array dimension of the texture (face = z % 6, array = z / 6).
 
 
 .. _transfer_flush_region: