1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.10"/>
<title>SDL2_gfx: /cygdrive/i/Sources/sdl2gfx/README Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">SDL2_gfx
 <span id="projectnumber">1.0.2</span>
</div>
<div id="projectbrief">GraphicsprimitivesandsurfacefunctionsforSDL2</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">/cygdrive/i/Sources/sdl2gfx/README</div> </div>
</div><!--header-->
<div class="contents">
<a href="_r_e_a_d_m_e.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> /*!</div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> \mainpage SDL2_gfx - Graphics primitives and surface functions for SDL2</div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> \section contact_sec Contact and License</div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> Email aschiffler at ferzkopp dot net to contact the author </div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> or better check author's homepage at http://www.ferzkopp.net </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> for the most up-to-date contact information.</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> This library is licenced under the zlib License, see the file LICENSE for details. </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> \section intro_sec Introduction</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> The SDL2_gfx library provides the basic drawing functions such as lines,</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> circles or polygons provided by SDL_gfx on SDL2 against renderers of SDL2.</div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> The current components of the SDL2_gfx library are:</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> - Graphic Primitives (SDL2_gfxPrimitives.h, SDL2_gfxPrimitives.c)</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> - Surface Rotozoomer (SDL2_rotozoom.h, SDL2_rotozoom.c)</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> - Framerate control (SDL2_framerate.h, SDL2_framerate.c)</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> - MMX image filters (SDL2_imageFilter.h, SDL2_imageFilter.c)</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> - Build-in 8x8 Font (SDL2_gfxPrimitives_font.h)</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> Note that SDL2_gfx is compatible with SDL version 2.0 (not SDL 1.2).</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> \section install_sec Installation</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> \subsection unix Unix/Linux</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> Use the standard autoconf/automake sequence to compile and install the library. </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> \verbatim</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  ./autogen.sh # (optional, recommended)</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  ./configure</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  make</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  make install</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> \endverbatim</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> \\subsubsection nommx Linker Configuration</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> The default location for the installation is /usr/local/lib and /usr/local/include. </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> This libary path may need to be added to the file the linker configuration file:</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> \verbatim</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  vi /etc/ld.so.conf</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  ldconfig</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> \endverbatim</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> \\subsubsection nommx Non-MMX Platforms</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> To build without MMX code enabled (i.e. ARM, PPC, AMD64 architectures):</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> \verbatim</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  ./configure --disable-mmx</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  make</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  make install</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> \endverbatim</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> \subsection visualstudio Windows (VS2012, VS2013)</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> Open the SDL2_gfx.sln solution file, right click on the solution and choose 'Rebuild'.</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> The SDL2 Visual Studio solution must be placed in a directory alongside SDL2_gfx and build in the same configuration, i.e. Debug or Release, beforehand so the referenced SDL2.lib file can be found.</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> \subsection platformosx Mac OSX </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> The usual autotools build chain should be used. MacPorts or fink may be required.</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> Xcode is supported via templates. See Xcode.zip - this template only supports SDL2_gfx </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> and not the tests. For this template, the Deployment Target (the lowest version to run on) </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> is set to 10.11 and expects the SDL2.framework preinstalled in the default location: /Library/Frameworks.</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> \section test_sec Test Programs</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> Change to the ./test directory and run</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> \verbatim</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  ./autogen.sh</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  ./configure</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  make</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> \endverbatim</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> to create several test programs for the libraries functions. This requires</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> the SDL2_gfx library to be previously compiled and installed.</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> See the source in the test/*.c files for some sample code and implementation hints.</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> \section documentation_sec Documentation</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> Please refer to the Doxygen-generated API documentation found in the</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> Docs/html folder as well as the test programs in the test folder.</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> \section changelog_sec Change Log</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> \verbinclude ChangeLog</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> */</div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.10
</small></address>
</body>
</html>
|
