Blender V5.3
BKE_material.hh File Reference

General operations, lookup, etc. for materials. More...

#include <optional>
#include <utility>

Go to the source code of this file.

Namespaces

namespace  blender
 BMesh Iterators.
namespace  blender::bke

Functions

Module
void blender::BKE_materials_init ()
void blender::BKE_materials_exit ()
Materials
void blender::BKE_object_materials_sync_length (Main *bmain, Object *ob, ID *id)
void blender::BKE_objects_materials_sync_length_all (Main *bmain, ID *id)
void blender::BKE_object_material_resize (Main *bmain, Object *ob, short totcol, bool do_id_user)
void blender::BKE_object_material_remap (Object *ob, const unsigned int *remap)
void blender::BKE_material_attr_indices_remap (bke::MutableAttributeAccessor attributes, const unsigned int *remap, int remap_num)
void blender::BKE_object_material_remap_calc (Object *ob_dst, Object *ob_src, short *remap_src_to_dst)
void blender::BKE_object_material_from_eval_data (Main *bmain, Object *ob_orig, const ID *data_eval)
Material * blender::BKE_material_add (Main *bmain, const char *name)
Material * blender::BKE_gpencil_material_add (Main *bmain, const char *name)
void blender::BKE_gpencil_material_attr_init (Material *ma)
void blender::BKE_material_make_node_previews_dirty (Material *ma)
RNA API
void blender::BKE_id_materials_copy (Main *bmain, ID *id_src, ID *id_dst)
void blender::BKE_id_material_resize (Main *bmain, ID *id, short totcol, bool do_id_user)
void blender::BKE_id_material_append (Main *bmain, ID *id, Material *ma)
Material * blender::BKE_id_material_pop (Main *bmain, ID *id, int index)
void blender::BKE_id_material_clear (Main *bmain, ID *id)
Evaluation API
Material * blender::BKE_object_material_get_eval (Object *ob, short act)
const Material * blender::BKE_object_material_get_eval (const Object &ob, const ID &data, short act)
int blender::BKE_object_material_count_eval (const Object *ob)
int blender::BKE_object_material_count_eval (const Object &ob, const ID &data)
std::optional< int > blender::BKE_id_material_index_max_eval (const ID &id)
int blender::BKE_id_material_used_eval (const ID &id)
int blender::BKE_id_material_used_with_fallback_eval (const ID &id)
int blender::BKE_object_material_used_with_fallback_eval (const Object &ob)
void blender::BKE_id_material_eval_assign (ID *id, int slot, Material *material)
void blender::BKE_id_material_eval_ensure_default_slot (ID *id)
Rendering
void blender::ramp_blend (int type, float r_col[4], float fac, const float col[4])
Default Materials

TODO: Explain expected usages? Seems to be primarily defined for GPU/viewport code?

Warning
NEVER use these materials as fallback data for regular ID data. They should only be used as template/copy source, or in some very specific, local and short-lived contexts.
Material * blender::BKE_material_default_empty ()
Material * blender::BKE_material_default_holdout ()
Material * blender::BKE_material_default_surface ()
Material * blender::BKE_material_default_volume ()
Material * blender::BKE_material_default_gpencil ()
Material * blender::BKE_material_default_gsplat ()
void blender::BKE_material_defaults_free_gpu ()
Dependency graph evaluation
void blender::BKE_material_eval (Depsgraph *depsgraph, Material *material)

Material Slots

enum  { blender::BKE_MAT_ASSIGN_EXISTING , blender::BKE_MAT_ASSIGN_USERPREF , blender::BKE_MAT_ASSIGN_OBDATA , blender::BKE_MAT_ASSIGN_OBJECT }
Material *** blender::BKE_object_material_array_p (Object *ob)
short * blender::BKE_object_material_len_p (Object *ob)
Material *** blender::BKE_id_material_array_p (ID *id)
short * blender::BKE_id_material_len_p (ID *id)
Material ** blender::BKE_object_material_get_p (Object *ob, short act)
Material * blender::BKE_object_material_get (Object *ob, short act)
void blender::BKE_id_material_assign (Main *bmain, ID *id, Material *ma, short act)
void blender::BKE_object_material_assign (Main *bmain, Object *ob, Material *ma, short act, int assign_type)
void blender::BKE_object_material_assign_single_obdata (Main *bmain, Object *ob, Material *ma, short act)
void blender::BKE_object_material_array_assign (Main *bmain, Object *ob, Material ***matar, int totcol, bool to_object_only)
short blender::BKE_object_material_slot_find_index (Object *ob, Material *ma)
bool blender::BKE_object_material_slot_add (Main *bmain, Object *ob, bool set_active=true)
bool blender::BKE_object_material_slot_remove (Main *bmain, Object *ob)
bool blender::BKE_object_material_slot_used (Object *object, short actcol)
void blender::BKE_object_material_active_index_sanitize (Object *ob)
int blender::BKE_object_material_remove_unused (Main *bmain, Object *ob)
int blender::BKE_object_material_remove_all (Main *bmain, Object *ob)
int blender::BKE_object_material_index_get (Object *ob, const Material *ma)
int blender::BKE_object_material_index_get_with_hint (Object *ob, const Material *ma, int hint_index)
int blender::BKE_object_material_ensure (Main *bmain, Object *ob, Material *material)
Material * blender::BKE_gpencil_material (Object *ob, short act)
MaterialGPencilStyle * blender::BKE_gpencil_material_settings (Object *ob, short act)
void blender::BKE_texpaint_slot_refresh_cache (Scene *scene, Material *ma, const Object *ob)
void blender::BKE_texpaint_slots_refresh_object (Scene *scene, Object *ob)
std::pair< bNodeTree *, bNode * > blender::BKE_texpaint_slot_material_find_node (Material *ma, short texpaint_slot)

Detailed Description

General operations, lookup, etc. for materials.

Definition in file BKE_material.hh.