add some docu to scene_node functions

Mon, 06 Apr 2026 20:27:11 +0200

author
Mike Becker <universe@uap-core.de>
date
Mon, 06 Apr 2026 20:27:11 +0200
changeset 302
066481b8b3a5
parent 301
10f7d14405b6
child 303
21ff357e773c

add some docu to scene_node functions

src/ascension/scene_node.h file | annotate | diff | comparison | revisions
--- a/src/ascension/scene_node.h	Sun Feb 08 14:47:28 2026 +0100
+++ b/src/ascension/scene_node.h	Mon Apr 06 20:27:11 2026 +0200
@@ -214,14 +214,30 @@
  * Unlinks a node from its parent.
  *
  * This might be useful to temporarily remove a subtree from a scene.
- * To permanently remove the node use asc_scene_node_free().
+ * To permanently remove the node, use asc_scene_node_free().
  *
  * @param node the node to unlink
  */
 void asc_scene_node_remove(AscSceneNode *node);
 
+/**
+ * Advises the node to update its graphics.
+ * This usually involves updating the geometry / mesh, etc.
+ *
+ * @param node the node
+ */
 void asc_scene_node_update(AscSceneNode *node);
 
+/**
+ * Advises the node to recalculate transformation matrices.
+ * This is recursively applied to all children.
+ *
+ * Usually you never need to call this function manually.
+ * It is automatically called when you manipulate the transformation components
+ * via the respective setters.
+ *
+ * @param node the node
+ */
 void asc_scene_node_update_transform(AscSceneNode *node);
 
 /**

mercurial