File: CastleImages.TGrayscaleImage.html

package info (click to toggle)
castle-game-engine 5.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 185,428 kB
  • sloc: pascal: 260,781; cpp: 1,363; objc: 713; makefile: 537; xml: 496; sh: 480; php: 4
file content (242 lines) | stat: -rw-r--r-- 14,803 bytes parent folder | download 
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
 
<!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: CastleImages: Class TGrayscaleImage</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">
<a name="TGrayscaleImage"></a><h1 class="cio">Class TGrayscaleImage</h1>
<table class="sections wide_list">
<tr>
<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>
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a  href="CastleImages.html">CastleImages</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TGrayscaleImage = class(<a class="normal" href="CastleImages.TCastleImage.html">TCastleImage</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Grayscale image. Color is a simple Byte value.</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="CastleImages.TEncodedImage.html">TEncodedImage</a></li>
<li class="ancestor"><a class="normal" href="CastleImages.TCastleImage.html">TCastleImage</a></li>
<li class="thisitem">TGrayscaleImage</li></ul><h2 class="overview">Overview</h2>
<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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>class function <b><a  href="CastleImages.TGrayscaleImage.html#PixelSize">PixelSize</a></b>: Cardinal; 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>class function <b><a  href="CastleImages.TGrayscaleImage.html#ColorComponentsCount">ColorComponentsCount</a></b>: Cardinal; 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>function <b><a  href="CastleImages.TGrayscaleImage.html#PixelPtr">PixelPtr</a></b>(const X, Y: Cardinal; const Z: Cardinal = 0): PByte;</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="CastleImages.TGrayscaleImage.html#RowPtr">RowPtr</a></b>(const Y: Cardinal; const Z: Cardinal = 0): <a  href="CastleUtils.html#PByteArray">PByteArray</a>;</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="CastleImages.TGrayscaleImage.html#Clear">Clear</a></b>(const Pixel: Byte); reintroduce;</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="CastleImages.TGrayscaleImage.html#IsClear">IsClear</a></b>(const Pixel: Byte): boolean; reintroduce;</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="CastleImages.TGrayscaleImage.html#HalfColors">HalfColors</a></b>;</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="CastleImages.TGrayscaleImage.html#ToGrayscaleAlphaImage">ToGrayscaleAlphaImage</a></b>: <a  href="CastleImages.TGrayscaleAlphaImage.html">TGrayscaleAlphaImage</a>;</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="CastleImages.TGrayscaleImage.html#LerpWith">LerpWith</a></b>(const Value: Single; SecondImage: <a  href="CastleImages.TCastleImage.html">TCastleImage</a>); 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>class procedure <b><a  href="CastleImages.TGrayscaleImage.html#MixColors">MixColors</a></b>(const OutputColor: Pointer; const Weights: <a  href="CastleVectors.html#TVector4Single">TVector4Single</a>; const Colors: <a  href="CastleVectors.html#TVector4Pointer">TVector4Pointer</a>); 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>function <b><a  href="CastleImages.TGrayscaleImage.html#AlphaChannel">AlphaChannel</a></b>( const AlphaTolerance: Byte): <a  href="CastleImages.html#TAlphaChannel">TAlphaChannel</a>; 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="CastleImages.TGrayscaleImage.html#Assign">Assign</a></b>(const Source: <a  href="CastleImages.TCastleImage.html">TCastleImage</a>); override;</code></td>
</tr>
</table>
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
<table class="summary 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"><code>property <b><a  href="CastleImages.TGrayscaleImage.html#GrayscalePixels">GrayscalePixels</a></b>: PByte read GetGrayscalePixels;</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>property <b><a  href="CastleImages.TGrayscaleImage.html#TreatAsAlpha">TreatAsAlpha</a></b>: boolean
      read FTreatAsAlpha write FTreatAsAlpha;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<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="PixelSize"></a><code>class function <b>PixelSize</b>: Cardinal; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="ColorComponentsCount"></a><code>class function <b>ColorComponentsCount</b>: Cardinal; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="PixelPtr"></a><code>function <b>PixelPtr</b>(const X, Y: Cardinal; const Z: Cardinal = 0): PByte;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="RowPtr"></a><code>function <b>RowPtr</b>(const Y: Cardinal; const Z: Cardinal = 0): <a  href="CastleUtils.html#PByteArray">PByteArray</a>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="Clear"></a><code>procedure <b>Clear</b>(const Pixel: Byte); reintroduce;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="IsClear"></a><code>function <b>IsClear</b>(const Pixel: Byte): boolean; reintroduce;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="HalfColors"></a><code>procedure <b>HalfColors</b>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Every pixels value is halved (divided by 2). This is done by simple bitshift, so you can be sure that all components are &lt; 2&circ;7 after this.</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="ToGrayscaleAlphaImage"></a><code>function <b>ToGrayscaleAlphaImage</b>: <a  href="CastleImages.TGrayscaleAlphaImage.html">TGrayscaleAlphaImage</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Add an alpha channel. The newly created alpha channel will have constant opaque alpha, except in the special case of <a class="normal" href="CastleImages.TGrayscaleImage.html#TreatAsAlpha">TGrayscaleImage.TreatAsAlpha</a> = <code>True</code> (where the contents will be copied to alpha, and intensity set to <a class="normal" href="CastleColors.html#White">white</a>).</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="LerpWith"></a><code>procedure <b>LerpWith</b>(const Value: Single; SecondImage: <a  href="CastleImages.TCastleImage.html">TCastleImage</a>); override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="MixColors"></a><code>class procedure <b>MixColors</b>(const OutputColor: Pointer; const Weights: <a  href="CastleVectors.html#TVector4Single">TVector4Single</a>; const Colors: <a  href="CastleVectors.html#TVector4Pointer">TVector4Pointer</a>); override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="AlphaChannel"></a><code>function <b>AlphaChannel</b>( const AlphaTolerance: Byte): <a  href="CastleImages.html#TAlphaChannel">TAlphaChannel</a>; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="Assign"></a><code>procedure <b>Assign</b>(const Source: <a  href="CastleImages.TCastleImage.html">TCastleImage</a>); override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<h3 class="detail">Properties</h3>
<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="GrayscalePixels"></a><code>property <b>GrayscalePixels</b>: PByte read GetGrayscalePixels;</code></td>
</tr>
<tr><td colspan="2">
<p>
This is the same pointer as <a class="normal" href="CastleImages.TEncodedImage.html#RawPixels">RawPixels</a>, only typecasted to PByte</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="TreatAsAlpha"></a><code>property <b>TreatAsAlpha</b>: boolean
      read FTreatAsAlpha write FTreatAsAlpha;</code></td>
</tr>
<tr><td colspan="2">
<p>
Should we treat grayscale image as pure alpha channel (without any color information) when using this as a texture.

<p>This property is meaningful only for a small subset of operations, right now: only when creating OpenGL texture from this image. If <code>True</code>, then the grayscale pixel data will be loaded as alpha channel contents (GL_ALPHA texture for OpenGL, it modifies only the fragments alpha value, it doesn't have any &quot;color&quot; in the normal sense). It is also the only way for <a class="normal" href="CastleImages.TGrayscaleImage.html">TGrayscaleImage</a> to return <a class="normal" href="CastleImages.TGrayscaleImage.html#AlphaChannel">AlphaChannel</a> &lt;&gt; acNone.</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&amp;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:10</em>
</span>
</td></tr></table></body></html>