mesa: update comments for _mesa_format_matches_format_and_type(), 80-column wrapping
authorBrian Paul <brianp@vmware.com>
Tue, 29 Nov 2011 01:09:14 +0000 (18:09 -0700)
committerBrian Paul <brianp@vmware.com>
Tue, 29 Nov 2011 01:10:30 +0000 (18:10 -0700)
src/mesa/main/formats.c

index c88464641a98a4d0eaec50f6e03f0a3e80751cb8..d3b12d008f140152a3c84369accecae6a9cd5765 100644 (file)
@@ -2480,11 +2480,12 @@ _mesa_format_to_type_and_comps(gl_format format,
 }
 
 /**
- * Returns a MESA_FORMAT describing pixels with the given format/type if
- * available, or MESA_FORMAT_NONE.
+ * Check if a gl_format exactly matches a GL formaat/type combination
+ * such that we can use memcpy() from one to the other.
  *
- * If a format is returned, it should be suitable to memcpy
- * _mesa_get_format_bytes() at a time to move the pixel data.
+ * Note: this matching assumes that GL_PACK/UNPACK_SWAP_BYTES is unset.
+ *
+ * \return GL_TRUE if the formats match, GL_FALSE otherwise.
  */
 GLboolean
 _mesa_format_matches_format_and_type(gl_format gl_format,
@@ -2494,13 +2495,11 @@ _mesa_format_matches_format_and_type(gl_format gl_format,
 
    /* Note: When reading a GL format/type combination, the format lists channel
     * assignments from most significant channel in the type to least
-    * significant.  A type with _REV indicates that the assignments are swapped,
-    * so they are listed from least significant to most significant.
-    *
-    * For sanity, please keep this switch statement ordered the same as the enum
-    * in formats.h.
+    * significant.  A type with _REV indicates that the assignments are
+    * swapped, so they are listed from least significant to most significant.
     *
-    * This matching assumes that GL_PACK/UNPACK_SWAP_BYTES is unset.
+    * For sanity, please keep this switch statement ordered the same as the
+    * enums in formats.h.
     */
 
    switch (gl_format) {