changeset 4937:a65cd5b551c2 libavcodec

add doxygen comments
author ivo
date Mon, 07 May 2007 20:07:35 +0000
parents 2e400c0e99f6
children ee6c1ce06470
files s3tc.h
diffstat 1 files changed, 16 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/s3tc.h	Mon May 07 15:44:42 2007 +0000
+++ b/s3tc.h	Mon May 07 20:07:35 2007 +0000
@@ -26,9 +26,25 @@
 #define FF_S3TC_DXT1    0x31545844
 #define FF_S3TC_DXT3    0x33545844
 
+/**
+ * Decode DXT1 encoded data to RGB32
+ * @param *src source buffer, has to be aligned on a 4-byte boundary
+ * @param *dst destination buffer
+ * @param w width of output image
+ * @param h height of output image
+ * @param stride line size of output image
+ */
 void ff_decode_dxt1(const uint8_t *src, uint8_t *dst,
                     const unsigned int w, const unsigned int h,
                     const unsigned int stride);
+/**
+ * Decode DXT3 encoded data to RGB32
+ * @param *src source buffer, has to be aligned on a 4-byte boundary
+ * @param *dst destination buffer
+ * @param w width of output image
+ * @param h height of output image
+ * @param stride line size of output image
+ */
 void ff_decode_dxt3(const uint8_t *src, uint8_t *dst,
                     const unsigned int w, const unsigned int h,
                     const unsigned int stride);