1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<title>Castle Game Engine: CastleCubeMaps</title>
<meta name="generator" content="PasDoc 0.13.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><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">
<h1 class="unit">Unit CastleCubeMaps</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Uses">Uses</a></td><td><a class="section" href="#PasDoc-Classes">Classes, Interfaces, Objects and Records</a></td><td><a class="section" href="#PasDoc-FuncsProcs">Functions and Procedures</a></td><td><a class="section" href="#PasDoc-Types">Types</a></td><td><a class="section" href="#PasDoc-Constants">Constants</a></td><td>Variables</td></tr></table>
<a name="PasDoc-Description"></a><h2 class="description">Description</h2>
<p>
Utilities for cube (environment) maps.</p>
<a name="PasDoc-Uses"></a><h2 class="uses">Uses</h2>
<ul class="useslist"><li><a href="CastleVectors.html">CastleVectors</a></li><li>Math</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Classes"></a><h3 class="cio">Classes, Interfaces, Objects and Records</h3>
<table class="classestable wide_list">
<tr class="listheader">
<th class="itemname">Name</th>
<th class="itemdesc">Description</th>
</tr>
<tr class="list">
<td class="itemname">record <a class="bold" href="CastleCubeMaps.TCubeMapInfo.html"><code>TCubeMapInfo</code></a></td>
<td class="itemdesc"> </td>
</tr>
</table>
<a name="PasDoc-FuncsProcs"></a><h3 class="summary">Functions and Procedures</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code>function <b><a href="CastleCubeMaps.html#CubeMapDirection">CubeMapDirection</a></b>(const Side: <a href="CastleCubeMaps.html#TCubeMapSide">TCubeMapSide</a>; const Pixel: Cardinal): <a href="CastleVectors.html#TVector3Single">TVector3Single</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>procedure <b><a href="CastleCubeMaps.html#DirectionToCubeMap">DirectionToCubeMap</a></b>(const Dir: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out Side: <a href="CastleCubeMaps.html#TCubeMapSide">TCubeMapSide</a>; out Pixel: Cardinal);</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code>procedure <b><a href="CastleCubeMaps.html#Direction4ToCubeMap">Direction4ToCubeMap</a></b>(const Dir: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out Side: <a href="CastleCubeMaps.html#TCubeMapSide4">TCubeMapSide4</a>; out Pixel: <a href="CastleVectors.html#TVector4Cardinal">TVector4Cardinal</a>; out Ratio: <a href="CastleVectors.html#TVector4Single">TVector4Single</a>);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code>function <b><a href="CastleCubeMaps.html#CubeMapSolidAngle">CubeMapSolidAngle</a></b>(const Side: <a href="CastleCubeMaps.html#TCubeMapSide">TCubeMapSide</a>; const Pixel: Cardinal): Single;</code></td>
</tr>
</table>
<a name="PasDoc-Types"></a><h3 class="summary">Types</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><b><a href="CastleCubeMaps.html#TCubeMapSide">TCubeMapSide</a></b> = (...);</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleCubeMaps.html#TCubeMapSide4">TCubeMapSide4</a></b> = array [0..3] of <a href="CastleCubeMaps.html#TCubeMapSide">TCubeMapSide</a>;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleCubeMaps.html#TCardinal4">TCardinal4</a></b> = array [0..3] of Cardinal;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleCubeMaps.html#TCubeMapFloat">TCubeMapFloat</a></b> = array [<a href="CastleCubeMaps.html#TCubeMapSide">TCubeMapSide</a>, 0..Sqr(<a href="CastleCubeMaps.html#CubeMapSize">CubeMapSize</a>) - 1] of <a href="CastleUtils.html#Float">Float</a>;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleCubeMaps.html#PCubeMapFloat">PCubeMapFloat</a></b> = ˆ<a href="CastleCubeMaps.html#TCubeMapFloat">TCubeMapFloat</a>;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleCubeMaps.html#TCubeMapByte">TCubeMapByte</a></b> = array [<a href="CastleCubeMaps.html#TCubeMapSide">TCubeMapSide</a>, 0..Sqr(<a href="CastleCubeMaps.html#CubeMapSize">CubeMapSize</a>) - 1] of Byte;</code></td>
</tr>
<tr class="list">
<td class="itemcode"><code><b><a href="CastleCubeMaps.html#PCubeMapByte">PCubeMapByte</a></b> = ˆ<a href="CastleCubeMaps.html#TCubeMapByte">TCubeMapByte</a>;</code></td>
</tr>
</table>
<a name="PasDoc-Constants"></a><h3 class="summary">Constants</h3>
<table class="summary wide_list">
<tr class="list">
<td class="itemcode"><code><b><a href="CastleCubeMaps.html#CubeMapSize">CubeMapSize</a></b> = 16;</code></td>
</tr>
<tr class="list2">
<td class="itemcode"><code><b><a href="CastleCubeMaps.html#CubeMapInfo">CubeMapInfo</a></b>: array [<a href="CastleCubeMaps.html#TCubeMapSide">TCubeMapSide</a>] of <a href="CastleCubeMaps.TCubeMapInfo.html">TCubeMapInfo</a> =
( (Dir: ( 1, 0, 0); Up: (0, -1, 0); Side: ( 0, 0,-1); ScreenX: 3; ScreenY: 0),
(Dir: (-1, 0, 0); Up: (0, -1, 0); Side: ( 0, 0, 1); ScreenX: 1; ScreenY: 0),
(Dir: ( 0, 1, 0); Up: (0, 0, 1); Side: ( 1, 0, 0); ScreenX: 2; ScreenY: -1),
(Dir: ( 0, -1, 0); Up: (0, 0, -1); Side: ( 1, 0, 0); ScreenX: 2; ScreenY: +1),
(Dir: ( 0, 0, 1); Up: (0, -1, 0); Side: ( 1, 0, 0); ScreenX: 2; ScreenY: 0),
(Dir: ( 0, 0, -1); Up: (0, -1, 0); Side: (-1, 0, 0); ScreenX: 0; ScreenY: 0)
);</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Functions and Procedures</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="CubeMapDirection"></a><code>function <b>CubeMapDirection</b>(const Side: <a href="CastleCubeMaps.html#TCubeMapSide">TCubeMapSide</a>; const Pixel: Cardinal): <a href="CastleVectors.html#TVector3Single">TVector3Single</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
Direction corresponding to given cube map side and pixel number. That is, assuming that the middle of cube is placed at (0, 0, 0), each pixel of the cube map corresponds to some direction.
<p>Pixel number must be between 0 and <a class="normal" href="CastleCubeMaps.html#CubeMapSize">CubeMapSize</a>*2-1. It's assumed that pixels are in the same order as they are in OpenGL images, that is row-by-row, from the lowest row to highest, in each row from left to right.
<p>Returned vector is <i>not normalized</i>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="DirectionToCubeMap"></a><code>procedure <b>DirectionToCubeMap</b>(const Dir: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out Side: <a href="CastleCubeMaps.html#TCubeMapSide">TCubeMapSide</a>; out Pixel: Cardinal);</code></td>
</tr>
<tr><td colspan="1">
<p>
Return cube map side and pixel that is the closest to given direction Dir. This is the reverse of <a class="normal" href="CastleCubeMaps.html#CubeMapDirection">CubeMapDirection</a> function.
<p>Given here Dir need not be normalized, although must not be zero.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="Direction4ToCubeMap"></a><code>procedure <b>Direction4ToCubeMap</b>(const Dir: <a href="CastleVectors.html#TVector3Single">TVector3Single</a>; out Side: <a href="CastleCubeMaps.html#TCubeMapSide4">TCubeMapSide4</a>; out Pixel: <a href="CastleVectors.html#TVector4Cardinal">TVector4Cardinal</a>; out Ratio: <a href="CastleVectors.html#TVector4Single">TVector4Single</a>);</code></td>
</tr>
<tr><td colspan="1">
<p>
Return 4 cube map indexes (side and pixel, along with ratio) that are closest to given direction Dir. All ratios will sum to 1.
<p>This is like <a class="normal" href="CastleCubeMaps.html#DirectionToCubeMap">DirectionToCubeMap</a>, except this returns 4 values. It allows you to do bilinear interpolation between cube map items.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="CubeMapSolidAngle"></a><code>function <b>CubeMapSolidAngle</b>(const Side: <a href="CastleCubeMaps.html#TCubeMapSide">TCubeMapSide</a>; const Pixel: Cardinal): Single;</code></td>
</tr>
<tr><td colspan="1">
<p>
Calculate solid angle of given pixel on the cube map.</p>
</td></tr>
</table>
<h3 class="detail">Types</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCubeMapSide"></a><code><b>TCubeMapSide</b> = (...);</code></td>
</tr>
<tr><td colspan="1">
<p>
Cube map faces.
<p>Order matches order of OpenGL constants GL_TEXTURE_CUBE_MAP_POSITIVE/NEGATIVE_X/Y/Z_ARB.</p>
<h6 class="description_section">Values</h6>
<ul>
<li>
csPositiveX: </li>
<li>
csNegativeX: </li>
<li>
csPositiveY: </li>
<li>
csNegativeY: </li>
<li>
csPositiveZ: </li>
<li>
csNegativeZ: </li>
</ul>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCubeMapSide4"></a><code><b>TCubeMapSide4</b> = array [0..3] of <a href="CastleCubeMaps.html#TCubeMapSide">TCubeMapSide</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCardinal4"></a><code><b>TCardinal4</b> = array [0..3] of Cardinal;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCubeMapFloat"></a><code><b>TCubeMapFloat</b> = array [<a href="CastleCubeMaps.html#TCubeMapSide">TCubeMapSide</a>, 0..Sqr(<a href="CastleCubeMaps.html#CubeMapSize">CubeMapSize</a>) - 1] of <a href="CastleUtils.html#Float">Float</a>;</code></td>
</tr>
<tr><td colspan="1">
<p>
Cube map, with each item being a Float.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="PCubeMapFloat"></a><code><b>PCubeMapFloat</b> = ˆ<a href="CastleCubeMaps.html#TCubeMapFloat">TCubeMapFloat</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="TCubeMapByte"></a><code><b>TCubeMapByte</b> = array [<a href="CastleCubeMaps.html#TCubeMapSide">TCubeMapSide</a>, 0..Sqr(<a href="CastleCubeMaps.html#CubeMapSize">CubeMapSize</a>) - 1] of Byte;</code></td>
</tr>
<tr><td colspan="1">
<p>
Cube map, with each item being in 0..1 range, encoded as a Byte. This assumes that every item is actually a float in 0..1 range, encoded as Byte.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="PCubeMapByte"></a><code><b>PCubeMapByte</b> = ˆ<a href="CastleCubeMaps.html#TCubeMapByte">TCubeMapByte</a>;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<h3 class="detail">Constants</h3>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="CubeMapSize"></a><code><b>CubeMapSize</b> = 16;</code></td>
</tr>
<tr><td colspan="1">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="itemcode"><a name="CubeMapInfo"></a><code><b>CubeMapInfo</b>: array [<a href="CastleCubeMaps.html#TCubeMapSide">TCubeMapSide</a>] of <a href="CastleCubeMaps.TCubeMapInfo.html">TCubeMapInfo</a> =
( (Dir: ( 1, 0, 0); Up: (0, -1, 0); Side: ( 0, 0,-1); ScreenX: 3; ScreenY: 0),
(Dir: (-1, 0, 0); Up: (0, -1, 0); Side: ( 0, 0, 1); ScreenX: 1; ScreenY: 0),
(Dir: ( 0, 1, 0); Up: (0, 0, 1); Side: ( 1, 0, 0); ScreenX: 2; ScreenY: -1),
(Dir: ( 0, -1, 0); Up: (0, 0, -1); Side: ( 1, 0, 0); ScreenX: 2; ScreenY: +1),
(Dir: ( 0, 0, 1); Up: (0, -1, 0); Side: ( 1, 0, 0); ScreenX: 2; ScreenY: 0),
(Dir: ( 0, 0, -1); Up: (0, -1, 0); Side: (-1, 0, 0); ScreenX: 0; ScreenY: 0)
);</code></td>
</tr>
<tr><td colspan="1">
<p>
Information about cube map faces.
<p>Names and orientation of faces match precisely OpenGL naming and orientation (see <a href="http://www.opengl.org/registry/specs/ARB/texture_cube_map.txt">http://www.opengl.org/registry/specs/ARB/texture_cube_map.txt</a>), so it's straighforward to use this for OpenGL cube maps.</p>
</td></tr>
</table>
<!-- Piwik -->
<script type="text/javascript">
var _paq = _paq || [];
_paq.push(["trackPageView"]);
_paq.push(["enableLinkTracking"]);
(function() {
var u=(("https:" == document.location.protocol) ? "https" : "http") + "://michalis.ii.uni.wroc.pl/piwik-castle-engine/";
_paq.push(["setTrackerUrl", u+"piwik.php"]);
_paq.push(["setSiteId", "1"]);
var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Piwik Code -->
<noscript>
<!-- Piwik Image Tracker -->
<img src="http://michalis.ii.uni.wroc.pl/piwik-castle-engine/piwik.php?idsite=1&rec=1" style="border:0" alt="" />
<!-- End Piwik -->
</noscript>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2015-06-15 04:43:09</em>
</span>
</td></tr></table></body></html>
|
