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

Functions
Module
void	BKE_materials_init (void)

void	BKE_materials_exit (void)

Materials
void	BKE_object_materials_test (struct Main bmain, struct Object ob, struct ID *id)

void	BKE_objects_materials_test_all (struct Main bmain, struct ID id)

void	BKE_object_material_resize (struct Main bmain, struct Object ob, short totcol, bool do_id_user)

void	BKE_object_material_remap (struct Object ob, const unsigned int remap)

void	BKE_object_material_remap_calc (struct Object ob_dst, struct Object ob_src, short *remap_src_to_dst)

void	BKE_object_material_from_eval_data (struct Main bmain, struct Object ob_orig, const struct ID *data_eval)

struct Material *	BKE_material_add (struct Main bmain, const char name)

struct Material *	BKE_gpencil_material_add (struct Main bmain, const char name)

void	BKE_gpencil_material_attr_init (struct Material *ma)

void	BKE_material_make_node_previews_dirty (struct Material *ma)

RNA API
void	BKE_id_materials_copy (struct Main bmain, struct ID id_src, struct ID *id_dst)

void	BKE_id_material_resize (struct Main bmain, struct ID id, short totcol, bool do_id_user)

void	BKE_id_material_append (struct Main bmain, struct ID id, struct Material *ma)

struct Material *	BKE_id_material_pop (struct Main bmain, struct ID id, int index)

void	BKE_id_material_clear (struct Main bmain, struct ID id)

Evaluation API
struct Material *	BKE_object_material_get_eval (struct Object *ob, short act)

int	BKE_object_material_count_eval (const struct Object *ob)

void	BKE_id_material_eval_assign (struct ID id, int slot, struct Material material)

void	BKE_id_material_eval_ensure_default_slot (struct ID *id)

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

Default Materials
struct Material *	BKE_material_default_empty (void)

struct Material *	BKE_material_default_holdout (void)

struct Material *	BKE_material_default_surface (void)

struct Material *	BKE_material_default_volume (void)

struct Material *	BKE_material_default_gpencil (void)

void	BKE_material_defaults_free_gpu (void)

Dependency graph evaluation
void	BKE_material_eval (struct Depsgraph depsgraph, struct Material material)

Material Slots
enum	{ BKE_MAT_ASSIGN_EXISTING , BKE_MAT_ASSIGN_USERPREF , BKE_MAT_ASSIGN_OBDATA , BKE_MAT_ASSIGN_OBJECT }

struct Material ***	BKE_object_material_array_p (struct Object *ob)

short *	BKE_object_material_len_p (struct Object *ob)

struct Material ***	BKE_id_material_array_p (struct ID *id)

short *	BKE_id_material_len_p (struct ID *id)

struct Material **	BKE_object_material_get_p (struct Object *ob, short act)

struct Material *	BKE_object_material_get (struct Object *ob, short act)

void	BKE_id_material_assign (struct Main bmain, struct ID id, struct Material *ma, short act)

void	BKE_object_material_assign (struct Main bmain, struct Object ob, struct Material *ma, short act, int assign_type)

void	BKE_object_material_assign_single_obdata (struct Main bmain, struct Object ob, struct Material *ma, short act)

void	BKE_object_material_array_assign (struct Main bmain, struct Object ob, struct Material ***matar, int totcol, bool to_object_only)

short	BKE_object_material_slot_find_index (struct Object ob, struct Material ma)

bool	BKE_object_material_slot_add (struct Main bmain, struct Object ob)

bool	BKE_object_material_slot_remove (struct Main bmain, struct Object ob)

bool	BKE_object_material_slot_used (struct 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)

struct Material *	BKE_gpencil_material (struct Object *ob, short act)

struct MaterialGPencilStyle *	BKE_gpencil_material_settings (struct Object *ob, short act)

void	BKE_texpaint_slot_refresh_cache (struct Scene scene, struct Material ma, const struct Object *ob)

void	BKE_texpaint_slots_refresh_object (struct Scene scene, struct Object ob)

struct bNode *	BKE_texpaint_slot_material_find_node (struct Material *ma, short texpaint_slot)

Detailed Description

General operations, lookup, etc. for materials.

Definition in file BKE_material.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
BKE_MAT_ASSIGN_EXISTING
BKE_MAT_ASSIGN_USERPREF
BKE_MAT_ASSIGN_OBDATA
BKE_MAT_ASSIGN_OBJECT

