svn merge -r 37306:39975 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / source / blender / blenpluginapi / plugin.h
1 /** \file blender/blenpluginapi/plugin.h
2  *  \ingroup blpluginapi
3  */
4 /* Copyright (c) 1999, Not a Number / NeoGeo b.v. 
5  * $Id$
6  * 
7  * All rights reserved.
8  * 
9  * Contact:      info@blender.org   
10  * Information:  http://www.blender.org
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
15  * 1. Redistributions of source code must retain the above copyright
16  *    notice, this list of conditions and the following disclaimer.
17  * 2. Redistributions in binary form must reproduce the above copyright
18  *    notice, this list of conditions and the following disclaimer in the
19  *    documentation and/or other materials provided with the distribution.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  */
33
34 #ifndef PLUGIN_H
35 #define PLUGIN_H
36
37 #include "externdef.h"
38 #include "iff.h"
39 #include "util.h"
40 #include "floatpatch.h"
41
42 #define B_PLUGIN_VERSION        6
43
44 typedef int (*TexDoit)(int, void*, float*, float*, float*, float*);
45 typedef int (*TexDoitold)(int, void*, float*, float*, float*);
46 typedef void (*SeqDoit)(void*, float, float, int, int, ImBuf*, ImBuf*, ImBuf*, ImBuf*);
47
48 typedef struct VarStruct {
49         int type;
50         char name[16];
51         float def, min, max;
52         char tip[80];
53 } VarStruct;
54
55 typedef struct _PluginInfo {
56         char *name;
57         char *snames;
58
59         int stypes;
60         int nvars;
61         VarStruct *varstr;
62         float *result;
63         float *cfra;
64
65         void (*init)(void);
66         void (*callback)(int);
67         TexDoit tex_doit;
68         SeqDoit seq_doit;
69
70         void (*instance_init)(void *);
71 } PluginInfo;
72
73 LIBEXPORT int plugin_tex_getversion(void);
74 LIBEXPORT int plugin_seq_getversion(void);
75 LIBEXPORT void plugin_getinfo(PluginInfo *);
76
77 /* *************** defines for button types ************** */
78
79 #define CHA     32
80 #define INT     96
81 #define FLO     128
82
83 #define TOG     (3<<9)
84 #define NUM     (5<<9)
85 #define LABEL   (10<<9)
86 #define NUMSLI  (14<<9)
87 #define COL     (15<<9)
88
89 /* return values (bitfield like) for textures (DNA_texture_types.h) */
90 #define TEX_INT         0
91 #define TEX_RGB         1
92 #define TEX_NOR         2
93
94 /* *************** API functions ******************** */
95
96         /* derived from the famous Perlin noise */
97 LIBIMPORT float hnoise(float noisesize, float x, float y, float z);
98         /* the original Perlin noise */
99 LIBIMPORT float hnoisep(float noisesize, float x, float y, float z);
100
101         /* soft turbulence */
102 LIBIMPORT float turbulence(float noisesize, float x, float y, float z, int depth);
103         /* hard turbulence */
104 LIBIMPORT float turbulence1(float noisesize, float x, float y, float z, int depth);
105
106 #endif /* PLUGIN_H */
107