Move documentation of sws_getCachedContext() from swscale.c to

swscale.h.


git-svn-id: svn://svn.mplayerhq.hu/mplayer/trunk@28523 b3059339-0415-0410-9bf9-f77b7e298cf2

1 files changed, 10 insertions, 0 deletions

diff --git a/libswscale/swscale.h b/libswscale/swscale.h
index 53e4489fdf..dbc1cd5c0e 100644
--- a/libswscale/swscale.h
+++ b/libswscale/swscale.h
@@ -149,6 +149,16 @@ SwsFilter *sws_getDefaultFilter(float lumaGBlur, float chromaGBlur,
                                 int verbose);
 void sws_freeFilter(SwsFilter *filter);
 
+/**
+ * Checks if context is valid or reallocs a new one instead.
+ * If context is NULL, just calls sws_getContext() to get a new one.
+ * Otherwise, checks if the parameters are the ones already saved in context.
+ * If that is the case, returns the current context.
+ * Otherwise, frees context and gets a new one.
+ *
+ * Be warned that srcFilter, dstFilter are not checked, they are
+ * asumed to remain valid.
+ */
 struct SwsContext *sws_getCachedContext(struct SwsContext *context,
                                         int srcW, int srcH, enum PixelFormat srcFormat,
                                         int dstW, int dstH, enum PixelFormat dstFormat, int flags,