Difference between revisions of "Developer Documentation"
From Synfig Studio :: Documentation
m (add links : Dev mailing list & Issue Tracker) |
m (add Ide intralink) |
||
| Line 10: | Line 10: | ||
* [[Building Documentation|Building Documentation]] | * [[Building Documentation|Building Documentation]] | ||
* {{l|Dev:Source code|Source code}} description and workflow | * {{l|Dev:Source code|Source code}} description and workflow | ||
| + | * {{l|Dev:IDE|IDE Setup}} | ||
* {{l|Dev:Roadmap|Roadmap}} | * {{l|Dev:Roadmap|Roadmap}} | ||
* {{l|Dev:Wish list|Wish List}} | * {{l|Dev:Wish list|Wish List}} | ||
Revision as of 19:40, 13 December 2014
The Developer Documentation part of this wiki is primarily for the following groups of people:
- Current developers of the code
- Future and potential developers
- Those interested in bug filing and generating ideas
Index:
- Build Instructions
- Building Documentation
- Source code description and workflow
- IDE Setup
- Roadmap
- Wish List
- Coding Conventions
- UI/UX Redesign
Synfig is divided into three main components: etl, synfig-core and synfig-studio.
- ETL is the extended template library. One of its most important components is the shared object class, which is the base class for most other parts of the application. Using "handles" to shared objects instead of c++ pointers provides garbage collection via reference counting.
- Synfig-core is the core/command-line (cli) renderer ("synfig") contains the document data structure for the application: valuenodes, layers, and canvases.
- Synfig Studio ("synfig-studio") provides the gui for the application.
- See also: How Synfig Works
Synfig use several external libs :
- Gtkmm 2, some work on branchs has been started to reach Gtkmm 3 (Migrating 2to3)
- Cairo (Cairo render mode)
- Freetype2 library (Text layer rendering in software render mode)
- libxmlplusplus (to parse the project files)
- Boost Program Options (synfig cli)
- MLT Framework - Media Loving Toolkit (Sound Layer)
Optionally you will also need :
- Magick++ the ImageMagick API (to build mod_magickpp, the magick++ module from synfig-core)
- libavcodec (to build mod_libavcodec, from synfig-core)
- libmng (to build mod_mng, from synfig-core)
... check the Build Instructions page for more detailed informations.
Complete coding tutorials:
- Adding a Layer
- Adding a Panel, Part I and Part II. Note: these are highly out of date please note that the directory "gtkmm" has been renamed to "gui", Panel is now know has Dock. Also, some files were moved into subfolders (take a look inside the "gui/docks" folder for example).
Other links:
