You never really know the scope of your code until you write documentation for it.
-
I've recently rebooted the GFX documentation, and am more or less retiring the single monolithic code project article here in favor of a wiki style format, probably hosted on github. As I've outlined the project and created the table of contents, it started to dawn on me how utterly wide and deep GFX is, from the drivers all the way down to the pixels you can drill down and down and down. Add to that all of the features, and the scope is huge. 9 markdown documents, 100s of lines each, at least. Here's the TOC so far (incomplete but pretty much fleshed out) just to give you an idea of this codebase. Wow. I can't believe I even wrote it, much less in the time I wrote it.
1. [Pixels](./pixels.md)
- 1.1 [Declaring common pixels](./pixels.md#1.1)
- 1.2 [Channels](./pixels.md#1.2)
- 1.3 [Colors](./pixels.md#1.3)
- 1.4 [Color models](./pixels.md#1.4)
- 1.5 [The alpha channel](./pixels.md#1.5)
- 1.6 [Indexed pixels](./pixels.md#1.6)
- 1.7 [Declaring custom pixels](./pixels.md#1.7)
- 1.8 [Converting pixels](./pixels.md#1.8)
- 1.9 [Metadata](./pixels.md#1.9)
2. [Draw targets](./draw_targets.md)
- 2.1 [Sources and destinations](./draw_targets.md#2.1)
- 2.2 [Bitmaps](./draw_targets.md#2.2)
- 2.2.1 [Standard bitmaps](./draw_targets.md#2.2.1)
- 2.2.2 [Const bitmaps](./draw_targets.md#2.2.2)
- 2.2.3 [Large bitmaps](./draw_targets.md#2.2.3)
- 2.3 [Drivers](./draw_targets.md#2.3)
- 2.4 [Viewports](./draw_targets.md#2.4)
- 2.5 [Sprites](./draw_targets.md#2.5)
- 2.6 [Custom](./draw_targets.md#2.6)
- 2.6.1 [Common members](./draw_targets.md#2.6.1)
- 2.6.2 [Capabilities](.draw_targets.md#2.6.2)
- 2.6.3 [Draw source members](./draw_targets.md#2.6.3)
- 2.6.4 [Draw destination members](./draw_targets.md#2.6.4)
- 2.6.5 [Initialization](./draw_targets.md#2.6.5)
3. Images
4. Fonts
- 4.1 Truetype TTF/OTF
- 4.1.1 Layout considerations
- 4.1.2 Storage considerations
- 4.1.3 Performance considerations
- 4.2 Raster FON
- 4.2.1 Performance considerations
- 4.2.2 Storage considerations
5. Drawing
- 5.1 Basic Shapes
- 5.2 Bitmaps and Draw Sources
- 5.3 Text
- 5.4 Images
- 5.5 Sprites
- 5.6 Alpha blending
- 5.6.1 Performance considerations
- 5.6.2 Draw target considerations
6. Positioning
- 6.1 Points
- 6.2 Sizes
- 6.3 Rectangles
- 6.4 Paths
7. Stream -
I've recently rebooted the GFX documentation, and am more or less retiring the single monolithic code project article here in favor of a wiki style format, probably hosted on github. As I've outlined the project and created the table of contents, it started to dawn on me how utterly wide and deep GFX is, from the drivers all the way down to the pixels you can drill down and down and down. Add to that all of the features, and the scope is huge. 9 markdown documents, 100s of lines each, at least. Here's the TOC so far (incomplete but pretty much fleshed out) just to give you an idea of this codebase. Wow. I can't believe I even wrote it, much less in the time I wrote it.
1. [Pixels](./pixels.md)
- 1.1 [Declaring common pixels](./pixels.md#1.1)
- 1.2 [Channels](./pixels.md#1.2)
- 1.3 [Colors](./pixels.md#1.3)
- 1.4 [Color models](./pixels.md#1.4)
- 1.5 [The alpha channel](./pixels.md#1.5)
- 1.6 [Indexed pixels](./pixels.md#1.6)
- 1.7 [Declaring custom pixels](./pixels.md#1.7)
- 1.8 [Converting pixels](./pixels.md#1.8)
- 1.9 [Metadata](./pixels.md#1.9)
2. [Draw targets](./draw_targets.md)
- 2.1 [Sources and destinations](./draw_targets.md#2.1)
- 2.2 [Bitmaps](./draw_targets.md#2.2)
- 2.2.1 [Standard bitmaps](./draw_targets.md#2.2.1)
- 2.2.2 [Const bitmaps](./draw_targets.md#2.2.2)
- 2.2.3 [Large bitmaps](./draw_targets.md#2.2.3)
- 2.3 [Drivers](./draw_targets.md#2.3)
- 2.4 [Viewports](./draw_targets.md#2.4)
- 2.5 [Sprites](./draw_targets.md#2.5)
- 2.6 [Custom](./draw_targets.md#2.6)
- 2.6.1 [Common members](./draw_targets.md#2.6.1)
- 2.6.2 [Capabilities](.draw_targets.md#2.6.2)
- 2.6.3 [Draw source members](./draw_targets.md#2.6.3)
- 2.6.4 [Draw destination members](./draw_targets.md#2.6.4)
- 2.6.5 [Initialization](./draw_targets.md#2.6.5)
3. Images
4. Fonts
- 4.1 Truetype TTF/OTF
- 4.1.1 Layout considerations
- 4.1.2 Storage considerations
- 4.1.3 Performance considerations
- 4.2 Raster FON
- 4.2.1 Performance considerations
- 4.2.2 Storage considerations
5. Drawing
- 5.1 Basic Shapes
- 5.2 Bitmaps and Draw Sources
- 5.3 Text
- 5.4 Images
- 5.5 Sprites
- 5.6 Alpha blending
- 5.6.1 Performance considerations
- 5.6.2 Draw target considerations
6. Positioning
- 6.1 Points
- 6.2 Sizes
- 6.3 Rectangles
- 6.4 Paths
7. StreamI don't see turtles listed there anywhere.
-
I don't see turtles listed there anywhere.
-
PIEBALDconsult wrote:
I don't see turtles listed there anywhere.
Did you look all the way down?
I think that's covered in the Sprites section.
-
I don't see turtles listed there anywhere.