granicus.if.org Git - imagemagick/blob - www/api/mogrify.html

   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, shrink-to-fit=no"  />
  10   <title>MagickWand, C API: Command-line Interface @ ImageMagick</title>
  11   <meta name="application-name" content="ImageMagick" />
  12   <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves." />
  13   <meta name="application-url" content="https://www.imagemagick.org" />
  14   <meta name="generator" content="PHP" />
  15   <meta name="keywords" content="magickwc, api:, command-line, interface, 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-2018 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="mogrify.html" rel="canonical" />
  27   <link href="https://www.imagemagick.org/images/wand.png" rel="icon" />
  28   <link href="https://www.imagemagick.org/images/wand.ico" rel="shortcut icon" />
  29   <link href="https://www.imagemagick.org/css/magick.html" rel="stylesheet" />
  30 </head>
  31 <body>
  32 <div class="magick-masthead">
  33   <div class="container">
  34     <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script>    <ins class="adsbygoogle"
  35          style="display:block"
  36          data-ad-client="ca-pub-3129977114552745"
  37          data-ad-slot="6345125851"
  38          data-ad-format="auto"></ins>
  39     <script>
  40       (adsbygoogle = window.adsbygoogle || []).push({});
  41     </script>
  42     <nav class="nav magick-nav">
  43       <a class="nav-link " href="https://www.imagemagick.org/index.html">Home</a>
  44       <a class="nav-link " href="https://www.imagemagick.org/script/download.html">Download</a>
  45       <a class="nav-link " href="https://www.imagemagick.org/script/command-line-tools.html">Tools</a>
  46       <a class="nav-link " href="https://www.imagemagick.org/script/command-line-processing.html">Command-line</a>
  47       <a class="nav-link " href="https://www.imagemagick.org/script/resources.html">Resources</a>
  48       <a class="nav-link " href="https://www.imagemagick.org/script/develop.html">Develop</a>
  49       <a class="nav-link " href="https://www.imagemagick.org/script/search.html">Search</a>
  50       <a class="nav-link float-right" href="https://www.imagemagick.org/discourse-server/">Community</a>
  51     </nav>
  52   </div>
  53 </div>
  54 <div class="container">
  55 <div class="magick-header">
  56 <p class="text-center"><a href="mogrify.html#MagickCommandGenesis">MagickCommandGenesis</a></p>
  57
  58 <h2><a href="http://www.imagemagick.org/api/MagickWand/mogrify_8c.html" id="MagickCommandGenesis">MagickCommandGenesis</a></h2>
  59
  60 <p>MagickCommandGenesis() applies image processing options to an image as prescribed by command line options.</p>
  61
  62 <p>It wiil look for special options like "-debug", "-bench", and "-distribute-cache" that needs to be applied even before the main processing begins, and may completely overrule normal command processing. Such 'Genesis' Options can only be given on the CLI, (not in a script) and are typically ignored (as they have been handled) if seen later.</p>
  63
  64 <p>The format of the MagickCommandGenesis method is:</p>
  65
  66 <pre class="text">
  67 MagickBooleanType MagickCommandGenesis(ImageInfo *image_info,
  68   MagickCommand command,int argc,char **argv,char **metadata,
  69   ExceptionInfo *exception)
  70 </pre>
  71
  72 <p>A description of each parameter follows:</p>
  73
  74 <dd>
  75 </dd>
  76
  77 <dd> </dd>
  78 <dl class="dl-horizontal">
  79 <dt>image_info</dt>
  80 <dd>the image info. </dd>
  81
  82 <dd> </dd>
  83 <dt>command</dt>
  84 <dd>Choose from ConvertImageCommand, IdentifyImageCommand, MogrifyImageCommand, CompositeImageCommand, CompareImagesCommand, ConjureImageCommand, StreamImageCommand, ImportImageCommand, DisplayImageCommand, or AnimateImageCommand. </dd>
  85
  86 <dd> </dd>
  87 <dt>argc</dt>
  88 <dd>Specifies a pointer to an integer describing the number of elements in the argument vector. </dd>
  89
  90 <dd> </dd>
  91 <dt>argv</dt>
  92 <dd>Specifies a pointer to a text array containing the command line arguments. </dd>
  93
  94 <dd> </dd>
  95 <dt>metadata</dt>
  96 <dd>any metadata is returned here. </dd>
  97
  98 <dd> </dd>
  99 <dt>exception</dt>
 100 <dd>return any errors or warnings in this structure. </dd>
 101
 102 <dd>  </dd>
 103 </dl>
 104 </div>
 105   <footer class="magick-footer">
 106     <p><a href="https://www.imagemagick.org/script/support.html">Donate</a> •
 107      <a href="https://www.imagemagick.org/script/sitemap.html">Sitemap</a> •
 108     <a href="https://www.imagemagick.org/script/links.html">Related</a> •
 109     <a href="https://www.imagemagick.org/script/security-policy.html">Security</a> •
 110     <a href="https://www.imagemagick.org/script/architecture.html">Architecture</a>
 111 </p>
 112     <p><a href="mogrify.html#">Back to top</a> •
 113     <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
 114     <a href="https://www.imagemagick.org/script/contact.html">Contact Us</a></p>
 115         <p><small>© 1999-2018 ImageMagick Studio LLC</small></p>
 116   </footer>
 117 </div><!-- /.container -->
 118
 119   <script src="https://localhost/ajax/libs/jquery/1.12.4/jquery.min.js"></script>
 120   <script src="https://www.imagemagick.org/js/magick.html"></script>
 121 </body>
 122 </html>