Merge branch 'master' into blender2.8
[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 Main *bmain, 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 struct Material *BKE_material_add_gpencil(struct Main *bmain, const char *name);
58 void BKE_material_copy_data(struct Main *bmain, struct Material *ma_dst, const struct Material *ma_src, const int flag);
59 struct Material *BKE_material_copy(struct Main *bmain, const struct Material *ma);
60 struct Material *BKE_material_localize(struct Material *ma);
61 struct Material *give_node_material(struct Material *ma); /* returns node material or self */
62 void BKE_material_make_local(struct Main *bmain, struct Material *ma, const bool lib_local);
63 void BKE_material_init_gpencil_settings(struct Material *ma);
64
65 /* UNUSED */
66 // void automatname(struct Material *);
67
68 /* material slots */
69
70 struct Material ***give_matarar(struct Object *ob);
71 short *give_totcolp(struct Object *ob);
72 struct Material ***give_matarar_id(struct ID *id); /* same but for ID's */
73 short *give_totcolp_id(struct ID *id);
74
75 enum {
76         /* use existing link option */
77         BKE_MAT_ASSIGN_EXISTING,
78         BKE_MAT_ASSIGN_USERPREF,
79         BKE_MAT_ASSIGN_OBDATA,
80         BKE_MAT_ASSIGN_OBJECT
81 };
82
83 struct Material *give_current_material(struct Object *ob, short act);
84 void assign_material_id(struct Main *bmain, struct ID *id, struct Material *ma, short act);
85 void assign_material(struct Main *bmain, struct Object *ob, struct Material *ma, short act, int assign_type);
86 void assign_matarar(struct Main *bmain, struct Object *ob, struct Material ***matar, short totcol);
87
88 short BKE_object_material_slot_find_index(struct Object *ob, struct Material *ma);
89 bool  BKE_object_material_slot_add(struct Main *bmain, struct Object *ob);
90 bool  BKE_object_material_slot_remove(struct Main *bmain, struct Object *ob);
91
92 struct MaterialGPencilStyle *BKE_material_gpencil_settings_get(struct Object *ob, short act);
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 ramp_blend(int type, float r_col[3], const float fac, const float col[3]);
105
106 /* copy/paste */
107 void clear_matcopybuf(void);
108 void free_matcopybuf(void);
109 void copy_matcopybuf(struct Main *bmain, struct Material *ma);
110 void paste_matcopybuf(struct Main *bmain, struct Material *ma);
111
112 /* Evaluation. */
113
114 struct Depsgraph;
115
116 void BKE_material_eval(struct Depsgraph *depsgraph, struct Material *material);
117
118 #ifdef __cplusplus
119 }
120 #endif
121
122 #endif