diff options
| author | Bastien Montagne <bastien@blender.org> | 2022-04-29 17:31:27 +0300 |
|---|---|---|
| committer | Bastien Montagne <bastien@blender.org> | 2022-04-29 18:57:46 +0300 |
| commit | f44a34fc55ba367e201d13cf0a1eddfe13199f8a (patch) | |
| tree | 9100a43bced08d8ca1fd8a259fe9eb09e3cc73c0 /source/blender/blenkernel/BKE_lib_remap.h | |
| parent | 3b7bce45d23e033a135b16b5da6cd741867f0a78 (diff) | |
BKE_lib_remap: add comment note about some remapping options.
Fact that those options are only used in a specific case, and that the
same behavior is ensured in a different part of the code in other cases,
is fairly confusing and unfortunate... At least document it.
Diffstat (limited to 'source/blender/blenkernel/BKE_lib_remap.h')
| -rw-r--r-- | source/blender/blenkernel/BKE_lib_remap.h | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/source/blender/blenkernel/BKE_lib_remap.h b/source/blender/blenkernel/BKE_lib_remap.h index b66d53b2321..57afbefd508 100644 --- a/source/blender/blenkernel/BKE_lib_remap.h +++ b/source/blender/blenkernel/BKE_lib_remap.h @@ -182,11 +182,18 @@ typedef enum IDRemapperApplyOptions { * * For remapping the old ID users will be decremented and the new ID users will be * incremented. When un-assigning the old ID users will be decremented. + * + * NOTE: Currently unused by main remapping code, since usercount is handled by + * `foreach_libblock_remap_callback_apply` there, depending on whether the remapped pointer does + * use it or not. Need for rare cases in UI handling though (see e.g. `image_id_remap` in + * `space_image.c`). */ ID_REMAP_APPLY_UPDATE_REFCOUNT = (1 << 0), /** * Make sure that the new ID datablock will have a 'real' user. + * + * NOTE: See Note for #ID_REMAP_APPLY_UPDATE_REFCOUNT above. */ ID_REMAP_APPLY_ENSURE_REAL = (1 << 1), |