this repo has no description
1/*!
2\mainpage
3
4<p>SDL_gpu is a C code library for making hardware-accelerated 2D graphics easy.</p>
5
6<p>SDL_gpu is licensed under the terms of the MIT License.<br>
7See LICENSE.txt for details of the usage license granted to you for this code.</p>
8
9<p>A good way to use this documentation is to start on the <a href="modules.html">Modules page</a>.</p>
10
11
12\section features FEATURES
13
14* High performance (it automatically collects and submits batches instead of separate draw commands for each sprite and redundant state changes)
15* Shader API
16* Arbitrary geometry rendering (triangles)
17* Can be integrated with explicit OpenGL calls (mixed 2D and 3D)
18* Full blend state control
19* Built-in primitive shapes (points, lines, tris, rects, ellipses, polygons, even arcs)
20* Uses a style familiar to SDL 1.2 users
21* Compatible with either SDL 1.2 or 2.0
22* Loads BMP, TGA, and PNG files via stb-image
23* Rotates and scales about the center of images, making reasoning about the resulting corner coordinates more obvious (adjustable via anchor settings)
24
25\section help_out HELP OUT
26
27SDL_gpu is free and open source! You can help either by contributing a pull request, filling out a bug report, sending an email, or give me a chance to put more time into it by donating:
28
29<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=3WJCLJ3P4BV9A">Donate to SDL_gpu development
30</a>
31
32Anything you can do to help is really appreciated!
33
34\section latest_source LATEST SOURCE
35
36<p>SDL_gpu is hosted on Github (https://github.com/grimfang4/sdl-gpu). You can check out the latest version of the source code with Git:<br>
37<pre>git clone https://github.com/grimfang4/sdl-gpu.git sdl-gpu</pre></p>
38
39
40\section dependencies DEPENDENCIES
41
42<p>SDL 1.2 or SDL 2.0 (www.libsdl.org)<br>
43A rendering backend<br>
44 Currently implemented: OpenGL 1.1, OpenGL 2.0, OpenGL 3.0, OpenGL 4.0, OpenGL ES 1.1, OpenGL ES 2.0, OpenGL ES 3.0</p>
45
46
47\section building BUILDING
48
49You can see automated build status at the project page on Travis CI:
50
51<a href="https://travis-ci.org/grimfang4/sdl-gpu.svg?branch=master">[Build Status]</a>
52
53Automated builds will soon be available on the Github.io page.
54
55<p>SDL_gpu uses CMake (www.cmake.org) to coordinate the library build process. CMake is available as a GUI program or on the command line.</p>
56
57<p>For Linux/UNIX systems, run CMake in the base directory:<br>
58<pre>cmake -G "Unix Makefiles"
59make
60sudo make install</pre></p>
61
62<p>For Linux/UNIX systems, changing the default installation directory can be done like so:<br>
63<pre>cmake -G "Unix Makefiles" -DCMAKE_INSTALL_PREFIX=/usr</pre></p>
64
65<p>For Windows systems, you can use cmake-gui and select appropriate options in there (warning: cmake-gui is messy!).</p>
66
67
68\section including_linking INCLUDING / LINKING
69
70<p>Add the include for SDL_gpu.h to your sources. Link to SDL2_gpu (libSDL2_gpu.a) or SDL_gpu (if you use the old SDL 1.2).</p>
71
72
73\section documentation FULL DOCUMENTATION
74
75<p>Documentation is automatically generated with Doxygen (http://sourceforge.net/projects/doxygen).<br><br>
76
77Pre-generated documentation can be found on the Github.io page:<br>
78https://grimfang4.github.io/sdl-gpu/<br>
79And at DinoMage Games:<br>
80http://dinomage.com/reference/SDL_gpu/</p>
81
82*/
83
84
85
86