* split TglBitmap into TglBitmap and TglBitmapData to be able to handle load, save...
[glBitmap.git] / doc / glBitmap.TglBitmap1D.html
index d41d806..1ab6fba 100644 (file)
@@ -21,7 +21,7 @@
 <code>type TglBitmap1D = class(<a class="normal" href="glBitmap.TglBitmap.html">TglBitmap</a>)</code></p>
 <h2 class="description">Description</h2>
 <p>
-wrapper class for 1-dimensional textures (OpenGL target = GL_TEXTURE_1D</p>
+wrapper class for 1-dimensional textures (OpenGL target = GL_TEXTURE_1D all operations on a bitmap object must be done from the render thread</p>
 <a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
 <ul class="hierarchy"><li class="ancestor">TObject</li>
 <li class="ancestor"><a class="normal" href="glBitmap.TglBitmap.html">TglBitmap</a></li>
@@ -30,23 +30,15 @@ wrapper class for 1-dimensional textures (OpenGL target = GL_TEXTURE_1D</p>
 <table class="summary wide_list">
 <tr class="list">
 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
-<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>
+<td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap1D.html#UploadDataIntern">UploadDataIntern</a></b>(const aDataObj: <a  href="glBitmap.TglBitmapData.html">TglBitmapData</a>; const aBuildWithGlu: Boolean);</code></td>
 </tr>
 <tr class="list2">
-<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
-<td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap1D.html#UploadData">UploadData</a></b>(const aBuildWithGlu: Boolean);</code></td>
-</tr>
-<tr class="list">
 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap1D.html#AfterConstruction">AfterConstruction</a></b>; override;</code></td>
 </tr>
-<tr class="list2">
-<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
-<td class="itemcode"><code>function <b><a  href="glBitmap.TglBitmap1D.html#FlipHorz">FlipHorz</a></b>: Boolean; override;</code></td>
-</tr>
 <tr class="list">
 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
-<td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap1D.html#GenTexture">GenTexture</a></b>(const aTestTextureSize: Boolean = true); override;</code></td>
+<td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmap1D.html#UploadData">UploadData</a></b>(const aDataObj: <a  href="glBitmap.TglBitmapData.html">TglBitmapData</a>; const aCheckSize: Boolean = true); override;</code></td>
 </tr>
 </table>
 <a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
@@ -61,34 +53,15 @@ wrapper class for 1-dimensional textures (OpenGL target = GL_TEXTURE_1D</p>
 <table class="detail wide_list">
 <tr class="list">
 <td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
-<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>
-</tr>
-<tr><td colspan="2">
-<p>
-set data pointer of texture data    </p>
-<h6 class="description_section">Parameters</h6>
-<dl class="parameters">
-<dt>aData</dt>
-<dd>pointer to new texture data (be carefull, aData could be freed by this function)</dd>
-<dt>aFormat</dt>
-<dd>format of the data stored at aData</dd>
-<dt>aWidth</dt>
-<dd>width of the texture data</dd>
-<dt>aHeight</dt>
-<dd>height of the texture data</dd>
-</dl>
-</td></tr>
-</table>
-<table class="detail wide_list">
-<tr class="list">
-<td class="visibility"><a  href="legend.html"><img  src="protected.gif" alt="Protected" title="Protected"></a></td>
-<td class="itemcode"><a name="UploadData"></a><code>procedure <b>UploadData</b>(const aBuildWithGlu: Boolean);</code></td>
+<td class="itemcode"><a name="UploadDataIntern"></a><code>procedure <b>UploadDataIntern</b>(const aDataObj: <a  href="glBitmap.TglBitmapData.html">TglBitmapData</a>; const aBuildWithGlu: Boolean);</code></td>
 </tr>
 <tr><td colspan="2">
 <p>
-upload the texture data to video card </p>
+upload the texture data to video card  </p>
 <h6 class="description_section">Parameters</h6>
 <dl class="parameters">
+<dt>aDataObj</dt>
+<dd>texture data object that contains the actual data</dd>
 <dt>aBuildWithGlu</dt>
 <dd>use glu functions to build mipmaps</dd>
 </dl>
@@ -107,26 +80,17 @@ this method is called after constructor and initializes the object</p>
 <table class="detail wide_list">
 <tr class="list">
 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
-<td class="itemcode"><a name="FlipHorz"></a><code>function <b>FlipHorz</b>: Boolean; override;</code></td>
+<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); override;</code></td>
 </tr>
 <tr><td colspan="2">
 <p>
-flip texture horizontally </p>
-<h6 class="description_section">Returns</h6>
-<p class="return"><code>True</code> on success, @fals otherwise</p></td></tr>
-</table>
-<table class="detail wide_list">
-<tr class="list">
-<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
-<td class="itemcode"><a name="GenTexture"></a><code>procedure <b>GenTexture</b>(const aTestTextureSize: Boolean = true); override;</code></td>
-</tr>
-<tr><td colspan="2">
-<p>
-generate texture (create texture object if not exist, set texture parameters and upload data </p>
+upload texture data from given data object to video card  </p>
 <h6 class="description_section">Parameters</h6>
 <dl class="parameters">
-<dt>aTestTextureSize</dt>
-<dd>check the size of the texture and throw exception if something is wrong</dd>
+<dt>aData</dt>
+<dd>texture data object that contains the actual data</dd>
+<dt>aCheckSize</dt>
+<dd>check size before upload and throw exception if something is wrong</dd>
 </dl>
 </td></tr>
 </table>
@@ -141,6 +105,6 @@ generate texture (create texture object if not exist, set texture parameters and
 actual with of the texture</p>
 </td></tr>
 </table>
-<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>
+<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>
 </span>
 </td></tr></table></body></html>