changeset 29762:bb26e1db5c90

Document slice ordering assumption done by sws_scale().
author stefano
date Fri, 30 Oct 2009 14:13:25 +0000
parents b5e34617a096
children 752432ff3360
files libswscale/swscale.h
diffstat 1 files changed, 5 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/libswscale/swscale.h	Fri Oct 30 10:03:54 2009 +0000
+++ b/libswscale/swscale.h	Fri Oct 30 14:13:25 2009 +0000
@@ -135,7 +135,11 @@
 /**
  * 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()