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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta content="en" name="language">
<title>deprecate</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link media="screen" href="../docutils-api.css" type="text/css" rel="stylesheet">
</head>
<body>
<div class="banner">
<img src="../images/gm-107x76.png" alt="GraphicMagick logo" width="107" height="76" />
<span class="title">GraphicsMagick</span>
<form action="http://www.google.com/search">
<input type="hidden" name="domains" value="www.graphicsmagick.org" />
<input type="hidden" name="sitesearch" value="www.graphicsmagick.org" />
<span class="nowrap"><input type="text" name="q" size="25" maxlength="255" /> <input type="submit" name="sa" value="Search" /></span>
</form>
</div>
<div class="navmenu">
<ul>
<li><a href="../index.html">Home</a></li>
<li><a href="../project.html">Project</a></li>
<li><a href="../download.html">Download</a></li>
<li><a href="../README.html">Install</a></li>
<li><a href="../Hg.html">Source</a></li>
<li><a href="../NEWS.html">News</a> </li>
<li><a href="../utilities.html">Utilities</a></li>
<li><a href="../programming.html">Programming</a></li>
<li><a href="../reference.html">Reference</a></li>
</ul>
</div>
<div class="document" id="deprecate">
<h1 class="title">deprecate</h1>
<p class="subtitle" id="methods-which-should-no-longer-be-used">Methods which should no longer be used</p>
<div class="contents topic" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#acquirecacheview" id="id21">AcquireCacheView</a></p></li>
<li><p><a class="reference internal" href="#acquirememory" id="id22">AcquireMemory</a></p></li>
<li><p><a class="reference internal" href="#clonememory" id="id23">CloneMemory</a></p></li>
<li><p><a class="reference internal" href="#getcacheview" id="id24">GetCacheView</a></p></li>
<li><p><a class="reference internal" href="#liberatememory" id="id25">LiberateMemory</a></p></li>
<li><p><a class="reference internal" href="#popimagepixels" id="id26">PopImagePixels</a></p></li>
<li><p><a class="reference internal" href="#pushimagepixels" id="id27">PushImagePixels</a></p></li>
<li><p><a class="reference internal" href="#reacquirememory" id="id28">ReacquireMemory</a></p></li>
<li><p><a class="reference internal" href="#setcacheview" id="id29">SetCacheView</a></p></li>
<li><p><a class="reference internal" href="#synccacheview" id="id30">SyncCacheView</a></p></li>
<li><p><a class="reference internal" href="#strip" id="id31">Strip</a></p></li>
</ul>
</div>
<div class="section" id="acquirecacheview">
<h1><a class="toc-backref" href="#id21">AcquireCacheView</a></h1>
<div class="section" id="synopsis">
<h2>Synopsis</h2>
<pre class="literal-block">const <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AcquireCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y,
const unsigned long columns, const unsigned long rows,
<a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
</div>
<div class="section" id="description">
<h2>Description</h2>
<p>Method AcquireCacheView gets pixels from the in-memory or disk pixel cache
as defined by the geometry parameters for read-only access. A pointer to
the pixels is returned if the pixels are transferred, otherwise NULL is
returned.</p>
<p>The format of the AcquireCacheView method is:</p>
<pre class="literal-block">const <a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *AcquireCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y,
const unsigned long columns, const unsigned long rows,
<a class="reference external" href="../api/types.html#exceptioninfo">ExceptionInfo</a> *exception );</pre>
<dl class="simple">
<dt>pixels:</dt>
<dd><p>Method AcquireCacheView returns a null pointer if an error
occurs, otherwise a pointer to the view pixels.</p>
</dd>
<dt>view:</dt>
<dd><p>The address of a structure of type ViewInfo.</p>
</dd>
<dt>x,y,columns,rows:</dt>
<dd><p>These values define the perimeter of a region of
pixels.</p>
</dd>
<dt>exception:</dt>
<dd><p>Return any errors or warnings in this structure.</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="acquirememory">
<h1><a class="toc-backref" href="#id22">AcquireMemory</a></h1>
<div class="section" id="id1">
<h2>Synopsis</h2>
<pre class="literal-block">void *AcquireMemory( const size_t size );</pre>
</div>
<div class="section" id="id2">
<h2>Description</h2>
<p>AcquireMemory() returns a pointer to a block of memory of at least size
bytes suitably aligned for any use. NULL is returned if insufficient
memory is available or the requested size is zero.</p>
<p>The format of the AcquireMemory method is:</p>
<pre class="literal-block">void *AcquireMemory( const size_t size );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>size:</dt>
<dd><p>The size of the memory in bytes to allocate.</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="clonememory">
<h1><a class="toc-backref" href="#id23">CloneMemory</a></h1>
<div class="section" id="id3">
<h2>Synopsis</h2>
<pre class="literal-block">void *CloneMemory( void *destination, const void *source, const size_t size );</pre>
</div>
<div class="section" id="id4">
<h2>Description</h2>
<p>CloneMemory() copies size bytes from memory area source to the
destination. Copying between objects that overlap will take place
correctly. It returns destination.</p>
<p>The format of the CloneMemory method is:</p>
<pre class="literal-block">void *CloneMemory( void *destination, const void *source, const size_t size );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>size:</dt>
<dd><p>The size of the memory in bytes to allocate.</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="getcacheview">
<h1><a class="toc-backref" href="#id24">GetCacheView</a></h1>
<div class="section" id="id5">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y,
const unsigned long columns, const unsigned long rows );</pre>
</div>
<div class="section" id="id6">
<h2>Description</h2>
<p>GetCacheView() gets writeable pixels from the in-memory or disk pixel
cache as defined by the geometry parameters. A pointer to the pixels
is returned if the pixels are transferred, otherwise a NULL is returned.</p>
<p>The format of the GetCacheView method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *GetCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y,
const unsigned long columns, const unsigned long rows );</pre>
<dl class="simple">
<dt>pixels:</dt>
<dd><p>Method GetCacheView returns a null pointer if an error
occurs, otherwise a pointer to the view pixels.</p>
</dd>
<dt>view:</dt>
<dd><p>The address of a structure of type ViewInfo.</p>
</dd>
<dt>x,y,columns,rows:</dt>
<dd><p>These values define the perimeter of a region of
pixels.</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="liberatememory">
<h1><a class="toc-backref" href="#id25">LiberateMemory</a></h1>
<div class="section" id="id7">
<h2>Synopsis</h2>
<pre class="literal-block">void LiberateMemory( void ** memory );</pre>
</div>
<div class="section" id="id8">
<h2>Description</h2>
<p>LiberateMemory() frees memory that has already been allocated, and
NULLs the pointer to it.</p>
<p>The format of the LiberateMemory method is:</p>
<pre class="literal-block">void LiberateMemory( void ** memory );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>memory:</dt>
<dd><p>A pointer to a block of memory to free for reuse.</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="popimagepixels">
<h1><a class="toc-backref" href="#id26">PopImagePixels</a></h1>
<div class="section" id="id9">
<h2>Synopsis</h2>
<pre class="literal-block">unsigned int PopImagePixels( const <a class="reference external" href="../api/types.html#image">Image</a> *, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum,
unsigned char *destination );</pre>
</div>
<div class="section" id="id10">
<h2>Description</h2>
<p>PopImagePixels() transfers one or more pixel components from the image pixel
cache to a user supplied buffer. True is returned if the pixels are
successfully transferred, otherwise False.</p>
<p>The format of the PopImagePixels method is:</p>
<pre class="literal-block">unsigned int PopImagePixels( const <a class="reference external" href="../api/types.html#image">Image</a> *, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum,
unsigned char *destination );</pre>
<dl class="simple">
<dt>status:</dt>
<dd><p>Method PopImagePixels returns True if the pixels are
successfully transferred, otherwise False.</p>
</dd>
<dt>image:</dt>
<dd><p>The image.</p>
</dd>
<dt>quantum:</dt>
<dd><p>Declare which pixel components to transfer (RGB, RGBA, etc).</p>
</dd>
<dt>destination:</dt>
<dd><p>The components are transferred to this buffer.</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="pushimagepixels">
<h1><a class="toc-backref" href="#id27">PushImagePixels</a></h1>
<div class="section" id="id11">
<h2>Synopsis</h2>
<pre class="literal-block">unsigned int PushImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum_type,
const unsigned char *source );</pre>
</div>
<div class="section" id="id12">
<h2>Description</h2>
<p>PushImagePixels() transfers one or more pixel components from a user
supplied buffer into the image pixel cache of an image. It returns True if
the pixels are successfully transferred, otherwise False.</p>
<p>The format of the PushImagePixels method is:</p>
<pre class="literal-block">unsigned int PushImagePixels( <a class="reference external" href="../api/types.html#image">Image</a> *image, const <a class="reference external" href="../api/types.html#quantumtype">QuantumType</a> quantum_type,
const unsigned char *source );</pre>
<dl class="simple">
<dt>status:</dt>
<dd><p>Method PushImagePixels returns True if the pixels are
successfully transferred, otherwise False.</p>
</dd>
<dt>image:</dt>
<dd><p>The image.</p>
</dd>
<dt>quantum_type:</dt>
<dd><p>Declare which pixel components to transfer (red, green,
blue, opacity, RGB, or RGBA).</p>
</dd>
<dt>source:</dt>
<dd><p>The pixel components are transferred from this buffer.</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="reacquirememory">
<h1><a class="toc-backref" href="#id28">ReacquireMemory</a></h1>
<div class="section" id="id13">
<h2>Synopsis</h2>
<pre class="literal-block">void ReacquireMemory( void ** memory, const size_t size );</pre>
</div>
<div class="section" id="id14">
<h2>Description</h2>
<p>ReacquireMemory() changes the size of the memory and returns a
pointer to the (possibly moved) block. The contents will be unchanged
up to the lesser of the new and old sizes.</p>
<p>The format of the ReacquireMemory method is:</p>
<pre class="literal-block">void ReacquireMemory( void ** memory, const size_t size );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>memory:</dt>
<dd><p>A pointer to a memory allocation. On return the pointer
may change but the contents of the original allocation will not.</p>
</dd>
<dt>size:</dt>
<dd><p>The new size of the allocated memory.</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="setcacheview">
<h1><a class="toc-backref" href="#id29">SetCacheView</a></h1>
<div class="section" id="id15">
<h2>Synopsis</h2>
<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y,
const unsigned long columns, const unsigned long rows );</pre>
</div>
<div class="section" id="id16">
<h2>Description</h2>
<p>SetCacheView() gets pixels from the in-memory or disk pixel cache as
defined by the geometry parameters. A pointer to the pixels is returned
if the pixels are transferred, otherwise a NULL is returned.</p>
<p>The format of the SetCacheView method is:</p>
<pre class="literal-block"><a class="reference external" href="../api/types.html#pixelpacket">PixelPacket</a> *SetCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view, const long x, const long y,
const unsigned long columns, const unsigned long rows );</pre>
<dl class="simple">
<dt>view:</dt>
<dd><p>The address of a structure of type ViewInfo.</p>
</dd>
<dt>x,y,columns,rows:</dt>
<dd><p>These values define the perimeter of a region of
pixels.</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="synccacheview">
<h1><a class="toc-backref" href="#id30">SyncCacheView</a></h1>
<div class="section" id="id17">
<h2>Synopsis</h2>
<pre class="literal-block">MagickPassFail SyncCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view );</pre>
</div>
<div class="section" id="id18">
<h2>Description</h2>
<p>SyncCacheView() saves the view pixels to the in-memory or disk cache.
The method returns MagickPass if the pixel region is synced, otherwise
MagickFail.</p>
<p>The format of the SyncCacheView method is:</p>
<pre class="literal-block">MagickPassFail SyncCacheView( <a class="reference external" href="../api/types.html#viewinfo">ViewInfo</a> *view );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>view:</dt>
<dd><p>The address of a structure of type ViewInfo.</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="strip">
<h1><a class="toc-backref" href="#id31">Strip</a></h1>
<div class="section" id="id19">
<h2>Synopsis</h2>
<pre class="literal-block">void Strip( char *message );</pre>
</div>
<div class="section" id="id20">
<h2>Description</h2>
<p>Method Strip strips any whitespace or quotes from the beginning and end of
a string of characters.</p>
<p>The format of the Strip method is:</p>
<pre class="literal-block">void Strip( char *message );</pre>
<p>A description of each parameter follows:</p>
<dl class="simple">
<dt>message:</dt>
<dd><p>Specifies an array of characters.</p>
</dd>
</dl>
</div>
</div>
</div>
<hr class="docutils">
<div class="document">
<p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2023<!--SPONSOR_LOGO--></p>
</div>
</div>
</body>
</html>
|
