* split TglBitmap into TglBitmap and TglBitmapData to be able to handle load, save...
[glBitmap.git] / doc / glBitmap.TglBitmapCubeMap.html
index e3bd45b..c893bb5 100644 (file)
@@ -21,7 +21,7 @@
 <code>type TglBitmapCubeMap = class(<a class="normal" href="glBitmap.TglBitmap2D.html">TglBitmap2D</a>)</code></p>
 <h2 class="description">Description</h2>
 <p>
-wrapper class for cube maps (OpenGL target = GL_TEXTURE_CUBE_MAP)</p>
+wrapper class for cube maps (OpenGL target = GL_TEXTURE_CUBE_MAP) 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,16 +30,16 @@ wrapper class for cube maps (OpenGL target = GL_TEXTURE_CUBE_MAP)</p>
 <a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
 <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.TglBitmapCubeMap.html#GenTexture">GenTexture</a></b>(const aTestTextureSize: Boolean = true); reintroduce;</code></td>
+<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.TglBitmapCubeMap.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>procedure <b><a  href="glBitmap.TglBitmapCubeMap.html#AfterConstruction">AfterConstruction</a></b>; override;</code></td>
+<td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmapCubeMap.html#UploadData">UploadData</a></b>(const aDataObj: <a  href="glBitmap.TglBitmapData.html">TglBitmapData</a>; const aCheckSize: Boolean = true); 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.TglBitmapCubeMap.html#GenerateCubeMap">GenerateCubeMap</a></b>(const aCubeTarget: Cardinal; const aTestTextureSize: Boolean = true);</code></td>
+<td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmapCubeMap.html#UploadCubeMap">UploadCubeMap</a></b>(const aDataObj: <a  href="glBitmap.TglBitmapData.html">TglBitmapData</a>; const aCubeTarget: Cardinal; const aCheckSize: Boolean);</code></td>
 </tr>
 <tr class="list2">
 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
@@ -54,43 +54,47 @@ wrapper class for cube maps (OpenGL target = GL_TEXTURE_CUBE_MAP)</p>
 <h3 class="detail">Methods</h3>
 <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="GenTexture"></a><code>procedure <b>GenTexture</b>(const aTestTextureSize: Boolean = true); reintroduce;</code></td>
+<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
+<td class="itemcode"><a name="AfterConstruction"></a><code>procedure <b>AfterConstruction</b>; override;</code></td>
 </tr>
 <tr><td colspan="2">
 <p>
-generate texture (create texture object if not exist, set texture parameters and upload data do not call directly for cubemaps, use GenerateCubeMap instead </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>
-</dl>
+this method is called after constructor and initializes the object</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="AfterConstruction"></a><code>procedure <b>AfterConstruction</b>; 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>
-this method is called after constructor and initializes the object</p>
+upload texture data from given data object to video card  </p>
+<h6 class="description_section">Parameters</h6>
+<dl class="parameters">
+<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>
 <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="GenerateCubeMap"></a><code>procedure <b>GenerateCubeMap</b>(const aCubeTarget: Cardinal; const aTestTextureSize: Boolean = true);</code></td>
+<td class="itemcode"><a name="UploadCubeMap"></a><code>procedure <b>UploadCubeMap</b>(const aDataObj: <a  href="glBitmap.TglBitmapData.html">TglBitmapData</a>; const aCubeTarget: Cardinal; const aCheckSize: Boolean);</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>aData</dt>
+<dd>texture data object that contains the actual data</dd>
 <dt>aCubeTarget</dt>
 <dd>cube map target to upload data to (e.g. GL_TEXTURE_CUBE_MAP_POSITIVE_X)</dd>
-<dt>aTestTextureSize</dt>
-<dd>check the size of the texture and throw exception if something is wrong</dd>
+<dt>aCheckSize</dt>
+<dd>check size before upload and throw exception if something is wrong</dd>
 </dl>
 </td></tr>
 </table>
@@ -128,6 +132,6 @@ unbind texture  </p>
 </dl>
 </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>