[Bf-docboard-svn] bf-manual: [8804] trunk/blender_docs/manual: Geometry Nodes: Node execution time overlay

[Hans Goudey]

Revision: 8804
          https://developer.blender.org/rBM8804
Author:   HooglyBoogly
Date:     2022-01-06 05:34:38 +0100 (Thu, 06 Jan 2022)
Log Message:
-----------
Geometry Nodes: Node execution time overlay

rBe4986f92f32b096aa85440f8f517e38fcdf15e07

Modified Paths:
--------------
    trunk/blender_docs/manual/modeling/geometry_nodes/fields.rst
    trunk/blender_docs/manual/modeling/geometry_nodes/inspection.rst

Added Paths:
-----------
    trunk/blender_docs/manual/images/modeling_geometry-nodes_inspection_node-timings.png

Added: trunk/blender_docs/manual/images/modeling_geometry-nodes_inspection_node-timings.png
===================================================================
(Binary files differ)

Index: trunk/blender_docs/manual/images/modeling_geometry-nodes_inspection_node-timings.png
===================================================================
--- trunk/blender_docs/manual/images/modeling_geometry-nodes_inspection_node-timings.png	2021-12-31 03:04:15 UTC (rev 8803)
+++ trunk/blender_docs/manual/images/modeling_geometry-nodes_inspection_node-timings.png	2022-01-06 04:34:38 UTC (rev 8804)

Property changes on: trunk/blender_docs/manual/images/modeling_geometry-nodes_inspection_node-timings.png
___________________________________________________________________
Added: svn:mime-type
## -0,0 +1 ##
+image/png
\ No newline at end of property
Modified: trunk/blender_docs/manual/modeling/geometry_nodes/fields.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/fields.rst	2021-12-31 03:04:15 UTC (rev 8803)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/fields.rst	2022-01-06 04:34:38 UTC (rev 8804)
@@ -65,6 +65,7 @@
 If you make the mistake of connecting a non-field socket to a field socket,
 the connection will be drawn as a solid red line indicating that there is an error.
 
+.. _field-node-types:
 
 Node Types
 ==========

Modified: trunk/blender_docs/manual/modeling/geometry_nodes/inspection.rst
===================================================================
--- trunk/blender_docs/manual/modeling/geometry_nodes/inspection.rst	2021-12-31 03:04:15 UTC (rev 8803)
+++ trunk/blender_docs/manual/modeling/geometry_nodes/inspection.rst	2022-01-06 04:34:38 UTC (rev 8804)
@@ -31,7 +31,7 @@
 data types the geometry contains, and a count of their elements.
 
 Socket values are only logged from when the node tree was executed, so a node must be
-connected to the group output to have a value for inspection. Values are not logged during
+connected to the *Group Output* to have a value for inspection. Values are not logged during
 rendering, to improve performance.
 
 
@@ -65,5 +65,29 @@
 
 When the inputs to a node are invalid, it displays a warning in the title.
 Hovering over the warning icon shows the error message. These warnings are only
-generated when the node is executed, so a node must be connected to the group output
+generated when the node is executed, so a node must be connected to the *Group Output*
 to have a warning.
+
+
+Node Timings Overlay
+====================
+
+.. figure:: /images/modeling_geometry-nodes_inspection_node-timings.png
+   :align: center
+
+   The node timings overlay.
+
+Node timings show how long a node took to execute the last time the node group was evaluated.
+They can be turned on in the overlays popover on the top right of the node editor.
+When a node group is used in multiple places, the timings depend on the context of
+the node editor, which is displayed in the path on the top left.
+
+Frame nodes display the total time from all of the contained nodes
+and the *Group Output* node displays the total time for the entire node group.
+
+The displayed timings should only be considered an approximation, since they can
+also take into account actions like copying or deleting a geometry input that aren't
+part of the node's operation. Also, when a node uses multiple CPU cores, the evaluation
+system might work on other nodes at the same time. It's also important to remember
+that :ref:`field nodes <field-node-types>` generally don't do work by themselves,
+so their execution time is only added to the data-flow nodes they are connected to.
\ No newline at end of file