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