File: attribute.html

package info (click to toggle)
imagemagick 7%3A6.2.4.5.dfsg1-0.14
  • links: PTS
  • area: main
  • in suites: etch-m68k
  • size: 29,968 kB
  • ctags: 13,698
  • sloc: ansic: 202,519; cpp: 17,315; sh: 10,363; xml: 5,523; perl: 4,486; makefile: 3,148; tcl: 459
file content (322 lines) | stat: -rw-r--r-- 12,063 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <style type="text/css"><!--
    @import url("../../www/magick.css");
  //--></style>
  <title>ImageMagick: MagickCore, C API for ImageMagick: Set Text Attributes</title>
  <meta http-equiv="Content-Language" content="en-US" />
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
  <meta http-equiv="Reply-to" content="magick-users@imagemagick.org" />
  <meta name="Generator" content="PHP" />
  <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, set, text, attributes, ImageMagick, PerlMagick, Magick++, Image, Magick" />
  <meta name="Description" content="ImageMagick (TM) is a free software suite to create, edit and compose bitmap images. It can read, convert and write images in a large variety of formats. Images can be cropped, colors can be changed, various effects can be applied, images can be rotated and combined, and text, lines, polygons, ellipses and Bézier curves can be added to images and stretched and rotated.  ImageMagick is free software: it is delivered with full source code and can be freely used, copied, modified and distributed. Its license is compatible with the GPL. It runs on all major operating systems.  Most of the functionality of ImageMagick can be used interactively from the command line; more often, however, the features are used from programs written in the programming languages Perl, C, C++, Python, PHP, Ruby or Java, for which ready-made ImageMagick interfaces (PerlMagick, Magick++, PythonMagick, MagickWand for PHP, RubyMagick, and JMagick) are available. This makes it possible to modify or create images automatically and dynamically.  ImageMagick supports many image formats (over 90 major formats) including popular formats like TIFF, JPEG, PNG, PDF, PhotoCD, and GIF." />
  <meta name="Rating" content="GENERAL" />
  <meta name="Robots" content="ALL" />
  <meta name="Generator" content="ImageMagick Studio LLC" />
  <meta name="Author" content="ImageMagick Studio LLC" />
  <meta name="Revisit-after" content="2 DAYS" />
  <meta name="Resource-type" content="document" />
  <meta name="Copyright" content="Copyright (c) 1999-2005 ImageMagick Studio LLC" />
  <meta name="Distribution" content="Global" />
  <link rel="shortcut icon" href="/../images/wand.ico"  type="image/x-icon" />
</head>

<body id="www-imagemagick-org">
  <table width="100%" id="titlebar" bgcolor="#f5f5f5" cellpadding="0" cellspacing="0" border="0" summary="ImageMagick">
    <tbody>
      <tr valign="top">
        <td align="left"><a href="../../index.html"><img id="titlebar-west" src="../../images/script.png" alt="[ImageMagick]" width="202" height="118" border="0" name="titlebar-west" /></a></td>
        <td width="35%"><br /></td>
        <td align="left"><a href="http://www.imagemagick.org/" target="1144187883"><img id="titlebar-west" src="../../images/sponsor.jpg" alt="[sponsor]" border="0" vspace="28" name="titlebar-west" /></a></td>
        <td width="65%"><br /></td>
        <td bgcolor="white" align="right"><a href="../../index.html"><img src="../../images/sprite.jpg" alt="" width="114" height="118" border="0" name="titlebar-east" /></a></td>
        <td bgcolor="white" align="right"><a href="../../index.html"><img id="titlebar-east" src="../../images/logo.jpg" alt="" width="114" height="118" border="0" name="titlebar-east" /></a></td>
      </tr>
    </tbody>
  </table>

  <table width="100%" border="0" cellpadding="0" cellspacing="0" summary="">
  <tbody>

    <tr valign="top" style="height: 100%;">
      <td id="menu" width="1%" height="100%">
      <p><a href="#main">Skip to page contents</a></p>
      <span>[</span>
      <a href="../../index.html">About ImageMagick</a>
      <a href="../../www/command-line-tools.html">Command-line Tools</a>
      <a href="../../www/api.html">Program Interfaces</a>
  <span>]</span><br /><span>[</span>
      <a href="../../www/install-source.html">Install from Source</a>
      <a href="../../www/binary-releases.html">Binary Releases</a>
      <a href="../../www/resources.html">Resources</a>
  <span>]</span><br /><span>[</span>
      <a href="../../www/download.html">Download</a>
  <span>]</span><br /><span>[</span>
      <a href="../../www/links.html">Links</a>
  <span>]</span><br /><br /><span>[</span>
      <a href="../../www/sponsors.html">Sponsors</a>
  <a href="http://www.thebest3d.com/dogwaffle" class="sponsor" target="sponsor">Project Dogwaffle digital<br /> image paint and<br />animation software</a><!-- 20050520 -->
      <span>]</span>
      </td>

      <td id="main" valign="top">
