svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r21908:22075
[blender.git] / source / blender / blenpluginapi / documentation.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  *
29  * @mainpage plugin API - the access point for texture and sequence
30  * plugins
31  *
32  * @section about About the plugin API
33  *
34  * This API wraps functions that are used by texture and sequence
35  * plugins. They are explicitly wrapped in order to make the
36  * dependencies to the rest of the system clear.
37  *
38  * @section issues Known issues with the plugin API
39  *
40  * - It can be difficult at times to get access to the API functions
41  * linked into the final executable. On gcc, the -fpic and -shared
42  * flags take care of this. On Irix, -shared is needed, but you also
43  * need a reference to the function to get the handle. This has
44  * momentarily been taken care of by pluginapi_force_ref().
45  *
46  * - Plugins need to define three functions that are needed for
47  * version bookkeeping and information. The plugin loading code
48  * explicitly checks for these functions. The nanes depend on whether
49  * it is a texture or sequence plugin.
50  *
51  * - The plugin loading occurs in sequence.c and texture.c. The
52  * following functions are involved:
53  *   - open_plugin_seq() (used in readfile.c, editseq.c, sequence.c)
54  *   - add_plugin_seq()  (used in editseq.c, sequence.c)
55  *   - free_plugin_seq() (used in editseq.c, sequence.c)
56  *   - open_plugin_tex() (used in texture.c, readfile.c)
57  *   - add_plugin_tex()  (used in texture.c, buttons.c)
58  *   - free_plugin_tex() (used in texture.c, buttons.c)
59  *   - test_dlerr()      (used in texture.c, sequence.c)
60  * Since the plugins are about to phase out, we will not sanitize this
61  * code. It will be removed as soon as the replacing system is in
62  * place.
63  * 
64  * @section dependencies Dependencies
65  *
66  * The plugins wraps functions from IMB and BLI. In addition, they
67  * define some useful variables.
68  * */
69