diff options
Diffstat (limited to 'source/blender/blenkernel/BKE_library.h')
| -rw-r--r-- | source/blender/blenkernel/BKE_library.h | 43 |
1 files changed, 23 insertions, 20 deletions
diff --git a/source/blender/blenkernel/BKE_library.h b/source/blender/blenkernel/BKE_library.h index 82ae832c73e..54b9fdac5b4 100644 --- a/source/blender/blenkernel/BKE_library.h +++ b/source/blender/blenkernel/BKE_library.h @@ -34,13 +34,13 @@ extern "C" { * WARNING: description below is ideal goal, current status of naming does not yet * fully follow it (this is WIP). * - * BKE_id_ should be used for rather high-level operations, that involve Main database and - * relations with other IDs, and can be considered as 'safe' (as in, in themselves, they leave - * affected IDs/Main in a consistent status). + * - BKE_id_ should be used for rather high-level operations, that involve Main database and + * relations with other IDs, and can be considered as 'safe' + * (as in, in themselves, they leave affected IDs/Main in a consistent status). * - * BKE_libblock_ should be used for lower level operations, that perform some parts of BKE_id_ ones, - * but will generally not ensure caller that affected data is in a consistent state - * by their own execution alone. + * - BKE_libblock_ should be used for lower level operations, + * that perform some parts of BKE_id_ ones, but will generally not ensure caller that affected + * data is in a consistent state by their own execution alone. * * Consequently, external code should not typically use BKE_libblock_ functions, * except in some specific cases requiring advanced (and potentially dangerous) handling. @@ -72,44 +72,47 @@ void *BKE_id_new_nomain(const short type, const char *name); */ enum { /* *** Generic options (should be handled by all ID types copying, ID creation, etc.). *** */ - /* Create datablock outside of any main database - similar to 'localize' functions of materials etc. */ + /** Create datablock outside of any main database - + * similar to 'localize' functions of materials etc. */ LIB_ID_CREATE_NO_MAIN = 1 << 0, - /* Do not affect user refcount of datablocks used by new one (which also gets zero usercount then). + /** Do not affect user refcount of datablocks used by new one + * (which also gets zero usercount then). * Implies LIB_ID_CREATE_NO_MAIN. */ LIB_ID_CREATE_NO_USER_REFCOUNT = 1 << 1, - /* Assume given 'newid' already points to allocated memory for whole datablock (ID + data) - USE WITH CAUTION! + /** Assume given 'newid' already points to allocated memory for whole datablock + * (ID + data) - USE WITH CAUTION! * Implies LIB_ID_CREATE_NO_MAIN. */ LIB_ID_CREATE_NO_ALLOCATE = 1 << 2, - /* Do not tag new ID for update in depsgraph. */ + /** Do not tag new ID for update in depsgraph. */ LIB_ID_CREATE_NO_DEG_TAG = 1 << 8, /* *** Specific options to some ID types or usages. *** */ /* *** May be ignored by unrelated ID copying functions. *** */ - /* Object only, needed by make_local code. */ + /** Object only, needed by make_local code. */ LIB_ID_COPY_NO_PROXY_CLEAR = 1 << 16, - /* Do not copy preview data, when supported. */ + /** Do not copy preview data, when supported. */ LIB_ID_COPY_NO_PREVIEW = 1 << 17, - /* Copy runtime data caches. */ + /** Copy runtime data caches. */ LIB_ID_COPY_CACHES = 1 << 18, - /* Don't copy id->adt, used by ID datablock localization routines. */ + /** Don't copy id->adt, used by ID datablock localization routines. */ LIB_ID_COPY_NO_ANIMDATA = 1 << 19, - /* Mesh: Reference CD data layers instead of doing real copy - USE WITH CAUTION! */ + /** Mesh: Reference CD data layers instead of doing real copy - USE WITH CAUTION! */ LIB_ID_COPY_CD_REFERENCE = 1 << 20, /* *** XXX Hackish/not-so-nice specific behaviors needed for some corner cases. *** */ /* *** Ideally we should not have those, but we need them for now... *** */ - /* EXCEPTION! Deep-copy actions used by animdata of copied ID. */ + /** EXCEPTION! Deep-copy actions used by animdata of copied ID. */ LIB_ID_COPY_ACTIONS = 1 << 24, - /* Keep the library pointer when copying datablock outside of bmain. */ + /** Keep the library pointer when copying datablock outside of bmain. */ LIB_ID_COPY_KEEP_LIB = 1 << 25, - /* EXCEPTION! Deep-copy shapekeys used by copied obdata ID. */ + /** EXCEPTION! Deep-copy shapekeys used by copied obdata ID. */ LIB_ID_COPY_SHAPEKEY = 1 << 26, /* *** Helper 'defines' gathering most common flag sets. *** */ - /* Shapekeys are not real ID's, more like local data to geometry IDs... */ + /** Shapekeys are not real ID's, more like local data to geometry IDs... */ LIB_ID_COPY_DEFAULT = LIB_ID_COPY_SHAPEKEY, - /* Generate a local copy, outside of bmain, to work on (used by COW e.g.). */ + /** Generate a local copy, outside of bmain, to work on (used by COW e.g.). */ LIB_ID_COPY_LOCALIZE = LIB_ID_CREATE_NO_MAIN | LIB_ID_CREATE_NO_USER_REFCOUNT | LIB_ID_CREATE_NO_DEG_TAG | LIB_ID_COPY_NO_PREVIEW | LIB_ID_COPY_CACHES, }; |