Blender V5.3
BKE_main.hh File Reference
#include <array>
#include <atomic>
#include "DNA_listBase.h"
#include "BLI_compiler_attrs.hh"
#include "BLI_map.hh"
#include "BLI_math_matrix_types.hh"
#include "BLI_set.hh"
#include "BLI_sys_types.hh"
#include "BLI_utility_mixins.hh"
#include "BLI_vector_set.hh"
#include "BKE_blender_project.hh"
#include "BKE_lib_query.hh"

Go to the source code of this file.

Classes

struct  blender::BlendThumbnail
struct  blender::MainIDRelationsEntryItem
struct  blender::MainIDRelationsEntry
struct  blender::MainIDRelations
struct  blender::MainColorspace
struct  blender::Main
struct  blender::MainMergeReport
class  blender::MainAllIDsIterator

Namespaces

namespace  blender
 BMesh Iterators.

Macros

#define FOREACH_MAIN_LISTBASE_ID_BEGIN(_lb, _id)
#define FOREACH_MAIN_LISTBASE_ID_END
#define FOREACH_MAIN_LISTBASE_BEGIN(_bmain, _lb)
#define FOREACH_MAIN_LISTBASE_END
#define FOREACH_MAIN_ID_BEGIN(_bmain, _id)
#define FOREACH_MAIN_ID_END
#define MAIN_VERSION_FILE_ATLEAST(main, ver, subver)
#define MAIN_VERSION_FILE_OLDER(main, ver, subver)
#define MAIN_VERSION_FILE_OLDER_OR_EQUAL(main, ver, subver)
#define LIBRARY_VERSION_FILE_ATLEAST(lib, ver, subver)
#define BLEN_THUMB_SIZE   128
#define BLEN_THUMB_MEMSIZE(_x, _y)
#define BLEN_THUMB_MEMSIZE_IS_VALID(_x, _y)

Typedefs

using blender::MainListsArray = std::array<ListBaseT<ID> *, INDEX_ID_MAX - 1>

Enumerations

enum  blender::eMainIDRelationsEntryTags {
  blender::MAINIDRELATIONS_ENTRY_TAGS_DOIT = 1 << 0 , blender::MAINIDRELATIONS_ENTRY_TAGS_PROCESSED_TO = 1 << 4 , blender::MAINIDRELATIONS_ENTRY_TAGS_PROCESSED_FROM = 1 << 5 , blender::MAINIDRELATIONS_ENTRY_TAGS_PROCESSED ,
  blender::MAINIDRELATIONS_ENTRY_TAGS_INPROGRESS_TO = 1 << 8 , blender::MAINIDRELATIONS_ENTRY_TAGS_INPROGRESS_FROM = 1 << 9 , blender::MAINIDRELATIONS_ENTRY_TAGS_INPROGRESS
}
enum  { blender::MAINIDRELATIONS_INCLUDE_UI = 1 << 0 }

Functions

