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