Commit: 58acb05061876bb384de9a267ea264ca74764648
Author: Dalai Felinto
Date:   Wed Nov 30 13:04:09 2016 +0100
Branches: render-layers
https://developer.blender.org/rB58acb05061876bb384de9a267ea264ca74764648

Add description for the functions

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

M       source/blender/blenkernel/intern/collection.c
M       source/blender/blenkernel/intern/layer.c

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

diff --git a/source/blender/blenkernel/intern/collection.c 
b/source/blender/blenkernel/intern/collection.c
index 5b7131b..b45c7a8 100644
--- a/source/blender/blenkernel/intern/collection.c
+++ b/source/blender/blenkernel/intern/collection.c
@@ -38,6 +38,10 @@
 
 #include "MEM_guardedalloc.h"
 
+/*
+ * Add a collection to a collection ListBase and syncronize all render layers
+ * The ListBase is NULL when the collection is to be added to the master 
collection
+ */
 Collection *BKE_collection_add(Scene *scene, ListBase *lb, const char *name)
 {
        Collection *cl = MEM_callocN(sizeof(Collection), "New Collection");
@@ -91,6 +95,9 @@ static bool collection_remlink(Collection *cl, Collection 
*cl_gone)
        return false;
 }
 
+/*
+ * Remove a collection from the scene, and syncronize all render layers
+ */
 void BKE_collection_remove(Scene *scene, Collection *cl)
 {
        Collection *cl_master = BKE_collection_master(scene);
@@ -107,12 +114,18 @@ void BKE_collection_remove(Scene *scene, Collection *cl)
        MEM_freeN(cl);
 }
 
+/*
+ * Returns the master collection
+ */
 Collection *BKE_collection_master(Scene *scene)
 {
        return scene->collections.first;
 }
 
-void BKE_collection_object_add(struct Scene *scene, struct Collection *cl, 
struct Object *ob)
+/*
+ * Add object to collection
+ */
+void BKE_collection_object_add(struct Scene *UNUSED(scene), struct Collection 
*cl, struct Object *ob)
 {
        BLI_addtail(&cl->objects, BLI_genericNodeN(ob));
        id_us_plus((ID *)ob);
diff --git a/source/blender/blenkernel/intern/layer.c 
b/source/blender/blenkernel/intern/layer.c
index 0ed7bb1..302e7ef 100644
--- a/source/blender/blenkernel/intern/layer.c
+++ b/source/blender/blenkernel/intern/layer.c
@@ -42,6 +42,10 @@ CollectionBase *collection_base_add(RenderLayer *rl, 
ListBase *lb, Collection *c
 
 /* RenderLayer */
 
+/*
+ * Add a new renderlayer
+ * by default, a renderlayer has the master collection
+ */
 RenderLayer *BKE_render_layer_add(Scene *scene, const char *name)
 {
        RenderLayer *rl = MEM_callocN(sizeof(RenderLayer), "Render Layer");
@@ -52,6 +56,9 @@ RenderLayer *BKE_render_layer_add(Scene *scene, const char 
*name)
        return rl;
 }
 
+/*
+ * Set the render engine of a renderlayer
+ */
 void BKE_render_layer_engine_set(struct RenderLayer *rl, const char *engine)
 {
        BLI_strncpy(rl->engine, engine, sizeof(rl->engine));
@@ -84,6 +91,10 @@ static ObjectBase *object_base_add(RenderLayer *rl, Object 
*ob)
 
 /* CollectionBase */
 
+/*
+ * Link a collection to a renderlayer
+ * The collection needs to be created separately
+ */
 CollectionBase *BKE_collection_link(RenderLayer *rl, Collection *cl)
 {
        CollectionBase *base = collection_base_add(rl, &rl->collection_bases, 
cl);
@@ -102,6 +113,10 @@ static void collection_base_free(RenderLayer *rl, 
CollectionBase *cb)
        }
 }
 
+/*
+ * Unlink a collection base from a renderlayer
+ * The corresponding collection is not removed from the master collection
+ */
 void BKE_collection_unlink(RenderLayer *rl, CollectionBase *cb)
 {
        collection_base_free(rl, cb);
@@ -154,6 +169,9 @@ CollectionBase *collection_base_add(RenderLayer *rl, 
ListBase *lb, Collection *c
 
 /* Override */
 
+/*
+ * Add a new datablock override
+ */
 void BKE_collection_override_datablock_add(CollectionBase *UNUSED(cb), const 
char *UNUSED(data_path), ID *UNUSED(id))
 {
        TODO_LAYER_OVERRIDE;

_______________________________________________
Bf-blender-cvs mailing list
[email protected]
https://lists.blender.org/mailman/listinfo/bf-blender-cvs

Reply via email to