Definition at line 79 of file BKE_material.h.

Function Documentation

◆ BKE_gpencil_material()

struct Material * BKE_gpencil_material	(	struct Object *	ob,
		short	act )

Definition at line 880 of file blenkernel/intern/material.cc.

References BKE_material_default_gpencil(), and BKE_object_material_get().

Referenced by blender::ed::greasepencil::grease_pencil_material_reveal_exec(), and blender::ed::greasepencil::material_isolate_exec().

◆ BKE_gpencil_material_add()

struct Material * BKE_gpencil_material_add	(	struct Main *	bmain,
		const char *	name )

Definition at line 320 of file blenkernel/intern/material.cc.

References BKE_gpencil_material_attr_init(), and BKE_material_add().

Referenced by BKE_grease_pencil_object_material_new(), BLO_update_defaults_startup_blend(), and new_material_exec().

◆ BKE_gpencil_material_attr_init()

void BKE_gpencil_material_attr_init ( struct Material * ma )

Definition at line 270 of file blenkernel/intern/material.cc.

References ARRAY_SET_ITEMS, MaterialGPencilStyle::fill_rgba, MaterialGPencilStyle::flag, GP_MATERIAL_STROKE_SHOW, Material::gp_style, MEM_callocN, MaterialGPencilStyle::mix_factor, MaterialGPencilStyle::mix_rgba, MaterialGPencilStyle::stroke_rgba, MaterialGPencilStyle::texture_offset, MaterialGPencilStyle::texture_pixsize, and MaterialGPencilStyle::texture_scale.

Referenced by BKE_gpencil_material_add(), BKE_gpencil_material_settings(), BKE_grease_pencil_object_material_ensure_active(), and material_default_gpencil_init().

◆ BKE_gpencil_material_settings()

struct MaterialGPencilStyle * BKE_gpencil_material_settings	(	struct Object *	ob,
		short	act )

Definition at line 890 of file blenkernel/intern/material.cc.

References BKE_gpencil_material_attr_init(), BKE_material_default_gpencil(), BKE_object_material_get(), and Material::gp_style.

Referenced by blender::draw::overlay::GreasePencil::draw_grease_pencil(), ED_gpencil_stroke_material_editable(), gpencil_material_pool_create(), gpencil_object_cache_add(), grease_pencil_object_cache_populate(), blender::ed::greasepencil::grease_pencil_texture_gradient_exec(), blender::ed::greasepencil::material_isolate_exec(), and OVERLAY_outline_grease_pencil().

◆ BKE_id_material_append()

void BKE_id_material_append	(	struct Main *	bmain,
		struct ID *	id,
		struct Material *	ma )

Definition at line 597 of file blenkernel/intern/material.cc.

References BKE_id_material_array_p(), BKE_id_material_len_p(), BKE_objects_materials_test_all(), DEG_id_tag_update(), DEG_relations_tag_update(), ID_RECALC_SYNC_TO_EVAL, id_us_plus(), and MEM_freeN().

◆ BKE_id_material_array_p()

struct Material *** BKE_id_material_array_p ( struct ID * id )

Note: Same as BKE_object_material_len_p but for ID's.

Definition at line 407 of file blenkernel/intern/material.cc.

References BLI_assert, GS, ID_CU_LEGACY, ID_CV, ID_GD_LEGACY, ID_GP, ID_MB, ID_ME, ID_PT, ID_VO, and OB_DATA_SUPPORT_ID.

Referenced by blender::nodes::node_geo_set_material_cc::assign_material_to_id_geometry(), BKE_id_material_append(), BKE_id_material_assign(), BKE_id_material_clear(), BKE_id_material_eval_assign(), BKE_id_material_pop(), BKE_id_material_resize(), BKE_id_materials_copy(), BKE_object_material_from_eval_data(), BKE_object_material_get_eval(), and mesh_separate_material_assign_mat_nr().

◆ BKE_id_material_assign()

void BKE_id_material_assign	(	struct Main *	bmain,
		struct ID *	id,
		struct Material *	ma,
		short	act )

Definition at line 998 of file blenkernel/intern/material.cc.

References BKE_id_material_array_p(), BKE_id_material_len_p(), BKE_objects_materials_test_all(), Material::id, id_us_min(), id_us_plus(), MAXMAT, and MEM_freeN().

◆ BKE_id_material_clear()

void BKE_id_material_clear	(	struct Main *	bmain,
		struct ID *	id )

Definition at line 659 of file blenkernel/intern/material.cc.

References BKE_id_material_array_p(), BKE_id_material_len_p(), BKE_objects_materials_test_all(), DEG_id_tag_update(), DEG_relations_tag_update(), ID_RECALC_SYNC_TO_EVAL, id_us_min(), material_data_index_clear_id(), and MEM_freeN().

Referenced by mesh_separate_material_assign_mat_nr().

◆ BKE_id_material_eval_assign()

void BKE_id_material_eval_assign	(	struct ID *	id,
		int	slot,
		struct Material *	material )

Definition at line 804 of file blenkernel/intern/material.cc.

References BKE_id_material_array_p(), BKE_id_material_len_p(), BLI_assert, BLI_assert_unreachable, ELEM, material, and MEM_reallocN.

Referenced by blender::nodes::node_geo_set_material_cc::assign_material_to_id_geometry(), BKE_id_material_eval_ensure_default_slot(), blender::geometry::execute_realize_mesh_tasks(), and blender::nodes::node_geo_set_material_cc::node_geo_exec().

◆ BKE_id_material_eval_ensure_default_slot()

void BKE_id_material_eval_ensure_default_slot ( struct ID * id )

Add an empty material slot if the id has no material slots. This material slot allows the material to be overwritten by object-linked materials.

Definition at line 831 of file blenkernel/intern/material.cc.

References BKE_id_material_eval_assign(), and BKE_id_material_len_p().

◆ BKE_id_material_len_p()

short * BKE_id_material_len_p ( struct ID * id )

◆ BKE_id_material_pop()

struct Material * BKE_id_material_pop	(	struct Main *	bmain,
		struct ID *	id,
		int	index )

Definition at line 621 of file blenkernel/intern/material.cc.

References BKE_id_material_array_p(), BKE_id_material_len_p(), BKE_objects_materials_test_all(), DEG_id_tag_update(), DEG_relations_tag_update(), ID_RECALC_SYNC_TO_EVAL, id_us_min(), material_data_index_remove_id(), MEM_freeN(), MEM_reallocN, and ret.

◆ BKE_id_material_resize()

void BKE_id_material_resize	(	struct Main *	bmain,
		struct ID *	id,
		short	totcol,
		bool	do_id_user )

Definition at line 566 of file blenkernel/intern/material.cc.

References BKE_id_material_array_p(), BKE_id_material_len_p(), DEG_id_tag_update(), DEG_relations_tag_update(), ID_RECALC_SYNC_TO_EVAL, id_us_min(), MEM_freeN(), and MEM_recallocN.

Referenced by BKE_object_materials_test(), and mesh_separate_material_assign_mat_nr().

◆ BKE_id_materials_copy()

void BKE_id_materials_copy	(	struct Main *	bmain,
		struct ID *	id_src,
		struct ID *	id_dst )

Definition at line 545 of file blenkernel/intern/material.cc.

References BKE_id_material_array_p(), BKE_id_material_len_p(), DEG_id_tag_update(), DEG_relations_tag_update(), ID_RECALC_SYNC_TO_EVAL, id_us_plus(), and MEM_dupallocN.

Referenced by BKE_mesh_to_pointcloud(), BKE_pointcloud_to_mesh(), and blender::bke::greasepencil::convert::legacy_gpencil_to_grease_pencil().

◆ BKE_material_add()

struct Material * BKE_material_add	(	struct Main *	bmain,
		const char *	name )

Definition at line 311 of file blenkernel/intern/material.cc.

References BKE_id_new(), and ID_MA.

Referenced by blender::io::usd::USDMaterialReader::add_material(), blender::io::alembic::utils::assign_materials(), BKE_gpencil_material_add(), get_or_create_current_material(), blender::io::obj::get_or_create_material(), Freestyle::BlenderStrokeRenderer::GetStrokeShader(), new_material_exec(), blender::animrig::tests::KeyframingTest::SetUp(), and DocumentImporter::writeMaterial().

◆ BKE_material_default_empty()

struct Material * BKE_material_default_empty ( void )

Definition at line 2075 of file blenkernel/intern/material.cc.

References default_material_empty.

Referenced by blender::workbench::Instance::get_material().

◆ BKE_material_default_gpencil()

struct Material * BKE_material_default_gpencil ( void )

