doxygen: blenkernel under core as module.
[blender.git] / source / blender / blenkernel / BKE_material.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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
30 #ifndef BKE_MATERIAL_H
31 #define BKE_MATERIAL_H
32
33 /** \file BKE_material.h
34  *  \ingroup bke
35  *  \brief General operations, lookup, etc. for materials.
36  */
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 struct Main;
42 struct Material;
43 struct ID;
44 struct Object;
45
46 /* materials */
47
48 void init_def_material(void);
49 void free_material(struct Material *sc); 
50 void test_object_materials(struct ID *id);
51 void resize_object_material(struct Object *ob, const short totcol);
52 void init_material(struct Material *ma);
53 struct Material *add_material(const char *name);
54 struct Material *copy_material(struct Material *ma);
55 struct Material *localize_material(struct Material *ma);
56 struct Material *give_node_material(struct Material *ma); /* returns node material or self */
57 void make_local_material(struct Material *ma);
58
59 void automatname(struct Material *);
60
61 /* material slots */
62
63 struct Material ***give_matarar(struct Object *ob);
64 short *give_totcolp(struct Object *ob);
65 struct Material ***give_matarar_id(struct ID *id); /* same but for ID's */
66 short *give_totcolp_id(struct ID *id);
67
68 struct Material *give_current_material(struct Object *ob, int act);
69 struct ID *material_from(struct Object *ob, int act);
70 void assign_material(struct Object *ob, struct Material *ma, int act);
71 void assign_matarar(struct Object *ob, struct Material ***matar, int totcol);
72
73 int find_material_index(struct Object *ob, struct Material *ma);
74
75 int object_add_material_slot(struct Object *ob);
76 int object_remove_material_slot(struct Object *ob);
77
78 /* rna api */
79 void material_append_id(struct ID *id, struct Material *ma);
80 struct Material *material_pop_id(struct ID *id, int index);
81
82 /* rendering */
83
84 void init_render_material(struct Material *, int, float *);
85 void init_render_materials(struct Main *, int, float *);
86 void end_render_material(struct Material *);
87 void end_render_materials(struct Main *);
88
89 int material_in_material(struct Material *parmat, struct Material *mat);
90
91 void ramp_blend(int type, float *r, float *g, float *b, float fac, float *col);
92
93 /* copy/paste */
94 void clear_matcopybuf(void);
95 void free_matcopybuf(void);
96 void copy_matcopybuf(struct Material *ma);
97 void paste_matcopybuf(struct Material *ma);
98
99 void clear_mat_mtex_copybuf(void);
100 void copy_mat_mtex_copybuf(struct ID *id);
101 void paste_mat_mtex_copybuf(struct ID *id);
102
103 #ifdef __cplusplus
104 }
105 #endif
106
107 #endif
108