* removed native OpenGL support
[glBitmap.git] / doc / glBitmap.TglBitmap1D.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 TglBitmap1D</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="TglBitmap1D"></a><h1 class="cio">Class TglBitmap1D</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>Fields</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 TglBitmap1D = class(<a class="normal" href="glBitmap.TglBitmap.html">TglBitmap</a>)</code></p>
22 <h2 class="description">Description</h2>
23 <p>
24 wrapper class for 1-dimensional textures (OpenGL target = GL_TEXTURE_1D</p>
25 <a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
26 <ul class="hierarchy"><li class="ancestor">TObject</li>
27 <li class="ancestor"><a class="normal" href="glBitmap.TglBitmap.html">TglBitmap</a></li>
28 <li class="thisitem">TglBitmap1D</li></ul><h2 class="overview">Overview</h2>
29 <a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
30 <table class="summary wide_list">
31 <tr class="list">
32 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
33 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap1D.html#SetDataPointer">SetDataPointer</a></b>(var aData: PByte; const aFormat: <a  href="glBitmap.html#TglBitmapFormat">TglBitmapFormat</a>; const aWidth: Integer = - 1; const aHeight: Integer = - 1); override;</code></td>
34 </tr>
35 <tr class="list2">
36 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
37 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap1D.html#UploadData">UploadData</a></b>(const aBuildWithGlu: Boolean);</code></td>
38 </tr>
39 <tr class="list">
40 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
41 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap1D.html#AfterConstruction">AfterConstruction</a></b>; override;</code></td>
42 </tr>
43 <tr class="list2">
44 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
45 <td class="itemcode"><code>function <b><a  href="glBitmap.TglBitmap1D.html#FlipHorz">FlipHorz</a></b>: Boolean; override;</code></td>
46 </tr>
47 <tr class="list">
48 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
49 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap1D.html#GenTexture">GenTexture</a></b>(const aTestTextureSize: Boolean = true); override;</code></td>
50 </tr>
51 </table>
52 <a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
53 <table class="summary wide_list">
54 <tr class="list">
55 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
56 <td class="itemcode"><code>property <b><a  href="glBitmap.TglBitmap1D.html#Width">Width</a></b>;</code></td>
57 </tr>
58 </table>
59 <h2 class="description">Description</h2>
60 <h3 class="detail">Methods</h3>
61 <table class="detail wide_list">
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"><a name="SetDataPointer"></a><code>procedure <b>SetDataPointer</b>(var aData: PByte; const aFormat: <a  href="glBitmap.html#TglBitmapFormat">TglBitmapFormat</a>; const aWidth: Integer = - 1; const aHeight: Integer = - 1); override;</code></td>
65 </tr>
66 <tr><td colspan="2">
67 <p>
68 set data pointer of texture data    </p>
69 <h6 class="description_section">Parameters</h6>
70 <dl class="parameters">
71 <dt>aData</dt>
72 <dd>pointer to new texture data (be carefull, aData could be freed by this function)</dd>
73 <dt>aFormat</dt>
74 <dd>format of the data stored at aData</dd>
75 <dt>aWidth</dt>
76 <dd>width of the texture data</dd>
77 <dt>aHeight</dt>
78 <dd>height of the texture data</dd>
79 </dl>
80 </td></tr>
81 </table>
82 <table class="detail wide_list">
83 <tr class="list">
84 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
85 <td class="itemcode"><a name="UploadData"></a><code>procedure <b>UploadData</b>(const aBuildWithGlu: Boolean);</code></td>
86 </tr>
87 <tr><td colspan="2">
88 <p>
89 upload the texture data to video card </p>
90 <h6 class="description_section">Parameters</h6>
91 <dl class="parameters">
92 <dt>aBuildWithGlu</dt>
93 <dd>use glu functions to build mipmaps</dd>
94 </dl>
95 </td></tr>
96 </table>
97 <table class="detail wide_list">
98 <tr class="list">
99 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
100 <td class="itemcode"><a name="AfterConstruction"></a><code>procedure <b>AfterConstruction</b>; override;</code></td>
101 </tr>
102 <tr><td colspan="2">
103 <p>
104 this method is called after constructor and initializes the object</p>
105 </td></tr>
106 </table>
107 <table class="detail wide_list">
108 <tr class="list">
109 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
110 <td class="itemcode"><a name="FlipHorz"></a><code>function <b>FlipHorz</b>: Boolean; override;</code></td>
111 </tr>
112 <tr><td colspan="2">
113 <p>
114 flip texture horizontally </p>
115 <h6 class="description_section">Returns</h6>
116 <p class="return"><code>True</code> on success, @fals otherwise</p></td></tr>
117 </table>
118 <table class="detail wide_list">
119 <tr class="list">
120 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
121 <td class="itemcode"><a name="GenTexture"></a><code>procedure <b>GenTexture</b>(const aTestTextureSize: Boolean = true); override;</code></td>
122 </tr>
123 <tr><td colspan="2">
124 <p>
125 generate texture (create texture object if not exist, set texture parameters and upload data </p>
126 <h6 class="description_section">Parameters</h6>
127 <dl class="parameters">
128 <dt>aTestTextureSize</dt>
129 <dd>check the size of the texture and throw exception if something is wrong</dd>
130 </dl>
131 </td></tr>
132 </table>
133 <h3 class="detail">Properties</h3>
134 <table class="detail wide_list">
135 <tr class="list">
136 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
137 <td class="itemcode"><a name="Width"></a><code>property <b>Width</b>;</code></td>
138 </tr>
139 <tr><td colspan="2">
140 <p>
141 actual with of the texture</p>
142 </td></tr>
143 </table>
144 <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>
145 </span>
146 </td></tr></table></body></html>