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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>cache_view - Working with Cache Views</title>
<link rel="stylesheet" type="text/css" href="../magick.css">
</head>
<body marginheight="1" marginwidth="1" topmargin="1" leftmargin="1">
<a name="top"></a>
<table border="0" cellpadding="0" cellspacing="0" summary="Masthead" width="100%">
<tbody>
<tr>
<td bgcolor="#003399" width="25%" height="118" background="../../images/background.gif"><a href="http://www.imagemagick.org/"><img src="../../images/script.gif" width="278" height="118" border="0" alt="" /></a></td>
<td bgcolor="#003399" width="60%" height="118" background="../../images/background.gif"><a href="http://www.networkeleven.com/direct.php?magick_all"><img src="../../images/promote.png" border="0" width="186" height="52" vspace="29" alt="Powered by NetworkEleven" /></a></td>
<td bgcolor="#003399" width="114" height="118" align="right"><img src="../../images/sprite.png" width="114" height="118" alt="" /></td>
<td bgcolor="#003399" width="114" height="118" align="right"><a href="http://www.imagemagick.net"><img src="../../images/logo.png" width="114" height="118" border="0" alt="ImageMagick logo" /></a></td>
</tr></tbody></table>
<table align="left" border="0" cellpadding="2" cellspacing="2" summary="Navigation buttons" width="20%">
<tr>
<td>
<form target="_self" action="../../index.html"><input type="submit" title="ImageMagick Home" value=" Home" style="background-color: #1947A3; background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold"></form></td>
<td>
<form target="_self" action="../../www/apis.html"><input type="submit" title="ImageMagick API" value=" API " style="background-color: #1947A3; background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold"></form></td>
<td>
<form target="_self" action="../../www/archives.html"><input type="submit" title="ImageMagick Download" value="Download" style="background-color: #1947A3; background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold"></form></td></tr></table>
<div align="right" style="margin-top:3px; padding-right:4px">
<form action="http://studio.imagemagick.org/Sage/scripts/Sage.cgi"><input type="TEXT" name="query" size="32" maxlength="255"> <input type="SUBMIT" name="sa" value="Search" style="background-color: #1947A3; background-image:url('../../../images/background.gif'); bgcolor:#003399; color:#fbc713; font-weight:bold"></form></div>
<table align="left" border="0" cellpadding="10" cellspacing="0" style="margin-top:-17px" width="100%">
<tr>
<td>
<P><a name="__index__"></a></P>
<!-- INDEX BEGIN -->
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#function_descriptions">FUNCTION DESCRIPTIONS</a></li>
<ul>
<li><a href="#acquirecacheview">AcquireCacheView</a></li>
<li><a href="#closecacheview">CloseCacheView</a></li>
<li><a href="#getcacheview">GetCacheView</a></li>
<li><a href="#getcacheviewindexes">GetCacheViewIndexes</a></li>
<li><a href="#getcacheviewpixels">GetCacheViewPixels</a></li>
<li><a href="#opencacheview">OpenCacheView</a></li>
<li><a href="#setcacheview">SetCacheView</a></li>
<li><a href="#synccacheview">SyncCacheView</a></li>
</ul>
</ul>
<!-- INDEX END -->
<hr />
<P>
</P>
<h1><a name="name">NAME</a></h1>
<P>cache_view - Working with Cache Views</P>
<P>
</P>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<P>const PixelPacket * <strong>AcquireCacheView</strong>( const ViewInfo *view_info, const long x, const long y, const unsigned long columns, const unsigned long rows, ExceptionInfo *exception );</P>
<P>void <strong>CloseCacheView</strong>( ViewInfo *view_info );</P>
<P>PixelPacket * <strong>GetCacheView</strong>( ViewInfo *view_info, const long x, const long y, const unsigned long columns, const unsigned long rows );</P>
<P>IndexPacket * <strong>GetCacheViewIndexes</strong>( const ViewInfo *view_info );</P>
<P>PixelPacket * <strong>GetCacheViewPixels</strong>( const ViewInfo *view_info );</P>
<P>ViewInfo * <strong>OpenCacheView</strong>( Image *image );</P>
<P>PixelPacket * <strong>SetCacheView</strong>( ViewInfo *view_info, const long x, const long y, const unsigned long columns, const unsigned long rows );</P>
<P>MagickBooleanType <strong>SyncCacheView</strong>( ViewInfo *view_info );</P>
<P>
</P>
<hr />
<h1><a name="function_descriptions">FUNCTION DESCRIPTIONS</a></h1>
<P>
</P>
<h2><a name="acquirecacheview">AcquireCacheView</a></h2>
<blockquote>AcquireCacheView() 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. </blockquote><P>The format of the AcquireCacheView method is:</P>
<blockquote>const <A HREF="types.html#PixelPacket">PixelPacket</A> *AcquireCacheView ( const <A HREF="types.html#ViewInfo">ViewInfo</A> *view_info, const long x, const long y, const unsigned long columns, const unsigned long rows, <A HREF="types.html#ExceptionInfo">ExceptionInfo</A> *exception ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong><a name="item_o_view_info_3a">view_info:</a></strong><br />
</dt>
<DD>
The address of a structure of type ViewInfo.
</dd>
<P></P>
<dt><strong><a name="item_o_x_2cy_2ccolumns_2crows_3a">x,y,columns,rows:</a></strong><br />
</dt>
<DD>
These values define the perimeter of a region of pixels.
</dd>
<P></P>
<dt><strong><a name="item_o_exception_3a">exception:</a></strong><br />
</dt>
<DD>
Return any errors or warnings in this structure.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="closecacheview">CloseCacheView</a></h2>
<blockquote>CloseCacheView() closes the specified view returned by a previous call to OpenCacheView ( ) . </blockquote><P>The format of the CloseCacheView method is:</P>
<blockquote>void CloseCacheView ( <A HREF="types.html#ViewInfo">ViewInfo</A> *view_info ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>view_info:</strong><br />
</dt>
<DD>
The address of a structure of type ViewInfo.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getcacheview">GetCacheView</a></h2>
<blockquote>GetCacheView() 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. </blockquote><P>The format of the GetCacheView method is:</P>
<blockquote><A HREF="types.html#PixelPacket">PixelPacket</A> *GetCacheView ( <A HREF="types.html#ViewInfo">ViewInfo</A> *view_info, const long x, const long y, const unsigned long columns, const unsigned long rows ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong><a name="item_o_pixels_3a">pixels:</a></strong><br />
</dt>
<DD>
Method GetCacheView returns a null pointer if an error occurs, otherwise a pointer to the view_info pixels.
</dd>
<P></P>
<dt><strong>view_info:</strong><br />
</dt>
<DD>
The address of a structure of type ViewInfo.
</dd>
<P></P>
<dt><strong>x,y,columns,rows:</strong><br />
</dt>
<DD>
These values define the perimeter of a region of pixels.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getcacheviewindexes">GetCacheViewIndexes</a></h2>
<blockquote>GetCacheViewIndexes() returns the indexes associated with the specified view. </blockquote><P>The format of the GetCacheViewIndexes method is:</P>
<blockquote>IndexPacket *GetCacheViewIndexes ( const <A HREF="types.html#ViewInfo">ViewInfo</A> *view_info ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>view_info:</strong><br />
</dt>
<DD>
The address of a structure of type ViewInfo.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="getcacheviewpixels">GetCacheViewPixels</a></h2>
<blockquote>GetCacheViewPixels() returns the pixels associated with the specified view. </blockquote><P>The format of the GetCacheViewPixels method is:</P>
<blockquote><A HREF="types.html#PixelPacket">PixelPacket</A> *GetCacheViewPixels ( const <A HREF="types.html#ViewInfo">ViewInfo</A> *view_info ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>view_info:</strong><br />
</dt>
<DD>
The address of a structure of type ViewInfo.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="opencacheview">OpenCacheView</a></h2>
<blockquote>OpenCacheView() opens a view into the pixel cache. </blockquote><P>The format of the OpenCacheView method is:</P>
<blockquote><A HREF="types.html#ViewInfo">ViewInfo</A> *OpenCacheView ( <A HREF="types.html#Image">Image</A> *image ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong><a name="item_o_image_3a">image:</a></strong><br />
</dt>
<DD>
The image.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="setcacheview">SetCacheView</a></h2>
<blockquote>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. </blockquote><P>The format of the SetCacheView method is:</P>
<blockquote><A HREF="types.html#PixelPacket">PixelPacket</A> *SetCacheView ( <A HREF="types.html#ViewInfo">ViewInfo</A> *view_info, const long x, const long y, const unsigned long columns, const unsigned long rows ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>view_info:</strong><br />
</dt>
<DD>
The address of a structure of type ViewInfo.
</dd>
<P></P>
<dt><strong>x,y,columns,rows:</strong><br />
</dt>
<DD>
These values define the perimeter of a region of pixels.
</dd>
<P></P></dl>
<P>
</P>
<h2><a name="synccacheview">SyncCacheView</a></h2>
<blockquote>SyncCacheView() saves the view_info pixels to the in-memory or disk cache. The method returns MagickTrue if the pixel region is synced, otherwise MagickFalse. </blockquote><P>The format of the SyncCacheView method is:</P>
<blockquote>MagickBooleanType SyncCacheView ( <A HREF="types.html#ViewInfo">ViewInfo</A> *view_info ); </blockquote><P>A description of each parameter follows:</P>
<dl>
<dt><strong>view_info:</strong><br />
</dt>
<DD>
The address of a structure of type ViewInfo.
</dd>
</dl>
<HR>
<a href="#top"><img src="../../../images/top.gif" border=0 width=42 height=42 align="right" alt="Top of page"></a>
<form action="http://studio.imagemagick.org/magick/" style="margin-top:5px">
<input type="submit" title="Help!" value="Help!" style="background-image:url('../../../images/background.gif'); color:#fbc713; font-weight:bold">
<small>"Image manipulation software that works like magick"</small>
</form></td>
</tr></table>
</body>
</html>
|
