Maniphest T93407

Blender 3.0: Code Architecture Wiki Documentation
Confirmed, NormalTO DO

Assigned To
None
Authored By
Dalai Felinto (dfelinto)
Nov 26 2021, 3:49 PM
Tags
  • Development Management
  • BF Blender
Subscribers
Bastien Montagne (mont29)
Brecht Van Lommel (brecht)
Dalai Felinto (dfelinto)
Evan Wilson (EAW)
Gorro_Rojo (Gorro_Rojo)
James Partsafas (JamesPartsafas)
Jeroen Bakker (jbakker)
5 More Subscribers
Tokens
"Love" token, awarded by mindinsomnia."100" token, awarded by EAW."Y So Serious" token, awarded by shader."Love" token, awarded by liquidificador."Love" token, awarded by ShenCiao."Love" token, awarded by PiloeGAO."Love" token, awarded by Raimund58."Love" token, awarded by filedescriptor.

Description

Architecture Wiki Documentation

The state of the online documentation is behind. As part of wrapping up the 3.0 release and preparing the 3.1 development a list of pasts of Blender will be tackled. The focus is on active areas that have overlap within different modules.

The audience is other developers that need to understand the main aspects of the code and its design constraints.


How to collaborate:

  • Choose one topic, edit this document to have your name besides this area.
  • Write the docs, ask for feedback, mark as done.

List of topics to be documented:

  • DNA (padding, rename, defaults).
  • ID Management. @Bastien Montagne (mont29)
    • Define general structure of this section.
    • Move existing Source/Architecture/ID page under this section and update it.
    • Get review for proposed structure.
    • Flesh out the documentation.
  • Undo (needs to be revised). Draft: P2674.
  • .blend file read/write
  • BMesh (relation with mesh, custom data, attributes).
  • Depsgraph (updated version).
  • Constraints.
  • Animation data.
  • Nodes sockets and animation data.
  • Geometry nodes and object types (point cloud, instances, curves, geometry nodes relation with other modifiers).
  • Gizmos.
  • message_bus.
  • Event system.
  • Notifiers.
  • Screen hierarchy.
  • GPU (batches).
  • Draw manager.
  • Selection.
  • Color management.
  • Overlay.
  • Motion track.
  • Bonus: Grease Pencil and Line Art.
  • Cycles
    • Scene graph
    • Closures
    • Volumes
    • Light sampling
    • Threads
    • EXR cache

Revisions and Commits

rB Blender
D13501

Related Objects

Event Timeline

Dalai Felinto (dfelinto) changed the task status from Needs Triage to Confirmed.Nov 26 2021, 3:49 PM
Dalai Felinto (dfelinto) created this task.
Dalai Felinto (dfelinto) added projects: Development Management, BF Blender.
Dalai Felinto (dfelinto) changed the subtype of this task from "Report" to "To Do".
Dalai Felinto (dfelinto) renamed this task from Blender 3.0: Architecture Wiki Documentation to Blender 3.0: Code Architecture Wiki Documentation.Nov 26 2021, 3:56 PM
Dalai Felinto (dfelinto) added subscribers: Sergey Sharybin (sergey), Brecht Van Lommel (brecht), Bastien Montagne (mont29) and 3 others.
Dalai Felinto (dfelinto) added a subscriber: Julian Eisel (Severin).Nov 26 2021, 4:13 PM
Falk David (filedescriptor) awarded a token.Nov 26 2021, 4:14 PM
Raimund Klink (Raimund58) awarded a token.Nov 26 2021, 4:19 PM
Léo Depoix (PiloeGAO) awarded a token.Nov 26 2021, 4:34 PM
Brecht Van Lommel (brecht) updated the task description.Nov 26 2021, 4:41 PM
James Partsafas (JamesPartsafas) added a subscriber: James Partsafas (JamesPartsafas).Nov 27 2021, 12:43 AM
Bastien Montagne (mont29) updated the task description.Nov 29 2021, 9:06 AM
Shen Ciao (ShenCiao) awarded a token.Nov 29 2021, 11:16 AM
G. Solis (liquidificador) awarded a token.Nov 29 2021, 5:53 PM
Bastien Montagne (mont29) updated the task description.Nov 30 2021, 10:23 AM
Bataev Artem (shader) awarded a token.Nov 30 2021, 12:43 PM
Evan Wilson (EAW) awarded a token.Dec 1 2021, 2:25 AM
Evan Wilson (EAW) added a subscriber: Evan Wilson (EAW).
Bastien Montagne (mont29) updated the task description.Dec 6 2021, 3:18 PM
Mindinsomnia (mindinsomnia) awarded a token.Dec 7 2021, 10:40 AM
Hans Goudey (HooglyBoogly) added a commit: rB7fbb767259bf: Docs: Add more comments to geometry set header.Dec 7 2021, 7:04 PM
Gorro_Rojo (Gorro_Rojo) added a subscriber: Gorro_Rojo (Gorro_Rojo).Dec 9 2021, 4:23 PM
Campbell Barton (campbellbarton) updated the task description.Dec 20 2021, 7:48 AM
Shen Ciao (ShenCiao) added a subscriber: Shen Ciao (ShenCiao).Dec 27 2021, 4:14 PM
Jacques Lucke (JacquesLucke) closed subtask T93753: Technical docs about geometry nodes in the wiki as Resolved.Dec 29 2021, 2:55 PM
Philipp Oeser (lichtwerk) added a subscriber: Philipp Oeser (lichtwerk).Feb 7 2022, 11:38 AM
Gorro_Rojo (Gorro_Rojo) added a comment.Feb 15 2022, 2:57 PM

Hi! As someone trying to get into Blender Dev, I'm a bit at a loss with the current state of the documentation and was wondering what happenned to this project? Specially since the 3.1 release is just around the corner and only a couple sub-items from this list appear to have been tackled.

Brecht Van Lommel (brecht) moved this task from Backlog to Code Quality on the Development Management board.Oct 5 2022, 4:19 PM