Rename GP_Context -> GP_Pixmap
[gfxprim.git] / doc / core.txt
blob439494a6021d2f31425d859128b2788a3586f32e
1 Library Core
2 ------------
4 Library core contains all basic data structures and functions that forms the
5 glue which holds the GFXprim libraries together.
7 The most important data structure is a link:pixmap.html[Pixmap] which
8 describes in-memory pixmap which is used extensively in all parts of the
9 library.
11 Core also contains link:gen.html[generated] code for basic pixel manipulations
12 such as link:get_put_pixel.html[GetPixel and PutPixel] as well as
13 link:blits.html[Blits] implementation.
15 Library Core is a place to implement common functinonality that is used from
16 the rest of the GFXprim modules, for example the link:debug.html[Debug layer]
17 or link:progress_callback.html[Progress callback].
19 .Main Core library parts
20 [grid="rows"]
21 [options="autowidth"]
22 |=============================================================================
23 | link:pixmap.html[Pixmap] | Describes in-memory pixmap
25 | link:basic_types.html[Basic types] | Types for size, lenght, pixel and
26                                        color
28 | link:pixels.html[Pixel types] | Pixel types handling and interface
30 | link:get_put_pixel.html[GetPixel and PutPixel] | Macros and functions to
31                                                    get and put pixels
33 | link:blits.html[Blits] | Blits (copies) a rectangular area from one pixmap to
34                            another as well as simple pixel format conversions
36 | link:progress_callback.html[Progress Callback] | Progress callback passed
37                                                    to all
38                                                    link:filters.html[filters]
39                                                    and
40                                                    link:loaders.html[loaders]
42 | link:debug.html[Debug layer] | Library debug layer
44 | link:core_common.html[Common macros] | Common macros and semi-internal
45                                          interface
47 | link:environment_variables.html[Environment variables] | Environment variables
49 |=============================================================================