Blender V5.3
BKE_material.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
11
12#include <optional>
13#include <utility>
14
15namespace blender {
16
17struct Depsgraph;
18struct ID;
19struct Main;
20struct Material;
21struct Object;
22struct Scene;
23struct bNode;
24struct bNodeTree;
26
27namespace bke {
29}
30
31/* -------------------------------------------------------------------- */
34
37
39
40/* -------------------------------------------------------------------- */
43
45void BKE_object_materials_sync_length(Main *bmain, Object *ob, ID *id);
46
49
50void BKE_object_material_resize(Main *bmain, Object *ob, short totcol, bool do_id_user);
51
61void BKE_object_material_remap(Object *ob, const unsigned int *remap);
62
69 const unsigned int *remap,
70 int remap_num);
71
78void BKE_object_material_remap_calc(Object *ob_dst, Object *ob_src, short *remap_src_to_dst);
82void BKE_object_material_from_eval_data(Main *bmain, Object *ob_orig, const ID *data_eval);
83Material *BKE_material_add(Main *bmain, const char *name);
84Material *BKE_gpencil_material_add(Main *bmain, const char *name);
87
88/* UNUSED */
89// void automatname(Material *);
90
92
93/* -------------------------------------------------------------------- */
96
102Material ***BKE_id_material_array_p(ID *id); /* same but for ID's */
103short *BKE_id_material_len_p(ID *id);
104
105enum {
106 /* use existing link option */
111};
112
115void BKE_id_material_assign(Main *bmain, ID *id, Material *ma, short act);
116void BKE_object_material_assign(Main *bmain, Object *ob, Material *ma, short act, int assign_type);
117
124void BKE_object_material_assign_single_obdata(Main *bmain, Object *ob, Material *ma, short act);
129 Main *bmain, Object *ob, Material ***matar, int totcol, bool to_object_only);
130
136bool BKE_object_material_slot_add(Main *bmain, Object *ob, bool set_active = true);
137bool BKE_object_material_slot_remove(Main *bmain, Object *ob);
138bool BKE_object_material_slot_used(Object *object, short actcol);
139
140/* Ensure the active material index is within the valid range. */
142
143/* Remove unused material slots and keep the active material index valid. */
144int BKE_object_material_remove_unused(Main *bmain, Object *ob);
145/* Remove all material slots and keep the active material index valid. */
146int BKE_object_material_remove_all(Main *bmain, Object *ob);
147
155int BKE_object_material_index_get_with_hint(Object *ob, const Material *ma, int hint_index);
156
157int BKE_object_material_ensure(Main *bmain, Object *ob, Material *material);
158
159Material *BKE_gpencil_material(Object *ob, short act);
160MaterialGPencilStyle *BKE_gpencil_material_settings(Object *ob, short act);
161
162void BKE_texpaint_slot_refresh_cache(Scene *scene, Material *ma, const Object *ob);
164std::pair<bNodeTree *, bNode *> BKE_texpaint_slot_material_find_node(Material *ma,
165 short texpaint_slot);
166
168
169/* -------------------------------------------------------------------- */
172
173void BKE_id_materials_copy(Main *bmain, ID *id_src, ID *id_dst);
174void BKE_id_material_resize(Main *bmain, ID *id, short totcol, bool do_id_user);
175void BKE_id_material_append(Main *bmain, ID *id, Material *ma);
176Material *BKE_id_material_pop(Main *bmain,
177 ID *id,
178 /* index is an int because of RNA. */
179 int index);
180void BKE_id_material_clear(Main *bmain, ID *id);
181
183
184/* -------------------------------------------------------------------- */
187
201const Material *BKE_object_material_get_eval(const Object &ob, const ID &data, short act);
208int BKE_object_material_count_eval(const Object &ob, const ID &data);
209
214std::optional<int> BKE_id_material_index_max_eval(const ID &id);
216int BKE_id_material_used_eval(const ID &id);
217
230
231void BKE_id_material_eval_assign(ID *id, int slot, Material *material);
237
239
240/* -------------------------------------------------------------------- */
243
249void ramp_blend(int type, float r_col[4], float fac, const float col[4]);
250
252
253/* -------------------------------------------------------------------- */
261
268
270
272
273/* -------------------------------------------------------------------- */
276
277void BKE_material_eval(Depsgraph *depsgraph, Material *material);
278
280
281} // namespace blender
Definition scene.h:133
#define index(i)
BMesh Iterators.
void BKE_id_material_eval_assign(ID *id, int slot, Material *material)
int BKE_object_material_count_eval(const Object *ob)
void ramp_blend(int type, float r_col[4], float fac, const float col[4])
int BKE_object_material_used_with_fallback_eval(const Object &ob)
void BKE_object_material_remap(Object *ob, const unsigned int *remap)
Material * BKE_gpencil_material(Object *ob, short act)
int BKE_object_material_remove_unused(Main *bmain, Object *ob)
bool BKE_object_material_slot_remove(Main *bmain, Object *ob)
short * BKE_object_material_len_p(Object *ob)
Material * BKE_material_default_surface()
Material *** BKE_object_material_array_p(Object *ob)
Material * BKE_gpencil_material_add(Main *bmain, const char *name)
bool BKE_object_material_slot_add(Main *bmain, Object *ob, bool set_active=true)
Material * BKE_object_material_get(Object *ob, short act)
short * BKE_id_material_len_p(ID *id)
Material *** BKE_id_material_array_p(ID *id)
int BKE_id_material_used_eval(const ID &id)
int BKE_object_material_index_get_with_hint(Object *ob, const Material *ma, int hint_index)
Material * BKE_material_default_empty()
void BKE_object_material_active_index_sanitize(Object *ob)
void BKE_object_material_assign(Main *bmain, Object *ob, Material *ma, short act, int assign_type)
void BKE_id_materials_copy(Main *bmain, ID *id_src, ID *id_dst)
Material * BKE_material_default_gpencil()
Material * BKE_material_default_volume()
int BKE_object_material_ensure(Main *bmain, Object *ob, Material *material)
MaterialGPencilStyle * BKE_gpencil_material_settings(Object *ob, short act)
int BKE_id_material_used_with_fallback_eval(const ID &id)
void BKE_gpencil_material_attr_init(Material *ma)
void BKE_id_material_assign(Main *bmain, ID *id, Material *ma, short act)
bool BKE_object_material_slot_used(Object *object, short actcol)
void BKE_texpaint_slot_refresh_cache(Scene *scene, Material *ma, const Object *ob)
BMesh const char void * data
void BKE_object_materials_sync_length(Main *bmain, Object *ob, ID *id)
void BKE_object_material_remap_calc(Object *ob_dst, Object *ob_src, short *remap_src_to_dst)
void BKE_id_material_resize(Main *bmain, ID *id, short totcol, bool do_id_user)
void BKE_id_material_append(Main *bmain, ID *id, Material *ma)
@ BKE_MAT_ASSIGN_EXISTING
@ BKE_MAT_ASSIGN_USERPREF
@ BKE_MAT_ASSIGN_OBJECT
@ BKE_MAT_ASSIGN_OBDATA
void BKE_id_material_eval_ensure_default_slot(ID *id)
Material * BKE_id_material_pop(Main *bmain, ID *id, int index)
void BKE_material_make_node_previews_dirty(Material *ma)
int BKE_object_material_index_get(Object *ob, const Material *ma)
void BKE_objects_materials_sync_length_all(Main *bmain, ID *id)
void BKE_object_material_array_assign(Main *bmain, Object *ob, Material ***matar, int totcol, bool to_object_only)
void BKE_material_eval(Depsgraph *depsgraph, Material *material)
void BKE_id_material_clear(Main *bmain, ID *id)
void BKE_object_material_resize(Main *bmain, Object *ob, short totcol, bool do_id_user)
std::optional< int > BKE_id_material_index_max_eval(const ID &id)
int BKE_object_material_remove_all(Main *bmain, Object *ob)
Material ** BKE_object_material_get_p(Object *ob, short act)
Material * BKE_object_material_get_eval(Object *ob, short act)
short BKE_object_material_slot_find_index(Object *ob, Material *ma)
void BKE_object_material_assign_single_obdata(Main *bmain, Object *ob, Material *ma, short act)
void BKE_texpaint_slots_refresh_object(Scene *scene, Object *ob)
void BKE_material_attr_indices_remap(bke::MutableAttributeAccessor attributes, const unsigned int *remap, int remap_num)
std::pair< bNodeTree *, bNode * > BKE_texpaint_slot_material_find_node(Material *ma, short texpaint_slot)
Material * BKE_material_add(Main *bmain, const char *name)
Material * BKE_material_default_gsplat()
Material * BKE_material_default_holdout()
void BKE_object_material_from_eval_data(Main *bmain, Object *ob_orig, const ID *data_eval)