From: Brian Paul <brianp@vmware.com>
Date: Fri, 21 Jun 2013 19:25:42 +0000 (-0600)
Subject: gallium/docs: more documentation for pipe_resource::array_size
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=a415aa9489270dcda616dc8e9fd01d9c0f3a4678;p=mesa.git

gallium/docs: more documentation for pipe_resource::array_size

It should never be zero and for cube/cube_arrays it should be a
multiple of six.

Reviewed-by: Roland Scheidegger <sroland@vmware.com>
---

diff --git a/src/gallium/docs/source/resources.rst b/src/gallium/docs/source/resources.rst
index 553e335dcf9..56a86d6cfca 100644
--- a/src/gallium/docs/source/resources.rst
+++ b/src/gallium/docs/source/resources.rst
@@ -85,6 +85,7 @@ PIPE_TEXTURE_1D / PIPE_TEXTURE_1D_ARRAY
       width must be a power of two
 - height0 must be 1
 - depth0 must be 1
+- array_size must be 1 for PIPE_TEXTURE_1D
 - Mipmaps can be used
 - Must use normalized coordinates
 
@@ -99,6 +100,7 @@ PIPE_TEXTURE_RECT
 2D surface with OpenGL GL_TEXTURE_RECTANGLE semantics.
 
 - depth0 must be 1
+- array_size must be 1
 - last_level must be 0
 - Must use unnormalized coordinates
 - Must use a clamp wrap mode
@@ -117,6 +119,7 @@ PIPE_TEXTURE_2D / PIPE_TEXTURE_2D_ARRAY
 - If PIPE_CAP_NPOT_TEXTURES is not supported,
       width and height must be powers of two
 - depth0 must be 1
+- array_size must be 1 for PIPE_TEXTURE_2D
 - Mipmaps can be used
 - Must use normalized coordinates
 - No special restrictions on wrap modes
@@ -139,6 +142,7 @@ Mipmap dimensions are reduced in all 3 coordinates.
 
 - If PIPE_CAP_NPOT_TEXTURES is not supported,
       width, height and depth must be powers of two
+- array_size must be 1
 - Must use normalized coordinates
 
 OpenGL: GL_TEXTURE_3D in GL 1.2 or GL_EXT_texture3D
@@ -161,6 +165,8 @@ Sampling may be optionally seamless if a driver supports it (PIPE_CAP_SEAMLESS_C
 resulting in filtering taking samples from multiple surfaces near to the edge.
 
 - Width and height must be equal
+- depth0 must be 1
+- array_size must be a multiple of 6
 - If PIPE_CAP_NPOT_TEXTURES is not supported,
       width and height must be powers of two
 - Must use normalized coordinates