<p class="navigation-index">[ <a href="#CloneImageAttributes">CloneImageAttributes</a> | <a href="#DeleteImageAttribute">DeleteImageAttribute</a> | <a href="#DestroyImageAttributes">DestroyImageAttributes</a> | <a href="#FormatImageAttribute">FormatImageAttribute</a> | <a href="#GetImageAttribute">GetImageAttribute</a> | <a href="#GetImageClippingPathAttribute">GetImageClippingPathAttribute</a> | <a href="#GetNextImageAttribute">GetNextImageAttribute</a> | <a href="#ResetImageAttributeIterator">ResetImageAttributeIterator</a> | <a href="#SetImageAttribute">SetImageAttribute</a> | <a href="#TracePSClipPath">TracePSClipPath</a> | <a href="#TraceSVGClipPath">TraceSVGClipPath</a> ]</p>

<div style="margin: auto;">
  <h2><a name="CloneImageAttributes">CloneImageAttributes</a></h2>
</div>

<p>CloneImageAttributes() clones one or more image attributes.</p>

<p>The format of the CloneImageAttributes method is:</p>

<pre class="code">
  MagickBooleanType CloneImageAttributes(Image *image,
    const Image *clone_image)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image.</p>

<h4>clone_image</h4>
<p>The clone image.</p>

<div style="margin: auto;">
  <h2><a name="DeleteImageAttribute">DeleteImageAttribute</a></h2>
</div>

<p>DeleteImageAttribute() deletes an attribute from the image.</p>

<p>The format of the DeleteImageAttribute method is:</p>

<pre class="code">
  MagickBooleanType DeleteImageAttribute(Image *image,const char *key)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image info.</p>

<h4>key</h4>
<p>The image key.</p>

<div style="margin: auto;">
  <h2><a name="DestroyImageAttributes">DestroyImageAttributes</a></h2>
</div>

<p>DestroyImageAttributes() deallocates memory associated with the image attribute list.</p>

<p>The format of the DestroyImageAttributes method is:</p>

<pre class="code">
  DestroyImageAttributes(Image *image)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image.</p>

<div style="margin: auto;">
  <h2><a name="FormatImageAttribute">FormatImageAttribute</a></h2>
</div>

<p>FormatImageAttribute() permits formatted key/value pairs to be saved as an image attribute.</p>

<p>The format of the FormatImageAttribute method is:</p>

<pre class="code">
  MagickBooleanType FormatImageAttribute(Image *image,const char *key,
    const char *format,...)
</pre>

<p>A description of each parameter follows.</p>

<h4> image</h4>
<p>The image.</p>

<h4> key</h4>
<p>The attribute key.</p>

<h4> format</h4>
<p>A string describing the format to use to write the remaining arguments.</p>

<div style="margin: auto;">
  <h2><a name="GetImageAttribute">GetImageAttribute</a></h2>
</div>

<p>GetImageAttribute() searches the list of image attributes and returns a pointer to the attribute if it exists otherwise NULL.</p>

<p>The format of the GetImageAttribute method is:</p>

<pre class="code">
  const ImageAttribute *GetImageAttribute(const Image *image,
    const char *key)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image.</p>

<h4>key</h4>
<p>These character strings are the name of an image attribute to return.</p>


<div style="margin: auto;">
  <h2><a name="GetImageClippingPathAttribute">GetImageClippingPathAttribute</a></h2>
