util: Document the meaning of util_format_layout.
authorJosé Fonseca <jfonseca@vmware.com>
Wed, 9 Dec 2009 10:59:38 +0000 (10:59 +0000)
committerJosé Fonseca <jfonseca@vmware.com>
Wed, 9 Dec 2009 11:00:26 +0000 (11:00 +0000)
commit59f6af51b858340139fe2139e2698fef8a5ad62f
tree650a9d24d85d725311d190b4d000f73efc9a1832
parent47c780180b888e115b630cd940fe9c29dd53b4c5
util: Document the meaning of util_format_layout.

The util_format_layout name was unfortunate and there
are  as been a lot of confusion due to this. Hopefully
this will shed some light on what it was meant for.

Bottom line is: do not rely on these values unless
you're automatically code generating pixel
packing/unpacking routines.

Suggestions for better names than util_format_layout
are welcome!
src/gallium/auxiliary/util/u_format.h