BKE_material.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once

 
#include <optional>
 
struct ID;
struct Main;
struct Material;
struct Object;
struct Scene;
struct bNode;
struct Depsgraph;
struct MaterialGPencilStyle;
 
/* -------------------------------------------------------------------- */
 
void BKE_materials_init();
void BKE_materials_exit();

 
/* -------------------------------------------------------------------- */

void BKE_object_materials_sync_length(Main *bmain, Object *ob, ID *id);

void BKE_objects_materials_sync_length_all(Main *bmain, ID *id);
 
void BKE_object_material_resize(Main *bmain, Object *ob, short totcol, bool do_id_user);
void BKE_object_material_remap(Object *ob, const unsigned int *remap);
void BKE_object_material_remap_calc(Object *ob_dst, Object *ob_src, short *remap_src_to_dst);
void BKE_object_material_from_eval_data(Main *bmain, Object *ob_orig, const ID *data_eval);
Material *BKE_material_add(Main *bmain, const char *name);
Material *BKE_gpencil_material_add(Main *bmain, const char *name);
void BKE_gpencil_material_attr_init(Material *ma);
void BKE_material_make_node_previews_dirty(Material *ma);
 
/* UNUSED */
// void automatname(Material *);

 
/* -------------------------------------------------------------------- */
 
Material ***BKE_object_material_array_p(Object *ob);
short *BKE_object_material_len_p(Object *ob);
Material ***BKE_id_material_array_p(ID *id); /* same but for ID's */
short *BKE_id_material_len_p(ID *id);
 
enum {
  /* use existing link option */
  BKE_MAT_ASSIGN_EXISTING,
  BKE_MAT_ASSIGN_USERPREF,
  BKE_MAT_ASSIGN_OBDATA,
  BKE_MAT_ASSIGN_OBJECT,
};
 
Material **BKE_object_material_get_p(Object *ob, short act);
Material *BKE_object_material_get(Object *ob, short act);
void BKE_id_material_assign(Main *bmain, ID *id, Material *ma, short act);
void BKE_object_material_assign(Main *bmain, Object *ob, Material *ma, short act, int assign_type);

void BKE_object_material_assign_single_obdata(Main *bmain, Object *ob, Material *ma, short act);
void BKE_object_material_array_assign(
    Main *bmain, Object *ob, Material ***matar, int totcol, bool to_object_only);
 
short BKE_object_material_slot_find_index(Object *ob, Material *ma);
bool BKE_object_material_slot_add(Main *bmain, Object *ob, bool set_active = true);
bool BKE_object_material_slot_remove(Main *bmain, Object *ob);
bool BKE_object_material_slot_used(Object *object, short actcol);
 
int BKE_object_material_index_get(Object *ob, const Material *ma);
int BKE_object_material_index_get_with_hint(Object *ob, const Material *ma, int hint_index);
 
int BKE_object_material_ensure(Main *bmain, Object *ob, Material *material);
 
Material *BKE_gpencil_material(Object *ob, short act);
MaterialGPencilStyle *BKE_gpencil_material_settings(Object *ob, short act);
 
void BKE_texpaint_slot_refresh_cache(Scene *scene, Material *ma, const Object *ob);
void BKE_texpaint_slots_refresh_object(Scene *scene, Object *ob);
bNode *BKE_texpaint_slot_material_find_node(Material *ma, short texpaint_slot);

 
/* -------------------------------------------------------------------- */
 
void BKE_id_materials_copy(Main *bmain, ID *id_src, ID *id_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);
Material *BKE_id_material_pop(Main *bmain,
                              ID *id,
                              /* index is an int because of RNA. */
                              int index);
void BKE_id_material_clear(Main *bmain, ID *id);

 
/* -------------------------------------------------------------------- */

Material *BKE_object_material_get_eval(Object *ob, short act);
const Material *BKE_object_material_get_eval(const Object &ob, const ID &data, short act);
int BKE_object_material_count_eval(const Object *ob);
int BKE_object_material_count_eval(const Object &ob, const ID &data);

std::optional<int> BKE_id_material_index_max_eval(const ID &id);
int BKE_id_material_used_eval(const ID &id);

int BKE_id_material_used_with_fallback_eval(const ID &id);
int BKE_object_material_used_with_fallback_eval(const Object &ob);
 
void BKE_id_material_eval_assign(ID *id, int slot, Material *material);
void BKE_id_material_eval_ensure_default_slot(ID *id);

 
/* -------------------------------------------------------------------- */

void ramp_blend(int type, float r_col[3], float fac, const float col[3]);

 
/* -------------------------------------------------------------------- */
 
Material *BKE_material_default_empty();
Material *BKE_material_default_holdout();
Material *BKE_material_default_surface();
Material *BKE_material_default_volume();
Material *BKE_material_default_gpencil();
 
void BKE_material_defaults_free_gpu();

 
/* -------------------------------------------------------------------- */
 
void BKE_material_eval(Depsgraph *depsgraph, Material *material);