f4c98fc0aeab08d3b1121d5f530d17c3f662cfec
[blender.git] / source / blender / blenkernel / BKE_material.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
28 #ifndef __BKE_MATERIAL_H__
29 #define __BKE_MATERIAL_H__
30
31 /** \file BKE_material.h
32  *  \ingroup bke
33  *  \brief General operations, lookup, etc. for materials.
34  */
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 struct Main;
40 struct Material;
41 struct ID;
42 struct Object;
43 struct Scene;
44
45 /* materials */
46
47 void init_def_material(void);
48 void BKE_material_free(struct Material *ma);
49 void BKE_material_free_ex(struct Material *ma, bool do_id_user);
50 void test_object_materials(struct Object *ob, struct ID *id);
51 void test_all_objects_materials(struct Main *bmain, struct ID *id);
52 void BKE_material_resize_object(struct Main *bmain, struct Object *ob, const short totcol, bool do_id_user);
53 void BKE_material_init(struct Material *ma);
54 void BKE_material_remap_object(struct Object *ob, const unsigned int *remap);
55 void BKE_material_remap_object_calc(struct  Object *ob_dst, struct Object *ob_src, short *remap_src_to_dst);
56 struct Material *BKE_material_add(struct Main *bmain, const char *name);
57 void BKE_material_copy_data(struct Main *bmain, struct Material *ma_dst, const struct Material *ma_src, const int flag);
58 struct Material *BKE_material_copy(struct Main *bmain, const struct Material *ma);
59 struct Material *BKE_material_localize(struct Material *ma);
60 struct Material *give_node_material(struct Material *ma); /* returns node material or self */
61 void BKE_material_make_local(struct Main *bmain, struct Material *ma, const bool lib_local);
62
63 /* UNUSED */
64 // void automatname(struct Material *);
65
66 /* material slots */
67
68 struct Material ***give_matarar(struct Object *ob);
69 short *give_totcolp(struct Object *ob);
70 struct Material ***give_matarar_id(struct ID *id); /* same but for ID's */
71 short *give_totcolp_id(struct ID *id);
72
73 enum {
74         /* use existing link option */
75         BKE_MAT_ASSIGN_EXISTING,
76         BKE_MAT_ASSIGN_USERPREF,
77         BKE_MAT_ASSIGN_OBDATA,
78         BKE_MAT_ASSIGN_OBJECT
79 };
80
81 struct Material *give_current_material(struct Object *ob, short act);
82 void assign_material_id(struct ID *id, struct Material *ma, short act);
83 void assign_material(struct Object *ob, struct Material *ma, short act, int assign_type);
84 void assign_matarar(struct Object *ob, struct Material ***matar, short totcol);
85
86 short BKE_object_material_slot_find_index(struct Object *ob, struct Material *ma);
87 bool  BKE_object_material_slot_add(struct Object *ob);
88 bool  BKE_object_material_slot_remove(struct Object *ob);
89
90 struct Image  *BKE_object_material_edit_image_get(struct Object *ob, short mat_nr);
91 struct Image **BKE_object_material_edit_image_get_array(struct Object *ob);
92 bool           BKE_object_material_edit_image_set(struct Object *ob, short mat_nr, struct Image *image);
93
94 void BKE_texpaint_slot_refresh_cache(struct Scene *scene, struct Material *ma);
95 void BKE_texpaint_slots_refresh_object(struct Scene *scene, struct Object *ob);
96
97 /* rna api */
98 void BKE_material_resize_id(struct Main *bmain, struct ID *id, short totcol, bool do_id_user);
99 void BKE_material_append_id(struct Main *bmain, struct ID *id, struct Material *ma);
100 struct Material *BKE_material_pop_id(struct Main *bmain, struct ID *id, int index, bool update_data); /* index is an int because of RNA */
101 void BKE_material_clear_id(struct Main *bmain, struct ID *id, bool update_data);
102 /* rendering */
103
104 void init_render_material(struct Material *, int, float *);
105 void init_render_materials(struct Main *, int r_mode, float *amd, bool do_default_material);
106 void end_render_material(struct Material *);
107 void end_render_materials(struct Main *);
108
109 bool material_in_material(struct Material *parmat, struct Material *mat);
110
111 void ramp_blend(int type, float r_col[3], const float fac, const float col[3]);
112
113 /* copy/paste */
114 void clear_matcopybuf(void);
115 void free_matcopybuf(void);
116 void copy_matcopybuf(struct Material *ma);
117 void paste_matcopybuf(struct Material *ma);
118
119 /* Evaluation. */
120
121 struct EvaluationContext;
122
123 void BKE_material_eval(const struct EvaluationContext *eval_ctx, struct Material *material);
124
125 #ifdef __cplusplus
126 }
127 #endif
128
129 #endif