* some small OpenGLES fixes
[glBitmap.git] / doc / glBitmap.TglBitmap.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: Class TglBitmap</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 <a name="TglBitmap"></a><h1 class="cio">Class TglBitmap</h1>
13 <table class="sections wide_list">
14 <tr>
15 <td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></td><td><a class="section" href="#PasDoc-Fields">Fields</a></td><td><a class="section" href="#PasDoc-Methods">Methods</a></td><td><a class="section" href="#PasDoc-Properties">Properties</a></td></tr></table>
16 <a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
17 <p class="unitlink">
18 <a  href="glBitmap.html">glBitmap</a></p>
19 <h2 class="declaration">Declaration</h2>
20 <p class="declaration">
21 <code>type TglBitmap = class(TObject)</code></p>
22 <h2 class="description">Description</h2>
23 <p>
24 base class for all glBitmap classes. used to manage OpenGL texture objects all operations on a bitmap object must be done from the render thread</p>
25 <a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
26 <ul class="hierarchy"><li class="ancestor">TObject</li>
27 <li class="thisitem">TglBitmap</li></ul><h2 class="overview">Overview</h2>
28 <a name="PasDoc-Fields"></a><h3 class="summary">Fields</h3>
29 <table class="summary wide_list">
30 <tr class="list">
31 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
32 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fID">fID</a></b>: GLuint;</code></td>
33 </tr>
34 <tr class="list2">
35 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
36 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fTarget">fTarget</a></b>: GLuint;</code></td>
37 </tr>
38 <tr class="list">
39 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
40 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fDeleteTextureOnFree">fDeleteTextureOnFree</a></b>: Boolean;</code></td>
41 </tr>
42 <tr class="list2">
43 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
44 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fFilterMin">fFilterMin</a></b>: GLenum;</code></td>
45 </tr>
46 <tr class="list">
47 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
48 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fFilterMag">fFilterMag</a></b>: GLenum;</code></td>
49 </tr>
50 <tr class="list2">
51 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
52 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fWrapS">fWrapS</a></b>: GLenum;</code></td>
53 </tr>
54 <tr class="list">
55 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
56 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fWrapT">fWrapT</a></b>: GLenum;</code></td>
57 </tr>
58 <tr class="list2">
59 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
60 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fWrapR">fWrapR</a></b>: GLenum;</code></td>
61 </tr>
62 <tr class="list">
63 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
64 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fAnisotropic">fAnisotropic</a></b>: Integer;</code></td>
65 </tr>
66 <tr class="list2">
67 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
68 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fBorderColor">fBorderColor</a></b>: array[0..3] of Single;</code></td>
69 </tr>
70 <tr class="list">
71 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
72 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fSwizzle">fSwizzle</a></b>: array[0..3] of GLenum;</code></td>
73 </tr>
74 <tr class="list2">
75 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
76 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fDimension">fDimension</a></b>: <a  href="glBitmap.TglBitmapSize.html">TglBitmapSize</a>;</code></td>
77 </tr>
78 <tr class="list">
79 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
80 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fMipMap">fMipMap</a></b>: <a  href="glBitmap.html#TglBitmapMipMap">TglBitmapMipMap</a>;</code></td>
81 </tr>
82 <tr class="list2">
83 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
84 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fCustomData">fCustomData</a></b>: Pointer;</code></td>
85 </tr>
86 <tr class="list">
87 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
88 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fCustomName">fCustomName</a></b>: String;</code></td>
89 </tr>
90 <tr class="list2">
91 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
92 <td class="itemcode"><code><b><a  href="glBitmap.TglBitmap.html#fCustomNameW">fCustomNameW</a></b>: WideString;</code></td>
93 </tr>
94 </table>
95 <a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
96 <table class="summary wide_list">
97 <tr class="list">
98 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
99 <td class="itemcode"><code>function <b><a  href="glBitmap.TglBitmap.html#GetWidth">GetWidth</a></b>: Integer; virtual;</code></td>
100 </tr>
101 <tr class="list2">
102 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
103 <td class="itemcode"><code>function <b><a  href="glBitmap.TglBitmap.html#GetHeight">GetHeight</a></b>: Integer; virtual;</code></td>
104 </tr>
105 <tr class="list">
106 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
107 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#SetCustomData">SetCustomData</a></b>(const aValue: Pointer);</code></td>
108 </tr>
109 <tr class="list2">
110 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
111 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#SetCustomName">SetCustomName</a></b>(const aValue: String);</code></td>
112 </tr>
113 <tr class="list">
114 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
115 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#SetCustomNameW">SetCustomNameW</a></b>(const aValue: WideString);</code></td>
116 </tr>
117 <tr class="list2">
118 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
119 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#SetDeleteTextureOnFree">SetDeleteTextureOnFree</a></b>(const aValue: Boolean);</code></td>
120 </tr>
121 <tr class="list">
122 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
123 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#SetID">SetID</a></b>(const aValue: Cardinal);</code></td>
124 </tr>
125 <tr class="list2">
126 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
127 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#SetMipMap">SetMipMap</a></b>(const aValue: <a  href="glBitmap.html#TglBitmapMipMap">TglBitmapMipMap</a>);</code></td>
128 </tr>
129 <tr class="list">
130 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
131 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#SetTarget">SetTarget</a></b>(const aValue: Cardinal);</code></td>
132 </tr>
133 <tr class="list2">
134 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
135 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#SetAnisotropic">SetAnisotropic</a></b>(const aValue: Integer);</code></td>
136 </tr>
137 <tr class="list">
138 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
139 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#CreateID">CreateID</a></b>;</code></td>
140 </tr>
141 <tr class="list2">
142 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
143 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#SetupParameters">SetupParameters</a></b>();</code></td>
144 </tr>
145 <tr class="list">
146 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
147 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#AfterConstruction">AfterConstruction</a></b>; override;</code></td>
148 </tr>
149 <tr class="list2">
150 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
151 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#BeforeDestruction">BeforeDestruction</a></b>; override;</code></td>
152 </tr>
153 <tr class="list">
154 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
155 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#SetFilter">SetFilter</a></b>(const aMin, aMag: GLenum);</code></td>
156 </tr>
157 <tr class="list2">
158 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
159 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#SetWrap">SetWrap</a></b>( const S: GLenum = GL_CLAMP_TO_EDGE; const T: GLenum = GL_CLAMP_TO_EDGE; const R: GLenum = GL_CLAMP_TO_EDGE);</code></td>
160 </tr>
161 <tr class="list">
162 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
163 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#SetSwizzle">SetSwizzle</a></b>(const r, g, b, a: GLenum);</code></td>
164 </tr>
165 <tr class="list2">
166 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
167 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#Bind">Bind</a></b>(const aEnableTextureUnit: Boolean = true); virtual;</code></td>
168 </tr>
169 <tr class="list">
170 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
171 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#Unbind">Unbind</a></b>(const aDisableTextureUnit: Boolean = true); virtual;</code></td>
172 </tr>
173 <tr class="list2">
174 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
175 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap.html#UploadData">UploadData</a></b>(const aDataObj: <a  href="glBitmap.TglBitmapData.html">TglBitmapData</a>; const aCheckSize: Boolean = true); virtual;</code></td>
176 </tr>
177 <tr class="list">
178 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
179 <td class="itemcode"><code>constructor <b><a  href="glBitmap.TglBitmap.html#Create">Create</a></b>; overload;</code></td>
180 </tr>
181 <tr class="list2">
182 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
183 <td class="itemcode"><code>constructor <b><a  href="glBitmap.TglBitmap.html#Create">Create</a></b>(const aData: <a  href="glBitmap.TglBitmapData.html">TglBitmapData</a>); overload;</code></td>
184 </tr>
185 </table>
186 <a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
187 <table class="summary wide_list">
188 <tr class="list">
189 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
190 <td class="itemcode"><code>property <b><a  href="glBitmap.TglBitmap.html#Width">Width</a></b>: Integer read <a  href="glBitmap.TglBitmap.html#GetWidth">GetWidth</a>;</code></td>
191 </tr>
192 <tr class="list2">
193 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
194 <td class="itemcode"><code>property <b><a  href="glBitmap.TglBitmap.html#Height">Height</a></b>: Integer read <a  href="glBitmap.TglBitmap.html#GetHeight">GetHeight</a>;</code></td>
195 </tr>
196 <tr class="list">
197 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
198 <td class="itemcode"><code>property <b><a  href="glBitmap.TglBitmap.html#ID">ID</a></b>: Cardinal  read <a  href="glBitmap.TglBitmap.html#fID">fID</a>                  write <a  href="glBitmap.TglBitmap.html#SetID">SetID</a>;</code></td>
199 </tr>
200 <tr class="list2">
201 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
202 <td class="itemcode"><code>property <b><a  href="glBitmap.TglBitmap.html#Target">Target</a></b>: Cardinal  read <a  href="glBitmap.TglBitmap.html#fTarget">fTarget</a>              write <a  href="glBitmap.TglBitmap.html#SetTarget">SetTarget</a>;</code></td>
203 </tr>
204 <tr class="list">
205 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
206 <td class="itemcode"><code>property <b><a  href="glBitmap.TglBitmap.html#DeleteTextureOnFree">DeleteTextureOnFree</a></b>: Boolean   read <a  href="glBitmap.TglBitmap.html#fDeleteTextureOnFree">fDeleteTextureOnFree</a> write <a  href="glBitmap.TglBitmap.html#SetDeleteTextureOnFree">SetDeleteTextureOnFree</a>;</code></td>
207 </tr>
208 <tr class="list2">
209 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
210 <td class="itemcode"><code>property <b><a  href="glBitmap.TglBitmap.html#MipMap">MipMap</a></b>: <a  href="glBitmap.html#TglBitmapMipMap">TglBitmapMipMap</a> read <a  href="glBitmap.TglBitmap.html#fMipMap">fMipMap</a>      write <a  href="glBitmap.TglBitmap.html#SetMipMap">SetMipMap</a>;</code></td>
211 </tr>
212 <tr class="list">
213 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
214 <td class="itemcode"><code>property <b><a  href="glBitmap.TglBitmap.html#Anisotropic">Anisotropic</a></b>: Integer         read <a  href="glBitmap.TglBitmap.html#fAnisotropic">fAnisotropic</a> write <a  href="glBitmap.TglBitmap.html#SetAnisotropic">SetAnisotropic</a>;</code></td>
215 </tr>
216 <tr class="list2">
217 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
218 <td class="itemcode"><code>property <b><a  href="glBitmap.TglBitmap.html#CustomData">CustomData</a></b>: Pointer    read <a  href="glBitmap.TglBitmap.html#fCustomData">fCustomData</a>  write <a  href="glBitmap.TglBitmap.html#SetCustomData">SetCustomData</a>;</code></td>
219 </tr>
220 <tr class="list">
221 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
222 <td class="itemcode"><code>property <b><a  href="glBitmap.TglBitmap.html#CustomName">CustomName</a></b>: String     read <a  href="glBitmap.TglBitmap.html#fCustomName">fCustomName</a>  write <a  href="glBitmap.TglBitmap.html#SetCustomName">SetCustomName</a>;</code></td>
223 </tr>
224 <tr class="list2">
225 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
226 <td class="itemcode"><code>property <b><a  href="glBitmap.TglBitmap.html#CustomNameW">CustomNameW</a></b>: WideString read <a  href="glBitmap.TglBitmap.html#fCustomNameW">fCustomNameW</a> write <a  href="glBitmap.TglBitmap.html#SetCustomNameW">SetCustomNameW</a>;</code></td>
227 </tr>
228 <tr class="list">
229 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
230 <td class="itemcode"><code>property <b><a  href="glBitmap.TglBitmap.html#Dimension">Dimension</a></b>: <a  href="glBitmap.TglBitmapSize.html">TglBitmapSize</a> read <a  href="glBitmap.TglBitmap.html#fDimension">fDimension</a>;</code></td>
231 </tr>
232 </table>
233 <h2 class="description">Description</h2>
234 <h3 class="detail">Fields</h3>
235 <table class="detail wide_list">
236 <tr class="list">
237 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
238 <td class="itemcode"><a name="fID"></a><code><b>fID</b>: GLuint;</code></td>
239 </tr>
240 <tr><td colspan="2">
241 <p>
242 name of the OpenGL texture object</p>
243 </td></tr>
244 </table>
245 <table class="detail wide_list">
246 <tr class="list">
247 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
248 <td class="itemcode"><a name="fTarget"></a><code><b>fTarget</b>: GLuint;</code></td>
249 </tr>
250 <tr><td colspan="2">
251 <p>
252 texture target (e.g. GL_TEXTURE_2D)</p>
253 </td></tr>
254 </table>
255 <table class="detail wide_list">
256 <tr class="list">
257 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
258 <td class="itemcode"><a name="fDeleteTextureOnFree"></a><code><b>fDeleteTextureOnFree</b>: Boolean;</code></td>
259 </tr>
260 <tr><td colspan="2">
261 <p>
262 delete OpenGL texture object when this object is destroyed</p>
263 </td></tr>
264 </table>
265 <table class="detail wide_list">
266 <tr class="list">
267 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
268 <td class="itemcode"><a name="fFilterMin"></a><code><b>fFilterMin</b>: GLenum;</code></td>
269 </tr>
270 <tr><td colspan="2">
271 <p>
272 min filter to apply to the texture</p>
273 </td></tr>
274 </table>
275 <table class="detail wide_list">
276 <tr class="list">
277 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
278 <td class="itemcode"><a name="fFilterMag"></a><code><b>fFilterMag</b>: GLenum;</code></td>
279 </tr>
280 <tr><td colspan="2">
281 <p>
282 mag filter to apply to the texture</p>
283 </td></tr>
284 </table>
285 <table class="detail wide_list">
286 <tr class="list">
287 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
288 <td class="itemcode"><a name="fWrapS"></a><code><b>fWrapS</b>: GLenum;</code></td>
289 </tr>
290 <tr><td colspan="2">
291 <p>
292 texture wrapping for x axis</p>
293 </td></tr>
294 </table>
295 <table class="detail wide_list">
296 <tr class="list">
297 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
298 <td class="itemcode"><a name="fWrapT"></a><code><b>fWrapT</b>: GLenum;</code></td>
299 </tr>
300 <tr><td colspan="2">
301 <p>
302 texture wrapping for y axis</p>
303 </td></tr>
304 </table>
305 <table class="detail wide_list">
306 <tr class="list">
307 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
308 <td class="itemcode"><a name="fWrapR"></a><code><b>fWrapR</b>: GLenum;</code></td>
309 </tr>
310 <tr><td colspan="2">
311 <p>
312 texture wrapping for z axis</p>
313 </td></tr>
314 </table>
315 <table class="detail wide_list">
316 <tr class="list">
317 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
318 <td class="itemcode"><a name="fAnisotropic"></a><code><b>fAnisotropic</b>: Integer;</code></td>
319 </tr>
320 <tr><td colspan="2">
321 <p>
322 anisotropic level</p>
323 </td></tr>
324 </table>
325 <table class="detail wide_list">
326 <tr class="list">
327 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
328 <td class="itemcode"><a name="fBorderColor"></a><code><b>fBorderColor</b>: array[0..3] of Single;</code></td>
329 </tr>
330 <tr><td colspan="2">
331 <p>
332 color of the texture border</p>
333 </td></tr>
334 </table>
335 <table class="detail wide_list">
336 <tr class="list">
337 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
338 <td class="itemcode"><a name="fSwizzle"></a><code><b>fSwizzle</b>: array[0..3] of GLenum;</code></td>
339 </tr>
340 <tr><td colspan="2">
341 <p>
342 color channel swizzle</p>
343 </td></tr>
344 </table>
345 <table class="detail wide_list">
346 <tr class="list">
347 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
348 <td class="itemcode"><a name="fDimension"></a><code><b>fDimension</b>: <a  href="glBitmap.TglBitmapSize.html">TglBitmapSize</a>;</code></td>
349 </tr>
350 <tr><td colspan="2">
351 <p>
352 size of this texture</p>
353 </td></tr>
354 </table>
355 <table class="detail wide_list">
356 <tr class="list">
357 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
358 <td class="itemcode"><a name="fMipMap"></a><code><b>fMipMap</b>: <a  href="glBitmap.html#TglBitmapMipMap">TglBitmapMipMap</a>;</code></td>
359 </tr>
360 <tr><td colspan="2">
361 <p>
362 mipmap type</p>
363 </td></tr>
364 </table>
365 <table class="detail wide_list">
366 <tr class="list">
367 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
368 <td class="itemcode"><a name="fCustomData"></a><code><b>fCustomData</b>: Pointer;</code></td>
369 </tr>
370 <tr><td colspan="2">
371 <p>
372 user defined data</p>
373 </td></tr>
374 </table>
375 <table class="detail wide_list">
376 <tr class="list">
377 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
378 <td class="itemcode"><a name="fCustomName"></a><code><b>fCustomName</b>: String;</code></td>
379 </tr>
380 <tr><td colspan="2">
381 <p>
382 user defined name</p>
383 </td></tr>
384 </table>
385 <table class="detail wide_list">
386 <tr class="list">
387 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
388 <td class="itemcode"><a name="fCustomNameW"></a><code><b>fCustomNameW</b>: WideString;</code></td>
389 </tr>
390 <tr><td colspan="2">
391 <p>
392 user defined name</p>
393 </td></tr>
394 </table>
395 <h3 class="detail">Methods</h3>
396 <table class="detail wide_list">
397 <tr class="list">
398 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
399 <td class="itemcode"><a name="GetWidth"></a><code>function <b>GetWidth</b>: Integer; virtual;</code></td>
400 </tr>
401 <tr><td colspan="2">
402 &nbsp;<h6 class="description_section">Returns</h6>
403 <p class="return">the actual width of the texture</p></td></tr>
404 </table>
405 <table class="detail wide_list">
406 <tr class="list">
407 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
408 <td class="itemcode"><a name="GetHeight"></a><code>function <b>GetHeight</b>: Integer; virtual;</code></td>
409 </tr>
410 <tr><td colspan="2">
411 &nbsp;<h6 class="description_section">Returns</h6>
412 <p class="return">the actual height of the texture</p></td></tr>
413 </table>
414 <table class="detail wide_list">
415 <tr class="list">
416 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
417 <td class="itemcode"><a name="SetCustomData"></a><code>procedure <b>SetCustomData</b>(const aValue: Pointer);</code></td>
418 </tr>
419 <tr><td colspan="2">
420 <p>
421 set a new value for fCustomData</p>
422 </td></tr>
423 </table>
424 <table class="detail wide_list">
425 <tr class="list">
426 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
427 <td class="itemcode"><a name="SetCustomName"></a><code>procedure <b>SetCustomName</b>(const aValue: String);</code></td>
428 </tr>
429 <tr><td colspan="2">
430 <p>
431 set a new value for fCustomName</p>
432 </td></tr>
433 </table>
434 <table class="detail wide_list">
435 <tr class="list">
436 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
437 <td class="itemcode"><a name="SetCustomNameW"></a><code>procedure <b>SetCustomNameW</b>(const aValue: WideString);</code></td>
438 </tr>
439 <tr><td colspan="2">
440 <p>
441 set a new value for fCustomNameW</p>
442 </td></tr>
443 </table>
444 <table class="detail wide_list">
445 <tr class="list">
446 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
447 <td class="itemcode"><a name="SetDeleteTextureOnFree"></a><code>procedure <b>SetDeleteTextureOnFree</b>(const aValue: Boolean);</code></td>
448 </tr>
449 <tr><td colspan="2">
450 <p>
451 set new value for fDeleteTextureOnFree</p>
452 </td></tr>
453 </table>
454 <table class="detail wide_list">
455 <tr class="list">
456 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
457 <td class="itemcode"><a name="SetID"></a><code>procedure <b>SetID</b>(const aValue: Cardinal);</code></td>
458 </tr>
459 <tr><td colspan="2">
460 <p>
461 set name of OpenGL texture object</p>
462 </td></tr>
463 </table>
464 <table class="detail wide_list">
465 <tr class="list">
466 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
467 <td class="itemcode"><a name="SetMipMap"></a><code>procedure <b>SetMipMap</b>(const aValue: <a  href="glBitmap.html#TglBitmapMipMap">TglBitmapMipMap</a>);</code></td>
468 </tr>
469 <tr><td colspan="2">
470 <p>
471 set new value for fMipMap</p>
472 </td></tr>
473 </table>
474 <table class="detail wide_list">
475 <tr class="list">
476 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
477 <td class="itemcode"><a name="SetTarget"></a><code>procedure <b>SetTarget</b>(const aValue: Cardinal);</code></td>
478 </tr>
479 <tr><td colspan="2">
480 <p>
481 set new value for target</p>
482 </td></tr>
483 </table>
484 <table class="detail wide_list">
485 <tr class="list">
486 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
487 <td class="itemcode"><a name="SetAnisotropic"></a><code>procedure <b>SetAnisotropic</b>(const aValue: Integer);</code></td>
488 </tr>
489 <tr><td colspan="2">
490 <p>
491 set new value for fAnisotrophic</p>
492 </td></tr>
493 </table>
494 <table class="detail wide_list">
495 <tr class="list">
496 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
497 <td class="itemcode"><a name="CreateID"></a><code>procedure <b>CreateID</b>;</code></td>
498 </tr>
499 <tr><td colspan="2">
500 <p>
501 create OpenGL texture object (delete exisiting object if exists)</p>
502 </td></tr>
503 </table>
504 <table class="detail wide_list">
505 <tr class="list">
506 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
507 <td class="itemcode"><a name="SetupParameters"></a><code>procedure <b>SetupParameters</b>();</code></td>
508 </tr>
509 <tr><td colspan="2">
510 <p>
511 setup texture parameters</p>
512 </td></tr>
513 </table>
514 <table class="detail wide_list">
515 <tr class="list">
516 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
517 <td class="itemcode"><a name="AfterConstruction"></a><code>procedure <b>AfterConstruction</b>; override;</code></td>
518 </tr>
519 <tr><td colspan="2">
520 <p>
521 this method is called after the constructor and sets the default values of this object</p>
522 </td></tr>
523 </table>
524 <table class="detail wide_list">
525 <tr class="list">
526 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
527 <td class="itemcode"><a name="BeforeDestruction"></a><code>procedure <b>BeforeDestruction</b>; override;</code></td>
528 </tr>
529 <tr><td colspan="2">
530 <p>
531 this method is called before the destructor and does some cleanup</p>
532 </td></tr>
533 </table>
534 <table class="detail wide_list">
535 <tr class="list">
536 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
537 <td class="itemcode"><a name="SetFilter"></a><code>procedure <b>SetFilter</b>(const aMin, aMag: GLenum);</code></td>
538 </tr>
539 <tr><td colspan="2">
540 <p>
541 set new texture filer  </p>
542 <h6 class="description_section">Parameters</h6>
543 <dl class="parameters">
544 <dt>aMin</dt>
545 <dd>min filter</dd>
546 <dt>aMag</dt>
547 <dd>mag filter</dd>
548 </dl>
549 </td></tr>
550 </table>
551 <table class="detail wide_list">
552 <tr class="list">
553 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
554 <td class="itemcode"><a name="SetWrap"></a><code>procedure <b>SetWrap</b>( const S: GLenum = GL_CLAMP_TO_EDGE; const T: GLenum = GL_CLAMP_TO_EDGE; const R: GLenum = GL_CLAMP_TO_EDGE);</code></td>
555 </tr>
556 <tr><td colspan="2">
557 <p>
558 set new texture wrapping   </p>
559 <h6 class="description_section">Parameters</h6>
560 <dl class="parameters">
561 <dt>S</dt>
562 <dd>texture wrapping for x axis</dd>
563 <dt>T</dt>
564 <dd>texture wrapping for y axis</dd>
565 <dt>R</dt>
566 <dd>texture wrapping for z axis</dd>
567 </dl>
568 </td></tr>
569 </table>
570 <table class="detail wide_list">
571 <tr class="list">
572 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
573 <td class="itemcode"><a name="SetSwizzle"></a><code>procedure <b>SetSwizzle</b>(const r, g, b, a: GLenum);</code></td>
574 </tr>
575 <tr><td colspan="2">
576 <p>
577 set new swizzle    </p>
578 <h6 class="description_section">Parameters</h6>
579 <dl class="parameters">
580 <dt>r</dt>
581 <dd>swizzle for red channel</dd>
582 <dt>g</dt>
583 <dd>swizzle for green channel</dd>
584 <dt>b</dt>
585 <dd>swizzle for blue channel</dd>
586 <dt>a</dt>
587 <dd>swizzle for alpha channel</dd>
588 </dl>
589 </td></tr>
590 </table>
591 <table class="detail wide_list">
592 <tr class="list">
593 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
594 <td class="itemcode"><a name="Bind"></a><code>procedure <b>Bind</b>(const aEnableTextureUnit: Boolean = true); virtual;</code></td>
595 </tr>
596 <tr><td colspan="2">
597 <p>
598 bind texture </p>
599 <h6 class="description_section">Parameters</h6>
600 <dl class="parameters">
601 <dt>aEnableTextureUnit</dt>
602 <dd>enable texture unit for this texture (e.g. glEnable(GL_TEXTURE_2D))</dd>
603 </dl>
604 </td></tr>
605 </table>
606 <table class="detail wide_list">
607 <tr class="list">
608 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
609 <td class="itemcode"><a name="Unbind"></a><code>procedure <b>Unbind</b>(const aDisableTextureUnit: Boolean = true); virtual;</code></td>
610 </tr>
611 <tr><td colspan="2">
612 <p>
613 bind texture </p>
614 <h6 class="description_section">Parameters</h6>
615 <dl class="parameters">
616 <dt>aDisableTextureUnit</dt>
617 <dd>disable texture unit for this texture (e.g. glEnable(GL_TEXTURE_2D))</dd>
618 </dl>
619 </td></tr>
620 </table>
621 <table class="detail wide_list">
622 <tr class="list">
623 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
624 <td class="itemcode"><a name="UploadData"></a><code>procedure <b>UploadData</b>(const aDataObj: <a  href="glBitmap.TglBitmapData.html">TglBitmapData</a>; const aCheckSize: Boolean = true); virtual;</code></td>
625 </tr>
626 <tr><td colspan="2">
627 <p>
628 upload texture data from given data object to video card  </p>
629 <h6 class="description_section">Parameters</h6>
630 <dl class="parameters">
631 <dt>aData</dt>
632 <dd>texture data object that contains the actual data</dd>
633 <dt>aCheckSize</dt>
634 <dd>check size before upload and throw exception if something is wrong</dd>
635 </dl>
636 </td></tr>
637 </table>
638 <table class="detail wide_list">
639 <tr class="list">
640 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
641 <td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>; overload;</code></td>
642 </tr>
643 <tr><td colspan="2">
644 <p>
645 constructor - creates an empty texture</p>
646 </td></tr>
647 </table>
648 <table class="detail wide_list">
649 <tr class="list">
650 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
651 <td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>(const aData: <a  href="glBitmap.TglBitmapData.html">TglBitmapData</a>); overload;</code></td>
652 </tr>
653 <tr><td colspan="2">
654 <p>
655 constructor - creates an texture object and uploads the given data</p>
656 </td></tr>
657 </table>
658 <h3 class="detail">Properties</h3>
659 <table class="detail wide_list">
660 <tr class="list">
661 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
662 <td class="itemcode"><a name="Width"></a><code>property <b>Width</b>: Integer read <a  href="glBitmap.TglBitmap.html#GetWidth">GetWidth</a>;</code></td>
663 </tr>
664 <tr><td colspan="2">
665 <p>
666 the actual width of the texture</p>
667 </td></tr>
668 </table>
669 <table class="detail wide_list">
670 <tr class="list">
671 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
672 <td class="itemcode"><a name="Height"></a><code>property <b>Height</b>: Integer read <a  href="glBitmap.TglBitmap.html#GetHeight">GetHeight</a>;</code></td>
673 </tr>
674 <tr><td colspan="2">
675 <p>
676 the actual height of the texture</p>
677 </td></tr>
678 </table>
679 <table class="detail wide_list">
680 <tr class="list">
681 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
682 <td class="itemcode"><a name="ID"></a><code>property <b>ID</b>: Cardinal  read <a  href="glBitmap.TglBitmap.html#fID">fID</a>                  write <a  href="glBitmap.TglBitmap.html#SetID">SetID</a>;</code></td>
683 </tr>
684 <tr><td colspan="2">
685 <p>
686 name of the OpenGL texture object</p>
687 </td></tr>
688 </table>
689 <table class="detail wide_list">
690 <tr class="list">
691 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
692 <td class="itemcode"><a name="Target"></a><code>property <b>Target</b>: Cardinal  read <a  href="glBitmap.TglBitmap.html#fTarget">fTarget</a>              write <a  href="glBitmap.TglBitmap.html#SetTarget">SetTarget</a>;</code></td>
693 </tr>
694 <tr><td colspan="2">
695 <p>
696 texture target (e.g. GL_TEXTURE_2D)</p>
697 </td></tr>
698 </table>
699 <table class="detail wide_list">
700 <tr class="list">
701 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
702 <td class="itemcode"><a name="DeleteTextureOnFree"></a><code>property <b>DeleteTextureOnFree</b>: Boolean   read <a  href="glBitmap.TglBitmap.html#fDeleteTextureOnFree">fDeleteTextureOnFree</a> write <a  href="glBitmap.TglBitmap.html#SetDeleteTextureOnFree">SetDeleteTextureOnFree</a>;</code></td>
703 </tr>
704 <tr><td colspan="2">
705 <p>
706 delete texture object when this object is destroyed</p>
707 </td></tr>
708 </table>
709 <table class="detail wide_list">
710 <tr class="list">
711 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
712 <td class="itemcode"><a name="MipMap"></a><code>property <b>MipMap</b>: <a  href="glBitmap.html#TglBitmapMipMap">TglBitmapMipMap</a> read <a  href="glBitmap.TglBitmap.html#fMipMap">fMipMap</a>      write <a  href="glBitmap.TglBitmap.html#SetMipMap">SetMipMap</a>;</code></td>
713 </tr>
714 <tr><td colspan="2">
715 <p>
716 mipmap type</p>
717 </td></tr>
718 </table>
719 <table class="detail wide_list">
720 <tr class="list">
721 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
722 <td class="itemcode"><a name="Anisotropic"></a><code>property <b>Anisotropic</b>: Integer         read <a  href="glBitmap.TglBitmap.html#fAnisotropic">fAnisotropic</a> write <a  href="glBitmap.TglBitmap.html#SetAnisotropic">SetAnisotropic</a>;</code></td>
723 </tr>
724 <tr><td colspan="2">
725 <p>
726 anisotropic level</p>
727 </td></tr>
728 </table>
729 <table class="detail wide_list">
730 <tr class="list">
731 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
732 <td class="itemcode"><a name="CustomData"></a><code>property <b>CustomData</b>: Pointer    read <a  href="glBitmap.TglBitmap.html#fCustomData">fCustomData</a>  write <a  href="glBitmap.TglBitmap.html#SetCustomData">SetCustomData</a>;</code></td>
733 </tr>
734 <tr><td colspan="2">
735 <p>
736 user defined data (use at will)</p>
737 </td></tr>
738 </table>
739 <table class="detail wide_list">
740 <tr class="list">
741 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
742 <td class="itemcode"><a name="CustomName"></a><code>property <b>CustomName</b>: String     read <a  href="glBitmap.TglBitmap.html#fCustomName">fCustomName</a>  write <a  href="glBitmap.TglBitmap.html#SetCustomName">SetCustomName</a>;</code></td>
743 </tr>
744 <tr><td colspan="2">
745 <p>
746 user defined name (use at will)</p>
747 </td></tr>
748 </table>
749 <table class="detail wide_list">
750 <tr class="list">
751 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
752 <td class="itemcode"><a name="CustomNameW"></a><code>property <b>CustomNameW</b>: WideString read <a  href="glBitmap.TglBitmap.html#fCustomNameW">fCustomNameW</a> write <a  href="glBitmap.TglBitmap.html#SetCustomNameW">SetCustomNameW</a>;</code></td>
753 </tr>
754 <tr><td colspan="2">
755 <p>
756 user defined name (as WideString; use at will)</p>
757 </td></tr>
758 </table>
759 <table class="detail wide_list">
760 <tr class="list">
761 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
762 <td class="itemcode"><a name="Dimension"></a><code>property <b>Dimension</b>: <a  href="glBitmap.TglBitmapSize.html">TglBitmapSize</a> read <a  href="glBitmap.TglBitmap.html#fDimension">fDimension</a>;</code></td>
763 </tr>
764 <tr><td colspan="2">
765 <p>
766 size of the texture</p>
767 </td></tr>
768 </table>
769 <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>
770 </span>
771 </td></tr></table></body></html>