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
|
<!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.11"/>
<title>AllegroGL: mainpage.foo 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="alleggl.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">AllegroGL
 <span id="projectnumber">0.4.4</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</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">mainpage.foo</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> /** \file mainpage.foo</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>  * This file only contains the information useful for the main page of the</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  * documentation - There is no code here.</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> </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> /** \mainpage AllegroGL</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> \section contents Table Of Contents:</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <ul><li> \ref aboutlib </li></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  <li> \ref license </li></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  <li> \ref aboutdoc </li></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  <li> \ref genbuild </li></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <li> \ref require </li></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <li> \ref install </li></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <ul><li> \ref unixinst </li></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <li> \ref minginst </li></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <li> \ref msvcinst </li></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <li> \ref dosinst </li></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <li> \ref macinst </li></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </ul></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  <li> \ref usagedocs </li></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <li> \ref moreinfo </li></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <li> \ref end </li></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </ul></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </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 aboutlib About AllegroGL</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> The library mostly provides functions to allow you to use OpenGL alongside</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> Allegro -- you use OpenGL for your rendering to the screen, and Allegro for</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> miscellaneous tasks like gathering input, doing timers, getting cross-platform</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> portability, loading data, and drawing your textures. So this library fills</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> the same hole that things like glut do.</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> AllegroGL also automatically exposes most, if not all, OpenGL extensions</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> available to user programs. This means you no longer have to manually load</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> them; extension management is already done for you.</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> \section license License</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 code is (C) AllegroGL contributors, and double licensed under the GPL and</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> zlib licenses. See gpl.txt or zlib.txt for details. (You can pick whichever one</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> you prefer.)</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> \section aboutdoc About this document</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> This document contains installation instructions, description of</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> the API, reference manual, and pointers to other resources such</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> as the FAQ, web page and the mailing list.</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> \section genbuild General build instructions</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> From version 0.4.4 onwards, AllegroGL is an addon library for Allegro and the</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> usual way to build it is by following the allegro compilation procedure. It</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> will configure, build and install AllegroGL using default options (a shared</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> release library).</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> However, you if you need a custom compiled library, e.g. with debug symbols or</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> a statically linked one, you can build AllegroGL manually, passing custom build</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> options.</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> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> \section require Requirements</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  General requirement: If you are building AllegroGL separatelly (outside Allegro</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  compilation procedure) it will depend on Allegro being successfully built two</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  directories above.</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  \b Unix:</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  You need an X server which provides the OpenGL/GLX functionality.</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  If you have successfully installed 3D drivers (NVidia, DRI drivers, ...)</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  then OpenGL/GLX libraries are already installed.</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  Otherwise XFree86 4.x has OpenGL/GLX built in. We have also successfully</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  used an earlier version, with development snapshots of Mesa3D 3.2 and</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  GLX extensions.</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  You also need to get the GLU library, preferably the SGI's one (see the</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  Mesa sourceforge webpage - http://Mesa3D.sf.net/ ).</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  If you want to build the generic driver you need Mesa 4.0 or higher</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  (only the "MesaLib" archive is mandatory, the "MesaDemos" one is</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  optionnal).</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  Links to the relevant sites can be found on the AllegroGL web site.</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  \b Windows/MSVC:</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  MSVC6 or MSVC2005 IDE</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  or</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  GNU make is required for MSVC.</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  \b Windows/Mingw:</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  If you use Mingw, you'll need the OpenGL header files and</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  libraries. These are normally included with Mingw.</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  </div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  In case your copy of Mingw does not have the OpenGL headers,</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  you can grab them here:</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  ftp://ftp.microsoft.com/softlib/mslfiles/opengl95.exe</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  This is a self-extracting archive.</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> </div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  You'll also need GNU make (mingw32-make) to compile AllegroGL.</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  \b DOS:</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  You need DJGPP and Mesa 4.0 http://Mesa3D.sf.net/ for OpenGL rendering</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  (only the "MesaLib" archive is mandatory, the "MesaDemos" one is</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  optionnal).</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  \b Mac OS X:</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  System version 10.1.x or newer is required to build AllegroGL.</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  Allegro WIP 4.1.11 or newer is also required, as older versions</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  did not support OS X.</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> \section install Installation</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  \subsection unixinst Unix instructions</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> For an optimised build, run `./configure' and `make' from the directory</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> containing this file. This will build the library (in 'lib/unix/') and the</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> examples (in 'examp/'). Use `make install' to install the library and</div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> header file. For that part you need write access to /usr/local.</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> </div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> If you want to build the generic driver, run `./configure --enable-generic'</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> and `make MESADIR=xxx' where xxx is the path to the Mesa 4.0 directory.</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> This will build both Mesa (GL and GLU) and AllegroGL</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> For a debug build, add `DEBUGMODE=1' on each of the command lines.</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> If you get errors about missing header files or libraries,</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> either for X or GL, see the instructions at the top of</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> `makefile'. Note that you need to have the X development</div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> package installed, if you are using Red Hat Linux or Debian</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> GNU/Linux.</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> </div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> </div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  \subsection minginst Mingw/32 instructions</div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> Mingw 2.0 and higher already come with the OpenGL header files</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> and libraries, so you can skip the next step.</div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> </div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> If you don't have the OpenGL header files (GL\\gl.h) and libraries, you will</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> first need to acquire thrm. These can be obtained from the Microsoft site,</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> or from MSVC.</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> If you obtained the self-extracting archive from the Microsoft site, then</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> run it. Move the produced header files (*.h) into C:\\Mingw32\\include\\GL\\</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> (replace C:\\Mingw32 by wherever you happen to have installed Mingw).</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> Ignore the other files, as they are only useful for MSVC.</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> </div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> You need to set up your environment if you haven't done that already.</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> Environment variable "PATH" should point to the "bin" directory of Mingw.</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> You can check that by typing "gcc" in the console. It must display something</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> like: "gcc: no input files". If it complains about a unknown command then type</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> "set PATH=%PATH%;C:\Mingw32\bin" (replace C:\\Mingw32 by wherever you happen to</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> have installed Mingw).</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> Also, you need to set MINGDIR env. variable. It must point to Mingw instalation</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> directory: "set MINGDIR=C:\Mingw32". You can check that with: "echo %MINGDIR%".</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> </div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> You will need to run 'fix mingw32' in the AllegroGL directory</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> to update makefile for Mingw32.</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> Since both Allegro and AllegroGL have native Mingw support</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> I am happy to say that you can build Allegro/AllegroGL programs</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> entirely using free software.</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span> </div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span> For an optimised build, run `make' from the directory containing</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> this file. Use `make install' to install the library and header</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> file. Some versions of Mingw come with `mingw32-make' instead of</div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> `make', so you may need to run that instead.</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> For a debug build, do the same but write `DEBUGMODE=1' on each</div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> of the command lines; for example, 'make DEBUGMODE=1' and</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> 'make install DEBUGMODE=1'.</div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> </div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span> Add 'STATICLINK=1' to the last two commands to build AllegroGL that can be</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> linked to statically linked allegro.</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> </div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  \subsection msvcinst MSVC6/7/8 instructions</div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> </div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> There are two completely different ways of compiling AllegroGL using MSVC. You</div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span> can use the old-fashion way decribed bellow (similar to building allegro, using</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> a GNU makefile and a command line), or you can locate the project file for your</div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> MSVC version in "projects" directory and compile AllegroGL lib and examples with</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> a few mouse clicks. You'll have to manually copy libs and headers to appropiate</div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> locations.</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> You can choose between several build configuration, depending against which</div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> Allegro library you want AllegroGL to be linked to. These configurations are:</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <pre> </div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  _____________________________________________________________</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  | Configuration name | AGL lib name | Allegro lib name |</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  |-------------------------------------------------------------|</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  | Release | agl.lib | alleg.lib |</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  | DLL Release | agl.lib & agl.dll | alleg.lib |</div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  | Static Release | agl_s.lib | alleg_s.lib |</div><div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  | Static Release CRT | agl_s_crt.lib | alleg_s_crt.lib |</div><div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  | Debug | agld.lib | alld.lib |</div><div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  | Static Debug | agld_s.lib | alld_s.lib |</div><div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  -------------------------------------------------------------</div><div class="line"><a name="l00204"></a><span class="lineno"> 204</span> </pre></div><div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  </div><div class="line"><a name="l00206"></a><span class="lineno"> 206</span> All configuration except "DLL Release" produce AllegroGL library that is</div><div class="line"><a name="l00207"></a><span class="lineno"> 207</span> statically linked to the executable.</div><div class="line"><a name="l00208"></a><span class="lineno"> 208</span> </div><div class="line"><a name="l00209"></a><span class="lineno"> 209</span> </div><div class="line"><a name="l00210"></a><span class="lineno"> 210</span> Instructione for compiling AllegroGL using command line follow.</div><div class="line"><a name="l00211"></a><span class="lineno"> 211</span> </div><div class="line"><a name="l00212"></a><span class="lineno"> 212</span> You must have a working copy of GNU Make (useful for</div><div class="line"><a name="l00213"></a><span class="lineno"> 213</span> building Allegro, anyway). This can be either DJGPP's or</div><div class="line"><a name="l00214"></a><span class="lineno"> 214</span> Mingw's (recommended).</div><div class="line"><a name="l00215"></a><span class="lineno"> 215</span> </div><div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  \b Step \b 1:</div><div class="line"><a name="l00217"></a><span class="lineno"> 217</span> </div><div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  The first thing you need to do is find `vcvars32.bat',</div><div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  somewhere in your Visual Studio directories (most probably,</div><div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  it's in 'vc98/bin'). Running this batch file will enable</div><div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  the command line compiler for the current DOS session. If you</div><div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  will use it often, or find that typing</div><div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  'c:\\progra~1\\micros~2\\vc98\\bin\\vcvars32.bat' gets annoying after a</div><div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  while, then (under Windows 9X) simply add that command to your</div><div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  autoexec.bat**</div><div class="line"><a name="l00226"></a><span class="lineno"> 226</span> </div><div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  Note: If at any stage, you get an "Out of Environment space"</div><div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  message, then please see the Allegro FAQ for how to fix this.</div><div class="line"><a name="l00229"></a><span class="lineno"> 229</span> </div><div class="line"><a name="l00230"></a><span class="lineno"> 230</span> </div><div class="line"><a name="l00231"></a><span class="lineno"> 231</span> ** The procedure is different for Windows ME and later.</div><div class="line"><a name="l00232"></a><span class="lineno"> 232</span>  If you're running Windows ME, you'll need to select "Run" off the</div><div class="line"><a name="l00233"></a><span class="lineno"> 233</span>  start menu, then type in "msconfig". Select the environment</div><div class="line"><a name="l00234"></a><span class="lineno"> 234</span>  tab. Add the lines inside vcvars32.bat in there by copy/pasting them.</div><div class="line"><a name="l00235"></a><span class="lineno"> 235</span>  Reboot your computer for the changes to take effect.</div><div class="line"><a name="l00236"></a><span class="lineno"> 236</span> </div><div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  If you're running Windows 2000/XP (NT?), then open Control Pannel,</div><div class="line"><a name="l00238"></a><span class="lineno"> 238</span>  then the "System" applet, then the "Advanced" tab, and</div><div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  finally the "Environment" button. Add the environment variables as</div><div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  they are in vcvars32.bat. This has to be done manually (yes it's long</div><div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  and painful, please redirect all flames to billg@microsoft.com)</div><div class="line"><a name="l00242"></a><span class="lineno"> 242</span>  You will need to log off and log back in for the changes to take effect.</div><div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div><div class="line"><a name="l00244"></a><span class="lineno"> 244</span> </div><div class="line"><a name="l00245"></a><span class="lineno"> 245</span> \b Step \b 2:</div><div class="line"><a name="l00246"></a><span class="lineno"> 246</span> </div><div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  Much like making Allegro, to configure AllegroGL for your compiler please run</div><div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  in the command prompt:</div><div class="line"><a name="l00249"></a><span class="lineno"> 249</span> </div><div class="line"><a name="l00250"></a><span class="lineno"> 250</span>  fix.bat msvc6 - for MSVC 6 and older</div><div class="line"><a name="l00251"></a><span class="lineno"> 251</span>  fix.bat msvc7 - for MSVC 7 (.NET) and 7.1 (.NET 2003)</div><div class="line"><a name="l00252"></a><span class="lineno"> 252</span>  fix.bat msvc8 - for MSVC 8 (.NET 2005)</div><div class="line"><a name="l00253"></a><span class="lineno"> 253</span> </div><div class="line"><a name="l00254"></a><span class="lineno"> 254</span>  Then type `make' to build the library in optimized mode, then `make install'</div><div class="line"><a name="l00255"></a><span class="lineno"> 255</span>  to install the library and header files in your MSVC directory.</div><div class="line"><a name="l00256"></a><span class="lineno"> 256</span> </div><div class="line"><a name="l00257"></a><span class="lineno"> 257</span>  For a debugging version, add `DEBUGMODE=1', to the last two command lines.</div><div class="line"><a name="l00258"></a><span class="lineno"> 258</span> </div><div class="line"><a name="l00259"></a><span class="lineno"> 259</span>  To link against a static runtime libraries, rather than the default dynamic</div><div class="line"><a name="l00260"></a><span class="lineno"> 260</span>  runtime libraries, add STATICRUNTIME=1, to the last two command lines.</div><div class="line"><a name="l00261"></a><span class="lineno"> 261</span> </div><div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  To link aginst a static version of allegro, add STATICLINK=1, to the last</div><div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  two command lines.</div><div class="line"><a name="l00264"></a><span class="lineno"> 264</span> </div><div class="line"><a name="l00265"></a><span class="lineno"> 265</span>  If you are using Mingw for GNU make, then you may need to run `mingw32-make'</div><div class="line"><a name="l00266"></a><span class="lineno"> 266</span>  instead of `make'.</div><div class="line"><a name="l00267"></a><span class="lineno"> 267</span> </div><div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  \subsection dosinst Dos instructions</div><div class="line"><a name="l00269"></a><span class="lineno"> 269</span> </div><div class="line"><a name="l00270"></a><span class="lineno"> 270</span> Please note that DOS support is currently in experimental stages.</div><div class="line"><a name="l00271"></a><span class="lineno"> 271</span> </div><div class="line"><a name="l00272"></a><span class="lineno"> 272</span> Unzip the archive files MesaLib-4.0.zip wherever you want.</div><div class="line"><a name="l00273"></a><span class="lineno"> 273</span> Unzip AllegroGL</div><div class="line"><a name="l00274"></a><span class="lineno"> 274</span> </div><div class="line"><a name="l00275"></a><span class="lineno"> 275</span> Create the environment variable MESADIR which defines the Mesa sources path :</div><div class="line"><a name="l00276"></a><span class="lineno"> 276</span>  set MESADIR=xxx</div><div class="line"><a name="l00277"></a><span class="lineno"> 277</span> where 'xxx' is the path to the Mesa root directory</div><div class="line"><a name="l00278"></a><span class="lineno"> 278</span> </div><div class="line"><a name="l00279"></a><span class="lineno"> 279</span> Go to the root directory of AllegroGL type 'fix djgpp' (without</div><div class="line"><a name="l00280"></a><span class="lineno"> 280</span> quotes) followed by 'make'. The GL, GLU and AllegroGL libraries are built.</div><div class="line"><a name="l00281"></a><span class="lineno"> 281</span> Finally type 'make install' to install the library</div><div class="line"><a name="l00282"></a><span class="lineno"> 282</span> </div><div class="line"><a name="l00283"></a><span class="lineno"> 283</span> You're done! You can now use AllegroGL on DOS. Try the example demos...</div><div class="line"><a name="l00284"></a><span class="lineno"> 284</span> </div><div class="line"><a name="l00285"></a><span class="lineno"> 285</span> For a debug build, do the same but write `DEBUGMODE=1' on each</div><div class="line"><a name="l00286"></a><span class="lineno"> 286</span> of the command lines.</div><div class="line"><a name="l00287"></a><span class="lineno"> 287</span> </div><div class="line"><a name="l00288"></a><span class="lineno"> 288</span> Note that you can also build :</div><div class="line"><a name="l00289"></a><span class="lineno"> 289</span> - The GLUT library (based on AMesa, Allegro and Mesa). Type 'make glut' to build it</div><div class="line"><a name="l00290"></a><span class="lineno"> 290</span>  then 'make install-glut' to install it.</div><div class="line"><a name="l00291"></a><span class="lineno"> 291</span> - The Mesa samples to test both Mesa and GLUT (note that you need to download</div><div class="line"><a name="l00292"></a><span class="lineno"> 292</span>  the MesaDemos archive file to compile mesa samples). Type 'make mesa-samples'</div><div class="line"><a name="l00293"></a><span class="lineno"> 293</span>  (Please note that not all the sample programs will be built. Now, as</div><div class="line"><a name="l00294"></a><span class="lineno"> 294</span>  of Mesa 3.4.2, most demos are for GLUT which has not yet been completely </div><div class="line"><a name="l00295"></a><span class="lineno"> 295</span>  ported to AMesa/Allegro).</div><div class="line"><a name="l00296"></a><span class="lineno"> 296</span> </div><div class="line"><a name="l00297"></a><span class="lineno"> 297</span> </div><div class="line"><a name="l00298"></a><span class="lineno"> 298</span>  \subsection macinst Mac OS X instructions</div><div class="line"><a name="l00299"></a><span class="lineno"> 299</span> </div><div class="line"><a name="l00300"></a><span class="lineno"> 300</span> First you will need to run `./fix.sh macosx' in order to prepare the</div><div class="line"><a name="l00301"></a><span class="lineno"> 301</span> makefile for Mac OS X. Then `make' will build the library (in `lib/macosx')</div><div class="line"><a name="l00302"></a><span class="lineno"> 302</span> and the examples (in `examp/'). Use `sudo make install' to install the</div><div class="line"><a name="l00303"></a><span class="lineno"> 303</span> library and the header files; this step will require your system root</div><div class="line"><a name="l00304"></a><span class="lineno"> 304</span> password and will install into /usr/local.</div><div class="line"><a name="l00305"></a><span class="lineno"> 305</span> </div><div class="line"><a name="l00306"></a><span class="lineno"> 306</span> For a debug build, add `DEBUGMODE=1' on `make' and `make install' calls,</div><div class="line"><a name="l00307"></a><span class="lineno"> 307</span> for example, `make DEBUGMODE=1' and `sudo make install DEBUGMODE=1'.</div><div class="line"><a name="l00308"></a><span class="lineno"> 308</span>  </div><div class="line"><a name="l00309"></a><span class="lineno"> 309</span> </div><div class="line"><a name="l00310"></a><span class="lineno"> 310</span> </div><div class="line"><a name="l00311"></a><span class="lineno"> 311</span> \section usagedocs Using AllegroGL</div><div class="line"><a name="l00312"></a><span class="lineno"> 312</span> </div><div class="line"><a name="l00313"></a><span class="lineno"> 313</span> A reference to the functions and macros available to user</div><div class="line"><a name="l00314"></a><span class="lineno"> 314</span> programs can be found by clicking on the links on top of this</div><div class="line"><a name="l00315"></a><span class="lineno"> 315</span> document, or online at the web site, and is</div><div class="line"><a name="l00316"></a><span class="lineno"> 316</span> also downloadable from there in various formats.</div><div class="line"><a name="l00317"></a><span class="lineno"> 317</span> </div><div class="line"><a name="l00318"></a><span class="lineno"> 318</span> The quick start guide and the FAQ are included in the </div><div class="line"><a name="l00319"></a><span class="lineno"> 319</span> distribution in the root directory.</div><div class="line"><a name="l00320"></a><span class="lineno"> 320</span> </div><div class="line"><a name="l00321"></a><span class="lineno"> 321</span> </div><div class="line"><a name="l00322"></a><span class="lineno"> 322</span> \section moreinfo More information</div><div class="line"><a name="l00323"></a><span class="lineno"> 323</span> </div><div class="line"><a name="l00324"></a><span class="lineno"> 324</span> </div><div class="line"><a name="l00325"></a><span class="lineno"> 325</span> web site: http://allegrogl.sourceforge.net/</div><div class="line"><a name="l00326"></a><span class="lineno"> 326</span> </div><div class="line"><a name="l00327"></a><span class="lineno"> 327</span>  The web site has introductory information, system</div><div class="line"><a name="l00328"></a><span class="lineno"> 328</span>  requirements, downloads, and Allegro patches, along with an</div><div class="line"><a name="l00329"></a><span class="lineno"> 329</span>  online version of the reference manual.</div><div class="line"><a name="l00330"></a><span class="lineno"> 330</span> </div><div class="line"><a name="l00331"></a><span class="lineno"> 331</span> </div><div class="line"><a name="l00332"></a><span class="lineno"> 332</span> mailing list: allegrogl-general@lists.sourceforge.net</div><div class="line"><a name="l00333"></a><span class="lineno"> 333</span> </div><div class="line"><a name="l00334"></a><span class="lineno"> 334</span> </div><div class="line"><a name="l00335"></a><span class="lineno"> 335</span>  All the developers are on this mailing list, and most of the</div><div class="line"><a name="l00336"></a><span class="lineno"> 336</span>  discussion here is about future development and bug fixing.</div><div class="line"><a name="l00337"></a><span class="lineno"> 337</span>  General questions about using the library make a welcome</div><div class="line"><a name="l00338"></a><span class="lineno"> 338</span>  change from the hard work of development, so newcomers are</div><div class="line"><a name="l00339"></a><span class="lineno"> 339</span>  very welcome! If you're not subscribed to the list, make</div><div class="line"><a name="l00340"></a><span class="lineno"> 340</span>  this clear when you post, so that people can Cc: their</div><div class="line"><a name="l00341"></a><span class="lineno"> 341</span>  replies to you.</div><div class="line"><a name="l00342"></a><span class="lineno"> 342</span> </div><div class="line"><a name="l00343"></a><span class="lineno"> 343</span> </div><div class="line"><a name="l00344"></a><span class="lineno"> 344</span> </div><div class="line"><a name="l00345"></a><span class="lineno"> 345</span> \section end Closing Words</div><div class="line"><a name="l00346"></a><span class="lineno"> 346</span> </div><div class="line"><a name="l00347"></a><span class="lineno"> 347</span> Good luck...</div><div class="line"><a name="l00348"></a><span class="lineno"> 348</span> </div><div class="line"><a name="l00349"></a><span class="lineno"> 349</span> </div><div class="line"><a name="l00350"></a><span class="lineno"> 350</span> -- The AllegroGL team</div><div class="line"><a name="l00351"></a><span class="lineno"> 351</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.11
</small></address>
</body>
</html>
|
