summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChad Versace <[email protected]>2015-12-31 12:02:04 -0800
committerChad Versace <[email protected]>2015-12-31 12:06:02 -0800
commit86ecb28ec6edd662775aa48513c013cadf4ddd6b (patch)
tree1c565e2d7cde868bbe116d9e833838dc447c4df9
parent5318424d4999b49cca84b11bc4d2eb70a7444fb8 (diff)
isl: Document some isl_surf::phys_level0_sa invariants
isl_dim_layout restricts the range of isl_surf::phys_level0_sa.
-rw-r--r--src/isl/isl.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/isl/isl.h b/src/isl/isl.h
index 22435e923b9..68d05e37186 100644
--- a/src/isl/isl.h
+++ b/src/isl/isl.h
@@ -492,12 +492,16 @@ enum isl_dim_layout {
*
* One-dimensional surfaces are identical to 2D surfaces with height of
* one.
+ *
+ * @invariant isl_surf::phys_level0_sa::depth == 1
*/
ISL_DIM_LAYOUT_GEN4_2D,
/**
* For details, see the G35 PRM >> Volume 1: Graphics Core >> Section
* 6.17.5: 3D Surfaces.
+ *
+ * @invariant isl_surf::phys_level0_sa::array_len == 1
*/
ISL_DIM_LAYOUT_GEN4_3D,