LibreSprite Source Code

If you are here, it's because you want to learn about LibreSprite source code. We'll try to write in these README.md files a summary of each module/library.

Modules & Libraries

LibreSprite is separated in the following layers/modules:

Level 0: Completely independent modules

These libraries are easy to use and embed in other software because they don't depend on any other component.

• base: Core/basic stuff, multithreading, utf8, sha1, file system, memory, etc.
• clip: Clipboard library.
• css: Pseudo-style sheet library.
• fixmath: Fixed point operations (original code from Allegro code by Shawn Hargreaves).
• flic: Library to load/save FLI/FLC files.
• gfx: Abstract graphics structures like point, size, rectangle, region, color, etc.
• observable: Signal/slot functions.
• script: JavaScript engine.
• undo: Generic library to manage a history of undoable commands.
• wacom: Wacom definitions to use Wintab API.

Level 1

• cfg (base): Library to load/save .ini files.
• gen (base): Helper utility to generate C++ files from different XMLs.

Level 2

• doc (base, fixmath, gfx): Document model library.
• she (sdl2, base, gfx, wacom): Platform abstraction layer.

Level 3

• filters (base, doc, gfx): Effects for images.
• render (base, doc, gfx): Library to render documents.
• ui (base, gfx, she): Portable UI library (buttons, windows, text fields, etc.)

Level 4

• app (base, doc, filters, fixmath, gfx, pen, render, scripting, she, ui, undo)

Level 5

• main (app, base, she, ui)

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 you need a memory dump file.