* split TglBitmap into TglBitmap and TglBitmapData to be able to handle load, save...
[glBitmap.git] / doc / glBitmap.TglBitmapCubeMap.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 TglBitmapCubeMap</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="TglBitmapCubeMap"></a><h1 class="cio">Class TglBitmapCubeMap</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>Properties</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 TglBitmapCubeMap = class(<a class="normal" href="glBitmap.TglBitmap2D.html">TglBitmap2D</a>)</code></p>
22 <h2 class="description">Description</h2>
23 <p>
24 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>
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="ancestor"><a class="normal" href="glBitmap.TglBitmap2D.html">TglBitmap2D</a></li>
29 <li class="thisitem">TglBitmapCubeMap</li></ul><h2 class="overview">Overview</h2>
30 <a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
31 <table class="summary wide_list">
32 <tr class="list">
33 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
34 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmapCubeMap.html#AfterConstruction">AfterConstruction</a></b>; override;</code></td>
35 </tr>
36 <tr class="list2">
37 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
38 <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>
39 </tr>
40 <tr class="list">
41 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
42 <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>
43 </tr>
44 <tr class="list2">
45 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
46 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmapCubeMap.html#Bind">Bind</a></b>( const aEnableTextureUnit: Boolean = true); reintroduce; virtual;</code></td>
47 </tr>
48 <tr class="list">
49 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
50 <td class="itemcode"><code>procedure <b><a  href="glBitmap.TglBitmapCubeMap.html#Unbind">Unbind</a></b>( const aDisableTextureUnit: Boolean = true); reintroduce; virtual;</code></td>
51 </tr>
52 </table>
53 <h2 class="description">Description</h2>
54 <h3 class="detail">Methods</h3>
55 <table class="detail wide_list">
56 <tr class="list">
57 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
58 <td class="itemcode"><a name="AfterConstruction"></a><code>procedure <b>AfterConstruction</b>; override;</code></td>
59 </tr>
60 <tr><td colspan="2">
61 <p>
62 this method is called after constructor and initializes the object</p>
63 </td></tr>
64 </table>
65 <table class="detail wide_list">
66 <tr class="list">
67 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
68 <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>
69 </tr>
70 <tr><td colspan="2">
71 <p>
72 upload texture data from given data object to video card  </p>
73 <h6 class="description_section">Parameters</h6>
74 <dl class="parameters">
75 <dt>aData</dt>
76 <dd>texture data object that contains the actual data</dd>
77 <dt>aCheckSize</dt>
78 <dd>check size before upload and throw exception if something is wrong</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="public.gif" alt="Public" title="Public"></a></td>
85 <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>
86 </tr>
87 <tr><td colspan="2">
88 <p>
89 upload texture data from given data object to video card   </p>
90 <h6 class="description_section">Parameters</h6>
91 <dl class="parameters">
92 <dt>aData</dt>
93 <dd>texture data object that contains the actual data</dd>
94 <dt>aCubeTarget</dt>
95 <dd>cube map target to upload data to (e.g. GL_TEXTURE_CUBE_MAP_POSITIVE_X)</dd>
96 <dt>aCheckSize</dt>
97 <dd>check size before upload and throw exception if something is wrong</dd>
98 </dl>
99 </td></tr>
100 </table>
101 <table class="detail wide_list">
102 <tr class="list">
103 <td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
104 <td class="itemcode"><a name="Bind"></a><code>procedure <b>Bind</b>( const aEnableTextureUnit: Boolean = true); reintroduce; virtual;</code></td>
105 </tr>
106 <tr><td colspan="2">
107 <p>
108 bind texture  </p>
109 <h6 class="description_section">Parameters</h6>
110 <dl class="parameters">
111 <dt>aEnableTexCoordsGen</dt>
112 <dd>enable cube map generator</dd>
113 <dt>aEnableTextureUnit</dt>
114 <dd>enable texture unit</dd>
115 </dl>
116 </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="Unbind"></a><code>procedure <b>Unbind</b>( const aDisableTextureUnit: Boolean = true); reintroduce; virtual;</code></td>
122 </tr>
123 <tr><td colspan="2">
124 <p>
125 unbind texture  </p>
126 <h6 class="description_section">Parameters</h6>
127 <dl class="parameters">
128 <dt>aDisableTexCoordsGen</dt>
129 <dd>disable cube map generator</dd>
130 <dt>aDisableTextureUnit</dt>
131 <dd>disable texture unit</dd>
132 </dl>
133 </td></tr>
134 </table>
135 <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>
136 </span>
137 </td></tr></table></body></html>