~ubuntu-branches/ubuntu/trusty/glew/trusty

<tr><td align="center"><i>Latest Release: <a href="https://sourceforge.net/project/showfiles.php?group_id=67586&package_id=67942&release_id=637800">1.5.1</a></i></td></tr>

<tr><td align="center"><a href="index.html">Download</a></td></tr>

<tr><td align="center"><a href="install.html">Installation</a></td></tr>

<tr><td align="center"><a href="basic.html">Basic Usage</a></td></tr>

<tr><td align="center"><b>Advanced Usage</b></td></tr>

<tr><td align="center"><a href="credits.html">Credits & Copyright</a></td></tr>

<tr><td align="center"><a href="log.html">Change Log</a></td></tr>

<tr><td align="center"><a href="http://sourceforge.net/projects/glew/">Project Page</a></td></tr>

<tr><td align="center"><a href="https://sourceforge.net/mail/?group_id=67586">Mailing Lists</a></td></tr>

<tr><td align="center"><a href="http://sourceforge.net/tracker/?group_id=67586">Bug Tracker</a></td></tr>

</table>

</table>

</td>

</tr>

<tr>

<tr><td align="center"><i>Last Update: 11-03-08</i></td></tr>

<a href="http://www.opengl.org"> <img src="./ogl_sm.jpg" width="68"

height="35" border="0" alt="OpenGL Logo"></a>

<a href="http://sourceforge.net"> <img

src="http://sourceforge.net/sflogo.php?group_id=67586&type=1"

width="88" height="31" border="0" alt="SourceForge Logo"></a>

</td>

</tr>

<tr><td align="center"><a

href="http://sourceforge.net/donate/index.php?group_id=67586"><img

src="http://images.sourceforge.net/images/project-support.jpg"

width="88" height="32" border="0" alt="Support This Project"></a></td></tr>

</table>

</td>

</tr>

</table>

</td>

<h1>The OpenGL Extension Wrangler Library</h1>

<h2>Automatic Code Generation</h2>

<p>

Starting from release 1.1.0, the source code and parts of the

documentation are automatically generated from the extension

100

specifications in a two-step process. In the first step,

101

specification files from the OpenGL registry are downloaded and

102

parsed. Skeleton descriptors are created for each extension. These

103

descriptors contain all necessary information for creating the source

104

code and documentation in a simple and compact format, including the

105

name of the extension, url link to the specification, tokens, function

106

declarations, typedefs and struct definitions. In the second step,

107

the header files as well as the library and glewinfo source are

108

generated from the descriptor files. The code generation scripts are

109

located in the <tt>auto</tt> subdirectory.

110

</p>

111

112

<p>

113

The code generation scripts require GNU make, wget, and perl. On

114

Windows, the simplest way to get access to these tools is to install

115

<a href="http://www.cygwin.com/">Cygwin</a>, but make sure that the

116

root directory is mounted in binary mode. The makefile in the

117

<tt>auto</tt> directory provides the following build targets:

118

</p>

119

120

121

122

123

124

<td align=left>Create the source files from the descriptors. If the

125

descriptors do not exist, create them from the spec files. If the spec

126

files do not exist, download them from the OpenGL repository.</td></tr>

127

<tr><td align="right" valign="top"><tt>make clean</tt></td>

128

129

<td align=left>Delete the source files.</td></tr>

130

<tr><td align="right" valign="top"><tt>make clobber</tt></td>

131

132

<td align=left>Delete the source files and the descriptors.</td></tr>

133

<tr><td align="right" valign="top"><tt>make destroy</tt></td>

134

135

<td align=left>Delete the source files, the descriptors, and the spec files.</td></tr>

136

<tr><td align="right" valign="top"><tt>make custom</tt></td>

137

138

<td align=left>Create the source files for the extensions

139

listed in <tt>auto/custom.txt</tt>. See "Custom Code

140

Generation" below for more details.</td></tr>

141

</table>

142

</center>

143

144

<h3>Adding a New Extension</h3>

145

146

<p>

147

To add a new extension, create a descriptor file for the extension in

148

<tt>auto/core</tt> and rerun the code generation scripts by typing

149

<tt>make clean; make</tt> in the <tt>auto</tt> directory.

150

</p>

151

152

<p>

153

The format of the descriptor file is given below. Items in

154

brackets are optional.

155

</p>

156

157

158

159

[<URL of Specification File>]<br>

160

    [<Token Name> <Token Value>]<br>

161

    [<Token Name> <Token Value>]<br>

162

    ...<br>

163

    [<Typedef>]<br>

