Add missing Requires.private and Libs.private to vapoursynth.pc.in.
[vapoursynth-svn.git] / doc / functions / loadpluginavs.rst
blobddb1b3ce3e01f50ca05ee4020aa2897efa60e64b
1 LoadPlugin (Avisynth Compatibility)
2 ===================================
4 .. function::   LoadPlugin(string path)
5    :module: avs
6    
7    Load an Avisynth plugin. If successful the loaded plugin's functions will end up in the avs namespace.
8    
9    The compatibility module can work with a large number of Avisynth's plugins. However, the wrapping is not complete, so the following things will cause problems:
10       * The plugin tries to call env->invoke().
11         These calls are ignored when it is safe to do so, but otherwise they will most likely trigger a fatal error.
12       * Plugins trying to read global variables.
13         There are no global variables.
14       * Plugins that use packed RGB24 input/output.
15         Nobody used it anyway.
16       * May deadlock when the Avisynth compatibility module does not have a prefetch list.
17         Can be worked around by increasing the number of threads used if it deadlocks.
18    
19    Returns an error if there are function name collisions.
21    Watch out for escape characters::
23       # Causes an error because \ is Python's escape character
24       LoadPlugin(path='c:\plugins\filter.dll')
25       # The correct way(s)
26       LoadPlugin(path='c:/plugins/filter.dll')
27       LoadPlugin(path=r'c:\plugins\filter.dll')
28       LoadPlugin(path='c:\\plugins\\filter.dll')