</div>

<p>GetImageClippingPathAttribute() searches the list of image attributes and returns a pointer to a clipping path if it exists otherwise NULL.</p>

<p>The format of the GetImageClippingPathAttribute method is:</p>

<pre class="code">
  const ImageAttribute *GetImageClippingPathAttribute(Image *image)
</pre>

<p>A description of each parameter follows:</p>

<h4>attribute</h4>
<p>Method GetImageClippingPathAttribute returns the clipping path if it exists otherwise NULL.</p>

<h4>image</h4>
<p>The image.</p>


<div style="margin: auto;">
  <h2><a name="GetNextImageAttribute">GetNextImageAttribute</a></h2>
</div>

<p>GetNextImageAttribute() gets the next image attribute.</p>

<p>The format of the GetNextImageAttribute method is:</p>

<pre class="code">
  const ImageAttribute *GetNextImageAttribute(const Image *image)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image.</p>

<div style="margin: auto;">
  <h2><a name="ResetImageAttributeIterator">ResetImageAttributeIterator</a></h2>
</div>

<p>ResetImageAttributeIterator() resets the image attributes iterator.  Use it in conjunction with GetNextImageAttribute() to iterate over all the values associated with an image.</p>

<p>The format of the ResetImageAttributeIterator method is:</p>

<pre class="code">
  ResetImageAttributeIterator(const ImageInfo *image)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image.</p>

<div style="margin: auto;">
  <h2><a name="SetImageAttribute">SetImageAttribute</a></h2>
</div>

<p>SetImageAttribute() searches the list of image attributes and replaces the attribute value.  If it is not found in the list, the attribute name and value is added to the list.   </p>

<p>The format of the SetImageAttribute method is:</p>

<pre class="code">
   MagickBooleanType SetImageAttribute(Image *image,const char *key,
     const char *value)
</pre>

<p>A description of each parameter follows:</p>

<h4>image</h4>
<p>The image.</p>

<h4>key</h4>
<p>The key.</p>

<h4>value</h4>
<p>The value.</p>

<div style="margin: auto;">
  <h2><a name="TracePSClipPath">TracePSClipPath</a></h2>
</div>

<p>TracePSClipPath() traces a clip path and returns it as Postscript.</p>

<p>The format of the TracePSClipPath method is:</p>

<pre class="code">
  char *TracePSClipPath(unsigned char *blob,size_t length,
    const unsigned long columns,const unsigned long rows)
</pre>

<p>A description of each parameter follows:</p>

<h4>blob</h4>
<p>The blob.</p>

<h4>length</h4>
<p>The length of the blob.</p>

<h4>columns</h4>
<p>The image width.</p>

<h4>rows</h4>
<p>The image height.</p>


<div style="margin: auto;">
  <h2><a name="TraceSVGClipPath">TraceSVGClipPath</a></h2>
</div>

<p>TraceSVGClipPath() traces a clip path and returns it as SVG.</p>

<p>The format of the TraceSVGClipPath method is:</p>

<pre class="code">
  char *TraceSVGClipPath(unsigned char *blob,size_t length,
    const unsigned long columns,const unsigned long rows)
</pre>

<p>A description of each parameter follows:</p>

<h4>blob</h4>
<p>The blob.</p>

<h4>length</h4>
<p>The length of the blob.</p>

<h4>columns</h4>
<p>The image width.</p>

<h4>rows</h4>
<p>The image height.</p>


      </td>
      <td id="margin" width="1%" height="100%" valign="top" align="right">&nbsp;</td>
    </tr>
  </tbody>
  </table>
  <div id="linkbar">
    <a href="http://redux.imagemagick.org/discussion-server" target="1194924617">Discourse Server</a> |
    <a href="../../www/mailing-list.html">Mailing Lists</a> |
    <a href="http://redux.imagemagick.org/gallery" target="1376323415">Image Gallery</a> |
    <a href="http://redux.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi" target="1077365451">ImageMagick Studio</a>
  </div>
  <div>
    <span id="footer-west">&copy; 1999-2005 ImageMagick Studio LLC</span>
  </div>
  <div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>