SDL2_gfx  1.0.1
GraphicsprimitivesandsurfacefunctionsforSDL2
/builddir/build/BUILD/SDL2_gfx-1.0.1/README
Go to the documentation of this file.
1 /*!
2 
3 \mainpage SDL2_gfx - Graphics primitives and surface functions for SDL2
4 
5 \section contact_sec Contact and License
6 
7 Email aschiffler at ferzkopp dot net to contact the author
8 or better check author's homepage at http://www.ferzkopp.net
9 for the most up-to-date contact information.
10 
11 This library is licenced under the zlib License, see the file LICENSE for details.
12 
13 
14 \section intro_sec Introduction
15 
16 The SDL2_gfx library provides the basic drawing functions such as lines,
17 circles or polygons provided by SDL_gfx on SDL2 against renderers of SDL2.
18 
19 The current components of the SDL2_gfx library are:
20 - Graphic Primitives (SDL2_gfxPrimitives.h, SDL2_gfxPrimitives.c)
21 - Surface Rotozoomer (SDL2_rotozoom.h, SDL2_rotozoom.c)
22 - Framerate control (SDL2_framerate.h, SDL2_framerate.c)
23 - MMX image filters (SDL2_imageFilter.h, SDL2_imageFilter.c)
24 - Build-in 8x8 Font (SDL2_gfxPrimitives_font.h)
25 
26 Note that SDL2_gfx is compatible with SDL version 2.0 (not SDL 1.2).
27 
28 \section install_sec Installation
29 
30 \subsection unix Unix/Linux
31 
32 Use the standard autoconf/automake sequence to compile and install the library.
33 \verbatim
34  ./autogen.sh # (optional, recommended)
35  ./configure
36  make
37  make install
38 \endverbatim
39 
40 \\subsubsection nommx Linker Configuration
41 
42 The default location for the installation is /usr/local/lib and /usr/local/include.
43 This libary path may need to be added to the file the linker configuration file:
44 \verbatim
45  vi /etc/ld.so.conf
46  ldconfig
47 \endverbatim
48 
49 \\subsubsection nommx Non-MMX Platforms
50 
51 To build without MMX code enabled (i.e. ARM, PPC, AMD64 architectures):
52 \verbatim
53  ./configure --disable-mmx
54  make
55  make install
56 \endverbatim
57 
58 \subsection visualstudio Windows (VC10, VS2012)
59 
60 Open SDL_gfx_VS2010.sln solution file and review README.
61 
62 \section test_sec Test Programs
63 
64 Change to the ./test directory and run
65 \verbatim
66  ./autogen.sh
67  ./configure
68  make
69 \endverbatim
70 to create several test programs for the libraries functions. This requires
71 the SDL2_gfx library to be previously compiled and installed.
72 
73 See the source in the test/*.c files for some sample code and implementation hints.
74 
75 \section documentation_sec Documentation
76 
77 Please refer to the Doxygen-generated API documentation found in the
78 Docs/html folder as well as the test programs in the test folder.
79 
80 \section changelog_sec Change Log
81 
82 \verbinclude ChangeLog
83 
84 */