* added documentation (in-code and pasdoc generated)
[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">Class&nbsp;<a class="bold" href="glBitmap.TglBitmapFormatDescriptor.html"><code>TglBitmapFormatDescriptor</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.TglBitmapPixelData.html"><code>TglBitmapPixelData</code></a></td>
70 <td class="itemdesc">&nbsp;</td>
71 </tr>
72 <tr class="list">
73 <td class="itemname">packed record&nbsp;<a class="bold" href="glBitmap.TglBitmapSize.html"><code>TglBitmapSize</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.TglBitmap.html"><code>TglBitmap</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.TglBitmap1D.html"><code>TglBitmap1D</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.TglBitmap2D.html"><code>TglBitmap2D</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.TglBitmapCubeMap.html"><code>TglBitmapCubeMap</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.TglBitmapNormalMap.html"><code>TglBitmapNormalMap</code></a></td>
98 <td class="itemdesc">&nbsp;</td>
99 </tr>
100 </table>
101 <a name="PasDoc-FuncsProcs"></a><h3 class="summary">Functions and Procedures</h3>
102 <table class="summary wide_list">
103 <tr class="list">
104 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapSetDefaultDeleteTextureOnFree">glBitmapSetDefaultDeleteTextureOnFree</a></b>(const aDeleteTextureOnFree: Boolean);</code></td>
105 </tr>
106 <tr class="list2">
107 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapSetDefaultFreeDataAfterGenTexture">glBitmapSetDefaultFreeDataAfterGenTexture</a></b>(const aFreeData: Boolean);</code></td>
108 </tr>
109 <tr class="list">
110 <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>
111 </tr>
112 <tr class="list2">
113 <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>
114 </tr>
115 <tr class="list">
116 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapSetDefaultFilter">glBitmapSetDefaultFilter</a></b>(const aMin, aMag: Integer);</code></td>
117 </tr>
118 <tr class="list2">
119 <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>
120 </tr>
121 <tr class="list">
122 <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>
123 </tr>
124 <tr class="list2">
125 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapGetDefaultDeleteTextureOnFree">glBitmapGetDefaultDeleteTextureOnFree</a></b>: Boolean;</code></td>
126 </tr>
127 <tr class="list">
128 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapGetDefaultFreeDataAfterGenTexture">glBitmapGetDefaultFreeDataAfterGenTexture</a></b>: Boolean;</code></td>
129 </tr>
130 <tr class="list2">
131 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapGetDefaultMipmap">glBitmapGetDefaultMipmap</a></b>: <a  href="glBitmap.html#TglBitmapMipMap">TglBitmapMipMap</a>;</code></td>
132 </tr>
133 <tr class="list">
134 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapGetDefaultFormat">glBitmapGetDefaultFormat</a></b>: <a  href="glBitmap.html#TglBitmapFormat">TglBitmapFormat</a>;</code></td>
135 </tr>
136 <tr class="list2">
137 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapGetDefaultFilter">glBitmapGetDefaultFilter</a></b>(var aMin, aMag: Cardinal);</code></td>
138 </tr>
139 <tr class="list">
140 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapGetDefaultTextureWrap">glBitmapGetDefaultTextureWrap</a></b>(var S, T, R: Cardinal);</code></td>
141 </tr>
142 <tr class="list2">
143 <td class="itemcode"><code>procedure <b><a  href="glBitmap.html#glBitmapGetDefaultSwizzle">glBitmapGetDefaultSwizzle</a></b>(var r, g, b, a: GLenum);</code></td>
144 </tr>
145 <tr class="list">
146 <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>
147 </tr>
148 <tr class="list2">
149 <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>
150 </tr>
151 <tr class="list">
152 <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>
153 </tr>
154 <tr class="list2">
155 <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>
156 </tr>
157 <tr class="list">
158 <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>
159 </tr>
160 <tr class="list2">
161 <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>
162 </tr>
163 <tr class="list">
164 <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>
165 </tr>
166 <tr class="list2">
167 <td class="itemcode"><code>function <b><a  href="glBitmap.html#glBitmapCreateTestTexture">glBitmapCreateTestTexture</a></b>(const aFormat: <a  href="glBitmap.html#TglBitmapFormat">TglBitmapFormat</a>): <a  href="glBitmap.TglBitmap2D.html">TglBitmap2D</a>;</code></td>
168 </tr>
169 </table>
170 <a name="PasDoc-Types"></a><h3 class="summary">Types</h3>
171 <table class="summary wide_list">
172 <tr class="list">
173 <td class="itemcode"><code><b><a  href="glBitmap.html#TglBitmapFormat">TglBitmapFormat</a></b> = (...);</code></td>
174 </tr>
175 <tr class="list2">
176 <td class="itemcode"><code><b><a  href="glBitmap.html#TglBitmapFileType">TglBitmapFileType</a></b> = (...);</code></td>
177 </tr>
178 <tr class="list">
179 <td class="itemcode"><code><b><a  href="glBitmap.html#TglBitmapFileTypes">TglBitmapFileTypes</a></b> = set of <a  href="glBitmap.html#TglBitmapFileType">TglBitmapFileType</a>;</code></td>
180 </tr>
181 <tr class="list2">
182 <td class="itemcode"><code><b><a  href="glBitmap.html#TglBitmapMipMap">TglBitmapMipMap</a></b> = (...);</code></td>
183 </tr>
184 <tr class="list">
185 <td class="itemcode"><code><b><a  href="glBitmap.html#TglBitmapNormalMapFunc">TglBitmapNormalMapFunc</a></b> = (...);</code></td>
186 </tr>
187 <tr class="list2">
188 <td class="itemcode"><code><b><a  href="glBitmap.html#PglBitmapPixelData">PglBitmapPixelData</a></b> = &circ;<a  href="glBitmap.TglBitmapPixelData.html">TglBitmapPixelData</a>;</code></td>
189 </tr>
190 <tr class="list">
191 <td class="itemcode"><code><b><a  href="glBitmap.html#TglBitmapSizeFields">TglBitmapSizeFields</a></b> = set of (ffX, ffY);</code></td>
192 </tr>
193 <tr class="list2">
194 <td class="itemcode"><code><b><a  href="glBitmap.html#TglBitmapPixelPosition">TglBitmapPixelPosition</a></b> = <a  href="glBitmap.TglBitmapSize.html">TglBitmapSize</a>;</code></td>
195 </tr>
196 <tr class="list">
197 <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>
198 </tr>
199 </table>
200 <a name="PasDoc-Constants"></a><h3 class="summary">Constants</h3>
201 <table class="summary wide_list">
202 <tr class="list">
203 <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>
204 </tr>
205 </table>
206 <h2 class="description">Description</h2>
207 <h3 class="detail">Functions and Procedures</h3>
208 <table class="detail wide_list">
209 <tr class="list">
210 <td class="itemcode"><a name="glBitmapSetDefaultDeleteTextureOnFree"></a><code>procedure <b>glBitmapSetDefaultDeleteTextureOnFree</b>(const aDeleteTextureOnFree: Boolean);</code></td>
211 </tr>
212 <tr><td colspan="1">
213 &nbsp;</td></tr>
214 </table>
215 <table class="detail wide_list">
216 <tr class="list">
217 <td class="itemcode"><a name="glBitmapSetDefaultFreeDataAfterGenTexture"></a><code>procedure <b>glBitmapSetDefaultFreeDataAfterGenTexture</b>(const aFreeData: Boolean);</code></td>
218 </tr>
219 <tr><td colspan="1">
220 &nbsp;</td></tr>
221 </table>
222 <table class="detail wide_list">
223 <tr class="list">
224 <td class="itemcode"><a name="glBitmapSetDefaultMipmap"></a><code>procedure <b>glBitmapSetDefaultMipmap</b>(const aValue: <a  href="glBitmap.html#TglBitmapMipMap">TglBitmapMipMap</a>);</code></td>
225 </tr>
226 <tr><td colspan="1">
227 &nbsp;</td></tr>
228 </table>
229 <table class="detail wide_list">
230 <tr class="list">
231 <td class="itemcode"><a name="glBitmapSetDefaultFormat"></a><code>procedure <b>glBitmapSetDefaultFormat</b>(const aFormat: <a  href="glBitmap.html#TglBitmapFormat">TglBitmapFormat</a>);</code></td>
232 </tr>
233 <tr><td colspan="1">
234 &nbsp;</td></tr>
235 </table>
236 <table class="detail wide_list">
237 <tr class="list">
238 <td class="itemcode"><a name="glBitmapSetDefaultFilter"></a><code>procedure <b>glBitmapSetDefaultFilter</b>(const aMin, aMag: Integer);</code></td>
239 </tr>
240 <tr><td colspan="1">
241 &nbsp;</td></tr>
242 </table>
243 <table class="detail wide_list">
244 <tr class="list">
245 <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>
246 </tr>
247 <tr><td colspan="1">
248 &nbsp;</td></tr>
249 </table>
250 <table class="detail wide_list">
251 <tr class="list">
252 <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>
253 </tr>
254 <tr><td colspan="1">
255 &nbsp;</td></tr>
256 </table>
257 <table class="detail wide_list">
258 <tr class="list">
259 <td class="itemcode"><a name="glBitmapGetDefaultDeleteTextureOnFree"></a><code>function <b>glBitmapGetDefaultDeleteTextureOnFree</b>: Boolean;</code></td>
260 </tr>
261 <tr><td colspan="1">
262 &nbsp;</td></tr>
263 </table>
264 <table class="detail wide_list">
265 <tr class="list">
266 <td class="itemcode"><a name="glBitmapGetDefaultFreeDataAfterGenTexture"></a><code>function <b>glBitmapGetDefaultFreeDataAfterGenTexture</b>: Boolean;</code></td>
267 </tr>
268 <tr><td colspan="1">
269 &nbsp;</td></tr>
270 </table>
271 <table class="detail wide_list">
272 <tr class="list">
273 <td class="itemcode"><a name="glBitmapGetDefaultMipmap"></a><code>function <b>glBitmapGetDefaultMipmap</b>: <a  href="glBitmap.html#TglBitmapMipMap">TglBitmapMipMap</a>;</code></td>
274 </tr>
275 <tr><td colspan="1">
276 &nbsp;</td></tr>
277 </table>
278 <table class="detail wide_list">
279 <tr class="list">
280 <td class="itemcode"><a name="glBitmapGetDefaultFormat"></a><code>function <b>glBitmapGetDefaultFormat</b>: <a  href="glBitmap.html#TglBitmapFormat">TglBitmapFormat</a>;</code></td>
281 </tr>
282 <tr><td colspan="1">
283 &nbsp;</td></tr>
284 </table>
285 <table class="detail wide_list">
286 <tr class="list">
287 <td class="itemcode"><a name="glBitmapGetDefaultFilter"></a><code>procedure <b>glBitmapGetDefaultFilter</b>(var aMin, aMag: Cardinal);</code></td>
288 </tr>
289 <tr><td colspan="1">
290 &nbsp;</td></tr>
291 </table>
292 <table class="detail wide_list">
293 <tr class="list">
294 <td class="itemcode"><a name="glBitmapGetDefaultTextureWrap"></a><code>procedure <b>glBitmapGetDefaultTextureWrap</b>(var S, T, R: Cardinal);</code></td>
295 </tr>
296 <tr><td colspan="1">
297 &nbsp;</td></tr>
298 </table>
299 <table class="detail wide_list">
300 <tr class="list">
301 <td class="itemcode"><a name="glBitmapGetDefaultSwizzle"></a><code>procedure <b>glBitmapGetDefaultSwizzle</b>(var r, g, b, a: GLenum);</code></td>
302 </tr>
303 <tr><td colspan="1">
304 &nbsp;</td></tr>
305 </table>
306 <table class="detail wide_list">
307 <tr class="list">
308 <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>
309 </tr>
310 <tr><td colspan="1">
311 &nbsp;</td></tr>
312 </table>
313 <table class="detail wide_list">
314 <tr class="list">
315 <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>
316 </tr>
317 <tr><td colspan="1">
318 &nbsp;</td></tr>
319 </table>
320 <table class="detail wide_list">
321 <tr class="list">
322 <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>
323 </tr>
324 <tr><td colspan="1">
325 &nbsp;</td></tr>
326 </table>
327 <table class="detail wide_list">
328 <tr class="list">
329 <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>
330 </tr>
331 <tr><td colspan="1">
332 &nbsp;</td></tr>
333 </table>
334 <table class="detail wide_list">
335 <tr class="list">
336 <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>
337 </tr>
338 <tr><td colspan="1">
339 &nbsp;</td></tr>
340 </table>
341 <table class="detail wide_list">
342 <tr class="list">
343 <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>
344 </tr>
345 <tr><td colspan="1">
346 &nbsp;</td></tr>
347 </table>
348 <table class="detail wide_list">
349 <tr class="list">
350 <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>
351 </tr>
352 <tr><td colspan="1">
353 &nbsp;</td></tr>
354 </table>
355 <table class="detail wide_list">
356 <tr class="list">
357 <td class="itemcode"><a name="glBitmapCreateTestTexture"></a><code>function <b>glBitmapCreateTestTexture</b>(const aFormat: <a  href="glBitmap.html#TglBitmapFormat">TglBitmapFormat</a>): <a  href="glBitmap.TglBitmap2D.html">TglBitmap2D</a>;</code></td>
358 </tr>
359 <tr><td colspan="1">
360 &nbsp;</td></tr>
361 </table>
362 <h3 class="detail">Types</h3>
363 <table class="detail wide_list">
364 <tr class="list">
365 <td class="itemcode"><a name="TglBitmapFormat"></a><code><b>TglBitmapFormat</b> = (...);</code></td>
366 </tr>
367 <tr><td colspan="1">
368 <p>
369 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>
370 <h6 class="description_section">Values</h6>
371 <ul>
372 <li>
373 tfEmpty = 0: &nbsp;</li>
374 <li>
375 tfAlpha4ub1: 1 x unsigned byte</li>
376 <li>
377 tfAlpha8ub1: 1 x unsigned byte</li>
378 <li>
379 tfAlpha16us1: 1 x unsigned short</li>
380 <li>
381 tfLuminance4ub1: 1 x unsigned byte</li>
382 <li>
383 tfLuminance8ub1: 1 x unsigned byte</li>
384 <li>
385 tfLuminance16us1: 1 x unsigned short</li>
386 <li>
387 tfLuminance4Alpha4ub2: 1 x unsigned byte (lum), 1 x unsigned byte (alpha)</li>
388 <li>
389 tfLuminance6Alpha2ub2: 1 x unsigned byte (lum), 1 x unsigned byte (alpha)</li>
390 <li>
391 tfLuminance8Alpha8ub2: 1 x unsigned byte (lum), 1 x unsigned byte (alpha)</li>
392 <li>
393 tfLuminance12Alpha4us2: 1 x unsigned short (lum), 1 x unsigned short (alpha)</li>
394 <li>
395 tfLuminance16Alpha16us2: 1 x unsigned short (lum), 1 x unsigned short (alpha)</li>
396 <li>
397 tfR3G3B2ub1: 1 x unsigned byte (3bit red, 3bit green, 2bit blue)</li>
398 <li>
399 tfRGBX4us1: 1 x unsigned short (4bit red, 4bit green, 4bit blue, 4bit reserverd)</li>
400 <li>
401 tfXRGB4us1: 1 x unsigned short (4bit reserved, 4bit red, 4bit green, 4bit blue)</li>
402 <li>
403 tfR5G6B5us1: 1 x unsigned short (5bit red, 6bit green, 5bit blue)</li>
404 <li>
405 tfRGB5X1us1: 1 x unsigned short (5bit red, 5bit green, 5bit blue, 1bit reserved)</li>
406 <li>
407 tfX1RGB5us1: 1 x unsigned short (1bit reserved, 5bit red, 5bit green, 5bit blue)</li>
408 <li>
409 tfRGB8ub3: 1 x unsigned byte (red), 1 x unsigned byte (green), 1 x unsigned byte (blue)</li>
410 <li>
411 tfRGBX8ui1: 1 x unsigned int (8bit red, 8bit green, 8bit blue, 8bit reserved)</li>
412 <li>
413 tfXRGB8ui1: 1 x unsigned int (8bit reserved, 8bit red, 8bit green, 8bit blue)</li>
414 <li>
415 tfRGB10X2ui1: 1 x unsigned int (10bit red, 10bit green, 10bit blue, 2bit reserved)</li>
416 <li>
417 tfX2RGB10ui1: 1 x unsigned int (2bit reserved, 10bit red, 10bit green, 10bit blue)</li>
418 <li>
419 tfRGB16us3: 1 x unsigned short (red), 1 x unsigned short (green), 1 x unsigned short (blue)</li>
420 <li>
421 tfRGBA4us1: 1 x unsigned short (4bit red, 4bit green, 4bit blue, 4bit alpha)</li>
422 <li>
423 tfARGB4us1: 1 x unsigned short (4bit alpha, 4bit red, 4bit green, 4bit blue)</li>
424 <li>
425 tfRGB5A1us1: 1 x unsigned short (5bit red, 5bit green, 5bit blue, 1bit alpha)</li>
426 <li>
427 tfA1RGB5us1: 1 x unsigned short (1bit alpha, 5bit red, 5bit green, 5bit blue)</li>
428 <li>
429 tfRGBA8ui1: 1 x unsigned int (8bit red, 8bit green, 8bit blue, 8 bit alpha)</li>
430 <li>
431 tfARGB8ui1: 1 x unsigned int (8 bit alpha, 8bit red, 8bit green, 8bit blue)</li>
432 <li>
433 tfRGBA8ub4: 1 x unsigned byte (red), 1 x unsigned byte (green), 1 x unsigned byte (blue), 1 x unsigned byte (alpha)</li>
434 <li>
435 tfRGB10A2ui1: 1 x unsigned int (10bit red, 10bit green, 10bit blue, 2bit alpha)</li>
436 <li>
437 tfA2RGB10ui1: 1 x unsigned int (2bit alpha, 10bit red, 10bit green, 10bit blue)</li>
438 <li>
439 tfRGBA16us4: 1 x unsigned short (red), 1 x unsigned short (green), 1 x unsigned short (blue), 1 x unsigned short (alpha)</li>
440 <li>
441 tfBGRX4us1: 1 x unsigned short (4bit blue, 4bit green, 4bit red, 4bit reserved)</li>
442 <li>
443 tfXBGR4us1: 1 x unsigned short (4bit reserved, 4bit blue, 4bit green, 4bit red)</li>
444 <li>
445 tfB5G6R5us1: 1 x unsigned short (5bit blue, 6bit green, 5bit red)</li>
446 <li>
447 tfBGR5X1us1: 1 x unsigned short (5bit blue, 5bit green, 5bit red, 1bit reserved)</li>
448 <li>
449 tfX1BGR5us1: 1 x unsigned short (1bit reserved, 5bit blue, 5bit green, 5bit red)</li>
450 <li>
451 tfBGR8ub3: 1 x unsigned byte (blue), 1 x unsigned byte (green), 1 x unsigned byte (red)</li>
452 <li>
453 tfBGRX8ui1: 1 x unsigned int (8bit blue, 8bit green, 8bit red, 8bit reserved)</li>
454 <li>
455 tfXBGR8ui1: 1 x unsigned int (8bit reserved, 8bit blue, 8bit green, 8bit red)</li>
456 <li>
457 tfBGR10X2ui1: 1 x unsigned int (10bit blue, 10bit green, 10bit red, 2bit reserved)</li>
458 <li>
459 tfX2BGR10ui1: 1 x unsigned int (2bit reserved, 10bit blue, 10bit green, 10bit red)</li>
460 <li>
461 tfBGR16us3: 1 x unsigned short (blue), 1 x unsigned short (green), 1 x unsigned short (red)</li>
462 <li>
463 tfBGRA4us1: 1 x unsigned short (4bit blue, 4bit green, 4bit red, 4bit alpha)</li>
464 <li>
465 tfABGR4us1: 1 x unsigned short (4bit alpha, 4bit blue, 4bit green, 4bit red)</li>
466 <li>
467 tfBGR5A1us1: 1 x unsigned short (5bit blue, 5bit green, 5bit red, 1bit alpha)</li>
468 <li>
469 tfA1BGR5us1: 1 x unsigned short (1bit alpha, 5bit blue, 5bit green, 5bit red)</li>
470 <li>
471 tfBGRA8ui1: 1 x unsigned int (8bit blue, 8bit green, 8bit red, 8bit alpha)</li>
472 <li>
473 tfABGR8ui1: 1 x unsigned int (8bit alpha, 8bit blue, 8bit green, 8bit red)</li>
474 <li>
475 tfBGRA8ub4: 1 x unsigned byte (blue), 1 x unsigned byte (green), 1 x unsigned byte (red), 1 x unsigned byte (alpha)</li>
476 <li>
477 tfBGR10A2ui1: 1 x unsigned int (10bit blue, 10bit green, 10bit red, 2bit alpha)</li>
478 <li>
479 tfA2BGR10ui1: 1 x unsigned int (2bit alpha, 10bit blue, 10bit green, 10bit red)</li>
480 <li>
481 tfBGRA16us4: 1 x unsigned short (blue), 1 x unsigned short (green), 1 x unsigned short (red), 1 x unsigned short (alpha)</li>
482 <li>
483 tfDepth16us1: 1 x unsigned short (depth)</li>
484 <li>
485 tfDepth24ui1: 1 x unsigned int (depth)</li>
486 <li>
487 tfDepth32ui1: 1 x unsigned int (depth)</li>
488 <li>
489 tfS3tcDtx1RGBA: &nbsp;</li>
490 <li>
491 tfS3tcDtx3RGBA: &nbsp;</li>
492 <li>
493 tfS3tcDtx5RGBA: &nbsp;</li>
494 </ul>
495 </td></tr>
496 </table>
497 <table class="detail wide_list">
498 <tr class="list">
499 <td class="itemcode"><a name="TglBitmapFileType"></a><code><b>TglBitmapFileType</b> = (...);</code></td>
500 </tr>
501 <tr><td colspan="1">
502 <p>
503 Portable Network Graphic file (PNG)</p>
504 <h6 class="description_section">Values</h6>
505 <ul>
506 <li>
507 ftDDS: Direct Draw Surface file (DDS)</li>
508 <li>
509 ftTGA: Targa Image File (TGA)</li>
510 <li>
511 ftBMP: Windows Bitmap File (BMP)</li>
512 <li>
513 ftRAW: glBitmap RAW file format</li>
514 </ul>
515 </td></tr>
516 </table>
517 <table class="detail wide_list">
518 <tr class="list">
519 <td class="itemcode"><a name="TglBitmapFileTypes"></a><code><b>TglBitmapFileTypes</b> = set of <a  href="glBitmap.html#TglBitmapFileType">TglBitmapFileType</a>;</code></td>
520 </tr>
521 <tr><td colspan="1">
522 &nbsp;</td></tr>
523 </table>
524 <table class="detail wide_list">
525 <tr class="list">
526 <td class="itemcode"><a name="TglBitmapMipMap"></a><code><b>TglBitmapMipMap</b> = (...);</code></td>
527 </tr>
528 <tr><td colspan="1">
529 <p>
530 possible mipmap types</p>
531 <h6 class="description_section">Values</h6>
532 <ul>
533 <li>
534 mmNone: no mipmaps</li>
535 <li>
536 mmMipmap: normal mipmaps</li>
537 <li>
538 mmMipmapGlu: mipmaps generated with glu functions</li>
539 </ul>
540 </td></tr>
541 </table>
542 <table class="detail wide_list">
543 <tr class="list">
544 <td class="itemcode"><a name="TglBitmapNormalMapFunc"></a><code><b>TglBitmapNormalMapFunc</b> = (...);</code></td>
545 </tr>
546 <tr><td colspan="1">
547 <p>
548 possible normal map functions</p>
549 <h6 class="description_section">Values</h6>
550 <ul>
551 <li>
552 nm4Samples: &nbsp;</li>
553 <li>
554 nmSobel: &nbsp;</li>
555 <li>
556 nm3x3: &nbsp;</li>
557 <li>
558 nm5x5: &nbsp;</li>
559 </ul>
560 </td></tr>
561 </table>
562 <table class="detail wide_list">
563 <tr class="list">
564 <td class="itemcode"><a name="PglBitmapPixelData"></a><code><b>PglBitmapPixelData</b> = &circ;<a  href="glBitmap.TglBitmapPixelData.html">TglBitmapPixelData</a>;</code></td>
565 </tr>
566 <tr><td colspan="1">
567 &nbsp;</td></tr>
568 </table>
569 <table class="detail wide_list">
570 <tr class="list">
571 <td class="itemcode"><a name="TglBitmapSizeFields"></a><code><b>TglBitmapSizeFields</b> = set of (ffX, ffY);</code></td>
572 </tr>
573 <tr><td colspan="1">
574 &nbsp;</td></tr>
575 </table>
576 <table class="detail wide_list">
577 <tr class="list">
578 <td class="itemcode"><a name="TglBitmapPixelPosition"></a><code><b>TglBitmapPixelPosition</b> = <a  href="glBitmap.TglBitmapSize.html">TglBitmapSize</a>;</code></td>
579 </tr>
580 <tr><td colspan="1">
581 &nbsp;</td></tr>
582 </table>
583 <table class="detail wide_list">
584 <tr class="list">
585 <td class="itemcode"><a name="TglBitmapFunction"></a><code><b>TglBitmapFunction</b> = procedure(var FuncRec: <a  href="glBitmap.TglBitmapFunctionRec.html">TglBitmapFunctionRec</a>);</code></td>
586 </tr>
587 <tr><td colspan="1">
588 <p>
589 callback to use for converting texture data</p>
590 </td></tr>
591 </table>
592 <h3 class="detail">Constants</h3>
593 <table class="detail wide_list">
594 <tr class="list">
595 <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>
596 </tr>
597 <tr><td colspan="1">
598 &nbsp;</td></tr>
599 </table>
600 <hr noshade size="1"><span class="appinfo"><em>Generated by <a  href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2014-12-21 15:05:48</em>
601 </span>
602 </td></tr></table></body></html>