Main * blender::BKE_main_new ()
void blender::BKE_main_init_from_reference (Main &bmain, const Main &reference)
void blender::BKE_main_clear (Main &bmain)
void blender::BKE_main_free (Main *bmain)
void blender::BKE_main_merge (Main *bmain_dst, Set< ID * > *force_merge_src_ids, Main **r_bmain_src, MainMergeReport &reports)
void blender::BKE_main_merge (Main *bmain_dst, Main **r_bmain_src, MainMergeReport &reports)
void blender::BKE_main_merge_as_archive_library (Main &bmain_dst, Main *&r_bmain_src, Library &dst_external_library, MainMergeReport &reports)
bool blender::BKE_main_is_empty (Main *bmain)
bool blender::BKE_main_has_issues (const Main *bmain)
bool blender::BKE_main_needs_overwrite_confirm (const Main *bmain)
void blender::BKE_main_lock (Main *bmain)
void blender::BKE_main_unlock (Main *bmain)
void blender::BKE_main_relations_create (Main *bmain, short flag)
void blender::BKE_main_relations_free (Main *bmain)
void blender::BKE_main_relations_tag_set (Main *bmain, eMainIDRelationsEntryTags tag, bool value)
Set< const ID * > * blender::BKE_main_set_create (Main *bmain, Set< const ID * > *set)
MainLibraryWeakReferenceMap * blender::BKE_main_library_weak_reference_create (Main *bmain) ATTR_NONNULL()
void blender::BKE_main_library_weak_reference_destroy (MainLibraryWeakReferenceMap *library_weak_reference_mapping) ATTR_NONNULL()
ID * blender::BKE_main_library_weak_reference_search_item (MainLibraryWeakReferenceMap *library_weak_reference_mapping, const char *library_filepath, const char *library_id_name) ATTR_NONNULL()
void blender::BKE_main_library_weak_reference_add_item (MainLibraryWeakReferenceMap *library_weak_reference_mapping, const char *library_filepath, const char *library_id_name, ID *new_id) ATTR_NONNULL()
void blender::BKE_main_library_weak_reference_update_item (MainLibraryWeakReferenceMap *library_weak_reference_mapping, const char *library_filepath, const char *library_id_name, ID *old_id, ID *new_id) ATTR_NONNULL()
void blender::BKE_main_library_weak_reference_remove_item (MainLibraryWeakReferenceMap *library_weak_reference_mapping, const char *library_filepath, const char *library_id_name, ID *old_id) ATTR_NONNULL()
ID * blender::BKE_main_library_weak_reference_find (Main *bmain, const char *library_filepath, const char *library_id_name)
void blender::BKE_main_library_weak_reference_add (ID *local_id, const char *library_filepath, const char *library_id_name)
BlendThumbnail * blender::BKE_main_thumbnail_from_buffer (Main *bmain, const uint8_t *rect, const int size[2])
BlendThumbnail * blender::BKE_main_thumbnail_from_imbuf (Main *bmain, ImBuf *img)
ImBuf * blender::BKE_main_thumbnail_to_imbuf (Main *bmain, BlendThumbnail *data)
void blender::BKE_main_thumbnail_create (Main *bmain)
const char * blender::BKE_main_blendfile_path (const Main *bmain) ATTR_NONNULL()
const char * blender::BKE_main_blendfile_path_from_global ()
const char * blender::BKE_main_blendfile_path_from_library (const Library &library)
ListBaseT< ID > * blender::which_libbase (Main *bmain, short type)
MainListsArray blender::BKE_main_lists_get (Main &bmain)

Detailed Description

Main struct

Main is the root of the 'data-base' of a Blender context. All data is put into lists, and all these lists are stored here.

Note
A Blender file is not much more than a binary dump of these lists. This list of lists is not serialized itself.
BKE_main files are for operations over the Main database itself, or generating extra temp data to help working with it. Those should typically not affect the data-blocks themselves.

Names

  • BKE_main_ should be used for functions in that file.

Definition in file BKE_main.hh.

Macro Definition Documentation

◆ BLEN_THUMB_MEMSIZE

#define BLEN_THUMB_MEMSIZE ( _x,
_y )
Value:
(sizeof(BlendThumbnail) + (size_t(_x) * size_t(_y)) * sizeof(int))

Definition at line 979 of file BKE_main.hh.

Referenced by blender::BKE_main_thumbnail_create(), blender::BKE_main_thumbnail_from_buffer(), blender::BKE_main_thumbnail_from_imbuf(), blender::blo_read_file_internal(), and blender::BLO_thumbnail_from_file().

◆ BLEN_THUMB_MEMSIZE_IS_VALID

#define BLEN_THUMB_MEMSIZE_IS_VALID ( _x,
_y )
Value:
(((_x) > 0 && (_y) > 0) && ((uint64_t)(_x) * (uint64_t)(_y) < (SIZE_MAX / (sizeof(int) * 4))))
#define SIZE_MAX
unsigned long long int uint64_t

Protect against buffer overflow vulnerability & negative sizes.

Definition at line 982 of file BKE_main.hh.

Referenced by blender::blo_read_file_internal(), blender::BLO_thumbnail_from_file(), and blender::read_file_thumbnail().

◆ BLEN_THUMB_SIZE

#define BLEN_THUMB_SIZE   128

The size of thumbnails (optionally) stored in the .blend files header.

NOTE(@ideasman42): This is kept small as it's stored uncompressed in the .blend file, where a larger size would increase the size of every .blend file unreasonably. If we wanted to increase the size, we'd want to use compression (JPEG or similar).

Definition at line 977 of file BKE_main.hh.

Referenced by blender::BKE_main_thumbnail_create(), blender::blend_file_thumb_from_camera(), and blender::blend_file_thumb_from_screenshot().

◆ FOREACH_MAIN_ID_BEGIN

