GPencil: Add option to mix color with texture
[blender.git] / source / blender / makesdna / DNA_material_types.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup DNA
22  */
23
24 #ifndef __DNA_MATERIAL_TYPES_H__
25 #define __DNA_MATERIAL_TYPES_H__
26
27 #include "DNA_defs.h"
28 #include "DNA_ID.h"
29 #include "DNA_listBase.h"
30
31 #ifndef MAX_MTEX
32 #  define MAX_MTEX 18
33 #endif
34
35 struct AnimData;
36 struct Image;
37 struct Ipo;
38 struct bNodeTree;
39
40 /* WATCH IT: change type? also make changes in ipo.h  */
41
42 typedef struct TexPaintSlot {
43   /** Image to be painted on. */
44   struct Image *ima;
45   /** Customdata index for uv layer, MAX_NAM.E*/
46   char *uvname;
47   /** Do we have a valid image and UV map. */
48   int valid;
49   /** Copy of node inteporlation setting. */
50   int interp;
51 } TexPaintSlot;
52
53 typedef struct MaterialGPencilStyle {
54   /** Texture image for strokes. */
55   struct Image *sima;
56   /** Texture image for filling. */
57   struct Image *ima;
58   /** Color for paint and strokes (alpha included). */
59   float stroke_rgba[4];
60   /** Color that should be used for drawing "fills" for strokes (alpha included). */
61   float fill_rgba[4];
62   /** Secondary color used for gradients and other stuff. */
63   float mix_rgba[4];
64   /** Settings. */
65   short flag;
66   /** Custom index for passes. */
67   short index;
68   /** Style for drawing strokes (used to select shader type). */
69   short stroke_style;
70   /** Style for filling areas (used to select shader type). */
71   short fill_style;
72   /** Factor used to define shader behavior (several uses). */
73   float mix_factor;
74   /** Angle used for gradients orientation. */
75   float gradient_angle;
76   /** Radius for radial gradients. */
77   float gradient_radius;
78   /** Cheesboard size. */
79   float pattern_gridsize;
80   /** Uv coordinates scale. */
81   float gradient_scale[2];
82   /** Factor to shift filling in 2d space. */
83   float gradient_shift[2];
84   /** Angle used for texture orientation. */
85   float texture_angle;
86   /** Texture scale (separated of uv scale). */
87   float texture_scale[2];
88   /** Factor to shift texture in 2d space. */
89   float texture_offset[2];
90   /** Texture opacity. */
91   float texture_opacity;
92   /** Pixel size for uv along the stroke. */
93   float texture_pixsize;
94   /** Drawing mode (line or dots). */
95   int mode;
96
97   /** Type of gradient. */
98   int gradient_type;
99
100   /** Factor used to mix texture and stroke color. */
101   float mix_stroke_factor;
102 } MaterialGPencilStyle;
103
104 /* MaterialGPencilStyle->flag */
105 typedef enum eMaterialGPencilStyle_Flag {
106   /* Fill Texture is a pattern */
107   GP_STYLE_FILL_PATTERN = (1 << 0),
108   /* don't display color */
109   GP_STYLE_COLOR_HIDE = (1 << 1),
110   /* protected from further editing */
111   GP_STYLE_COLOR_LOCKED = (1 << 2),
112   /* do onion skinning */
113   GP_STYLE_COLOR_ONIONSKIN = (1 << 3),
114   /* clamp texture */
115   GP_STYLE_COLOR_TEX_CLAMP = (1 << 4),
116   /* mix fill texture */
117   GP_STYLE_FILL_TEX_MIX = (1 << 5),
118   /* Flip fill colors */
119   GP_STYLE_COLOR_FLIP_FILL = (1 << 6),
120   /* Stroke Texture is a pattern */
121   GP_STYLE_STROKE_PATTERN = (1 << 7),
122   /* Stroke show main switch */
123   GP_STYLE_STROKE_SHOW = (1 << 8),
124   /* Fill  show main switch */
125   GP_STYLE_FILL_SHOW = (1 << 9),
126   /* Don't rotate dots/boxes */
127   GP_STYLE_COLOR_LOCK_DOTS = (1 << 10),
128   /* mix stroke texture */
129   GP_STYLE_STROKE_TEX_MIX = (1 << 11),
130 } eMaterialGPencilStyle_Flag;
131
132 typedef enum eMaterialGPencilStyle_Mode {
133   GP_STYLE_MODE_LINE = 0, /* line */
134   GP_STYLE_MODE_DOTS = 1, /* dots */
135   GP_STYLE_MODE_BOX = 2,  /* rectangles */
136 } eMaterialGPencilStyle_Mode;
137
138 typedef struct Material {
139   ID id;
140   /** Animation data (must be immediately after id for utilities to use it). */
141   struct AnimData *adt;
142
143   short flag;
144   char _pad1[2];
145
146   /* Colors from Blender Internal that we are still using. */
147   float r, g, b, a;
148   float specr, specg, specb;
149   float alpha DNA_DEPRECATED;
150   float ray_mirror DNA_DEPRECATED;
151   float spec;
152   /** Renamed and inversed to roughness. */
153   float gloss_mir DNA_DEPRECATED;
154   float roughness;
155   float metallic;
156
157   /** Nodes */
158   char use_nodes;
159
160   /** Preview render. */
161   char pr_type;
162   short pr_texture;
163   short pr_flag;
164
165   /** Index for render passes. */
166   short index;
167
168   struct bNodeTree *nodetree;
169   /** Old animation system, deprecated for 2.5. */
170   struct Ipo *ipo DNA_DEPRECATED;
171   struct PreviewImage *preview;
172
173   /* Freestyle line settings. */
174   float line_col[4];
175   short line_priority;
176   short vcol_alpha;
177
178   /* Texture painting slots. */
179   short paint_active_slot;
180   short paint_clone_slot;
181   short tot_slots;
182   char _pad2[2];
183
184   /* Transparency. */
185   float alpha_threshold;
186   float refract_depth;
187   char blend_method;
188   char blend_shadow;
189   char blend_flag;
190   char _pad3[1];
191
192   /**
193    * Cached slots for texture painting, must be refreshed in
194    * refresh_texpaint_image_cache before using.
195    */
196   struct TexPaintSlot *texpaintslot;
197
198   /** Runtime cache for GLSL materials. */
199   ListBase gpumaterial;
200
201   /** Grease pencil color. */
202   struct MaterialGPencilStyle *gp_style;
203 } Material;
204
205 /* **************** MATERIAL ********************* */
206
207 /* maximum number of materials per material array.
208  * (on object, mesh, light, etc.). limited by
209  * short mat_nr in verts, faces.
210  * -1 because for active material we store the index + 1 */
211 #define MAXMAT (32767 - 1)
212
213 /* flag */
214 /* for render */
215 /* #define MA_IS_USED      (1 << 0) */ /* UNUSED */
216                                        /* for dopesheet */
217 #define MA_DS_EXPAND (1 << 1)
218 /* for dopesheet (texture stack expander)
219  * NOTE: this must have the same value as other texture stacks,
220  * otherwise anim-editors will not read correctly
221  */
222 #define MA_DS_SHOW_TEXS (1 << 2)
223
224 /* ramps */
225 #define MA_RAMP_BLEND 0
226 #define MA_RAMP_ADD 1
227 #define MA_RAMP_MULT 2
228 #define MA_RAMP_SUB 3
229 #define MA_RAMP_SCREEN 4
230 #define MA_RAMP_DIV 5
231 #define MA_RAMP_DIFF 6
232 #define MA_RAMP_DARK 7
233 #define MA_RAMP_LIGHT 8
234 #define MA_RAMP_OVERLAY 9
235 #define MA_RAMP_DODGE 10
236 #define MA_RAMP_BURN 11
237 #define MA_RAMP_HUE 12
238 #define MA_RAMP_SAT 13
239 #define MA_RAMP_VAL 14
240 #define MA_RAMP_COLOR 15
241 #define MA_RAMP_SOFT 16
242 #define MA_RAMP_LINEAR 17
243
244 /* texco */
245 #define TEXCO_ORCO (1 << 0)
246 /* #define TEXCO_REFL      (1 << 1) */ /* deprecated */
247 /* #define TEXCO_NORM      (1 << 2) */ /* deprecated */
248 #define TEXCO_GLOB (1 << 3)
249 #define TEXCO_UV (1 << 4)
250 #define TEXCO_OBJECT (1 << 5)
251 /* #define TEXCO_LAVECTOR  (1 << 6) */ /* deprecated */
252 /* #define TEXCO_VIEW      (1 << 7) */ /* deprecated */
253 /* #define TEXCO_STICKY   (1 << 8) */  /* deprecated */
254 /* #define TEXCO_OSA       (1 << 9) */ /* deprecated */
255 #define TEXCO_WINDOW (1 << 10)
256 /* #define NEED_UV         (1 << 11) */ /* deprecated */
257 /* #define TEXCO_TANGENT   (1 << 12) */ /* deprecated */
258 /* still stored in vertex->accum, 1 D */
259 #define TEXCO_STRAND (1 << 13)
260 /** strand is used for normal materials, particle for halo materials */
261 #define TEXCO_PARTICLE (1 << 13)
262 /* #define TEXCO_STRESS    (1 << 14) */ /* deprecated */
263 /* #define TEXCO_SPEED     (1 << 15) */ /* deprecated */
264
265 /* mapto */
266 #define MAP_COL (1 << 0)
267 #define MAP_ALPHA (1 << 7)
268
269 /* pmapto */
270 /* init */
271 #define MAP_PA_INIT ((1 << 5) - 1)
272 #define MAP_PA_TIME (1 << 0)
273 #define MAP_PA_LIFE (1 << 1)
274 #define MAP_PA_DENS (1 << 2)
275 #define MAP_PA_SIZE (1 << 3)
276 #define MAP_PA_LENGTH (1 << 4)
277 /* reset */
278 #define MAP_PA_IVEL (1 << 5)
279 /* physics */
280 #define MAP_PA_PVEL (1 << 6)
281 /* path cache */
282 #define MAP_PA_CLUMP (1 << 7)
283 #define MAP_PA_KINK (1 << 8)
284 #define MAP_PA_ROUGH (1 << 9)
285 #define MAP_PA_FREQ (1 << 10)
286
287 /* pr_type */
288 #define MA_FLAT 0
289 #define MA_SPHERE 1
290 #define MA_CUBE 2
291 #define MA_SHADERBALL 3
292 #define MA_SPHERE_A 4 /* Used for icon renders only. */
293 #define MA_TEXTURE 5
294 #define MA_LAMP 6
295 #define MA_SKY 7
296 #define MA_HAIR 10
297 #define MA_ATMOS 11
298 #define MA_CLOTH 12
299 #define MA_FLUID 13
300
301 /* pr_flag */
302 #define MA_PREVIEW_WORLD (1 << 0)
303
304 /* blend_method */
305 enum {
306   MA_BM_SOLID,
307   MA_BM_ADD,
308   MA_BM_MULTIPLY,
309   MA_BM_CLIP,
310   MA_BM_HASHED,
311   MA_BM_BLEND,
312 };
313
314 /* blend_flag */
315 enum {
316   MA_BL_HIDE_BACKFACE = (1 << 0),
317   MA_BL_SS_REFRACTION = (1 << 1),
318   MA_BL_FLAG_UNUSED_2 = (1 << 2), /* cleared */
319   MA_BL_TRANSLUCENCY = (1 << 3),
320 };
321
322 /* blend_shadow */
323 enum {
324   MA_BS_NONE = 0,
325   MA_BS_SOLID,
326   MA_BS_CLIP,
327   MA_BS_HASHED,
328 };
329
330 /* Grease Pencil Stroke styles */
331 enum {
332   GP_STYLE_STROKE_STYLE_SOLID = 0,
333   GP_STYLE_STROKE_STYLE_TEXTURE,
334 };
335
336 /* Grease Pencil Fill styles */
337 enum {
338   GP_STYLE_FILL_STYLE_SOLID = 0,
339   GP_STYLE_FILL_STYLE_GRADIENT,
340   GP_STYLE_FILL_STYLE_CHESSBOARD,
341   GP_STYLE_FILL_STYLE_TEXTURE,
342 };
343
344 /* Grease Pencil Gradient Types */
345 enum {
346   GP_STYLE_GRADIENT_LINEAR = 0,
347   GP_STYLE_GRADIENT_RADIAL,
348 };
349
350 #endif