[FFmpeg-cvslog] r29804 - trunk/libswscale/swscale.h

[stefano]

Author: stefano
Date: Fri Oct 30 15:13:25 2009
New Revision: 29804

Log:
Document slice ordering assumption done by sws_scale().

Modified:
   trunk/libswscale/swscale.h

Modified: trunk/libswscale/swscale.h
==============================================================================
--- trunk/libswscale/swscale.h	Fri Oct 30 11:03:54 2009	(r29803)
+++ trunk/libswscale/swscale.h	Fri Oct 30 15:13:25 2009	(r29804)
@@ -135,7 +135,11 @@ struct SwsContext *sws_getContext(int sr
 /**
  * Scales the image slice in srcSlice and puts the resulting scaled
  * slice in the image in dst. A slice is a sequence of consecutive
- * rows in an image. Slices can be bottom to top or top to bottom.
+ * rows in an image.
+ *
+ * Slices have to be provided in sequential order, either in
+ * top-bottom or bottom-top order. If slices are provided in
+ * non-sequential order the behavior of the function is undefined.
  *
  * @param context   the scaling context previously created with
  *                  sws_getContext()