#define FOREACH_MAIN_ID_BEGIN ( _bmain,
_id )
Value:
{ \
ListBaseT<ID> *_lb; \
FOREACH_MAIN_LISTBASE_BEGIN ((_bmain), _lb) { \
FOREACH_MAIN_LISTBASE_ID_BEGIN (_lb, (_id))

Top level foreach-like macro allowing to loop over all IDs in a given #Main data-base.

NOTE: Order tries to go from 'user IDs' to 'used IDs' (e.g. collections will be processed before objects, which will be processed before obdata types, etc.).

WARNING: DO NOT use break statement with that macro, use #FOREACH_MAIN_LISTBASE and #FOREACH_MAIN_LISTBASE_ID instead if you need that kind of control flow.

Definition at line 729 of file BKE_main.hh.

Referenced by blender::BKE_asset_weak_reference_foreach_main(), blender::BKE_blendfile_link_pack(), blender::BKE_blendfile_override(), blender::BKE_bpath_foreach_path_main(), blender::BKE_brush_duplicate(), blender::BKE_collection_duplicate(), blender::BKE_id_multi_tagged_delete(), blender::BKE_lib_id_clear_library_data(), blender::BKE_lib_override_library_create_from_id(), blender::BKE_lib_override_library_create_from_tag(), blender::BKE_lib_override_library_delete(), blender::BKE_lib_override_library_id_hierarchy_reset(), blender::BKE_lib_override_library_main_hierarchy_root_ensure(), blender::BKE_lib_override_library_main_operations_create(), blender::BKE_lib_override_library_main_operations_restore(), blender::BKE_lib_override_library_main_tag(), blender::BKE_lib_override_library_main_unused_cleanup(), blender::BKE_lib_override_library_main_update(), blender::BKE_lib_override_library_main_validate(), blender::BKE_lib_override_library_proxy_convert(), blender::BKE_libblock_find_session_uid(), blender::BKE_library_main_rebuild_hierarchy(), blender::BKE_library_unused_linked_data_set_tag(), blender::BKE_main_id_newptr_and_tag_clear(), blender::BKE_main_id_refcount_recompute(), blender::BKE_main_idmap_create(), blender::BKE_main_is_empty(), blender::BKE_main_merge(), blender::BKE_main_relations_create(), blender::BKE_main_set_create(), blender::BKE_object_duplicate(), blender::BKE_scene_duplicate(), blender::blendfile_relocate_postprocess_cleanup(), blender::blendfile_relocate_postprocess_liboverrides(), blender::blo_do_versions_280(), blender::blo_do_versions_300(), blender::blo_do_versions_404(), blender::BLO_main_validate_embedded_flag(), blender::BLO_main_validate_embedded_liboverrides(), blender::blo_read_file_internal(), blender::BLO_readfile_id_runtime_data_free_all(), blender::animrig::versioning::convert_legacy_action_assignments(), blender::ed::object::copy_object_set_idnew(), blender::do_versions_after_linking_250(), blender::do_versions_after_linking_300(), blender::do_versions_idproperty_ui_data(), blender::ED_preview_restart_work(), blender::expand_main(), blender::filelist_readjob_main_assets_add_items(), blender::ed::outliner::id_override_library_create_hierarchy(), blender::ed::outliner::id_override_library_create_hierarchy_process(), blender::IMB_colormanagement_working_space_convert(), blender::bke::blendfile::PartialWriteContext::is_valid(), blender::bke::greasepencil::convert::legacy_gpencil_sanitize_annotations(), blender::lib_link_all(), blender::lib_override_libraries_index_define(), blender::lib_override_library_main_resync_on_library_indirect_level(), blender::lib_override_library_resync(), blender::lib_override_library_resync_build_missing_ids_data(), blender::lib_override_prefill_newid_from_existing_overrides(), blender::lib_override_resync_tagging_finalize(), blender::lib_query_unused_ids_direct_tag(), blender::lib_query_unused_ids_recursive_tag(), blender::libblock_remap_data(), blender::library_link_begin(), blender::long_id_names_process_action_slots_identifiers(), blender::ed::object::make_override_library_exec(), blender::memfile_undosys_step_decode(), blender::ed::outliner::outliner_clear_newid_from_main(), blender::pack_linked_ids(), blender::UniqueName_Map::populate(), blender::ed::asset::pre_save_assets(), blender::read_undo_move_libmain_data(), blender::read_undo_remap_noundo_data(), blender::bke::blendfile::PartialWriteContext::remove_unused(), blender::replace_action(), blender::reuse_bmain_data_invalid_local_usages_fix(), blender::seq::seq_duplicate_postprocess(), blender::setup_app_data(), blender::animrig::versioning::tag_action_users_for_slotted_actions_conversion(), blender::UnusedIDsData::tag_ids(), blender::bke::tests::TEST_F(), blender::bke::tests::TEST_F(), blender::bke::tests::TEST_F(), blender::bke::tests::TEST_F(), blender::bke::tests::TEST_F(), blender::version_nla_action_strip_hold(), blender::version_nla_tweakmode_incomplete(), and blender::version_system_idprops_generate().

◆ FOREACH_MAIN_ID_END

#define FOREACH_MAIN_ID_END
Value:
} \
} \
((void)0)
#define FOREACH_MAIN_LISTBASE_ID_END
Definition BKE_main.hh:703
#define FOREACH_MAIN_LISTBASE_END
Definition BKE_main.hh:715

