Document slice ordering assumption done by sws_scale().

Originally committed as revision 29804 to svn://svn.mplayerhq.hu/mplayer/trunk/libswscale

1 files changed, 5 insertions, 1 deletions

diff --git a/libswscale/swscale.h b/libswscale/swscale.h
index 87e64e2885..abc23fcf40 100644
--- a/libswscale/swscale.h
+++ b/libswscale/swscale.h
@@ -135,7 +135,11 @@ struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat
 /**
  * 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()