griefith/test
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Cleanup: BKE Blendfile: Improve PartialWriteContext documentation.

Browse Source
This commit is contained in:
Bastien Montagne
2024-07-23 18:20:08 +02:00
parent d5a55935ea
commit f69f920164
1 changed files with 16 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
source/blender/blenkernel/BKE_blendfile.hh
View File

@@ -255,6 +255,9 @@ class PartialWriteContext : NonCopyable, NonMovable {
*
* WARNING: This also means that dependencies like obdata, shape-keys or actions are not
* duplicated either.
*
* NOTE: Either #CLEAR_DEPENDENCIES or #ADD_DEPENDENCIES must be specified in the final
* operation flags for all ID dependencies. This can be achieved by
*/
CLEAR_DEPENDENCIES = 1 << 8,
/**
@@ -301,10 +304,13 @@ class PartialWriteContext : NonCopyable, NonMovable {
* already exists in the context, it is returned instead of duplicating it again.
*
* \param options: Control how the added ID (and its dependencies) are handled. See
* #IDAddOptions and #IDAddOperations above for details.
* \param dependencies_filter_cb: Optional, a callback called for each ID usages. Currently, only
* accepted return values are the ones included in
* #MASK_PER_ID_USAGE.
* #IDAddOptions and #IDAddOperations above for details.
* If no #dependencies_filter_cb callback is specified, #options.operations must contain
* either #CLEAR_DEPENDENCIES or #ADD_DEPENDENCIES.
* \param dependencies_filter_cb: Optional, a callback called for each ID usages, which returns
* specific operations flags for each ID usage.
* Currently, only accepted return values are the ones included in #MASK_PER_ID_USAGE.
* Returned flags must always contain either #CLEAR_DEPENDENCIES or #ADD_DEPENDENCIES.
*
* \return The pointer to the duplicated ID in the partial write context.
*/
@@ -322,10 +328,9 @@ class PartialWriteContext : NonCopyable, NonMovable {
* #matching_uid_map_, and its `session_uid` is not guaranteed to be constant (as it may be
* preempted later by another ID added from the current G_MAIN).
*
* \param options: Control how the added ID (and its dependencies) are handled. See
* #IDAddOptions and #IDAddOperations above for details, note that only
* relevant operations currently are the #SET_FAKE_USER and #SET_CLIPBOARD_MARK
* ones.
* \param options: Control how the created ID is handled. See #IDAddOptions and #IDAddOperations
* above for details, note that the only relevant operation flags currently are the
* #SET_FAKE_USER and #SET_CLIPBOARD_MARK ones.
*/
ID *id_create(short id_type, StringRefNull id_name, Library *library, IDAddOptions options);
@@ -345,10 +350,9 @@ class PartialWriteContext : NonCopyable, NonMovable {
* Remove all unused IDs from the current context.
*
* \param clear_extra_user: If `true`, the runtime tag ensuring that IDs are written on disk will
* be cleared. In other words, only IDs flagged with 'fake user' and
* their dependencies will be kept.
* Allows to also remove IDs that were added to this context during the
* same editing session, and were not flagged as 'fake user'.
* be cleared. In other words, only IDs flagged with 'fake user' and their dependencies
* will be kept. Allows to also remove IDs that were added to this context during the same
* editing session, and were not flagged as 'fake user'.
*/
void remove_unused(bool clear_extra_user = false);