diff rle.h @ 4768:542e4c4fc15a libavcodec

move doxy from .c to .h
author michael
date Tue, 03 Apr 2007 01:20:31 +0000
parents a3667e74f44b
children 7cd3ffe4897f
line wrap: on
line diff
--- a/rle.h	Tue Apr 03 01:01:46 2007 +0000
+++ b/rle.h	Tue Apr 03 01:20:31 2007 +0000
@@ -22,6 +22,15 @@
 #ifndef RLE_H
 #define RLE_H
 
+/**
+ * RLE compress the row, with maximum size of out_size. Value before repeated bytes is (count ^ xor) + add.
+ * @param outbuf Output buffer
+ * @param out_size Maximum output size
+ * @param ptr Input buffer
+ * @param bpp Bytes per pixel
+ * @param w Image width
+ * @return Size of output in bytes, or -1 if larger than out_size
+ */
 int ff_rle_encode(uint8_t *outbuf, int out_size, const uint8_t *inbuf, int bpp, int w, int8_t add, uint8_t xor);
 
 #endif /* RLE_H */