aseprite
/
aseprite
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
aseprite/src/README.md

61 lines
2.3 KiB
Markdown
Raw Normal View History

Update src/README.md
2013-08-05 18:40:48 -07:00
# Aseprite Source Code
Add "she" layer. This is the starting point to create a layer to isolate Allegro access. In the future, we will be able to switch to SDL or Allegro 5 easily. Anyway this will be a progressive refactoring.
2012-07-14 12:55:16 -07:00
Update src/README.md
2013-08-05 18:40:48 -07:00
If you are here is because you want to learn about Aseprite source
Refactor: Create doc::Context and move some logic from app::Document to doc::Document The objective of these changes is to create a more testable doc/logic API. Included changes: - Added doc::Context, doc::Documents (the old app::Documents), and doc::Sprites (and observers for each) - Added raster::Sprite::createBasicSprite() - Added doc::ColorMode (equal to raster::PixelFormat) - Added some methods to doc::Document: context(), sprites(), sprite() (to replace app::Document::getSprite()), width/height(), colorMode(), name(), and close() - Moved app::DocumentObserver/Event to doc::DocumentObserver/Event - Replaced app::ContextObserver with doc::DocumentsObserver and a couple of signals. - Renamed app::Context::getActiveDocument() with doc::Context::activeDocument() - Renamed app::Context::getActiveLocation() with app::Context::activeLocation() - Removed app::ContextObserverList - Removed app::DocumentId (now we can use doc::ObjectId) - Removed app::Context::getSettings()
2014-07-28 20:53:24 -07:00
code. We'll try to write in these `README.md` files a summary of each
Add "she" layer. This is the starting point to create a layer to isolate Allegro access. In the future, we will be able to switch to SDL or Allegro 5 easily. Anyway this will be a progressive refactoring.
2012-07-14 12:55:16 -07:00
module/library.
Update src/README.md
2013-08-05 18:40:48 -07:00
# Modules & Libraries
Aseprite is separated in the following layers/modules:
## Level 0: Completely independent modules
These libraries are easy to be used and embedded in other software
because they don't depend on any other component.
* [allegro](allegro/): Modified version of [Allegro](http://alleg.sourceforge.net/) library, used for keyboard/mouse input, and drawing 2D graphics on screen.
* [base](base/): Core/basic stuff, multithreading, utf8, sha1, file system, memory, etc.
Refactor: Create doc::Context and move some logic from app::Document to doc::Document The objective of these changes is to create a more testable doc/logic API. Included changes: - Added doc::Context, doc::Documents (the old app::Documents), and doc::Sprites (and observers for each) - Added raster::Sprite::createBasicSprite() - Added doc::ColorMode (equal to raster::PixelFormat) - Added some methods to doc::Document: context(), sprites(), sprite() (to replace app::Document::getSprite()), width/height(), colorMode(), name(), and close() - Moved app::DocumentObserver/Event to doc::DocumentObserver/Event - Replaced app::ContextObserver with doc::DocumentsObserver and a couple of signals. - Renamed app::Context::getActiveDocument() with doc::Context::activeDocument() - Renamed app::Context::getActiveLocation() with app::Context::activeLocation() - Removed app::ContextObserverList - Removed app::DocumentId (now we can use doc::ObjectId) - Removed app::Context::getSettings()
2014-07-28 20:53:24 -07:00
* [css](css/): Pseudo-style sheet library.
doc and gfx libraries depends on fixmath (fix #817)
2015-09-24 06:02:52 -07:00
* [fixmath](fixmath/): Fixed point operations (original code from Allegro code by Shawn Hargreaves).
* [flic](flic/): Library to load/save FLI/FLC files.
Remove reference to V8 in README.md
2015-10-28 15:45:01 -07:00
* [scripting](scripting/): JavaScript engine.
Rename undo2 to undo library Now that the old undo library doesn't exist, we can use "undo" namespace again.
2015-01-18 17:16:29 -08:00
* [undo](undo/): Generic library to manage a history of undoable commands.
Update src/README.md
2013-08-05 18:40:48 -07:00
## Level 1
Add simpleini to replace Allegro 4 configuration routines
2014-10-16 17:27:25 -07:00
* [cfg](cfg/) (base): Library to load/save .ini files.
Add "gen" utility to generate UI widget wrappers from XML files
2014-07-13 09:24:57 -07:00
* [gen](gen/) (base): Helper utility to generate C++ files from different XMLs.
doc and gfx libraries depends on fixmath (fix #817)
2015-09-24 06:02:52 -07:00
* [gfx](gfx/) (fixmath): Abstract graphics structures like point, size, rectangle, region, color, etc.
Change README.md to see dependencies between (...)
2013-08-05 18:58:07 -07:00
* [net](net/) (base): Networking library to send HTTP requests.
Remove mongoose code The webserver isn't functional yet, and mongoose license is GPL now.
2016-02-16 13:52:15 -08:00
* [webserver](webserver/) (base): HTTP web server
Update src/README.md
2013-08-05 18:40:48 -07:00
## Level 2
doc and gfx libraries depends on fixmath (fix #817)
2015-09-24 06:02:52 -07:00
* [doc](doc/) (base, fixmath, gfx): Document model library.
* [she](she/) (allegro, base, gfx): A wrapper for the Allegro library.
## Level 3
Merge "raster" namespace into "doc" library
2014-10-20 18:21:31 -07:00
* [filters](filters/) (base, doc, gfx): Effects for images.
doc and gfx libraries depends on fixmath (fix #817)
2015-09-24 06:02:52 -07:00
* [render](render/) (base, doc, gfx): Library to render documents.
Change README.md to see dependencies between (...)
2013-08-05 18:58:07 -07:00
* [ui](ui/) (base, gfx, she): Portable UI library (buttons, windows, text fields, etc.)
* [updater](updater/) (base, net): Component to check for updates.
Update src/README.md
2013-08-05 18:40:48 -07:00
doc and gfx libraries depends on fixmath (fix #817)
2015-09-24 06:02:52 -07:00
## Level 4
Update src/README.md
2013-08-05 18:40:48 -07:00
Unify all render code in one library Changes: * Create render library (move util/render.cpp to render/render.cpp) * Move app::Zoom class to render::Zoom * Remove doc::Image::merge() member function * Add gfx::Clip helper class (to clip dst/src rectangles before a blit) * Move doc::composite_image() to render::composite_image() * Remove doc::Sprite::render() * Replace Sprite::getPixel() with render::get_sprite_pixel() * Remove doc::layer_render() function * Convert DitheringMethod to a enum class * Add AppRender to configure a render::Render with the app configuration * Move checked background preferences as document-specific configuration * Add doc::Sprite::layer() and palette() member functions * Add doc::Layer::cel() member function * Add doc::Palette::entry() member function() * Add doc::frame_t type * Move create_palette_from_rgb/convert_pixel_format to render library * ExportSpriteSheet doesn't need a temporary image now that we can specify the source rectangle in the render routine
2014-12-28 06:06:11 -08:00
* [iff](iff/) (base, doc, render): Image File Formats library (load/save documents).
Update src/README.md
2013-08-05 18:40:48 -07:00
doc and gfx libraries depends on fixmath (fix #817)
2015-09-24 06:02:52 -07:00
## Level 5
Update src/README.md
2013-08-05 18:40:48 -07:00
doc and gfx libraries depends on fixmath (fix #817)
2015-09-24 06:02:52 -07:00
* [app](app/) (allegro, base, doc, filters, fixmath, gfx, iff, render, scripting, she, ui, undo, updater, webserver)
Refactor: Create doc::Context and move some logic from app::Document to doc::Document The objective of these changes is to create a more testable doc/logic API. Included changes: - Added doc::Context, doc::Documents (the old app::Documents), and doc::Sprites (and observers for each) - Added raster::Sprite::createBasicSprite() - Added doc::ColorMode (equal to raster::PixelFormat) - Added some methods to doc::Document: context(), sprites(), sprite() (to replace app::Document::getSprite()), width/height(), colorMode(), name(), and close() - Moved app::DocumentObserver/Event to doc::DocumentObserver/Event - Replaced app::ContextObserver with doc::DocumentsObserver and a couple of signals. - Renamed app::Context::getActiveDocument() with doc::Context::activeDocument() - Renamed app::Context::getActiveLocation() with app::Context::activeLocation() - Removed app::ContextObserverList - Removed app::DocumentId (now we can use doc::ObjectId) - Removed app::Context::getSettings()
2014-07-28 20:53:24 -07:00
doc and gfx libraries depends on fixmath (fix #817)
2015-09-24 06:02:52 -07:00
## Level 6
Refactor: Create doc::Context and move some logic from app::Document to doc::Document The objective of these changes is to create a more testable doc/logic API. Included changes: - Added doc::Context, doc::Documents (the old app::Documents), and doc::Sprites (and observers for each) - Added raster::Sprite::createBasicSprite() - Added doc::ColorMode (equal to raster::PixelFormat) - Added some methods to doc::Document: context(), sprites(), sprite() (to replace app::Document::getSprite()), width/height(), colorMode(), name(), and close() - Moved app::DocumentObserver/Event to doc::DocumentObserver/Event - Replaced app::ContextObserver with doc::DocumentsObserver and a couple of signals. - Renamed app::Context::getActiveDocument() with doc::Context::activeDocument() - Renamed app::Context::getActiveLocation() with app::Context::activeLocation() - Removed app::ContextObserverList - Removed app::DocumentId (now we can use doc::ObjectId) - Removed app::Context::getSettings()
2014-07-28 20:53:24 -07:00
Change README.md to see dependencies between (...)
2013-08-05 18:58:07 -07:00
* [main](main/) (app, base, she, ui)
Add a special section in src/README.md about debugging tricks
2015-04-07 13:19:34 -07:00
# Debugging Tricks
On Windows, you can use F5 to show the amount of used memory. Also
`Ctrl+Shift+Q` crashes the application in case that you want to test
the anticrash feature or your need a memory dump file.