Definition at line 735 of file BKE_main.hh.

Referenced by blender::BKE_asset_weak_reference_foreach_main(), blender::BKE_blendfile_link_pack(), blender::BKE_blendfile_override(), blender::BKE_bpath_foreach_path_main(), blender::BKE_brush_duplicate(), blender::BKE_collection_duplicate(), blender::BKE_id_multi_tagged_delete(), blender::BKE_lib_id_clear_library_data(), blender::BKE_lib_override_library_create_from_id(), blender::BKE_lib_override_library_create_from_tag(), blender::BKE_lib_override_library_delete(), blender::BKE_lib_override_library_id_hierarchy_reset(), blender::BKE_lib_override_library_main_hierarchy_root_ensure(), blender::BKE_lib_override_library_main_operations_create(), blender::BKE_lib_override_library_main_operations_restore(), blender::BKE_lib_override_library_main_tag(), blender::BKE_lib_override_library_main_unused_cleanup(), blender::BKE_lib_override_library_main_update(), blender::BKE_lib_override_library_main_validate(), blender::BKE_lib_override_library_proxy_convert(), blender::BKE_libblock_find_session_uid(), blender::BKE_library_main_rebuild_hierarchy(), blender::BKE_library_unused_linked_data_set_tag(), blender::BKE_main_id_newptr_and_tag_clear(), blender::BKE_main_id_refcount_recompute(), blender::BKE_main_idmap_create(), blender::BKE_main_is_empty(), blender::BKE_main_merge(), blender::BKE_main_relations_create(), blender::BKE_main_set_create(), blender::BKE_object_duplicate(), blender::BKE_scene_duplicate(), blender::blendfile_relocate_postprocess_cleanup(), blender::blendfile_relocate_postprocess_liboverrides(), blender::blo_do_versions_280(), blender::blo_do_versions_300(), blender::blo_do_versions_404(), blender::BLO_main_validate_embedded_flag(), blender::BLO_main_validate_embedded_liboverrides(), blender::blo_read_file_internal(), blender::BLO_readfile_id_runtime_data_free_all(), blender::animrig::versioning::convert_legacy_action_assignments(), blender::ed::object::copy_object_set_idnew(), blender::do_versions_after_linking_250(), blender::do_versions_after_linking_300(), blender::do_versions_idproperty_ui_data(), blender::ED_preview_restart_work(), blender::expand_main(), blender::filelist_readjob_main_assets_add_items(), blender::ed::outliner::id_override_library_create_hierarchy(), blender::ed::outliner::id_override_library_create_hierarchy_process(), blender::IMB_colormanagement_working_space_convert(), blender::bke::blendfile::PartialWriteContext::is_valid(), blender::bke::greasepencil::convert::legacy_gpencil_sanitize_annotations(), blender::lib_link_all(), blender::lib_override_libraries_index_define(), blender::lib_override_library_main_resync_on_library_indirect_level(), blender::lib_override_library_resync(), blender::lib_override_library_resync_build_missing_ids_data(), blender::lib_override_prefill_newid_from_existing_overrides(), blender::lib_override_resync_tagging_finalize(), blender::lib_query_unused_ids_direct_tag(), blender::lib_query_unused_ids_recursive_tag(), blender::libblock_remap_data(), blender::library_link_begin(), blender::long_id_names_process_action_slots_identifiers(), blender::ed::object::make_override_library_exec(), blender::memfile_undosys_step_decode(), blender::ed::outliner::outliner_clear_newid_from_main(), blender::pack_linked_ids(), blender::UniqueName_Map::populate(), blender::ed::asset::pre_save_assets(), blender::read_undo_move_libmain_data(), blender::read_undo_remap_noundo_data(), blender::bke::blendfile::PartialWriteContext::remove_unused(), blender::replace_action(), blender::reuse_bmain_data_invalid_local_usages_fix(), blender::seq::seq_duplicate_postprocess(), blender::setup_app_data(), blender::animrig::versioning::tag_action_users_for_slotted_actions_conversion(), blender::UnusedIDsData::tag_ids(), blender::bke::tests::TEST_F(), blender::bke::tests::TEST_F(), blender::bke::tests::TEST_F(), blender::bke::tests::TEST_F(), blender::bke::tests::TEST_F(), blender::version_nla_action_strip_hold(), blender::version_nla_tweakmode_incomplete(), and blender::version_system_idprops_generate().