Definition at line 2095 of file blenkernel/intern/material.cc.

References default_material_gpencil.

Referenced by BKE_gpencil_material(), BKE_gpencil_material_settings(), and BKE_grease_pencil_object_material_ensure_from_active_input_material().

◆ BKE_material_default_holdout()

struct Material * BKE_material_default_holdout ( void )

Definition at line 2080 of file blenkernel/intern/material.cc.

References default_material_holdout.

◆ BKE_material_default_surface()

struct Material * BKE_material_default_surface ( void )

Definition at line 2085 of file blenkernel/intern/material.cc.

References default_material_surface.

Referenced by ED_node_shader_default(), blender::eevee::ShaderModule::material_default_shader_get(), and blender::eevee::ShaderModule::material_shader_get().

◆ BKE_material_default_volume()

struct Material * BKE_material_default_volume ( void )

Definition at line 2090 of file blenkernel/intern/material.cc.

References default_material_volume.

Referenced by ED_node_shader_default(), blender::eevee::ShaderModule::material_default_shader_get(), and blender::eevee::ShaderModule::material_shader_get().

◆ BKE_material_defaults_free_gpu()

void BKE_material_defaults_free_gpu ( void )

Definition at line 2100 of file blenkernel/intern/material.cc.

References default_materials, ListBase::first, GPU_material_free(), and Material::gpumaterial.

Referenced by gpu_codegen_exit(), and GPU_materials_free().

◆ BKE_material_eval()

void BKE_material_eval	(	struct Depsgraph *	depsgraph,
		struct Material *	material )

Definition at line 1965 of file blenkernel/intern/material.cc.

References DEG_debug_print_eval(), depsgraph, and GPU_material_free().

◆ BKE_material_make_node_previews_dirty()

void BKE_material_make_node_previews_dirty ( struct Material * ma )

Definition at line 304 of file blenkernel/intern/material.cc.

References Material::nodetree, and nodetree_mark_previews_dirty_reccursive().

Referenced by ED_render_engine_changed().

◆ BKE_materials_exit()

void BKE_materials_exit ( void )

Definition at line 2124 of file blenkernel/intern/material.cc.

References default_materials, and material_free_data().

Referenced by WM_exit_ex().

◆ BKE_materials_init()

void BKE_materials_init ( void )

Definition at line 2112 of file blenkernel/intern/material.cc.

References default_material_gpencil, default_material_holdout, default_material_surface, default_material_volume, default_materials, material_default_gpencil_init(), material_default_holdout_init(), material_default_surface_init(), material_default_volume_init(), and material_init_data().

Referenced by main().

◆ BKE_object_material_array_assign()

void BKE_object_material_array_assign	(	struct Main *	bmain,
		struct Object *	ob,
		struct Material ***	matar,
		int	totcol,
		bool	to_object_only )

Warning: this calls many more update calls per object then are needed, could be optimized.

Definition at line 1265 of file blenkernel/intern/material.cc.

References Object::actcol, BKE_MAT_ASSIGN_OBJECT, BKE_MAT_ASSIGN_USERPREF, BKE_object_material_assign(), BKE_object_material_slot_remove(), Object::matbits, and Object::totcol.

Referenced by ED_grease_pencil_join_objects_exec(), blender::ed::greasepencil::grease_pencil_separate_layer(), blender::ed::greasepencil::grease_pencil_separate_material(), blender::ed::greasepencil::grease_pencil_separate_selected(), material_slot_copy_exec(), mesh_separate_arrays(), and mesh_separate_tagged().

◆ BKE_object_material_array_p()

struct Material *** BKE_object_material_array_p ( struct Object * ob )

Definition at line 333 of file blenkernel/intern/material.cc.

References Object::data, ELEM, bGPdata::mat, Curve::mat, MetaBall::mat, PointCloud::mat, GreasePencil::material_array, OB_CURVES, OB_CURVES_LEGACY, OB_FONT, OB_GPENCIL_LEGACY, OB_GREASE_PENCIL, OB_MBALL, OB_MESH, OB_POINTCLOUD, OB_SURF, OB_VOLUME, and Object::type.

