this repo has no description
Updated documentation mainpage.
+24
-22
+24
-22
SDL_gpu/mainpage.dox
+24
-22
SDL_gpu/mainpage.dox
···
1
1
/*!
2
2
\mainpage
3
3
4
-
SDL_gpu is a C code library for making hardware-accelerated 2D graphics easy.
4
+
<p>SDL_gpu is a C code library for making hardware-accelerated 2D graphics easy.</p>
5
5
6
-
SDL_gpu is licensed under the terms of the MIT License.
7
-
See LICENSE.txt for details of the usage license granted to you for this code.
6
+
<p>SDL_gpu is licensed under the terms of the MIT License.<br>
7
+
See 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>
8
10
9
11
10
12
\section latest_source LATEST SOURCE
11
13
12
-
SDL_gpu is hosted on Google Code (http://code.google.com/p/sdl-gpu). You can check out the latest version of the source code with Subversion:
13
-
svn checkout http://sdl-gpu.googlecode.com/svn/trunk/ sdl-gpu
14
+
<p>SDL_gpu is hosted on Google Code (http://code.google.com/p/sdl-gpu). You can check out the latest version of the source code with Subversion:<br>
15
+
<pre>svn checkout http://sdl-gpu.googlecode.com/svn/trunk/ sdl-gpu</pre></p>
14
16
15
-
To check out everything, including the pre-generated documentation:
16
-
svn checkout http://sdl-gpu.googlecode.com/svn/ sdl-gpu
17
+
<p>To check out everything, including the pre-generated documentation:<br>
18
+
<pre>svn checkout http://sdl-gpu.googlecode.com/svn/ sdl-gpu</pre></p>
17
19
18
-
For just the current library code, use:
19
-
svn checkout http://sdl-gpu.googlecode.com/svn/trunk/ sdl-gpu
20
+
<p>For just the current library code, use:<br>
21
+
<pre>svn checkout http://sdl-gpu.googlecode.com/svn/trunk/ sdl-gpu</pre></p>
20
22
21
23
22
24
\section dependencies DEPENDENCIES
23
25
24
-
SDL 1.2 or SDL 2.0 (www.libsdl.org)
25
-
A rendering backend
26
-
Currently implemented: OpenGL 1.1, OpenGL 2.0, OpenGL 3.0, OpenGL ES 1.1, OpenGL ES 2.0
26
+
<p>SDL 1.2 or SDL 2.0 (www.libsdl.org)<br>
27
+
A rendering backend<br>
28
+
Currently implemented: OpenGL 1.1, OpenGL 2.0, OpenGL 3.0, OpenGL ES 1.1, OpenGL ES 2.0</p>
27
29
28
30
29
31
\section building BUILDING
30
32
31
-
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.
33
+
<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>
32
34
33
-
For Linux/UNIX systems, run CMake in the base directory:
34
-
cmake -G "Unix Makefiles"
35
+
<p>For Linux/UNIX systems, run CMake in the base directory:<br>
36
+
<pre>cmake -G "Unix Makefiles"
35
37
make
36
-
sudo make install
38
+
sudo make install</pre></p>
37
39
38
-
For Linux/UNIX systems, changing the default installation directory can be done like so:
39
-
cmake -G "Unix Makefiles" -DCMAKE_INSTALL_PREFIX=/usr
40
+
<p>For Linux/UNIX systems, changing the default installation directory can be done like so:<br>
41
+
<pre>cmake -G "Unix Makefiles" -DCMAKE_INSTALL_PREFIX=/usr</pre></p>
40
42
41
-
For Windows systems, you can use cmake-gui and select appropriate options in there (warning: cmake-gui is messy!).
43
+
<p>For Windows systems, you can use cmake-gui and select appropriate options in there (warning: cmake-gui is messy!).</p>
42
44
43
45
44
46
\section including_linking INCLUDING / LINKING
45
47
46
-
Add the include for SDL_gpu.h to your sources. Link to SDL_gpu (libSDL_gpu.a) or SDL2_gpu (if you use SDL2).
48
+
<p>Add the include for SDL_gpu.h to your sources. Link to SDL_gpu (libSDL_gpu.a) or SDL2_gpu (if you use SDL2).</p>
47
49
48
50
49
51
\section documentation DOCUMENTATION
50
52
51
-
Documentation is automatically generated with Doxygen (http://sourceforge.net/projects/doxygen).
52
-
Pre-generated documentation can be found in the repository's base documentation directory.
53
+
<p>Documentation is automatically generated with Doxygen (http://sourceforge.net/projects/doxygen).<br>
54
+
Pre-generated documentation can be found in the repository's base documentation directory.</p>
53
55
54
56
*/
55
57