1 2 3 4 5<!doctype html> 6<html lang="en"> 7<head> 8 <meta charset="utf-8" /> 9 <meta name="viewport" content="width=device-width, initial-scale=1" /> 10 <title>ImageMagick - MagickWand, C API: Property Methods</title> 11 <meta name="application-name" content="ImageMagick" /> 12 <meta name="description" content="Use ImageMagick® to create, edit, compose, and convert digital images. Resize an image, crop it, change its shades and colors, add captions, and more." /> 13 <meta name="application-url" content="https://imagemagick.org" /> 14 <meta name="generator" content="PHP" /> 15 <meta name="keywords" content="magickwc, api:, property, methods, image processing software" /> 16 <meta name="rating" content="GENERAL" /> 17 <meta name="robots" content="INDEX, FOLLOW" /> 18 <meta name="generator" content="ImageMagick Studio LLC" /> 19 <meta name="author" content="ImageMagick Studio LLC" /> 20 <meta name="revisit-after" content="2 DAYS" /> 21 <meta name="resource-type" content="document" /> 22 <meta name="copyright" content="Copyright (c) 1999-2020 ImageMagick Studio LLC" /> 23 <meta name="distribution" content="Global" /> 24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" /> 25 <meta property='og:url' content='../../' /> 26 <meta property='og:title' content='ImageMagick' /> 27 <meta property='og:image' content='../../../images/logo.png' /> 28 <meta property='og:type' content='website' /> 29 <meta property='og:site_name' content='ImageMagick' /> 30 <meta property='og:description' content="Create, Edit, Compose, or Convert Digital Images" /> 31 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" /> 32 <link href="magick-property.html" rel="canonical" /> 33 <link href="../../../images/wand.png" rel="icon" /> 34 <link href="../../../images/wand.ico" rel="shortcut icon" /> 35 <link href="../../assets/magick.css" rel="stylesheet" /> 36</head> 37<body> 38 <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top"> 39 <div class="container-fluid"> 40 <a class="navbar-brand" href="../../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../../images/wand.ico"/></a> 41 <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation"> 42 <span class="navbar-toggler-icon"></span> 43 </button> 44 45 <div class="collapse navbar-collapse" id="magick-navbars"> 46 <ul class="navbar-nav me-auto mb-2 mb-md-0"> 47 <li class="nav-item"> 48 <a class="nav-link " href="../../www/index.html">Home</a> 49 </li> 50 <li class="nav-item"> 51 <a class="nav-link " href="../../www/download.html">Download</a> 52 </li> 53 <li class="nav-item"> 54 <a class="nav-link " href="../../www/command-line-tools.html">Tools</a> 55 </li> 56 <li class="nav-item"> 57 <a class="nav-link " href="../../www/command-line-processing.html">CLI</a> 58 </li> 59 <li class="nav-item"> 60 <a class="nav-link " href="../../www/develop.html">Develop</a> 61 </li> 62 <li class="nav-item"> 63 <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a> 64 </li> 65 <li class="nav-item"> 66 <iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe> 67 </li> 68 </ul> 69 <form class="d-flex form-inline" action="https://imagemagick.org/script/search.php"> 70 <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search"> 71 <button class="btn btn-outline-success" type="submit" name="sa">Search</button> 72 </form> 73 </div> 74 </div> 75 </nav> 76 77 <div class="container"> 78 <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script> 79 <ins class="adsbygoogle" 80 style="display:block" 81 data-ad-client="ca-pub-3129977114552745" 82 data-ad-slot="6345125851" 83 data-full-width-responsive="true" 84 data-ad-format="horizontal"></ins> 85 <script> 86 (adsbygoogle = window.adsbygoogle || []).push({}); 87 </script> 88 89 </div> 90 91 <main class="container"> 92 <div class="magick-template"> 93<div class="magick-header"> 94<p class="text-center"><a href="magick-property.html#MagickDeleteImageArtifact">MagickDeleteImageArtifact</a> • <a href="magick-property.html#MagickDeleteImageProperty">MagickDeleteImageProperty</a> • <a href="magick-property.html#MagickDeleteOption">MagickDeleteOption</a> • <a href="magick-property.html#MagickGetAntialias">MagickGetAntialias</a> • <a href="magick-property.html#MagickGetBackgroundColor">MagickGetBackgroundColor</a> • <a href="magick-property.html#MagickGetColorspace">MagickGetColorspace</a> • <a href="magick-property.html#MagickGetCompression">MagickGetCompression</a> • <a href="magick-property.html#MagickGetCompressionQuality">MagickGetCompressionQuality</a> • <a href="magick-property.html#MagickGetCopyright">MagickGetCopyright</a> • <a href="magick-property.html#MagickGetFilename">MagickGetFilename</a> • <a href="magick-property.html#MagickGetFont">MagickGetFont</a> • <a href="magick-property.html#MagickGetFormat">MagickGetFormat</a> • <a href="magick-property.html#MagickGetGravity">MagickGetGravity</a> • <a href="magick-property.html#MagickGetHomeURL">MagickGetHomeURL</a> • <a href="magick-property.html#MagickGetImageArtifact">MagickGetImageArtifact</a> • <a href="magick-property.html#MagickGetImageArtifacts">MagickGetImageArtifacts</a> • <a href="magick-property.html#MagickGetImageProfile">MagickGetImageProfile</a> • <a href="magick-property.html#MagickGetImageProfiles">MagickGetImageProfiles</a> • <a href="magick-property.html#MagickGetImageProperty">MagickGetImageProperty</a> • <a href="magick-property.html#MagickGetImageProperties">MagickGetImageProperties</a> • <a href="magick-property.html#MagickGetInterlaceScheme">MagickGetInterlaceScheme</a> • <a href="magick-property.html#MagickGetInterpolateMethod">MagickGetInterpolateMethod</a> • <a href="magick-property.html#MagickGetOption">MagickGetOption</a> • <a href="magick-property.html#MagickGetOptions">MagickGetOptions</a> • <a href="magick-property.html#MagickGetOrientation">MagickGetOrientation</a> • <a href="magick-property.html#MagickGetPackageName">MagickGetPackageName</a> • <a href="magick-property.html#MagickGetPage">MagickGetPage</a> • <a href="magick-property.html#MagickGetPointsize">MagickGetPointsize</a> • <a href="magick-property.html#MagickGetQuantumDepth">MagickGetQuantumDepth</a> • <a href="magick-property.html#MagickGetQuantumRange">MagickGetQuantumRange</a> • <a href="magick-property.html#MagickGetReleaseDate">MagickGetReleaseDate</a> • <a href="magick-property.html#MagickGetResolution">MagickGetResolution</a> • <a href="magick-property.html#MagickGetResource">MagickGetResource</a> • <a href="magick-property.html#MagickGetResourceLimit">MagickGetResourceLimit</a> • <a href="magick-property.html#MagickGetSamplingFactors">MagickGetSamplingFactors</a> • <a href="magick-property.html#MagickGetSize">MagickGetSize</a> • <a href="magick-property.html#MagickGetSizeOffset">MagickGetSizeOffset</a> • <a href="magick-property.html#MagickGetType">MagickGetType</a> • <a href="magick-property.html#MagickGetVersion">MagickGetVersion</a> • <a href="magick-property.html#MagickProfileImage">MagickProfileImage</a> • <a href="magick-property.html#MagickRemoveImageProfile">MagickRemoveImageProfile</a> • <a href="magick-property.html#MagickSetAntialias">MagickSetAntialias</a> • <a href="magick-property.html#MagickSetBackgroundColor">MagickSetBackgroundColor</a> • <a href="magick-property.html#MagickSetColorspace">MagickSetColorspace</a> • <a href="magick-property.html#MagickSetCompression">MagickSetCompression</a> • <a href="magick-property.html#MagickSetCompressionQuality">MagickSetCompressionQuality</a> • <a href="magick-property.html#MagickSetDepth">MagickSetDepth</a> • <a href="magick-property.html#MagickSetExtract">MagickSetExtract</a> • <a href="magick-property.html#MagickSetFilename">MagickSetFilename</a> • <a href="magick-property.html#MagickSetFont">MagickSetFont</a> • <a href="magick-property.html#MagickSetFormat">MagickSetFormat</a> • <a href="magick-property.html#MagickSetGravity">MagickSetGravity</a> • <a href="magick-property.html#MagickSetImageArtifact">MagickSetImageArtifact</a> • <a href="magick-property.html#MagickSetImageProfile">MagickSetImageProfile</a> • <a href="magick-property.html#MagickSetImageProperty">MagickSetImageProperty</a> • <a href="magick-property.html#MagickSetInterlaceScheme">MagickSetInterlaceScheme</a> • <a href="magick-property.html#MagickSetInterpolateMethod">MagickSetInterpolateMethod</a> • <a href="magick-property.html#MagickSetOption">MagickSetOption</a> • <a href="magick-property.html#MagickSetOrientation">MagickSetOrientation</a> • <a href="magick-property.html#MagickSetPage">MagickSetPage</a> • <a href="magick-property.html#MagickSetPassphrase">MagickSetPassphrase</a> • <a href="magick-property.html#MagickSetPointsize">MagickSetPointsize</a> • <a href="magick-property.html#MagickSetProgressMonitor">MagickSetProgressMonitor</a> • <a href="magick-property.html#MagickSetResourceLimit">MagickSetResourceLimit</a> • <a href="magick-property.html#MagickSetResolution">MagickSetResolution</a> • <a href="magick-property.html#MagickSetSamplingFactors">MagickSetSamplingFactors</a> • <a href="magick-property.html#MagickSetSeed">MagickSetSeed</a> • <a href="magick-property.html#MagickSetSecurityPolicy">MagickSetSecurityPolicy</a> • <a href="magick-property.html#MagickSetSize">MagickSetSize</a> • <a href="magick-property.html#MagickSetSizeOffset">MagickSetSizeOffset</a> • <a href="magick-property.html#MagickSetType">MagickSetType</a></p> 95 96<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickDeleteImageArtifact">MagickDeleteImageArtifact</a></h2> 97 98<p>MagickDeleteImageArtifact() deletes a wand artifact.</p> 99 100<p>The format of the MagickDeleteImageArtifact method is:</p> 101 102<pre class="text"> 103MagickBooleanType MagickDeleteImageArtifact(MagickWand *wand, 104 const char *artifact) 105</pre> 106 107<p>A description of each parameter follows:</p> 108 109<dd> 110</dd> 111 112<dd> </dd> 113<dl class="dl-horizontal"> 114<dt>image</dt> 115<dd>the image. </dd> 116 117<dd> </dd> 118<dt>artifact</dt> 119<dd>the image artifact. </dd> 120 121<dd> </dd> 122</dl> 123<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickDeleteImageProperty">MagickDeleteImageProperty</a></h2> 124 125<p>MagickDeleteImageProperty() deletes a wand property.</p> 126 127<p>The format of the MagickDeleteImageProperty method is:</p> 128 129<pre class="text"> 130MagickBooleanType MagickDeleteImageProperty(MagickWand *wand, 131 const char *property) 132</pre> 133 134<p>A description of each parameter follows:</p> 135 136<dd> 137</dd> 138 139<dd> </dd> 140<dl class="dl-horizontal"> 141<dt>image</dt> 142<dd>the image. </dd> 143 144<dd> </dd> 145<dt>property</dt> 146<dd>the image property. </dd> 147 148<dd> </dd> 149</dl> 150<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickDeleteOption">MagickDeleteOption</a></h2> 151 152<p>MagickDeleteOption() deletes a wand option.</p> 153 154<p>The format of the MagickDeleteOption method is:</p> 155 156<pre class="text"> 157MagickBooleanType MagickDeleteOption(MagickWand *wand, 158 const char *option) 159</pre> 160 161<p>A description of each parameter follows:</p> 162 163<dd> 164</dd> 165 166<dd> </dd> 167<dl class="dl-horizontal"> 168<dt>image</dt> 169<dd>the image. </dd> 170 171<dd> </dd> 172<dt>option</dt> 173<dd>the image option. </dd> 174 175<dd> </dd> 176</dl> 177<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetAntialias">MagickGetAntialias</a></h2> 178 179<p>MagickGetAntialias() returns the antialias property associated with the wand.</p> 180 181<p>The format of the MagickGetAntialias method is:</p> 182 183<pre class="text"> 184MagickBooleanType MagickGetAntialias(const MagickWand *wand) 185</pre> 186 187<p>A description of each parameter follows:</p> 188 189<dd> 190</dd> 191 192<dd> </dd> 193<dl class="dl-horizontal"> 194<dt>wand</dt> 195<dd>the magick wand. </dd> 196 197<dd> </dd> 198</dl> 199<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetBackgroundColor">MagickGetBackgroundColor</a></h2> 200 201<p>MagickGetBackgroundColor() returns the wand background color.</p> 202 203<p>The format of the MagickGetBackgroundColor method is:</p> 204 205<pre class="text"> 206PixelWand *MagickGetBackgroundColor(MagickWand *wand) 207</pre> 208 209<p>A description of each parameter follows:</p> 210 211<dd> 212</dd> 213 214<dd> </dd> 215<dl class="dl-horizontal"> 216<dt>wand</dt> 217<dd>the magick wand. </dd> 218 219<dd> </dd> 220</dl> 221<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetColorspace">MagickGetColorspace</a></h2> 222 223<p>MagickGetColorspace() gets the wand colorspace type.</p> 224 225<p>The format of the MagickGetColorspace method is:</p> 226 227<pre class="text"> 228ColorspaceType MagickGetColorspace(MagickWand *wand) 229</pre> 230 231<p>A description of each parameter follows:</p> 232 233<dd> 234</dd> 235 236<dd> </dd> 237<dl class="dl-horizontal"> 238<dt>wand</dt> 239<dd>the magick wand. </dd> 240 241<dd> </dd> 242</dl> 243<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetCompression">MagickGetCompression</a></h2> 244 245<p>MagickGetCompression() gets the wand compression type.</p> 246 247<p>The format of the MagickGetCompression method is:</p> 248 249<pre class="text"> 250CompressionType MagickGetCompression(MagickWand *wand) 251</pre> 252 253<p>A description of each parameter follows:</p> 254 255<dd> 256</dd> 257 258<dd> </dd> 259<dl class="dl-horizontal"> 260<dt>wand</dt> 261<dd>the magick wand. </dd> 262 263<dd> </dd> 264</dl> 265<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetCompressionQuality">MagickGetCompressionQuality</a></h2> 266 267<p>MagickGetCompressionQuality() gets the wand compression quality.</p> 268 269<p>The format of the MagickGetCompressionQuality method is:</p> 270 271<pre class="text"> 272size_t MagickGetCompressionQuality(MagickWand *wand) 273</pre> 274 275<p>A description of each parameter follows:</p> 276 277<dd> 278</dd> 279 280<dd> </dd> 281<dl class="dl-horizontal"> 282<dt>wand</dt> 283<dd>the magick wand. </dd> 284 285<dd> </dd> 286</dl> 287<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetCopyright">MagickGetCopyright</a></h2> 288 289<p>MagickGetCopyright() returns the ImageMagick API copyright as a string constant.</p> 290 291<p>The format of the MagickGetCopyright method is:</p> 292 293<pre class="text"> 294const char *MagickGetCopyright(void) 295</pre> 296 297<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetFilename">MagickGetFilename</a></h2> 298 299<p>MagickGetFilename() returns the filename associated with an image sequence.</p> 300 301<p>The format of the MagickGetFilename method is:</p> 302 303<pre class="text"> 304const char *MagickGetFilename(const MagickWand *wand) 305</pre> 306 307<p>A description of each parameter follows:</p> 308 309<dd> 310</dd> 311 312<dd> </dd> 313<dl class="dl-horizontal"> 314<dt>wand</dt> 315<dd>the magick wand. </dd> 316 317<dd> </dd> 318</dl> 319<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetFont">MagickGetFont</a></h2> 320 321<p>MagickGetFont() returns the font associated with the MagickWand.</p> 322 323<p>The format of the MagickGetFont method is:</p> 324 325<pre class="text"> 326char *MagickGetFont(MagickWand *wand) 327</pre> 328 329<p>A description of each parameter follows:</p> 330 331<dd> 332</dd> 333 334<dd> </dd> 335<dl class="dl-horizontal"> 336<dt>wand</dt> 337<dd>the magick wand. </dd> 338 339<dd> </dd> 340</dl> 341<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetFormat">MagickGetFormat</a></h2> 342 343<p>MagickGetFormat() returns the format of the magick wand.</p> 344 345<p>The format of the MagickGetFormat method is:</p> 346 347<pre class="text"> 348const char MagickGetFormat(MagickWand *wand) 349</pre> 350 351<p>A description of each parameter follows:</p> 352 353<dd> 354</dd> 355 356<dd> </dd> 357<dl class="dl-horizontal"> 358<dt>wand</dt> 359<dd>the magick wand. </dd> 360 361<dd> </dd> 362</dl> 363<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetGravity">MagickGetGravity</a></h2> 364 365<p>MagickGetGravity() gets the wand gravity.</p> 366 367<p>The format of the MagickGetGravity method is:</p> 368 369<pre class="text"> 370GravityType MagickGetGravity(MagickWand *wand) 371</pre> 372 373<p>A description of each parameter follows:</p> 374 375<dd> 376</dd> 377 378<dd> </dd> 379<dl class="dl-horizontal"> 380<dt>wand</dt> 381<dd>the magick wand. </dd> 382 383<dd> </dd> 384</dl> 385<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetHomeURL">MagickGetHomeURL</a></h2> 386 387<p>MagickGetHomeURL() returns the ImageMagick home URL.</p> 388 389<p>The format of the MagickGetHomeURL method is:</p> 390 391<pre class="text"> 392char *MagickGetHomeURL(void) 393</pre> 394 395<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetImageArtifact">MagickGetImageArtifact</a></h2> 396 397<p>MagickGetImageArtifact() returns a value associated with the specified artifact. Use MagickRelinquishMemory() to free the value when you are finished with it.</p> 398 399<p>The format of the MagickGetImageArtifact method is:</p> 400 401<pre class="text"> 402char *MagickGetImageArtifact(MagickWand *wand,const char *artifact) 403</pre> 404 405<p>A description of each parameter follows:</p> 406 407<dd> 408</dd> 409 410<dd> </dd> 411<dl class="dl-horizontal"> 412<dt>wand</dt> 413<dd>the magick wand. </dd> 414 415<dd> </dd> 416<dt>artifact</dt> 417<dd>the artifact. </dd> 418 419<dd> </dd> 420</dl> 421<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetImageArtifacts">MagickGetImageArtifacts</a></h2> 422 423<p>MagickGetImageArtifacts() returns all the artifact names that match the specified pattern associated with a wand. Use MagickGetImageProperty() to return the value of a particular artifact. Use MagickRelinquishMemory() to free the value when you are finished with it.</p> 424 425<p>The format of the MagickGetImageArtifacts method is:</p> 426 427<pre class="text"> 428char *MagickGetImageArtifacts(MagickWand *wand, 429 const char *pattern,size_t *number_artifacts) 430</pre> 431 432<p>A description of each parameter follows:</p> 433 434<dd> 435</dd> 436 437<dd> </dd> 438<dl class="dl-horizontal"> 439<dt>wand</dt> 440<dd>the magick wand. </dd> 441 442<dd> </dd> 443<dt>pattern</dt> 444<dd>Specifies a pointer to a text string containing a pattern. </dd> 445 446<dd> </dd> 447<dt>number_artifacts</dt> 448<dd>the number artifacts associated with this wand. </dd> 449 450<dd> </dd> 451</dl> 452<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetImageProfile">MagickGetImageProfile</a></h2> 453 454<p>MagickGetImageProfile() returns the named image profile.</p> 455 456<p>The format of the MagickGetImageProfile method is:</p> 457 458<pre class="text"> 459unsigned char *MagickGetImageProfile(MagickWand *wand,const char *name, 460 size_t *length) 461</pre> 462 463<p>A description of each parameter follows:</p> 464 465<dd> 466</dd> 467 468<dd> </dd> 469<dl class="dl-horizontal"> 470<dt>wand</dt> 471<dd>the magick wand. </dd> 472 473<dd> </dd> 474<dt>name</dt> 475<dd>Name of profile to return: ICC, IPTC, or generic profile. </dd> 476 477<dd> </dd> 478<dt>length</dt> 479<dd>the length of the profile. </dd> 480 481<dd> </dd> 482</dl> 483<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetImageProfiles">MagickGetImageProfiles</a></h2> 484 485<p>MagickGetImageProfiles() returns all the profile names that match the specified pattern associated with a wand. Use MagickGetImageProfile() to return the value of a particular property. Use MagickRelinquishMemory() to free the value when you are finished with it.</p> 486 487<p>The format of the MagickGetImageProfiles method is:</p> 488 489<pre class="text"> 490char *MagickGetImageProfiles(MagickWand *wand,const char *pattern, 491 size_t *number_profiles) 492</pre> 493 494<p>A description of each parameter follows:</p> 495 496<dd> 497</dd> 498 499<dd> </dd> 500<dl class="dl-horizontal"> 501<dt>wand</dt> 502<dd>the magick wand. </dd> 503 504<dd> </dd> 505<dt>pattern</dt> 506<dd>Specifies a pointer to a text string containing a pattern. </dd> 507 508<dd> </dd> 509<dt>number_profiles</dt> 510<dd>the number profiles associated with this wand. </dd> 511 512<dd> </dd> 513</dl> 514<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetImageProperty">MagickGetImageProperty</a></h2> 515 516<p>MagickGetImageProperty() returns a value associated with the specified property. Use MagickRelinquishMemory() to free the value when you are finished with it.</p> 517 518<p>The format of the MagickGetImageProperty method is:</p> 519 520<pre class="text"> 521char *MagickGetImageProperty(MagickWand *wand,const char *property) 522</pre> 523 524<p>A description of each parameter follows:</p> 525 526<dd> 527</dd> 528 529<dd> </dd> 530<dl class="dl-horizontal"> 531<dt>wand</dt> 532<dd>the magick wand. </dd> 533 534<dd> </dd> 535<dt>property</dt> 536<dd>the property. </dd> 537 538<dd> </dd> 539</dl> 540<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetImageProperties">MagickGetImageProperties</a></h2> 541 542<p>MagickGetImageProperties() returns all the property names that match the specified pattern associated with a wand. Use MagickGetImageProperty() to return the value of a particular property. Use MagickRelinquishMemory() to free the value when you are finished with it.</p> 543 544<p>The format of the MagickGetImageProperties method is:</p> 545 546<pre class="text"> 547char *MagickGetImageProperties(MagickWand *wand, 548 const char *pattern,size_t *number_properties) 549</pre> 550 551<p>A description of each parameter follows:</p> 552 553<dd> 554</dd> 555 556<dd> </dd> 557<dl class="dl-horizontal"> 558<dt>wand</dt> 559<dd>the magick wand. </dd> 560 561<dd> </dd> 562<dt>pattern</dt> 563<dd>Specifies a pointer to a text string containing a pattern. </dd> 564 565<dd> </dd> 566<dt>number_properties</dt> 567<dd>the number properties associated with this wand. </dd> 568 569<dd> </dd> 570</dl> 571<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetInterlaceScheme">MagickGetInterlaceScheme</a></h2> 572 573<p>MagickGetInterlaceScheme() gets the wand interlace scheme.</p> 574 575<p>The format of the MagickGetInterlaceScheme method is:</p> 576 577<pre class="text"> 578InterlaceType MagickGetInterlaceScheme(MagickWand *wand) 579</pre> 580 581<p>A description of each parameter follows:</p> 582 583<dd> 584</dd> 585 586<dd> </dd> 587<dl class="dl-horizontal"> 588<dt>wand</dt> 589<dd>the magick wand. </dd> 590 591<dd> </dd> 592</dl> 593<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetInterpolateMethod">MagickGetInterpolateMethod</a></h2> 594 595<p>MagickGetInterpolateMethod() gets the wand compression.</p> 596 597<p>The format of the MagickGetInterpolateMethod method is:</p> 598 599<pre class="text"> 600PixelInterpolateMethod MagickGetInterpolateMethod(MagickWand *wand) 601</pre> 602 603<p>A description of each parameter follows:</p> 604 605<dd> 606</dd> 607 608<dd> </dd> 609<dl class="dl-horizontal"> 610<dt>wand</dt> 611<dd>the magick wand. </dd> 612 613<dd> </dd> 614</dl> 615<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetOption">MagickGetOption</a></h2> 616 617<p>MagickGetOption() returns a value associated with a wand and the specified key. Use MagickRelinquishMemory() to free the value when you are finished with it.</p> 618 619<p>The format of the MagickGetOption method is:</p> 620 621<pre class="text"> 622char *MagickGetOption(MagickWand *wand,const char *key) 623</pre> 624 625<p>A description of each parameter follows:</p> 626 627<dd> 628</dd> 629 630<dd> </dd> 631<dl class="dl-horizontal"> 632<dt>wand</dt> 633<dd>the magick wand. </dd> 634 635<dd> </dd> 636<dt>key</dt> 637<dd>the key. </dd> 638 639<dd> </dd> 640</dl> 641<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetOptions">MagickGetOptions</a></h2> 642 643<p>MagickGetOptions() returns all the option names that match the specified pattern associated with a wand. Use MagickGetOption() to return the value of a particular option. Use MagickRelinquishMemory() to free the value when you are finished with it.</p> 644 645<p>The format of the MagickGetOptions method is:</p> 646 647<pre class="text"> 648char *MagickGetOptions(MagickWand *wand,const char *pattern, 649 size_t *number_options) 650</pre> 651 652<p>A description of each parameter follows:</p> 653 654<dd> 655</dd> 656 657<dd> </dd> 658<dl class="dl-horizontal"> 659<dt>wand</dt> 660<dd>the magick wand. </dd> 661 662<dd> </dd> 663<dt>pattern</dt> 664<dd>Specifies a pointer to a text string containing a pattern. </dd> 665 666<dd> </dd> 667<dt>number_options</dt> 668<dd>the number options associated with this wand. </dd> 669 670<dd> </dd> 671</dl> 672<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetOrientation">MagickGetOrientation</a></h2> 673 674<p>MagickGetOrientation() gets the wand orientation type.</p> 675 676<p>The format of the MagickGetOrientation method is:</p> 677 678<pre class="text"> 679OrientationType MagickGetOrientation(MagickWand *wand) 680</pre> 681 682<p>A description of each parameter follows:</p> 683 684<dd> 685</dd> 686 687<dd> </dd> 688<dl class="dl-horizontal"> 689<dt>wand</dt> 690<dd>the magick wand. </dd> 691 692<dd> </dd> 693</dl> 694<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetPackageName">MagickGetPackageName</a></h2> 695 696<p>MagickGetPackageName() returns the ImageMagick package name as a string constant.</p> 697 698<p>The format of the MagickGetPackageName method is:</p> 699 700<pre class="text"> 701const char *MagickGetPackageName(void) 702</pre> 703 704 705<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetPage">MagickGetPage</a></h2> 706 707<p>MagickGetPage() returns the page geometry associated with the magick wand.</p> 708 709<p>The format of the MagickGetPage method is:</p> 710 711<pre class="text"> 712MagickBooleanType MagickGetPage(const MagickWand *wand, 713 size_t *width,size_t *height,ssize_t *x,ssize_t *y) 714</pre> 715 716<p>A description of each parameter follows:</p> 717 718<dd> 719</dd> 720 721<dd> </dd> 722<dl class="dl-horizontal"> 723<dt>wand</dt> 724<dd>the magick wand. </dd> 725 726<dd> </dd> 727<dt>width</dt> 728<dd>the page width. </dd> 729 730<dd> </dd> 731<dt>height</dt> 732<dd>page height. </dd> 733 734<dd> </dd> 735<dt>x</dt> 736<dd>the page x-offset. </dd> 737 738<dd> </dd> 739<dt>y</dt> 740<dd>the page y-offset. </dd> 741 742<dd> </dd> 743</dl> 744<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetPointsize">MagickGetPointsize</a></h2> 745 746<p>MagickGetPointsize() returns the font pointsize associated with the MagickWand.</p> 747 748<p>The format of the MagickGetPointsize method is:</p> 749 750<pre class="text"> 751double MagickGetPointsize(MagickWand *wand) 752</pre> 753 754<p>A description of each parameter follows:</p> 755 756<dd> 757</dd> 758 759<dd> </dd> 760<dl class="dl-horizontal"> 761<dt>wand</dt> 762<dd>the magick wand. </dd> 763 764<dd> </dd> 765</dl> 766<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetQuantumDepth">MagickGetQuantumDepth</a></h2> 767 768<p>MagickGetQuantumDepth() returns the ImageMagick quantum depth as a string constant.</p> 769 770<p>The format of the MagickGetQuantumDepth method is:</p> 771 772<pre class="text"> 773const char *MagickGetQuantumDepth(size_t *depth) 774</pre> 775 776<p>A description of each parameter follows:</p> 777 778<dd> 779</dd> 780 781<dd> </dd> 782<dl class="dl-horizontal"> 783<dt>depth</dt> 784<dd>the quantum depth is returned as a number. </dd> 785 786<dd> </dd> 787</dl> 788<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetQuantumRange">MagickGetQuantumRange</a></h2> 789 790<p>MagickGetQuantumRange() returns the ImageMagick quantum range as a string constant.</p> 791 792<p>The format of the MagickGetQuantumRange method is:</p> 793 794<pre class="text"> 795const char *MagickGetQuantumRange(size_t *range) 796</pre> 797 798<p>A description of each parameter follows:</p> 799 800<dd> 801</dd> 802 803<dd> </dd> 804<dl class="dl-horizontal"> 805<dt>range</dt> 806<dd>the quantum range is returned as a number. </dd> 807 808<dd> </dd> 809</dl> 810<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetReleaseDate">MagickGetReleaseDate</a></h2> 811 812<p>MagickGetReleaseDate() returns the ImageMagick release date as a string constant.</p> 813 814<p>The format of the MagickGetReleaseDate method is:</p> 815 816<pre class="text"> 817const char *MagickGetReleaseDate(void) 818</pre> 819 820<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetResolution">MagickGetResolution</a></h2> 821 822<p>MagickGetResolution() gets the image X and Y resolution.</p> 823 824<p>The format of the MagickGetResolution method is:</p> 825 826<pre class="text"> 827MagickBooleanType MagickGetResolution(const MagickWand *wand,double *x, 828 double *y) 829</pre> 830 831<p>A description of each parameter follows:</p> 832 833<dd> 834</dd> 835 836<dd> </dd> 837<dl class="dl-horizontal"> 838<dt>wand</dt> 839<dd>the magick wand. </dd> 840 841<dd> </dd> 842<dt>x</dt> 843<dd>the x-resolution. </dd> 844 845<dd> </dd> 846<dt>y</dt> 847<dd>the y-resolution. </dd> 848 849<dd> </dd> 850</dl> 851<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetResource">MagickGetResource</a></h2> 852 853<p>MagickGetResource() returns the specified resource in megabytes.</p> 854 855<p>The format of the MagickGetResource method is:</p> 856 857<pre class="text"> 858MagickSizeType MagickGetResource(const ResourceType type) 859</pre> 860 861<p>A description of each parameter follows:</p> 862 863<dd> 864</dd> 865 866<dd> </dd> 867<dl class="dl-horizontal"> 868<dt>wand</dt> 869<dd>the magick wand. </dd> 870 871<dd> </dd> 872</dl> 873<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetResourceLimit">MagickGetResourceLimit</a></h2> 874 875<p>MagickGetResourceLimit() returns the specified resource limit in megabytes.</p> 876 877<p>The format of the MagickGetResourceLimit method is:</p> 878 879<pre class="text"> 880MagickSizeType MagickGetResourceLimit(const ResourceType type) 881</pre> 882 883<p>A description of each parameter follows:</p> 884 885<dd> 886</dd> 887 888<dd> </dd> 889<dl class="dl-horizontal"> 890<dt>wand</dt> 891<dd>the magick wand. </dd> 892 893<dd> </dd> 894</dl> 895<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetSamplingFactors">MagickGetSamplingFactors</a></h2> 896 897<p>MagickGetSamplingFactors() gets the horizontal and vertical sampling factor.</p> 898 899<p>The format of the MagickGetSamplingFactors method is:</p> 900 901<pre class="text"> 902double *MagickGetSamplingFactor(MagickWand *wand, 903 size_t *number_factors) 904</pre> 905 906<p>A description of each parameter follows:</p> 907 908<dd> 909</dd> 910 911<dd> </dd> 912<dl class="dl-horizontal"> 913<dt>wand</dt> 914<dd>the magick wand. </dd> 915 916<dd> </dd> 917<dt>number_factors</dt> 918<dd>the number of factors in the returned array. </dd> 919 920<dd> </dd> 921</dl> 922<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetSize">MagickGetSize</a></h2> 923 924<p>MagickGetSize() returns the size associated with the magick wand.</p> 925 926<p>The format of the MagickGetSize method is:</p> 927 928<pre class="text"> 929MagickBooleanType MagickGetSize(const MagickWand *wand, 930 size_t *columns,size_t *rows) 931</pre> 932 933<p>A description of each parameter follows:</p> 934 935<dd> 936</dd> 937 938<dd> </dd> 939<dl class="dl-horizontal"> 940<dt>wand</dt> 941<dd>the magick wand. </dd> 942 943<dd> </dd> 944<dt>columns</dt> 945<dd>the width in pixels. </dd> 946 947<dd> </dd> 948<dt>height</dt> 949<dd>the height in pixels. </dd> 950 951<dd> </dd> 952</dl> 953<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetSizeOffset">MagickGetSizeOffset</a></h2> 954 955<p>MagickGetSizeOffset() returns the size offset associated with the magick wand.</p> 956 957<p>The format of the MagickGetSizeOffset method is:</p> 958 959<pre class="text"> 960MagickBooleanType MagickGetSizeOffset(const MagickWand *wand, 961 ssize_t *offset) 962</pre> 963 964<p>A description of each parameter follows:</p> 965 966<dd> 967</dd> 968 969<dd> </dd> 970<dl class="dl-horizontal"> 971<dt>wand</dt> 972<dd>the magick wand. </dd> 973 974<dd> </dd> 975<dt>offset</dt> 976<dd>the image offset. </dd> 977 978<dd> </dd> 979</dl> 980<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetType">MagickGetType</a></h2> 981 982<p>MagickGetType() returns the wand type.</p> 983 984<p>The format of the MagickGetType method is:</p> 985 986<pre class="text"> 987ImageType MagickGetType(MagickWand *wand) 988</pre> 989 990<p>A description of each parameter follows:</p> 991 992<dd> 993</dd> 994 995<dd> </dd> 996<dl class="dl-horizontal"> 997<dt>wand</dt> 998<dd>the magick wand. </dd> 999 1000<dd> </dd> 1001</dl> 1002<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickGetVersion">MagickGetVersion</a></h2> 1003 1004<p>MagickGetVersion() returns the ImageMagick API version as a string constant and as a number.</p> 1005 1006<p>The format of the MagickGetVersion method is:</p> 1007 1008<pre class="text"> 1009const char *MagickGetVersion(size_t *version) 1010</pre> 1011 1012<p>A description of each parameter follows:</p> 1013 1014<dd> 1015</dd> 1016 1017<dd> </dd> 1018<dl class="dl-horizontal"> 1019<dt>version</dt> 1020<dd>the ImageMagick version is returned as a number. </dd> 1021 1022<dd> </dd> 1023</dl> 1024<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickProfileImage">MagickProfileImage</a></h2> 1025 1026<p>MagickProfileImage() adds or removes a ICC, IPTC, or generic profile from an image. If the profile is NULL, it is removed from the image otherwise added. Use a name of '*' and a profile of NULL to remove all profiles from the image.</p> 1027 1028<p>The format of the MagickProfileImage method is:</p> 1029 1030<pre class="text"> 1031MagickBooleanType MagickProfileImage(MagickWand *wand,const char *name, 1032 const void *profile,const size_t length) 1033</pre> 1034 1035<p>A description of each parameter follows:</p> 1036 1037<dd> 1038</dd> 1039 1040<dd> </dd> 1041<dl class="dl-horizontal"> 1042<dt>wand</dt> 1043<dd>the magick wand. </dd> 1044 1045<dd> </dd> 1046<dt>name</dt> 1047<dd>Name of profile to add or remove: ICC, IPTC, or generic profile. </dd> 1048 1049<dd> </dd> 1050<dt>profile</dt> 1051<dd>the profile. </dd> 1052 1053<dd> </dd> 1054<dt>length</dt> 1055<dd>the length of the profile. </dd> 1056 1057<dd> </dd> 1058</dl> 1059<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickRemoveImageProfile">MagickRemoveImageProfile</a></h2> 1060 1061<p>MagickRemoveImageProfile() removes the named image profile and returns it.</p> 1062 1063<p>The format of the MagickRemoveImageProfile method is:</p> 1064 1065<pre class="text"> 1066unsigned char *MagickRemoveImageProfile(MagickWand *wand, 1067 const char *name,size_t *length) 1068</pre> 1069 1070<p>A description of each parameter follows:</p> 1071 1072<dd> 1073</dd> 1074 1075<dd> </dd> 1076<dl class="dl-horizontal"> 1077<dt>wand</dt> 1078<dd>the magick wand. </dd> 1079 1080<dd> </dd> 1081<dt>name</dt> 1082<dd>Name of profile to return: ICC, IPTC, or generic profile. </dd> 1083 1084<dd> </dd> 1085<dt>length</dt> 1086<dd>the length of the profile. </dd> 1087 1088<dd> </dd> 1089</dl> 1090<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetAntialias">MagickSetAntialias</a></h2> 1091 1092<p>MagickSetAntialias() sets the antialias propery of the wand.</p> 1093 1094<p>The format of the MagickSetAntialias method is:</p> 1095 1096<pre class="text"> 1097MagickBooleanType MagickSetAntialias(MagickWand *wand, 1098 const MagickBooleanType antialias) 1099</pre> 1100 1101<p>A description of each parameter follows:</p> 1102 1103<dd> 1104</dd> 1105 1106<dd> </dd> 1107<dl class="dl-horizontal"> 1108<dt>wand</dt> 1109<dd>the magick wand. </dd> 1110 1111<dd> </dd> 1112<dt>antialias</dt> 1113<dd>the antialias property. </dd> 1114 1115<dd> </dd> 1116</dl> 1117<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetBackgroundColor">MagickSetBackgroundColor</a></h2> 1118 1119<p>MagickSetBackgroundColor() sets the wand background color.</p> 1120 1121<p>The format of the MagickSetBackgroundColor method is:</p> 1122 1123<pre class="text"> 1124MagickBooleanType MagickSetBackgroundColor(MagickWand *wand, 1125 const PixelWand *background) 1126</pre> 1127 1128<p>A description of each parameter follows:</p> 1129 1130<dd> 1131</dd> 1132 1133<dd> </dd> 1134<dl class="dl-horizontal"> 1135<dt>wand</dt> 1136<dd>the magick wand. </dd> 1137 1138<dd> </dd> 1139<dt>background</dt> 1140<dd>the background pixel wand. </dd> 1141 1142<dd> </dd> 1143</dl> 1144<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetColorspace">MagickSetColorspace</a></h2> 1145 1146<p>MagickSetColorspace() sets the wand colorspace type.</p> 1147 1148<p>The format of the MagickSetColorspace method is:</p> 1149 1150<pre class="text"> 1151MagickBooleanType MagickSetColorspace(MagickWand *wand, 1152 const ColorspaceType colorspace) 1153</pre> 1154 1155<p>A description of each parameter follows:</p> 1156 1157<dd> 1158</dd> 1159 1160<dd> </dd> 1161<dl class="dl-horizontal"> 1162<dt>wand</dt> 1163<dd>the magick wand. </dd> 1164 1165<dd> </dd> 1166<dt>colorspace</dt> 1167<dd>the wand colorspace. </dd> 1168 1169<dd> </dd> 1170</dl> 1171<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetCompression">MagickSetCompression</a></h2> 1172 1173<p>MagickSetCompression() sets the wand compression type.</p> 1174 1175<p>The format of the MagickSetCompression method is:</p> 1176 1177<pre class="text"> 1178MagickBooleanType MagickSetCompression(MagickWand *wand, 1179 const CompressionType compression) 1180</pre> 1181 1182<p>A description of each parameter follows:</p> 1183 1184<dd> 1185</dd> 1186 1187<dd> </dd> 1188<dl class="dl-horizontal"> 1189<dt>wand</dt> 1190<dd>the magick wand. </dd> 1191 1192<dd> </dd> 1193<dt>compression</dt> 1194<dd>the wand compression. </dd> 1195 1196<dd> </dd> 1197</dl> 1198<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetCompressionQuality">MagickSetCompressionQuality</a></h2> 1199 1200<p>MagickSetCompressionQuality() sets the wand compression quality.</p> 1201 1202<p>The format of the MagickSetCompressionQuality method is:</p> 1203 1204<pre class="text"> 1205MagickBooleanType MagickSetCompressionQuality(MagickWand *wand, 1206 const size_t quality) 1207</pre> 1208 1209<p>A description of each parameter follows:</p> 1210 1211<dd> 1212</dd> 1213 1214<dd> </dd> 1215<dl class="dl-horizontal"> 1216<dt>wand</dt> 1217<dd>the magick wand. </dd> 1218 1219<dd> </dd> 1220<dt>quality</dt> 1221<dd>the wand compression quality. </dd> 1222 1223<dd> </dd> 1224</dl> 1225<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetDepth">MagickSetDepth</a></h2> 1226 1227<p>MagickSetDepth() sets the wand pixel depth.</p> 1228 1229<p>The format of the MagickSetDepth method is:</p> 1230 1231<pre class="text"> 1232MagickBooleanType MagickSetDepth(MagickWand *wand, 1233 const size_t depth) 1234</pre> 1235 1236<p>A description of each parameter follows:</p> 1237 1238<dd> 1239</dd> 1240 1241<dd> </dd> 1242<dl class="dl-horizontal"> 1243<dt>wand</dt> 1244<dd>the magick wand. </dd> 1245 1246<dd> </dd> 1247<dt>depth</dt> 1248<dd>the wand pixel depth. </dd> 1249 1250<dd> </dd> 1251</dl> 1252<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetExtract">MagickSetExtract</a></h2> 1253 1254<p>MagickSetExtract() sets the extract geometry before you read or write an image file. Use it for inline cropping (e.g. 200x200+0+0) or resizing (e.g.200x200).</p> 1255 1256<p>The format of the MagickSetExtract method is:</p> 1257 1258<pre class="text"> 1259MagickBooleanType MagickSetExtract(MagickWand *wand, 1260 const char *geometry) 1261</pre> 1262 1263<p>A description of each parameter follows:</p> 1264 1265<dd> 1266</dd> 1267 1268<dd> </dd> 1269<dl class="dl-horizontal"> 1270<dt>wand</dt> 1271<dd>the magick wand. </dd> 1272 1273<dd> </dd> 1274<dt>geometry</dt> 1275<dd>the extract geometry. </dd> 1276 1277<dd> </dd> 1278</dl> 1279<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetFilename">MagickSetFilename</a></h2> 1280 1281<p>MagickSetFilename() sets the filename before you read or write an image file.</p> 1282 1283<p>The format of the MagickSetFilename method is:</p> 1284 1285<pre class="text"> 1286MagickBooleanType MagickSetFilename(MagickWand *wand, 1287 const char *filename) 1288</pre> 1289 1290<p>A description of each parameter follows:</p> 1291 1292<dd> 1293</dd> 1294 1295<dd> </dd> 1296<dl class="dl-horizontal"> 1297<dt>wand</dt> 1298<dd>the magick wand. </dd> 1299 1300<dd> </dd> 1301<dt>filename</dt> 1302<dd>the image filename. </dd> 1303 1304<dd> </dd> 1305</dl> 1306<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetFont">MagickSetFont</a></h2> 1307 1308<p>MagickSetFont() sets the font associated with the MagickWand.</p> 1309 1310<p>The format of the MagickSetFont method is:</p> 1311 1312<pre class="text"> 1313MagickBooleanType MagickSetFont(MagickWand *wand, const char *font) 1314</pre> 1315 1316<p>A description of each parameter follows:</p> 1317 1318<dd> 1319</dd> 1320 1321<dd> </dd> 1322<dl class="dl-horizontal"> 1323<dt>wand</dt> 1324<dd>the magick wand. </dd> 1325 1326<dd> </dd> 1327<dt>font</dt> 1328<dd>the font </dd> 1329 1330<dd> </dd> 1331</dl> 1332<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetFormat">MagickSetFormat</a></h2> 1333 1334<p>MagickSetFormat() sets the format of the magick wand.</p> 1335 1336<p>The format of the MagickSetFormat method is:</p> 1337 1338<pre class="text"> 1339MagickBooleanType MagickSetFormat(MagickWand *wand,const char *format) 1340</pre> 1341 1342<p>A description of each parameter follows:</p> 1343 1344<dd> 1345</dd> 1346 1347<dd> </dd> 1348<dl class="dl-horizontal"> 1349<dt>wand</dt> 1350<dd>the magick wand. </dd> 1351 1352<dd> </dd> 1353<dt>format</dt> 1354<dd>the image format. </dd> 1355 1356<dd> </dd> 1357</dl> 1358<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetGravity">MagickSetGravity</a></h2> 1359 1360<p>MagickSetGravity() sets the gravity type.</p> 1361 1362<p>The format of the MagickSetGravity type is:</p> 1363 1364<pre class="text"> 1365MagickBooleanType MagickSetGravity(MagickWand *wand, 1366 const GravityType type) 1367</pre> 1368 1369<p>A description of each parameter follows:</p> 1370 1371<dd> 1372</dd> 1373 1374<dd> </dd> 1375<dl class="dl-horizontal"> 1376<dt>wand</dt> 1377<dd>the magick wand. </dd> 1378 1379<dd> </dd> 1380<dt>type</dt> 1381<dd>the gravity type. </dd> 1382 1383<dd> </dd> 1384</dl> 1385<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetImageArtifact">MagickSetImageArtifact</a></h2> 1386 1387<p>MagickSetImageArtifact() sets a key-value pair in the image artifact namespace. Artifacts differ from properties. Properties are public and are generally exported to an external image format if the format supports it. Artifacts are private and are utilized by the internal ImageMagick API to modify the behavior of certain algorithms.</p> 1388 1389<p>The format of the MagickSetImageArtifact method is:</p> 1390 1391<pre class="text"> 1392MagickBooleanType MagickSetImageArtifact(MagickWand *wand, 1393 const char *artifact,const char *value) 1394</pre> 1395 1396<p>A description of each parameter follows:</p> 1397 1398<dd> 1399</dd> 1400 1401<dd> </dd> 1402<dl class="dl-horizontal"> 1403<dt>wand</dt> 1404<dd>the magick wand. </dd> 1405 1406<dd> </dd> 1407<dt>artifact</dt> 1408<dd>the artifact. </dd> 1409 1410<dd> </dd> 1411<dt>value</dt> 1412<dd>the value. </dd> 1413 1414<dd> </dd> 1415</dl> 1416<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetImageProfile">MagickSetImageProfile</a></h2> 1417 1418<p>MagickSetImageProfile() adds a named profile to the magick wand. If a profile with the same name already exists, it is replaced. This method differs from the MagickProfileImage() method in that it does not apply any CMS color profiles.</p> 1419 1420<p>The format of the MagickSetImageProfile method is:</p> 1421 1422<pre class="text"> 1423MagickBooleanType MagickSetImageProfile(MagickWand *wand, 1424 const char *name,const void *profile,const size_t length) 1425</pre> 1426 1427<p>A description of each parameter follows:</p> 1428 1429<dd> 1430</dd> 1431 1432<dd> </dd> 1433<dl class="dl-horizontal"> 1434<dt>wand</dt> 1435<dd>the magick wand. </dd> 1436 1437<dd> </dd> 1438<dt>name</dt> 1439<dd>Name of profile to add or remove: ICC, IPTC, or generic profile. </dd> 1440 1441<dd> </dd> 1442<dt>profile</dt> 1443<dd>the profile. </dd> 1444 1445<dd> </dd> 1446<dt>length</dt> 1447<dd>the length of the profile. </dd> 1448 1449<dd> </dd> 1450</dl> 1451<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetImageProperty">MagickSetImageProperty</a></h2> 1452 1453<p>MagickSetImageProperty() associates a property with an image.</p> 1454 1455<p>The format of the MagickSetImageProperty method is:</p> 1456 1457<pre class="text"> 1458MagickBooleanType MagickSetImageProperty(MagickWand *wand, 1459 const char *property,const char *value) 1460</pre> 1461 1462<p>A description of each parameter follows:</p> 1463 1464<dd> 1465</dd> 1466 1467<dd> </dd> 1468<dl class="dl-horizontal"> 1469<dt>wand</dt> 1470<dd>the magick wand. </dd> 1471 1472<dd> </dd> 1473<dt>property</dt> 1474<dd>the property. </dd> 1475 1476<dd> </dd> 1477<dt>value</dt> 1478<dd>the value. </dd> 1479 1480<dd> </dd> 1481</dl> 1482<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetInterlaceScheme">MagickSetInterlaceScheme</a></h2> 1483 1484<p>MagickSetInterlaceScheme() sets the image compression.</p> 1485 1486<p>The format of the MagickSetInterlaceScheme method is:</p> 1487 1488<pre class="text"> 1489MagickBooleanType MagickSetInterlaceScheme(MagickWand *wand, 1490 const InterlaceType interlace_scheme) 1491</pre> 1492 1493<p>A description of each parameter follows:</p> 1494 1495<dd> 1496</dd> 1497 1498<dd> </dd> 1499<dl class="dl-horizontal"> 1500<dt>wand</dt> 1501<dd>the magick wand. </dd> 1502 1503<dd> </dd> 1504<dt>interlace_scheme</dt> 1505<dd>the image interlace scheme: NoInterlace, LineInterlace, PlaneInterlace, PartitionInterlace. </dd> 1506 1507<dd> </dd> 1508</dl> 1509<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetInterpolateMethod">MagickSetInterpolateMethod</a></h2> 1510 1511<p>MagickSetInterpolateMethod() sets the interpolate pixel method.</p> 1512 1513<p>The format of the MagickSetInterpolateMethod method is:</p> 1514 1515<pre class="text"> 1516MagickBooleanType MagickSetInterpolateMethod(MagickWand *wand, 1517 const InterpolateMethodPixel method) 1518</pre> 1519 1520<p>A description of each parameter follows:</p> 1521 1522<dd> 1523</dd> 1524 1525<dd> </dd> 1526<dl class="dl-horizontal"> 1527<dt>wand</dt> 1528<dd>the magick wand. </dd> 1529 1530<dd> </dd> 1531<dt>method</dt> 1532<dd>the interpolate pixel method. </dd> 1533 1534<dd> </dd> 1535</dl> 1536<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetOption">MagickSetOption</a></h2> 1537 1538<p>MagickSetOption() associates one or options with the wand (.e.g MagickSetOption(wand,"jpeg:perserve","yes")).</p> 1539 1540<p>The format of the MagickSetOption method is:</p> 1541 1542<pre class="text"> 1543MagickBooleanType MagickSetOption(MagickWand *wand,const char *key, 1544 const char *value) 1545</pre> 1546 1547<p>A description of each parameter follows:</p> 1548 1549<dd> 1550</dd> 1551 1552<dd> </dd> 1553<dl class="dl-horizontal"> 1554<dt>wand</dt> 1555<dd>the magick wand. </dd> 1556 1557<dd> </dd> 1558<dt>key</dt> 1559<dd> The key. </dd> 1560 1561<dd> </dd> 1562<dt>value</dt> 1563<dd> The value. </dd> 1564 1565<dd> </dd> 1566</dl> 1567<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetOrientation">MagickSetOrientation</a></h2> 1568 1569<p>MagickSetOrientation() sets the wand orientation type.</p> 1570 1571<p>The format of the MagickSetOrientation method is:</p> 1572 1573<pre class="text"> 1574MagickBooleanType MagickSetOrientation(MagickWand *wand, 1575 const OrientationType orientation) 1576</pre> 1577 1578<p>A description of each parameter follows:</p> 1579 1580<dd> 1581</dd> 1582 1583<dd> </dd> 1584<dl class="dl-horizontal"> 1585<dt>wand</dt> 1586<dd>the magick wand. </dd> 1587 1588<dd> </dd> 1589<dt>orientation</dt> 1590<dd>the wand orientation. </dd> 1591 1592<dd> </dd> 1593</dl> 1594<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetPage">MagickSetPage</a></h2> 1595 1596<p>MagickSetPage() sets the page geometry of the magick wand.</p> 1597 1598<p>The format of the MagickSetPage method is:</p> 1599 1600<pre class="text"> 1601MagickBooleanType MagickSetPage(MagickWand *wand, 1602 const size_t width,const size_t height,const ssize_t x, 1603 const ssize_t y) 1604</pre> 1605 1606<p>A description of each parameter follows:</p> 1607 1608<dd> 1609</dd> 1610 1611<dd> </dd> 1612<dl class="dl-horizontal"> 1613<dt>wand</dt> 1614<dd>the magick wand. </dd> 1615 1616<dd> </dd> 1617<dt>width</dt> 1618<dd>the page width. </dd> 1619 1620<dd> </dd> 1621<dt>height</dt> 1622<dd>the page height. </dd> 1623 1624<dd> </dd> 1625<dt>x</dt> 1626<dd>the page x-offset. </dd> 1627 1628<dd> </dd> 1629<dt>y</dt> 1630<dd>the page y-offset. </dd> 1631 1632<dd> </dd> 1633</dl> 1634<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetPassphrase">MagickSetPassphrase</a></h2> 1635 1636<p>MagickSetPassphrase() sets the passphrase.</p> 1637 1638<p>The format of the MagickSetPassphrase method is:</p> 1639 1640<pre class="text"> 1641MagickBooleanType MagickSetPassphrase(MagickWand *wand, 1642 const char *passphrase) 1643</pre> 1644 1645<p>A description of each parameter follows:</p> 1646 1647<dd> 1648</dd> 1649 1650<dd> </dd> 1651<dl class="dl-horizontal"> 1652<dt>wand</dt> 1653<dd>the magick wand. </dd> 1654 1655<dd> </dd> 1656<dt>passphrase</dt> 1657<dd>the passphrase. </dd> 1658 1659<dd> </dd> 1660</dl> 1661<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetPointsize">MagickSetPointsize</a></h2> 1662 1663<p>MagickSetPointsize() sets the font pointsize associated with the MagickWand.</p> 1664 1665<p>The format of the MagickSetPointsize method is:</p> 1666 1667<pre class="text"> 1668MagickBooleanType MagickSetPointsize(MagickWand *wand, 1669 const double pointsize) 1670</pre> 1671 1672<p>A description of each parameter follows:</p> 1673 1674<dd> 1675</dd> 1676 1677<dd> </dd> 1678<dl class="dl-horizontal"> 1679<dt>wand</dt> 1680<dd>the magick wand. </dd> 1681 1682<dd> </dd> 1683<dt>pointsize</dt> 1684<dd>the size of the font </dd> 1685 1686<dd> </dd> 1687</dl> 1688<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetProgressMonitor">MagickSetProgressMonitor</a></h2> 1689 1690<p>MagickSetProgressMonitor() sets the wand progress monitor to the specified method and returns the previous progress monitor if any. The progress monitor method looks like this:</p> 1691 1692<pre class="text"> 1693 MagickBooleanType MagickProgressMonitor(const char *text, 1694const MagickOffsetType offset,const MagickSizeType span, 1695void *client_data) 1696</pre> 1697 1698<p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p> 1699 1700<p>The format of the MagickSetProgressMonitor method is:</p> 1701 1702<pre class="text"> 1703MagickProgressMonitor MagickSetProgressMonitor(MagickWand *wand 1704 const MagickProgressMonitor progress_monitor,void *client_data) 1705</pre> 1706 1707<p>A description of each parameter follows:</p> 1708 1709<dd> 1710</dd> 1711 1712<dd> </dd> 1713<dl class="dl-horizontal"> 1714<dt>wand</dt> 1715<dd>the magick wand. </dd> 1716 1717<dd> </dd> 1718<dt>progress_monitor</dt> 1719<dd>Specifies a pointer to a method to monitor progress of an image operation. </dd> 1720 1721<dd> </dd> 1722<dt>client_data</dt> 1723<dd>Specifies a pointer to any client data. </dd> 1724 1725<dd> </dd> 1726</dl> 1727<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetResourceLimit">MagickSetResourceLimit</a></h2> 1728 1729<p>MagickSetResourceLimit() sets the limit for a particular resource in megabytes.</p> 1730 1731<p>The format of the MagickSetResourceLimit method is:</p> 1732 1733<pre class="text"> 1734MagickBooleanType MagickSetResourceLimit(const ResourceType type, 1735 const MagickSizeType limit) 1736</pre> 1737 1738<p>A description of each parameter follows:</p> 1739 1740<dd> 1741</dd> 1742 1743<dd> </dd> 1744<dl class="dl-horizontal"> 1745<dt>type</dt> 1746<dd>the type of resource: AreaResource, MemoryResource, MapResource, DiskResource, FileResource. </dd> 1747 1748<dd> o The maximum limit for the resource. </dd> 1749 1750<dd> </dd> 1751</dl> 1752<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetResolution">MagickSetResolution</a></h2> 1753 1754<p>MagickSetResolution() sets the image resolution.</p> 1755 1756<p>The format of the MagickSetResolution method is:</p> 1757 1758<pre class="text"> 1759MagickBooleanType MagickSetResolution(MagickWand *wand, 1760 const double x_resolution,const double y_resolution) 1761</pre> 1762 1763<p>A description of each parameter follows:</p> 1764 1765<dd> 1766</dd> 1767 1768<dd> </dd> 1769<dl class="dl-horizontal"> 1770<dt>wand</dt> 1771<dd>the magick wand. </dd> 1772 1773<dd> </dd> 1774<dt>x_resolution</dt> 1775<dd>the image x resolution. </dd> 1776 1777<dd> </dd> 1778<dt>y_resolution</dt> 1779<dd>the image y resolution. </dd> 1780 1781<dd> </dd> 1782</dl> 1783<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetSamplingFactors">MagickSetSamplingFactors</a></h2> 1784 1785<p>MagickSetSamplingFactors() sets the image sampling factors.</p> 1786 1787<p>The format of the MagickSetSamplingFactors method is:</p> 1788 1789<pre class="text"> 1790MagickBooleanType MagickSetSamplingFactors(MagickWand *wand, 1791 const size_t number_factors,const double *sampling_factors) 1792</pre> 1793 1794<p>A description of each parameter follows:</p> 1795 1796<dd> 1797</dd> 1798 1799<dd> </dd> 1800<dl class="dl-horizontal"> 1801<dt>wand</dt> 1802<dd>the magick wand. </dd> 1803 1804<dd> </dd> 1805<dt>number_factoes</dt> 1806<dd>the number of factors. </dd> 1807 1808<dd> </dd> 1809<dt>sampling_factors</dt> 1810<dd>An array of doubles representing the sampling factor for each color component (in RGB order). </dd> 1811 1812<dd> </dd> 1813</dl> 1814<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetSeed">MagickSetSeed</a></h2> 1815 1816<p>MagickSetSeed() sets the pseudo-random number generator seed. Use it to generate a pedictable sequence of random numbers.</p> 1817 1818<p>The format of the MagickSetSeed method is:</p> 1819 1820<pre class="text"> 1821void MagickSetSeed(const unsigned long seed) 1822</pre> 1823 1824<p>A description of each parameter follows:</p> 1825 1826<dd> 1827</dd> 1828 1829<dd> </dd> 1830<dl class="dl-horizontal"> 1831<dt>seed</dt> 1832<dd>the seed. </dd> 1833 1834<dd> </dd> 1835</dl> 1836<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetSecurityPolicy">MagickSetSecurityPolicy</a></h2> 1837 1838<p>MagickSetSecurityPolicy() sets the ImageMagick security policy. It returns MagickFalse if the policy is already set or if the policy does not parse.</p> 1839 1840<p>The format of the MagickSetAntialias method is:</p> 1841 1842<pre class="text"> 1843MagickBooleanType MagickSetAntialias(MagickWand *wand, 1844 const char *policy) 1845</pre> 1846 1847<p>A description of each parameter follows:</p> 1848 1849<dd> 1850</dd> 1851 1852<dd> </dd> 1853<dl class="dl-horizontal"> 1854<dt>wand</dt> 1855<dd>the magick wand. </dd> 1856 1857<dd> </dd> 1858<dt>policy</dt> 1859<dd>the security policy in the XML format. </dd> 1860 1861<dd> </dd> 1862</dl> 1863<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetSize">MagickSetSize</a></h2> 1864 1865<p>MagickSetSize() sets the size of the magick wand. Set it before you read a raw image format such as RGB, GRAY, or CMYK.</p> 1866 1867<p>The format of the MagickSetSize method is:</p> 1868 1869<pre class="text"> 1870MagickBooleanType MagickSetSize(MagickWand *wand, 1871 const size_t columns,const size_t rows) 1872</pre> 1873 1874<p>A description of each parameter follows:</p> 1875 1876<dd> 1877</dd> 1878 1879<dd> </dd> 1880<dl class="dl-horizontal"> 1881<dt>wand</dt> 1882<dd>the magick wand. </dd> 1883 1884<dd> </dd> 1885<dt>columns</dt> 1886<dd>the width in pixels. </dd> 1887 1888<dd> </dd> 1889<dt>rows</dt> 1890<dd>the rows in pixels. </dd> 1891 1892<dd> </dd> 1893</dl> 1894<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetSizeOffset">MagickSetSizeOffset</a></h2> 1895 1896<p>MagickSetSizeOffset() sets the size and offset of the magick wand. Set it before you read a raw image format such as RGB, GRAY, or CMYK.</p> 1897 1898<p>The format of the MagickSetSizeOffset method is:</p> 1899 1900<pre class="text"> 1901MagickBooleanType MagickSetSizeOffset(MagickWand *wand, 1902 const size_t columns,const size_t rows, 1903 const ssize_t offset) 1904</pre> 1905 1906<p>A description of each parameter follows:</p> 1907 1908<dd> 1909</dd> 1910 1911<dd> </dd> 1912<dl class="dl-horizontal"> 1913<dt>wand</dt> 1914<dd>the magick wand. </dd> 1915 1916<dd> </dd> 1917<dt>columns</dt> 1918<dd>the image width in pixels. </dd> 1919 1920<dd> </dd> 1921<dt>rows</dt> 1922<dd>the image rows in pixels. </dd> 1923 1924<dd> </dd> 1925<dt>offset</dt> 1926<dd>the image offset. </dd> 1927 1928<dd> </dd> 1929</dl> 1930<h2><a href="../../api/MagickWand/magick-property_8c.html" id="MagickSetType">MagickSetType</a></h2> 1931 1932<p>MagickSetType() sets the image type attribute.</p> 1933 1934<p>The format of the MagickSetType method is:</p> 1935 1936<pre class="text"> 1937MagickBooleanType MagickSetType(MagickWand *wand, 1938 const ImageType image_type) 1939</pre> 1940 1941<p>A description of each parameter follows:</p> 1942 1943<dd> 1944</dd> 1945 1946<dd> </dd> 1947<dl class="dl-horizontal"> 1948<dt>wand</dt> 1949<dd>the magick wand. </dd> 1950 1951<dd> </dd> 1952<dt>image_type</dt> 1953<dd>the image type: UndefinedType, BilevelType, GrayscaleType, GrayscaleAlphaType, PaletteType, PaletteAlphaType, TrueColorType, TrueColorAlphaType, ColorSeparationType, ColorSeparationAlphaType, or OptimizeType. </dd> 1954 1955<dd> </dd> 1956</dl> 1957</div> 1958 </div> 1959 </main><!-- /.container --> 1960 <footer class="magick-footer"> 1961 <div class="container-fluid"> 1962 <a href="../../www/security-policy.html">Security</a> • 1963 <a href="../../www/news.html">News</a> 1964 1965 <a href="magick-property.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../../images/wand.ico"/></a> 1966 1967 <a href="../../www/links.html">Related</a> • 1968 <a href="../../www/sitemap.html">Sitemap</a> 1969 <br/> 1970 <a href="../../www/support.html">Sponsor</a> • 1971 <a href="../../www/cite.html">Cite</a> • 1972 <a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> • 1973 <a href="../../www/contact.html">Contact Us</a> 1974 <br/> 1975 <a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> • 1976 <a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 416.32" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path fill="currentColor" d="M160.83 416.32c193.2 0 298.92-160.22 298.92-298.92 0-4.51 0-9-.2-13.52A214 214 0 0 0 512 49.38a212.93 212.93 0 0 1-60.44 16.6 105.7 105.7 0 0 0 46.3-58.19 209 209 0 0 1-66.79 25.37 105.09 105.09 0 0 0-181.73 71.91 116.12 116.12 0 0 0 2.66 24c-87.28-4.3-164.73-46.3-216.56-109.82A105.48 105.48 0 0 0 68 159.6a106.27 106.27 0 0 1-47.53-13.11v1.43a105.28 105.28 0 0 0 84.21 103.06 105.67 105.67 0 0 1-47.33 1.84 105.06 105.06 0 0 0 98.14 72.94A210.72 210.72 0 0 1 25 370.84a202.17 202.17 0 0 1-25-1.43 298.85 298.85 0 0 0 160.83 46.92"/></svg></a> 1977 <br/> 1978 <small>© 1999-2021 ImageMagick Studio LLC</small> 1979 </div> 1980 </footer> 1981 1982 <!-- Javascript assets --> 1983 <script src="../../assets/magick.js" ></script> 1984 </body> 1985</html> 1986