164

    [<Typedef>]<br>

165

    ...<br>

166

    [<Function Signature>]<br>

167

    [<Function Signature>]<br>

168

    ...<br>

169

<!--     [<Function Definition>]<br>

170

    [<Function Definition>]<br>

171

    ...<br> -->

172

</p>

173

174

<!--

175

<p>

176

Note that <tt>Function Definitions</tt> are copied to the header files

177

without changes and have to be terminated with a semicolon. In

178

contrast, <tt>Tokens</tt>, <tt>Function signatures</tt>, and

179

<tt>Typedefs</tt> should not be terminated with a semicolon.

180

</p>

181

-->

182

183

<p>

184

Take a look at one of the files in <tt>auto/core</tt> for an

185

example. Note that typedefs and function signatures should not be

186

terminated with a semicolon.

187

</p>

188

189

<h3>Custom Code Generation</h3>

190

<p>

191

Starting from GLEW 1.3.0, it is possible to control which extensions

192

to include in the libarary by specifying a list in

193

<tt>auto/custom.txt</tt>. This is useful when you do not need all the

194

extensions and would like to reduce the size of the source files.

195

Type <tt>make clean; make custom</tt> in the <tt>auto</tt> directory

196

to rerun the scripts with the custom list of extensions.

197

</p>

198

199

<p>

200

For example, the following is the list of extensions needed to get GLEW and the

201

utilities to compile.

202

</p>

203

204

205

WGL_ARB_extensions_string<br>

206

WGL_ARB_multisample<br>

207

WGL_ARB_pixel_format<br>

208

WGL_ARB_pbuffer<br>

209

WGL_EXT_extensions_string<br>

210

WGL_ATI_pixel_format_float<br>

211

WGL_NV_float_buffer<br>

212

</p>

213

214

<h2>Multiple Rendering Contexts (GLEW MX)</h2>

215

216

<p>Starting with release 1.2.0, thread-safe support for multiple

217

rendering contexts, possibly with different capabilities, is

218

available. Since this is not required by most users, it is not added

219

to the binary releases to maintain compatibility between different

220

versions. To include multi-context support, you have to do the

221

following:</p>

222

<ol>

223

<li>Compile and use GLEW with the <tt>GLEW_MX</tt> preprocessor token

224

defined.</li>

225

<li>For each rendering context, create a <tt>GLEWContext</tt> object

226

that will be available as long as the rendering context exists.</li>

227

<li>Define a macro or function called <tt>glewGetContext()</tt> that

228

returns a pointer to the <tt>GLEWContext</tt> object associated with

229

the rendering context from which OpenGL/WGL/GLX calls are issued. This

230

dispatch mechanism is primitive, but generic.

231

<li>Make sure that you call <tt>glewInit()</tt> after creating the

232

<tt>GLEWContext</tt> object in each rendering context. Note, that the

233

<tt>GLEWContext</tt> pointer returned by <tt>glewGetContext()</tt> has

234

to reside in global or thread-local memory.

235

</ol>

236

237

<p>Note that according to the <a

238

href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/opengl/ntopnglr_6yer.asp">MSDN

239

WGL documentation</a>, you have to initialize the entry points for

240

every rendering context that use pixel formats with different

241

capabilities For example, the pixel formats provided by the generic

242

software OpenGL implementation by Microsoft vs. the hardware

243

accelerated pixel formats have different capabilities. <b>GLEW by

244

default ignores this requirement, and does not define per-context

245

entry points (you can however do this using the steps described

246

above).</b> Assuming a global namespace for the entry points works in

247

most situations, because typically all hardware accelerated pixel

248

formats provide the same entry points and capabilities. This means

249

that unless you use the multi-context version of GLEW, you need to

250

call <tt>glewInit()</tt> only once in your program, or more precisely,

251

once per process.</p>

252

253

<h2>Separate Namespace</h2>

254

255

<p>

256

To avoid name clashes when linking with libraries that include the

257

same symbols, extension entry points are declared in a separate

258

namespace (release 1.1.0 and up). This is achieved by aliasing OpenGL

259

function names to their GLEW equivalents. For instance,

260

<tt>glFancyFunction</tt> is simply an alias to

261

<tt>glewFancyFunction</tt>. The separate namespace does not effect

262

token and function pointer definitions.

263

</p>

264

265

<h2>Known Issues</h2>

266

267

<p>

268

GLEW requires GLX 1.2 for compatibility with GLUT.

269

</p>

270

271

</td>

272

</tr>

273

274

</table>

275

276

</body>

Older »