# HG changeset patch
# User stefano
# Date 1234395749 0
# Node ID 0fdb808fda4118a4b816e34934fd13b1f2af7805
# Parent  5d76e0dbe16ec56b7c11d5908edb8710ed581d02
Document sws_getContext().

diff -r 5d76e0dbe16e -r 0fdb808fda41 libswscale/swscale.h
--- a/libswscale/swscale.h	Wed Feb 11 23:11:06 2009 +0000
+++ b/libswscale/swscale.h	Wed Feb 11 23:42:29 2009 +0000
@@ -114,6 +114,19 @@
 
 void sws_freeContext(struct SwsContext *swsContext);
 
+/**
+ * Allocates and returns a SwsContext. You need it to perform
+ * scaling/conversion operations using sws_scale().
+ *
+ * @param srcW the width of the source image
+ * @param srcH the height of the source image
+ * @param srcFormat the source image format
+ * @param dstW the width of the destination image
+ * @param dstH the height of the destination image
+ * @param dstFormat the destination image format
+ * @param flags specify which algorithm and options to use for rescaling
+ * @return a pointer to an allocated context, or NULL in case of error
+ */
 struct SwsContext *sws_getContext(int srcW, int srcH, enum PixelFormat srcFormat, int dstW, int dstH, enum PixelFormat dstFormat, int flags,
                                   SwsFilter *srcFilter, SwsFilter *dstFilter, double *param);
 int sws_scale(struct SwsContext *context, uint8_t* src[], int srcStride[], int srcSliceY,