[Bf-blender-cvs] [d2f2f732a5f] blenloader-api: add comment in ModifierTypeInfo

Jacques Lucke noreply at git.blender.org
Sun Mar 8 12:39:29 CET 2020


Commit: d2f2f732a5fa3f9983465876edec61b3a3ce118a
Author: Jacques Lucke
Date:   Sun Mar 8 12:24:51 2020 +0100
Branches: blenloader-api
https://developer.blender.org/rBd2f2f732a5fa3f9983465876edec61b3a3ce118a

add comment in ModifierTypeInfo

===================================================================

M	source/blender/blenkernel/BKE_modifier.h

===================================================================

diff --git a/source/blender/blenkernel/BKE_modifier.h b/source/blender/blenkernel/BKE_modifier.h
index 36ee212a9e6..847f828a2a2 100644
--- a/source/blender/blenkernel/BKE_modifier.h
+++ b/source/blender/blenkernel/BKE_modifier.h
@@ -336,7 +336,19 @@ typedef struct ModifierTypeInfo {
    */
   void (*freeRuntimeData)(void *runtime_data);
 
+  /* Is called when the modifier is written to a file. The modifier data struct itself is written
+   * already.
+   *
+   * This method should write any additional arrays and referenced structs that should be
+   * stored in the file.
+   */
   void (*bloWrite)(struct BloWriter *writer, const struct ModifierData *md);
+
+  /* Is called when the modifier is read from a file.
+   *
+   * It can be used to update pointers to arrays and other structs. Furthermore, fields that have
+   * not been written (e.g. runtime data) can be reset.
+   */
   void (*bloRead)(struct BloReader *reader, struct ModifierData *md);
 } ModifierTypeInfo;



More information about the Bf-blender-cvs mailing list