magick++.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1" />
  6. <title>ImageMagick – Magick++, C++ API</title>
  7. <meta name="application-name" content="ImageMagick" />
  8. <meta name="description" content="" />
  9. <meta name="application-url" content="https://imagemagick.org" />
  10. <meta name="generator" content="PHP" />
  11. <meta name="keywords" content="magick++, c++, api, image processing software" />
  12. <meta name="rating" content="GENERAL" />
  13. <meta name="robots" content="INDEX, FOLLOW" />
  14. <meta name="generator" content="ImageMagick Studio LLC" />
  15. <meta name="author" content="ImageMagick Studio LLC" />
  16. <meta name="revisit-after" content="2 DAYS" />
  17. <meta name="resource-type" content="document" />
  18. <meta name="copyright" content="Copyright (c) 1999 ImageMagick Studio LLC" />
  19. <meta name="distribution" content="Global" />
  20. <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" />
  21. <meta property='og:url' content='../' />
  22. <meta property='og:title' content='ImageMagick' />
  23. <meta property='og:image' content='../images/logo.png' />
  24. <meta property='og:type' content='website' />
  25. <meta property='og:site_name' content='ImageMagick' />
  26. <meta property='og:description' content="Create, Edit, Compose, or Convert Digital Images" />
  27. <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
  28. <link href="magick++.html" rel="canonical" />
  29. <link href="../images/wand.png" rel="icon" />
  30. <link href="../images/wand.ico" rel="shortcut icon" />
  31. <link href="assets/magick.css" rel="stylesheet" />
  32. </head>
  33. <body>
  34. <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
  35. <div class="container-fluid">
  36. <a class="navbar-brand" href="../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../images/wand.ico"/></a>
  37. <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">
  38. <span class="navbar-toggler-icon"></span>
  39. </button>
  40. <div class="collapse navbar-collapse" id="magick-navbars">
  41. <ul class="navbar-nav me-auto mb-2 mb-md-0">
  42. <li class="nav-item">
  43. <a class="nav-link " href="../www/download.html">Download</a>
  44. </li>
  45. <li class="nav-item">
  46. <a class="nav-link " href="../www/command-line-tools.html">Tools</a>
  47. </li>
  48. <li class="nav-item">
  49. <a class="nav-link " href="../www/command-line-processing.html">CLI</a>
  50. </li>
  51. <li class="nav-item">
  52. <a class="nav-link " href="../www/develop.html">Develop</a>
  53. </li>
  54. <li class="nav-item">
  55. <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a>
  56. </li>
  57. <li class="nav-item">
  58. <iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe>
  59. </li>
  60. </ul>
  61. <form class="d-flex form-inline" action="search.html">
  62. <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search">
  63. <button class="btn btn-outline-success" type="submit" name="sa">Search</button>
  64. </form>
  65. </div>
  66. </div>
  67. </nav>
  68. <div class="container">
  69. <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script>
  70. <ins class="adsbygoogle"
  71. style="display:block"
  72. data-ad-client="ca-pub-3129977114552745"
  73. data-ad-slot="6345125851"
  74. data-full-width-responsive="true"
  75. data-ad-format="horizontal"></ins>
  76. <script>
  77. (adsbygoogle = window.adsbygoogle || []).push({});
  78. </script>
  79. </div>
  80. <main class="container">
  81. <div class="magick-template">
  82. <div class="magick-header">
  83. <p class="text-center"><a href="magick++.html#documentation">Documentation</a> • <a href="magick++.html#get">Obtaining Magick++</a> • <a href="magick++.html#install">Installation</a> • <a href="magick++.html#bugs">Reporting Bugs</a></p>
  84. <a class="anchor" id="intro"></a>
  85. <p class="lead magick-description"><a href="api/Magick++/index.html">Magick++ API</a> is the object-oriented C++ API to the <a href="../">ImageMagick</a> image-processing library.</p>
  86. <p>Magick++ supports an object model which is inspired by <a href="perl-magick.html">PerlMagick</a>.
  87. Images support implicit reference counting so that copy constructors
  88. and assignment incur almost no cost. The cost of actually copying an
  89. image (if necessary) is done just before modification and this copy
  90. is managed automagically by Magick++. De-referenced copies are
  91. automagically deleted. The image objects support value (rather than
  92. pointer) semantics so it is trivial to support multiple generations
  93. of an image in memory at one time.
  94. </p>
  95. <p>Magick++ provides integrated support for the <a href="http://www.sgi.com/tech/stl/">Standard
  96. Template Library</a> (STL) so that the powerful containers available
  97. (e.g. <a href="http://www.sgi.com/tech/stl/Deque.html">deque</a>,
  98. <a href="http://www.sgi.com/tech/stl/Vector.html">vector</a>, <a href="http://www.sgi.com/tech/stl/List.html">list</a>,
  99. and <a href="http://www.sgi.com/tech/stl/Map.html">map</a>) can
  100. be used to write programs similar to those possible with PERL &amp;
  101. PerlMagick. STL-compatible template versions of ImageMagick's
  102. list-style operations are provided so that operations may be
  103. performed on multiple images stored in STL containers.
  104. </p>
  105. <h2>Documentation</h2>
  106. <a class="anchor" id="documentation"></a>
  107. <p>Detailed <a href="../Magick++/index.html">documentation</a> is
  108. provided for all Magick++ classes, class methods, and template
  109. functions which comprise the API. See a <a href="../Magick++/tutorial/Magick++_tutorial.pdf"> Gentle Introduction to Magick++</a> for an introductory tutorial to Magick++. We include the <a href="../Magick++/tutorial/Magick++_tutorial.odt" >source</a> if you want to correct, enhance, or expand the tutorial.</p>
  110. <h2>Obtaining Magick++</h2>
  111. <a class="anchor" id="get"></a>
  112. <p>Magick++ is included as part of <a href="../index.html">ImageMagick</a>
  113. source releases and may be retrieved via <a href="../www/download.html">HTTP</a>
  114. or <a href="https://github.com/ImageMagick/ImageMagick/tree/main/Magick%2B%2B">GitHub</a>.
  115. </p>
  116. <h2>Installation</h2>
  117. <a class="anchor" id="install"></a>
  118. <p>Once you have the Magick++ sources available, follow these detailed
  119. <a href="../Magick++/Install.html">installation instructions</a> for UNIX and
  120. Windows.
  121. </p>
  122. <h2>Usage</h2>
  123. <p>A helper script named <samp>Magick++-config</samp> is installed
  124. under Linux which assists with recalling compilation options required
  125. to compile and link programs which use Magick++. For example, the
  126. following command compiles and links the source file <samp>demo.cpp</samp>
  127. to produce the executable <samp>demo</samp> (notice that quotes are
  128. backward quotes):
  129. </p>
  130. <pre class="bg-light text-dark mx-4"><samp>c++ `Magick++-config --cxxflags --cppflags` -O2 -o demo demo.cpp \
  131. `Magick++-config --ldflags --libs` </samp></pre>
  132. <p>Set the <samp>PKG_CONFIG_PATH</samp> environment variable if ImageMagick is not in your default system path:</p>
  133. <pre class="bg-light text-dark mx-4"><samp>export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig </samp></pre>
  134. <p>Windows users may get started by manually editing a project file
  135. for one of the Magick++ demo programs.
  136. </p>
  137. <p>Note, under Windows (and possibly the Mac) it may be necessary to initialize the ImageMagick library prior to using the Magick++ library. This initialization is performed by passing the path to the ImageMagick DLLs (assumed to be in the same directory as your program) to the InitializeMagick() function call. This is commonly performed by providing the path to your program (argv[0]) as shown in the following example: </p>
  138. <pre class="bg-light text-dark mx-4"><samp>int main( int argc, char ** argv) {
  139. InitializeMagick(*argv);
  140. ... </samp></pre>
  141. <p>This initialization step is not required under Linux, Linux,
  142. Cygwin, or any other operating environment that supports the notion
  143. of <var>installing</var> ImageMagick in a known location. </p>
  144. <p>Here is a example program that utilizes the Magick++ API to get you started, <a href="https://imagemagick.org/source/magick++.cpp">magick++.cpp</a>. It reads an image, crops it, and writes it to disk in the PNG image format.</p>
  145. <pre class="pre-scrollable bg-light text-dark mx-4"><code>
  146. #include &lt;Magick++.h>
  147. #include &lt;iostream>
  148. using namespace std;
  149. using namespace Magick;
  150. int main(int argc,char **argv)
  151. {
  152. InitializeMagick(*argv);
  153. // Construct the image object. Seperating image construction from the
  154. // the read operation ensures that a failure to read the image file
  155. // doesn't render the image object useless.
  156. Image image;
  157. try {
  158. // Read a file into image object
  159. image.read( "logo:" );
  160. // Crop the image to specified size (width, height, xOffset, yOffset)
  161. image.crop( Geometry(100,100, 100, 100) );
  162. // Write the image to a file
  163. image.write( "logo.png" );
  164. }
  165. catch( Exception &amp;error_ )
  166. {
  167. cout &lt;&lt; "Caught exception: " &lt;&lt; error_.what() &lt;&lt; endl;
  168. return 1;
  169. }
  170. return 0;
  171. } </code></pre>
  172. <h2>Reporting Bugs</h2>
  173. <a class="anchor" id="bugs"></a>
  174. <p>Questions regarding usage should be directed to or to report any bugs go to
  175. <a href="https://github.com/ImageMagick/ImageMagick/discussions">Magick++ community forum</a>.
  176. </p>
  177. </div>
  178. </div>
  179. </main><!-- /.container -->
  180. <footer class="magick-footer">
  181. <div class="container-fluid">
  182. <a href="../www/security-policy.html">Security</a> •
  183. <a href="../www/news.html">News</a>
  184. <a href="magick++.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../images/wand.ico"/></a>
  185. <a href="../www/links.html">Related</a> •
  186. <a href="../www/sitemap.html">Sitemap</a>
  187. <br/>
  188. <a href="../www/support.html">Sponsor</a> •
  189. <a href="../www/cite.html">Cite</a> •
  190. <a href="http://pgp.mit.edu/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
  191. <a href="../www/https://imagemagick.org/script/contact.php">Contact Us</a>
  192. <br/>
  193. <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> •
  194. <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 300 300" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path d="M178.57 127.15 290.27 0h-26.46l-97.03 110.38L89.34 0H0l117.13 166.93L0 300.25h26.46l102.4-116.59 81.8 116.59h89.34M36.01 19.54H76.66l187.13 262.13h-40.66"/></svg></a>
  195. <br/>
  196. <small>Copyright © 1999 ImageMagick Studio LLC</small>
  197. </div>
  198. </footer>
  199. <!-- Javascript assets -->
  200. <script src="assets/magick.js" ></script>
  201. </body>
  202. </html>