◆ FOREACH_MAIN_LISTBASE_BEGIN

◆ FOREACH_MAIN_LISTBASE_END

◆ FOREACH_MAIN_LISTBASE_ID_BEGIN

◆ FOREACH_MAIN_LISTBASE_ID_END

◆ LIBRARY_VERSION_FILE_ATLEAST

#define LIBRARY_VERSION_FILE_ATLEAST ( lib,
ver,
subver )
Value:
((lib)->runtime->versionfile == 0 || (lib)->runtime->versionfile > (ver) || \
((lib)->runtime->versionfile == (ver) && (lib)->runtime->subversionfile >= (subver)))
Note
in case versionfile is 0, this check is invalid, always return false then. This happens typically when a library is missing, by definition its data (placeholder IDs) does not need versioning anyway then.

Definition at line 966 of file BKE_main.hh.

Referenced by blender::blendfile_or_libraries_versions_atleast().

◆ MAIN_VERSION_FILE_ATLEAST

#define MAIN_VERSION_FILE_ATLEAST ( main,
ver,
subver )
Value:
((main)->versionfile > (ver) || \
((main)->versionfile == (ver) && (main)->subversionfile >= (subver)))
#define main()

Definition at line 949 of file BKE_main.hh.

Referenced by blender::blendfile_or_libraries_versions_atleast(), blender::blo_do_versions_250(), blender::blo_do_versions_260(), blender::blo_do_versions_270(), blender::blo_do_versions_280(), blender::blo_do_versions_290(), blender::blo_do_versions_300(), blender::blo_do_versions_400(), blender::blo_do_versions_401(), blender::blo_do_versions_402(), blender::blo_do_versions_403(), blender::blo_do_versions_404(), blender::blo_do_versions_405(), blender::blo_do_versions_500(), blender::blo_do_versions_501(), blender::blo_do_versions_502(), blender::blo_do_versions_503(), blender::blo_do_versions_pre250(), blender::do_versions(), blender::do_versions_after_linking_250(), blender::do_versions_after_linking_270(), blender::do_versions_after_linking_280(), blender::do_versions_after_linking_290(), blender::do_versions_after_linking_300(), blender::do_versions_after_linking_400(), blender::do_versions_after_linking_401(), blender::do_versions_after_linking_402(), blender::do_versions_after_linking_403(), blender::do_versions_after_linking_404(), blender::do_versions_after_linking_405(), blender::do_versions_after_linking_500(), blender::do_versions_after_linking_501(), blender::do_versions_after_linking_502(), blender::do_versions_after_linking_503(), and blender::version_get_scene_compositor_node_tree().

◆ MAIN_VERSION_FILE_OLDER

#define MAIN_VERSION_FILE_OLDER ( main,
ver,
subver )
Value:
((main)->versionfile < (ver) || \
((main)->versionfile == (ver) && (main)->subversionfile < (subver)))

Definition at line 953 of file BKE_main.hh.

Referenced by blender::blo_do_versions_260(), and blender::blo_do_versions_290().

◆ MAIN_VERSION_FILE_OLDER_OR_EQUAL

#define MAIN_VERSION_FILE_OLDER_OR_EQUAL ( main,
ver,
subver )
Value:
((main)->versionfile < (ver) || \
((main)->versionfile == (ver) && (main)->subversionfile <= (subver)))

Definition at line 957 of file BKE_main.hh.

Referenced by blender::blo_split_main(), blender::read_file_version_and_colorspace(), and blender::read_global().