Docs: Add comments to node tree runtime struct clarifying design #118056

Merged
Hans Goudey merged 3 commits from HooglyBoogly/blender:cleanup-node-tree-runtime-comments into main 2024-02-12 17:44:21 +01:00
Member

Currently we have some old code from shader/compositor/texture nodes
that stores runtime data during and after evaluation on the node tree
itself. This is meant to be avoided, since the node tree is just meant
to be evaluation instructions.

Currently we have some old code from shader/compositor/texture nodes that stores runtime data during and after evaluation on the node tree itself. This is meant to be avoided, since the node tree is just meant to be evaluation _instructions_.
Hans Goudey added 1 commit 2024-02-09 19:10:53 +01:00
6292a2d7c7 Docs: Add comments to node tree runtime struct clarifying design
Currently we have some old code from shader/compositor/texture nodes
that stores runtime data during and after evaluation on the node tree
itself. This is meant to be avoided, since the node tree is just meant
to be evaluation _instructions_.
Hans Goudey requested review from Sergey Sharybin 2024-02-09 19:12:13 +01:00
Hans Goudey requested review from Jacques Lucke 2024-02-09 19:12:14 +01:00
Hans Goudey added this to the Nodes & Physics project 2024-02-09 19:12:22 +01:00
Jacques Lucke reviewed 2024-02-09 20:52:08 +01:00
@ -119,1 +119,3 @@
* as long as necessary, even while the tree is being modified.
* \todo Move this out of the node tree to improve semantic/physical separation between the node
* tree execution instructions and its evaluation. For example, storing execution data in the
* tree itself requires the evaluator to have ownership of the tree, which should be unnecessary.
Member

What does "ownership of the tree" mean here?

What does "ownership of the tree" mean here?
Author
Member

I'm referring to the way materials and scenes own bNodeTree, but trying not to be specific. I just mean that to evaluate a node tree you shouldn't have to modify it.

I'm referring to the way materials and scenes own `bNodeTree`, but trying not to be specific. I just mean that to evaluate a node tree you shouldn't have to modify it.
Member

I just mean that to evaluate a node tree you shouldn't have to modify it.

Maybe saying that directly would be better :)

> I just mean that to evaluate a node tree you shouldn't have to modify it. Maybe saying that directly would be better :)
Author
Member

Heh, yeah, probably, thanks!

Heh, yeah, probably, thanks!
HooglyBoogly marked this conversation as resolved
Sergey Sharybin approved these changes 2024-02-12 09:24:34 +01:00
Hans Goudey added 2 commits 2024-02-12 16:49:45 +01:00
Jacques Lucke approved these changes 2024-02-12 17:35:47 +01:00
Hans Goudey merged commit d434ef6566 into main 2024-02-12 17:44:21 +01:00
Hans Goudey deleted branch cleanup-node-tree-runtime-comments 2024-02-12 17:44:23 +01:00
Sign in to join this conversation.
No Label
Interest
Alembic
Interest
Animation & Rigging
Interest
Asset Browser
Interest
Asset Browser Project Overview
Interest
Audio
Interest
Automated Testing
Interest
Blender Asset Bundle
Interest
BlendFile
Interest
Collada
Interest
Compatibility
Interest
Compositing
Interest
Core
Interest
Cycles
Interest
Dependency Graph
Interest
Development Management
Interest
EEVEE
Interest
EEVEE & Viewport
Interest
Freestyle
Interest
Geometry Nodes
Interest
Grease Pencil
Interest
ID Management
Interest
Images & Movies
Interest
Import Export
Interest
Line Art
Interest
Masking
Interest
Metal
Interest
Modeling
Interest
Modifiers
Interest
Motion Tracking
Interest
Nodes & Physics
Interest
OpenGL
Interest
Overlay
Interest
Overrides
Interest
Performance
Interest
Physics
Interest
Pipeline, Assets & IO
Interest
Platforms, Builds & Tests
Interest
Python API
Interest
Render & Cycles
Interest
Render Pipeline
Interest
Sculpt, Paint & Texture
Interest
Text Editor
Interest
Translations
Interest
Triaging
Interest
Undo
Interest
USD
Interest
User Interface
Interest
UV Editing
Interest
VFX & Video
Interest
Video Sequencer
Interest
Virtual Reality
Interest
Vulkan
Interest
Wayland
Interest
Workbench
Interest: X11
Legacy
Blender 2.8 Project
Legacy
Milestone 1: Basic, Local Asset Browser
Legacy
OpenGL Error
Meta
Good First Issue
Meta
Papercut
Meta
Retrospective
Meta
Security
Module
Animation & Rigging
Module
Core
Module
Development Management
Module
EEVEE & Viewport
Module
Grease Pencil
Module
Modeling
Module
Nodes & Physics
Module
Pipeline, Assets & IO
Module
Platforms, Builds & Tests
Module
Python API
Module
Render & Cycles
Module
Sculpt, Paint & Texture
Module
Triaging
Module
User Interface
Module
VFX & Video
Platform
FreeBSD
Platform
Linux
Platform
macOS
Platform
Windows
Priority
High
Priority
Low
Priority
Normal
Priority
Unbreak Now!
Status
Archived
Status
Confirmed
Status
Duplicate
Status
Needs Info from Developers
Status
Needs Information from User
Status
Needs Triage
Status
Resolved
Type
Bug
Type
Design
Type
Known Issue
Type
Patch
Type
Report
Type
To Do
No Milestone
No Assignees
3 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#118056
No description provided.