* removed some compiler defines
[glBitmap.git] / doc / glBitmap.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
2 <html>
3 <head>
4 <title>glBitmap</title>
5 <meta name="generator" content="PasDoc 0.13.0">
6 <meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
7 <link rel="StyleSheet" type="text/css" href="pasdoc.css">
8 </head>
9 <body>
10 <table class="container"><tr><td class="navigation">
11 <p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
12 <h1 class="unit">Unit glBitmap</h1>
13 <table class="sections wide_list">
14 <tr>
15 <td><a class="section" href="#PasDoc-Description">Description</a></td><td>Uses</td><td><a class="section" href="#PasDoc-Classes">Classes, Interfaces, Objects and Records</a></td><td><a class="section" href="#PasDoc-FuncsProcs">Functions and Procedures</a></td><td><a class="section" href="#PasDoc-Types">Types</a></td><td><a class="section" href="#PasDoc-Constants">Constants</a></td><td>Variables</td></tr></table>
16 <a name="PasDoc-Description"></a><h2 class="description">Description</h2>
17 <p>
18 glBitmap by Steffen Xonna aka Lossy eX (2003-2008) <a  href="http://www.opengl24.de/index.php?cat=header&amp;file=glbitmap">http://www.opengl24.de/index.php?cat=header&amp;file=glbitmap</a>
19
20 <p>modified by Delphi OpenGL Community (<a  href="http://delphigl.com/">http://delphigl.com/</a>) (2013)
21
22 <p>The contents of this file are used with permission, subject to the Mozilla Public License Version 1.1 (the &quot;License&quot;); you may not use this file except in compliance with the License. You may obtain a copy of the License at <a  href="http://www.mozilla.org/MPL/MPL-1.1.html">http://www.mozilla.org/MPL/MPL-1.1.html</a>
23
24 <p>The glBitmap is a Delphi/FPC unit that contains several wrapper classes to manage OpenGL texture objects. Below you can find a list of the main functionality of this classes: - load texture data from file (e.g. BMP, TGA, DDS, PNG, JPEG, ...) - load texture data from several other image objects (e.g. TBitmap, TLazIntfImage, SDL Surface) - save texture data to file (e.g. BMP, TGA, DDS, PNG, JPEG, ...) - save texture data to several other image objects (e.g. TBitmap, TLazIntfImage, SDL Surface) - support for many texture formats (e.g. RGB8, BGR8, RGBA8, BGRA8, ...) - manage texture properties (e.g. Filter, Clamp, Mipmap, ...) - upload texture data to video card - download texture data from video card - manipulate texture data (e.g. add alpha, remove alpha, convert to other format, switch RGB, ...)</p>
25 <a name="PasDoc-Uses"></a><h2 class="overview">Overview</h2>
26 <a name="PasDoc-Classes"></a><h3 class="cio">Classes, Interfaces, Objects and Records</h3>
27 <table class="classestable wide_list">
28 <tr class="listheader">
29 <th class="itemname">Name</th>
30 <th class="itemdesc">Description</th>
31 </tr>
32 <tr class="list">
33 <td class="itemname">Class&nbsp;<a class="bold" href="glBitmap.EglBitmap.html"><code>EglBitmap</code></a></td>
34 <td class="itemdesc">&nbsp;</td>
35 </tr>
36 <tr class="list2">
37 <td class="itemname">Class&nbsp;<a class="bold" href="glBitmap.EglBitmapNotSupported.html"><code>EglBitmapNotSupported</code></a></td>
38 <td class="itemdesc">&nbsp;</td>
39 </tr>
40 <tr class="list">
41 <td class="itemname">Class&nbsp;<a class="bold" href="glBitmap.EglBitmapSizeToLarge.html"><code>EglBitmapSizeToLarge</code></a></td>
42 <td class="itemdesc">&nbsp;</td>
43 </tr>
44 <tr class="list2">
45 <td class="itemname">Class&nbsp;<a class="bold" href="glBitmap.EglBitmapNonPowerOfTwo.html"><code>EglBitmapNonPowerOfTwo</code></a></td>
46 <td class="itemdesc">&nbsp;</td>
47 </tr>
48 <tr class="list">
49 <td class="itemname">Class&nbsp;<a class="bold" href="glBitmap.EglBitmapUnsupportedFormat.html"><code>EglBitmapUnsupportedFormat</code></a></td>
50 <td class="itemdesc">&nbsp;</td>
51 </tr>
52 <tr class="list2">
53 <td class="itemname">packed record&nbsp;<a class="bold" href="glBitmap.TglBitmapRec4ui.html"><code>TglBitmapRec4ui</code></a></td>
54 <td class="itemdesc">&nbsp;</td>
55 </tr>
56 <tr class="list">
57 <td class="itemname">packed record&nbsp;<a class="bold" href="glBitmap.TglBitmapRec4ub.html"><code>TglBitmapRec4ub</code></a></td>
58 <td class="itemdesc">&nbsp;</td>
59 </tr>
60 <tr class="list2">
61 <td class="itemname">packed record&nbsp;<a class="bold" href="glBitmap.TglBitmapRec4ul.html"><code>TglBitmapRec4ul</code></a></td>
62 <td class="itemdesc">&nbsp;</td>
63 </tr>
64 <tr class="list">
65 <td class="itemname">packed record&nbsp;<a class="bold" href="glBitmap.TglBitmapPixelData.html"><code>TglBitmapPixelData</code></a></td>
66 <td class="itemdesc">&nbsp;</td>
67 </tr>
68 <tr class="list2">
69 <td class="itemname">packed record&nbsp;<a class="bold" href="glBitmap.TglBitmapSize.html"><code>TglBitmapSize</code></a></td>
70 <td class="itemdesc">&nbsp;</td>
71 </tr>
72 <tr class="list">
73 <td class="itemname">Class&nbsp;<a class="bold" href="glBitmap.TglBitmapFormatDescriptor.html"><code>TglBitmapFormatDescriptor</code></a></td>
74 <td class="itemdesc">&nbsp;</td>
75 </tr>
76 <tr class="list2">
77 <td class="itemname">record&nbsp;<a class="bold" href="glBitmap.TglBitmapFunctionRec.html"><code>TglBitmapFunctionRec</code></a></td>
78 <td class="itemdesc">&nbsp;</td>
79 </tr>
80 <tr class="list">
81 <td class="itemname">Class&nbsp;<a class="bold" href="glBitmap.TglBitmapData.html"><code>TglBitmapData</code></a></td>
82 <td class="itemdesc">&nbsp;</td>
83 </tr>
84 <tr class="list2">
85 <td class="itemname">Class&nbsp;<a class="bold" href="glBitmap.TglBitmap.html"><code>TglBitmap</code></a></td>
86 <td class="itemdesc">&nbsp;</td>
87 </tr>
88 <tr class="list">
89 <td class="itemname">Class&nbsp;<a class="bold" href="glBitmap.TglBitmap1D.html"><code>TglBitmap1D</code></a></td>
90 <td class="itemdesc">&nbsp;</td>
91 </tr>
92 <tr class="list2">
93 <td class="itemname">Class&nbsp;<a class="bold" href="glBitmap.TglBitmap2D.html"><code>TglBitmap2D</code></a></td>
94 <td class="itemdesc">&nbsp;</td>
95 </tr>
96 <tr class="list">
97 <td class="itemname">Class&nbsp;<a class="bold" href="glBitmap.TglBitmapCubeMap.html"><code>TglBitmapCubeMap</code></a></td>
98 <td class="itemdesc">&nbsp;</td>
99 </tr>
100 <tr class="list2">
101 <td class="itemname">Class&nbsp;<a class="bold" href="glBitmap.TglBitmapNormalMap.html"><code>TglBitmapNormalMap</code></a></td>
102 <td class="itemdesc">&nbsp;</td>
103 </tr>
104 </table>
105 <a name="PasDoc-FuncsProcs"></a><h3 class="summary">Functions and Procedures</h3>
106 <table class="summary wide_list">
107 <tr class="list">
108 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapSetDefaultDeleteTextureOnFree">glBitmapSetDefaultDeleteTextureOnFree</a></b>(const aDeleteTextureOnFree: Boolean);</code></td>
109 </tr>
110 <tr class="list2">
111 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapSetDefaultFreeDataAfterGenTexture">glBitmapSetDefaultFreeDataAfterGenTexture</a></b>(const aFreeData: Boolean);</code></td>
112 </tr>
113 <tr class="list">
114 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapSetDefaultMipmap">glBitmapSetDefaultMipmap</a></b>(const aValue: <a  href="glBitmap.html#TglBitmapMipMap">TglBitmapMipMap</a>);</code></td>
115 </tr>
116 <tr class="list2">
117 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapSetDefaultFormat">glBitmapSetDefaultFormat</a></b>(const aFormat: <a  href="glBitmap.html#TglBitmapFormat">TglBitmapFormat</a>);</code></td>
118 </tr>
119 <tr class="list">
120 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapSetDefaultFilter">glBitmapSetDefaultFilter</a></b>(const aMin, aMag: Integer);</code></td>
121 </tr>
122 <tr class="list2">
123 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapSetDefaultWrap">glBitmapSetDefaultWrap</a></b>( const S: Cardinal = GL_CLAMP_TO_EDGE; const T: Cardinal = GL_CLAMP_TO_EDGE; const R: Cardinal = GL_CLAMP_TO_EDGE);</code></td>
124 </tr>
125 <tr class="list">
126 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapSetDefaultSwizzle">glBitmapSetDefaultSwizzle</a></b>(const r: GLenum = GL_RED; g: GLenum = GL_GREEN; b: GLenum = GL_BLUE; a: GLenum = GL_ALPHA);</code></td>
127 </tr>
128 <tr class="list2">
129 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapGetDefaultDeleteTextureOnFree">glBitmapGetDefaultDeleteTextureOnFree</a></b>: Boolean;</code></td>
130 </tr>
131 <tr class="list">
132 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapGetDefaultFreeDataAfterGenTexture">glBitmapGetDefaultFreeDataAfterGenTexture</a></b>: Boolean;</code></td>
133 </tr>
134 <tr class="list2">
135 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapGetDefaultMipmap">glBitmapGetDefaultMipmap</a></b>: <a  href="glBitmap.html#TglBitmapMipMap">TglBitmapMipMap</a>;</code></td>
136 </tr>
137 <tr class="list">
138 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapGetDefaultFormat">glBitmapGetDefaultFormat</a></b>: <a  href="glBitmap.html#TglBitmapFormat">TglBitmapFormat</a>;</code></td>
139 </tr>
140 <tr class="list2">
141 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapGetDefaultFilter">glBitmapGetDefaultFilter</a></b>(var aMin, aMag: Cardinal);</code></td>
142 </tr>
143 <tr class="list">
144 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapGetDefaultTextureWrap">glBitmapGetDefaultTextureWrap</a></b>(var S, T, R: Cardinal);</code></td>
145 </tr>
146 <tr class="list2">
147 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapGetDefaultSwizzle">glBitmapGetDefaultSwizzle</a></b>(var r, g, b, a: GLenum);</code></td>
148 </tr>
149 <tr class="list">
150 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapSize">glBitmapSize</a></b>(X: Integer = -1; Y: Integer = -1): <a  href="glBitmap.TglBitmapSize.html">TglBitmapSize</a>;</code></td>
151 </tr>
152 <tr class="list2">
153 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapPosition">glBitmapPosition</a></b>(X: Integer = -1; Y: Integer = -1): <a  href="glBitmap.html#TglBitmapPixelPosition">TglBitmapPixelPosition</a>;</code></td>
154 </tr>
155 <tr class="list">
156 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapRec4ub">glBitmapRec4ub</a></b>(const r, g, b, a: Byte): <a  href="glBitmap.TglBitmapRec4ub.html">TglBitmapRec4ub</a>;</code></td>
157 </tr>
158 <tr class="list2">
159 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapRec4ui">glBitmapRec4ui</a></b>(const r, g, b, a: Cardinal): <a  href="glBitmap.TglBitmapRec4ui.html">TglBitmapRec4ui</a>;</code></td>
160 </tr>
161 <tr class="list">
162 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapRec4ul">glBitmapRec4ul</a></b>(const r, g, b, a: QWord): <a  href="glBitmap.TglBitmapRec4ul.html">TglBitmapRec4ul</a>;</code></td>
163 </tr>
164 <tr class="list2">
165 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapRec4ubCompare">glBitmapRec4ubCompare</a></b>(const r1, r2: <a  href="glBitmap.TglBitmapRec4ub.html">TglBitmapRec4ub</a>): Boolean;</code></td>
166 </tr>
167 <tr class="list">
168 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapRec4uiCompare">glBitmapRec4uiCompare</a></b>(const r1, r2: <a  href="glBitmap.TglBitmapRec4ui.html">TglBitmapRec4ui</a>): Boolean;</code></td>
169 </tr>
170 <tr class="list2">
171 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapCreateTestData">glBitmapCreateTestData</a></b>(const aFormat: <a  href="glBitmap.html#TglBitmapFormat">TglBitmapFormat</a>): <a  href="glBitmap.TglBitmapData.html">TglBitmapData</a>;</code></td>
172 </tr>
173 </table>
174 <a name="PasDoc-Types"></a><h3 class="summary">Types</h3>
175 <table class="summary wide_list">
176 <tr class="list">
177 <td class="itemcode"><code><b><a  href="glBitmap.html#TglBitmapFormat">TglBitmapFormat</a></b> = (...);</code></td>
178 </tr>
179 <tr class="list2">
180 <td class="itemcode"><code><b><a  href="glBitmap.html#TglBitmapFileType">TglBitmapFileType</a></b> = (...);</code></td>
181 </tr>
182 <tr class="list">
183 <td class="itemcode"><code><b><a  href="glBitmap.html#TglBitmapFileTypes">TglBitmapFileTypes</a></b> = set of <a  href="glBitmap.html#TglBitmapFileType">TglBitmapFileType</a>;</code></td>
184 </tr>
185 <tr class="list2">
186 <td class="itemcode"><code><b><a  href="glBitmap.html#TglBitmapMipMap">TglBitmapMipMap</a></b> = (...);</code></td>
187 </tr>
188 <tr class="list">
189 <td class="itemcode"><code><b><a  href="glBitmap.html#TglBitmapNormalMapFunc">TglBitmapNormalMapFunc</a></b> = (...);</code></td>
190 </tr>
191 <tr class="list2">
192 <td class="itemcode"><code><b><a  href="glBitmap.html#PglBitmapPixelData">PglBitmapPixelData</a></b> = &circ;<a  href="glBitmap.TglBitmapPixelData.html">TglBitmapPixelData</a>;</code></td>
193 </tr>
194 <tr class="list">
195 <td class="itemcode"><code><b><a  href="glBitmap.html#TglBitmapSizeFields">TglBitmapSizeFields</a></b> = set of (ffX, ffY);</code></td>
196 </tr>
197 <tr class="list2">
198 <td class="itemcode"><code><b><a  href="glBitmap.html#TglBitmapPixelPosition">TglBitmapPixelPosition</a></b> = <a  href="glBitmap.TglBitmapSize.html">TglBitmapSize</a>;</code></td>
199 </tr>
200 <tr class="list">
201 <td class="itemcode"><code><b><a  href="glBitmap.html#TglBitmapFunction">TglBitmapFunction</a></b> = procedure(var FuncRec: <a  href="glBitmap.TglBitmapFunctionRec.html">TglBitmapFunctionRec</a>);</code></td>
202 </tr>
203 </table>
204 <a name="PasDoc-Constants"></a><h3 class="summary">Constants</h3>
205 <table class="summary wide_list">
206 <tr class="list">
207 <td class="itemcode"><code><b><a  href="glBitmap.html#NULL_SIZE">NULL_SIZE</a></b>: <a  href="glBitmap.TglBitmapSize.html">TglBitmapSize</a> = (Fields: []; X: 0; Y: 0);</code></td>
208 </tr>
209 </table>
210 <h2 class="description">Description</h2>
211 <h3 class="detail">Functions and Procedures</h3>
212 <table class="detail wide_list">
213 <tr class="list">
214 <td class="itemcode"><a name="glBitmapSetDefaultDeleteTextureOnFree"></a><code>procedure <b>glBitmapSetDefaultDeleteTextureOnFree</b>(const aDeleteTextureOnFree: Boolean);</code></td>
215 </tr>
216 <tr><td colspan="1">
217 &nbsp;</td></tr>
218 </table>
219 <table class="detail wide_list">
220 <tr class="list">
221 <td class="itemcode"><a name="glBitmapSetDefaultFreeDataAfterGenTexture"></a><code>procedure <b>glBitmapSetDefaultFreeDataAfterGenTexture</b>(const aFreeData: Boolean);</code></td>
222 </tr>
223 <tr><td colspan="1">
224 &nbsp;</td></tr>
225 </table>
226 <table class="detail wide_list">
227 <tr class="list">
228 <td class="itemcode"><a name="glBitmapSetDefaultMipmap"></a><code>procedure <b>glBitmapSetDefaultMipmap</b>(const aValue: <a  href="glBitmap.html#TglBitmapMipMap">TglBitmapMipMap</a>);</code></td>
229 </tr>
230 <tr><td colspan="1">
231 &nbsp;</td></tr>
232 </table>
233 <table class="detail wide_list">
234 <tr class="list">
235 <td class="itemcode"><a name="glBitmapSetDefaultFormat"></a><code>procedure <b>glBitmapSetDefaultFormat</b>(const aFormat: <a  href="glBitmap.html#TglBitmapFormat">TglBitmapFormat</a>);</code></td>
236 </tr>
237 <tr><td colspan="1">
238 &nbsp;</td></tr>
239 </table>
240 <table class="detail wide_list">
241 <tr class="list">
242 <td class="itemcode"><a name="glBitmapSetDefaultFilter"></a><code>procedure <b>glBitmapSetDefaultFilter</b>(const aMin, aMag: Integer);</code></td>
243 </tr>
244 <tr><td colspan="1">
245 &nbsp;</td></tr>
246 </table>
247 <table class="detail wide_list">
248 <tr class="list">
249 <td class="itemcode"><a name="glBitmapSetDefaultWrap"></a><code>procedure <b>glBitmapSetDefaultWrap</b>( const S: Cardinal = GL_CLAMP_TO_EDGE; const T: Cardinal = GL_CLAMP_TO_EDGE; const R: Cardinal = GL_CLAMP_TO_EDGE);</code></td>
250 </tr>
251 <tr><td colspan="1">
252 &nbsp;</td></tr>
253 </table>
254 <table class="detail wide_list">
255 <tr class="list">
256 <td class="itemcode"><a name="glBitmapSetDefaultSwizzle"></a><code>procedure <b>glBitmapSetDefaultSwizzle</b>(const r: GLenum = GL_RED; g: GLenum = GL_GREEN; b: GLenum = GL_BLUE; a: GLenum = GL_ALPHA);</code></td>
257 </tr>
258 <tr><td colspan="1">
259 &nbsp;</td></tr>
260 </table>
261 <table class="detail wide_list">
262 <tr class="list">
263 <td class="itemcode"><a name="glBitmapGetDefaultDeleteTextureOnFree"></a><code>function <b>glBitmapGetDefaultDeleteTextureOnFree</b>: Boolean;</code></td>
264 </tr>
265 <tr><td colspan="1">
266 &nbsp;</td></tr>
267 </table>
268 <table class="detail wide_list">
269 <tr class="list">
270 <td class="itemcode"><a name="glBitmapGetDefaultFreeDataAfterGenTexture"></a><code>function <b>glBitmapGetDefaultFreeDataAfterGenTexture</b>: Boolean;</code></td>
271 </tr>
272 <tr><td colspan="1">
273 &nbsp;</td></tr>
274 </table>
275 <table class="detail wide_list">
276 <tr class="list">
277 <td class="itemcode"><a name="glBitmapGetDefaultMipmap"></a><code>function <b>glBitmapGetDefaultMipmap</b>: <a  href="glBitmap.html#TglBitmapMipMap">TglBitmapMipMap</a>;</code></td>
278 </tr>
279 <tr><td colspan="1">
280 &nbsp;</td></tr>
281 </table>
282 <table class="detail wide_list">
283 <tr class="list">
284 <td class="itemcode"><a name="glBitmapGetDefaultFormat"></a><code>function <b>glBitmapGetDefaultFormat</b>: <a  href="glBitmap.html#TglBitmapFormat">TglBitmapFormat</a>;</code></td>
285 </tr>
286 <tr><td colspan="1">
287 &nbsp;</td></tr>
288 </table>
289 <table class="detail wide_list">
290 <tr class="list">
291 <td class="itemcode"><a name="glBitmapGetDefaultFilter"></a><code>procedure <b>glBitmapGetDefaultFilter</b>(var aMin, aMag: Cardinal);</code></td>
292 </tr>
293 <tr><td colspan="1">
294 &nbsp;</td></tr>
295 </table>
296 <table class="detail wide_list">
297 <tr class="list">
298 <td class="itemcode"><a name="glBitmapGetDefaultTextureWrap"></a><code>procedure <b>glBitmapGetDefaultTextureWrap</b>(var S, T, R: Cardinal);</code></td>
299 </tr>
300 <tr><td colspan="1">
301 &nbsp;</td></tr>
302 </table>
303 <table class="detail wide_list">
304 <tr class="list">
305 <td class="itemcode"><a name="glBitmapGetDefaultSwizzle"></a><code>procedure <b>glBitmapGetDefaultSwizzle</b>(var r, g, b, a: GLenum);</code></td>
306 </tr>
307 <tr><td colspan="1">
308 &nbsp;</td></tr>
309 </table>
310 <table class="detail wide_list">
311 <tr class="list">
312 <td class="itemcode"><a name="glBitmapSize"></a><code>function <b>glBitmapSize</b>(X: Integer = -1; Y: Integer = -1): <a  href="glBitmap.TglBitmapSize.html">TglBitmapSize</a>;</code></td>
313 </tr>
314 <tr><td colspan="1">
315 &nbsp;</td></tr>
316 </table>
317 <table class="detail wide_list">
318 <tr class="list">
319 <td class="itemcode"><a name="glBitmapPosition"></a><code>function <b>glBitmapPosition</b>(X: Integer = -1; Y: Integer = -1): <a  href="glBitmap.html#TglBitmapPixelPosition">TglBitmapPixelPosition</a>;</code></td>
320 </tr>
321 <tr><td colspan="1">
322 &nbsp;</td></tr>
323 </table>
324 <table class="detail wide_list">
325 <tr class="list">
326 <td class="itemcode"><a name="glBitmapRec4ub"></a><code>function <b>glBitmapRec4ub</b>(const r, g, b, a: Byte): <a  href="glBitmap.TglBitmapRec4ub.html">TglBitmapRec4ub</a>;</code></td>
327 </tr>
328 <tr><td colspan="1">
329 &nbsp;</td></tr>
330 </table>
331 <table class="detail wide_list">
332 <tr class="list">
333 <td class="itemcode"><a name="glBitmapRec4ui"></a><code>function <b>glBitmapRec4ui</b>(const r, g, b, a: Cardinal): <a  href="glBitmap.TglBitmapRec4ui.html">TglBitmapRec4ui</a>;</code></td>
334 </tr>
335 <tr><td colspan="1">
336 &nbsp;</td></tr>
337 </table>
338 <table class="detail wide_list">
339 <tr class="list">
340 <td class="itemcode"><a name="glBitmapRec4ul"></a><code>function <b>glBitmapRec4ul</b>(const r, g, b, a: QWord): <a  href="glBitmap.TglBitmapRec4ul.html">TglBitmapRec4ul</a>;</code></td>
341 </tr>
342 <tr><td colspan="1">
343 &nbsp;</td></tr>
344 </table>
345 <table class="detail wide_list">
346 <tr class="list">
347 <td class="itemcode"><a name="glBitmapRec4ubCompare"></a><code>function <b>glBitmapRec4ubCompare</b>(const r1, r2: <a  href="glBitmap.TglBitmapRec4ub.html">TglBitmapRec4ub</a>): Boolean;</code></td>
348 </tr>
349 <tr><td colspan="1">
350 &nbsp;</td></tr>
351 </table>
352 <table class="detail wide_list">
353 <tr class="list">
354 <td class="itemcode"><a name="glBitmapRec4uiCompare"></a><code>function <b>glBitmapRec4uiCompare</b>(const r1, r2: <a  href="glBitmap.TglBitmapRec4ui.html">TglBitmapRec4ui</a>): Boolean;</code></td>
355 </tr>
356 <tr><td colspan="1">
357 &nbsp;</td></tr>
358 </table>
359 <table class="detail wide_list">
360 <tr class="list">
361 <td class="itemcode"><a name="glBitmapCreateTestData"></a><code>function <b>glBitmapCreateTestData</b>(const aFormat: <a  href="glBitmap.html#TglBitmapFormat">TglBitmapFormat</a>): <a  href="glBitmap.TglBitmapData.html">TglBitmapData</a>;</code></td>
362 </tr>
363 <tr><td colspan="1">
364 &nbsp;</td></tr>
365 </table>
366 <h3 class="detail">Types</h3>
367 <table class="detail wide_list">
368 <tr class="list">
369 <td class="itemcode"><a name="TglBitmapFormat"></a><code><b>TglBitmapFormat</b> = (...);</code></td>
370 </tr>
371 <tr><td colspan="1">
372 <p>
373 type that describes the format of the data stored in a texture. the name of formats is composed of the following constituents: - multiple channels: - channel (e.g. R, G, B, A or Alpha, Luminance or X (reserved)) - width of the chanel in bit (4, 8, 16, ...) - data type (e.g. ub, us, ui) - number of elements of data types</p>
374 <h6 class="description_section">Values</h6>
375 <ul>
376 <li>
377 tfEmpty = 0: &nbsp;</li>
378 <li>
379 tfAlpha4ub1: 1 x unsigned byte</li>
380 <li>
381 tfAlpha8ub1: 1 x unsigned byte</li>
382 <li>
383 tfAlpha16us1: 1 x unsigned short</li>
384 <li>
385 tfLuminance4ub1: 1 x unsigned byte</li>
386 <li>
387 tfLuminance8ub1: 1 x unsigned byte</li>
388 <li>
389 tfLuminance16us1: 1 x unsigned short</li>
390 <li>
391 tfLuminance4Alpha4ub2: 1 x unsigned byte (lum), 1 x unsigned byte (alpha)</li>
392 <li>
393 tfLuminance6Alpha2ub2: 1 x unsigned byte (lum), 1 x unsigned byte (alpha)</li>
394 <li>
395 tfLuminance8Alpha8ub2: 1 x unsigned byte (lum), 1 x unsigned byte (alpha)</li>
396 <li>
397 tfLuminance12Alpha4us2: 1 x unsigned short (lum), 1 x unsigned short (alpha)</li>
398 <li>
399 tfLuminance16Alpha16us2: 1 x unsigned short (lum), 1 x unsigned short (alpha)</li>
400 <li>
401 tfR3G3B2ub1: 1 x unsigned byte (3bit red, 3bit green, 2bit blue)</li>
402 <li>
403 tfRGBX4us1: 1 x unsigned short (4bit red, 4bit green, 4bit blue, 4bit reserverd)</li>
404 <li>
405 tfXRGB4us1: 1 x unsigned short (4bit reserved, 4bit red, 4bit green, 4bit blue)</li>
406 <li>
407 tfR5G6B5us1: 1 x unsigned short (5bit red, 6bit green, 5bit blue)</li>
408 <li>
409 tfRGB5X1us1: 1 x unsigned short (5bit red, 5bit green, 5bit blue, 1bit reserved)</li>
410 <li>
411 tfX1RGB5us1: 1 x unsigned short (1bit reserved, 5bit red, 5bit green, 5bit blue)</li>
412 <li>
413 tfRGB8ub3: 1 x unsigned byte (red), 1 x unsigned byte (green), 1 x unsigned byte (blue)</li>
414 <li>
415 tfRGBX8ui1: 1 x unsigned int (8bit red, 8bit green, 8bit blue, 8bit reserved)</li>
416 <li>
417 tfXRGB8ui1: 1 x unsigned int (8bit reserved, 8bit red, 8bit green, 8bit blue)</li>
418 <li>
419 tfRGB10X2ui1: 1 x unsigned int (10bit red, 10bit green, 10bit blue, 2bit reserved)</li>
420 <li>
421 tfX2RGB10ui1: 1 x unsigned int (2bit reserved, 10bit red, 10bit green, 10bit blue)</li>
422 <li>
423 tfRGB16us3: 1 x unsigned short (red), 1 x unsigned short (green), 1 x unsigned short (blue)</li>
424 <li>
425 tfRGBA4us1: 1 x unsigned short (4bit red, 4bit green, 4bit blue, 4bit alpha)</li>
426 <li>
427 tfARGB4us1: 1 x unsigned short (4bit alpha, 4bit red, 4bit green, 4bit blue)</li>
428 <li>
429 tfRGB5A1us1: 1 x unsigned short (5bit red, 5bit green, 5bit blue, 1bit alpha)</li>
430 <li>
431 tfA1RGB5us1: 1 x unsigned short (1bit alpha, 5bit red, 5bit green, 5bit blue)</li>
432 <li>
433 tfRGBA8ui1: 1 x unsigned int (8bit red, 8bit green, 8bit blue, 8 bit alpha)</li>
434 <li>
435 tfARGB8ui1: 1 x unsigned int (8 bit alpha, 8bit red, 8bit green, 8bit blue)</li>
436 <li>
437 tfRGBA8ub4: 1 x unsigned byte (red), 1 x unsigned byte (green), 1 x unsigned byte (blue), 1 x unsigned byte (alpha)</li>
438 <li>
439 tfRGB10A2ui1: 1 x unsigned int (10bit red, 10bit green, 10bit blue, 2bit alpha)</li>
440 <li>
441 tfA2RGB10ui1: 1 x unsigned int (2bit alpha, 10bit red, 10bit green, 10bit blue)</li>
442 <li>
443 tfRGBA16us4: 1 x unsigned short (red), 1 x unsigned short (green), 1 x unsigned short (blue), 1 x unsigned short (alpha)</li>
444 <li>
445 tfBGRX4us1: 1 x unsigned short (4bit blue, 4bit green, 4bit red, 4bit reserved)</li>
446 <li>
447 tfXBGR4us1: 1 x unsigned short (4bit reserved, 4bit blue, 4bit green, 4bit red)</li>
448 <li>
449 tfB5G6R5us1: 1 x unsigned short (5bit blue, 6bit green, 5bit red)</li>
450 <li>
451 tfBGR5X1us1: 1 x unsigned short (5bit blue, 5bit green, 5bit red, 1bit reserved)</li>
452 <li>
453 tfX1BGR5us1: 1 x unsigned short (1bit reserved, 5bit blue, 5bit green, 5bit red)</li>
454 <li>
455 tfBGR8ub3: 1 x unsigned byte (blue), 1 x unsigned byte (green), 1 x unsigned byte (red)</li>
456 <li>
457 tfBGRX8ui1: 1 x unsigned int (8bit blue, 8bit green, 8bit red, 8bit reserved)</li>
458 <li>
459 tfXBGR8ui1: 1 x unsigned int (8bit reserved, 8bit blue, 8bit green, 8bit red)</li>
460 <li>
461 tfBGR10X2ui1: 1 x unsigned int (10bit blue, 10bit green, 10bit red, 2bit reserved)</li>
462 <li>
463 tfX2BGR10ui1: 1 x unsigned int (2bit reserved, 10bit blue, 10bit green, 10bit red)</li>
464 <li>
465 tfBGR16us3: 1 x unsigned short (blue), 1 x unsigned short (green), 1 x unsigned short (red)</li>
466 <li>
467 tfBGRA4us1: 1 x unsigned short (4bit blue, 4bit green, 4bit red, 4bit alpha)</li>
468 <li>
469 tfABGR4us1: 1 x unsigned short (4bit alpha, 4bit blue, 4bit green, 4bit red)</li>
470 <li>
471 tfBGR5A1us1: 1 x unsigned short (5bit blue, 5bit green, 5bit red, 1bit alpha)</li>
472 <li>
473 tfA1BGR5us1: 1 x unsigned short (1bit alpha, 5bit blue, 5bit green, 5bit red)</li>
474 <li>
475 tfBGRA8ui1: 1 x unsigned int (8bit blue, 8bit green, 8bit red, 8bit alpha)</li>
476 <li>
477 tfABGR8ui1: 1 x unsigned int (8bit alpha, 8bit blue, 8bit green, 8bit red)</li>
478 <li>
479 tfBGRA8ub4: 1 x unsigned byte (blue), 1 x unsigned byte (green), 1 x unsigned byte (red), 1 x unsigned byte (alpha)</li>
480 <li>
481 tfBGR10A2ui1: 1 x unsigned int (10bit blue, 10bit green, 10bit red, 2bit alpha)</li>
482 <li>
483 tfA2BGR10ui1: 1 x unsigned int (2bit alpha, 10bit blue, 10bit green, 10bit red)</li>
484 <li>
485 tfBGRA16us4: 1 x unsigned short (blue), 1 x unsigned short (green), 1 x unsigned short (red), 1 x unsigned short (alpha)</li>
486 <li>
487 tfDepth16us1: 1 x unsigned short (depth)</li>
488 <li>
489 tfDepth24ui1: 1 x unsigned int (depth)</li>
490 <li>
491 tfDepth32ui1: 1 x unsigned int (depth)</li>
492 <li>
493 tfS3tcDtx1RGBA: &nbsp;</li>
494 <li>
495 tfS3tcDtx3RGBA: &nbsp;</li>
496 <li>
497 tfS3tcDtx5RGBA: &nbsp;</li>
498 </ul>
499 </td></tr>
500 </table>
501 <table class="detail wide_list">
502 <tr class="list">
503 <td class="itemcode"><a name="TglBitmapFileType"></a><code><b>TglBitmapFileType</b> = (...);</code></td>
504 </tr>
505 <tr><td colspan="1">
506 <p>
507 type to define suitable file formats</p>
508 <h6 class="description_section">Values</h6>
509 <ul>
510 <li>
511 ftPNG: Portable Network Graphic file (PNG)</li>
512 <li>
513 ftJPEG: JPEG file</li>
514 <li>
515 ftDDS: Direct Draw Surface file (DDS)</li>
516 <li>
517 ftTGA: Targa Image File (TGA)</li>
518 <li>
519 ftBMP: Windows Bitmap File (BMP)</li>
520 <li>
521 ftRAW: glBitmap RAW file format</li>
522 </ul>
523 </td></tr>
524 </table>
525 <table class="detail wide_list">
526 <tr class="list">
527 <td class="itemcode"><a name="TglBitmapFileTypes"></a><code><b>TglBitmapFileTypes</b> = set of <a  href="glBitmap.html#TglBitmapFileType">TglBitmapFileType</a>;</code></td>
528 </tr>
529 <tr><td colspan="1">
530 &nbsp;</td></tr>
531 </table>
532 <table class="detail wide_list">
533 <tr class="list">
534 <td class="itemcode"><a name="TglBitmapMipMap"></a><code><b>TglBitmapMipMap</b> = (...);</code></td>
535 </tr>
536 <tr><td colspan="1">
537 <p>
538 possible mipmap types</p>
539 <h6 class="description_section">Values</h6>
540 <ul>
541 <li>
542 mmNone: no mipmaps</li>
543 <li>
544 mmMipmap: normal mipmaps</li>
545 <li>
546 mmMipmapGlu: mipmaps generated with glu functions</li>
547 </ul>
548 </td></tr>
549 </table>
550 <table class="detail wide_list">
551 <tr class="list">
552 <td class="itemcode"><a name="TglBitmapNormalMapFunc"></a><code><b>TglBitmapNormalMapFunc</b> = (...);</code></td>
553 </tr>
554 <tr><td colspan="1">
555 <p>
556 possible normal map functions</p>
557 <h6 class="description_section">Values</h6>
558 <ul>
559 <li>
560 nm4Samples: &nbsp;</li>
561 <li>
562 nmSobel: &nbsp;</li>
563 <li>
564 nm3x3: &nbsp;</li>
565 <li>
566 nm5x5: &nbsp;</li>
567 </ul>
568 </td></tr>
569 </table>
570 <table class="detail wide_list">
571 <tr class="list">
572 <td class="itemcode"><a name="PglBitmapPixelData"></a><code><b>PglBitmapPixelData</b> = &circ;<a  href="glBitmap.TglBitmapPixelData.html">TglBitmapPixelData</a>;</code></td>
573 </tr>
574 <tr><td colspan="1">
575 &nbsp;</td></tr>
576 </table>
577 <table class="detail wide_list">
578 <tr class="list">
579 <td class="itemcode"><a name="TglBitmapSizeFields"></a><code><b>TglBitmapSizeFields</b> = set of (ffX, ffY);</code></td>
580 </tr>
581 <tr><td colspan="1">
582 &nbsp;</td></tr>
583 </table>
584 <table class="detail wide_list">
585 <tr class="list">
586 <td class="itemcode"><a name="TglBitmapPixelPosition"></a><code><b>TglBitmapPixelPosition</b> = <a  href="glBitmap.TglBitmapSize.html">TglBitmapSize</a>;</code></td>
587 </tr>
588 <tr><td colspan="1">
589 &nbsp;</td></tr>
590 </table>
591 <table class="detail wide_list">
592 <tr class="list">
593 <td class="itemcode"><a name="TglBitmapFunction"></a><code><b>TglBitmapFunction</b> = procedure(var FuncRec: <a  href="glBitmap.TglBitmapFunctionRec.html">TglBitmapFunctionRec</a>);</code></td>
594 </tr>
595 <tr><td colspan="1">
596 <p>
597 callback to use for converting texture data</p>
598 </td></tr>
599 </table>
600 <h3 class="detail">Constants</h3>
601 <table class="detail wide_list">
602 <tr class="list">
603 <td class="itemcode"><a name="NULL_SIZE"></a><code><b>NULL_SIZE</b>: <a  href="glBitmap.TglBitmapSize.html">TglBitmapSize</a> = (Fields: []; X: 0; Y: 0);</code></td>
604 </tr>
605 <tr><td colspan="1">
606 &nbsp;</td></tr>
607 </table>
608 <hr noshade size="1"><span class="appinfo"><em>Generated by <a  href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2014-12-24 04:27:09</em>
609 </span>
610 </td></tr></table></body></html>