Referenced by BKE_object_duplicate(), BKE_object_material_get_p(), BKE_object_material_remap(), BKE_object_material_slot_find_index(), BKE_object_material_slot_remove(), blender::deg::DepsgraphNodeBuilder::build_object_data(), blender::deg::DepsgraphRelationBuilder::build_object_data(), blender::ed::greasepencil::grease_pencil_separate_layer(), blender::ed::greasepencil::grease_pencil_separate_material(), blender::ed::greasepencil::grease_pencil_separate_selected(), blender::ed::object::make_local_exec(), material_slot_copy_exec(), mesh_separate_arrays(), mesh_separate_tagged(), object_material_assign(), blender::ed::space_node::preview_prepare_scene(), preview_prepare_scene(), and similar_face_select_exec().

◆ BKE_object_material_assign()

void BKE_object_material_assign	(	struct Main *	bmain,
		struct Object *	ob,
		struct Material *	ma,
		short	act,
		int	assign_type )

Definition at line 1142 of file blenkernel/intern/material.cc.

References object_material_assign().

Referenced by MeshImporter::assign_material_to_geom(), blender::ed::greasepencil::bake_grease_pencil_animation_exec(), BKE_grease_pencil_object_material_ensure_from_brush(), BKE_grease_pencil_object_material_new(), BKE_object_material_array_assign(), BKE_object_material_ensure(), BKE_object_material_slot_add(), blender::ed::object::drop_named_material_invoke(), get_or_create_current_material(), blender::ed::object::make_links_data_exec(), blender::ed::outliner::material_drop_invoke(), blender::animrig::tests::KeyframingTest::SetUp(), blender::ed::object::single_mat_users(), and ui_drop_material_exec().

◆ BKE_object_material_assign_single_obdata()

void BKE_object_material_assign_single_obdata	(	struct Main *	bmain,
		struct Object *	ob,
		struct Material *	ma,
		short	act )

Similar to BKE_object_material_assign with BKE_MAT_ASSIGN_OBDATA type, but does not scan whole Main for other usages of the same obdata. Only use in cases where you know that the object's obdata is only used by this one object.

Definition at line 1147 of file blenkernel/intern/material.cc.

References BKE_MAT_ASSIGN_OBDATA, and object_material_assign().

Referenced by blender::io::alembic::utils::assign_materials(), and utils::assign_materials().

◆ BKE_object_material_count_eval()

int BKE_object_material_count_eval ( const struct Object * ob )

Referenced by gpencil_material_pool_create(), gpencil_object_cache_add(), blender::io::hydra::CurvesData::write_materials(), and blender::io::hydra::VolumeData::write_materials().

◆ BKE_object_material_ensure()

int BKE_object_material_ensure	(	Main *	bmain,
		Object *	ob,
		Material *	material )

Definition at line 866 of file blenkernel/intern/material.cc.

References BKE_MAT_ASSIGN_USERPREF, BKE_object_material_assign(), BKE_object_material_index_get(), BKE_object_material_slot_add(), and Object::totcol.

Referenced by blender::ed::greasepencil::clipboard_materials_remap(), and blender::ed::greasepencil::grease_pencil_material_copy_to_object_exec().

◆ BKE_object_material_from_eval_data()

void BKE_object_material_from_eval_data	(	struct Main *	bmain,
		struct Object *	ob_orig,
		const struct ID *	data_eval )

Copy materials from evaluated geometry to the original geometry of an object.

Referenced by blender::ed::object::apply_grease_pencil_for_modifier(), blender::ed::object::apply_grease_pencil_for_modifier_all_keyframes(), blender::ed::object::modifier_apply_obdata(), blender::ed::object::object_convert_exec(), and blender::ed::geometry::store_result_geometry().

◆ BKE_object_material_get()

struct Material * BKE_object_material_get	(	struct Object *	ob,
		short	act )

Definition at line 725 of file blenkernel/intern/material.cc.

References BKE_object_material_get_p(), Material::gp_style, OB_GREASE_PENCIL, and Object::type.

◆ BKE_object_material_get_eval()

struct Material * BKE_object_material_get_eval	(	struct Object *	ob,
		short	act )

On evaluated objects the number of materials on an object and its data might go out of sync. This is because during evaluation materials can be added/removed on the object data.

For rendering or exporting we generally use the materials on the object data. However, some material indices might be overwritten by the object.

Definition at line 753 of file blenkernel/intern/material.cc.

References BKE_id_material_array_p(), BKE_id_material_len_p(), BLI_assert, clamp_i(), DEG_is_evaluated_object(), get_evaluated_object_data_with_materials(), Object::mat, Object::matbits, material, materials_data, and Object::totcol.