]> granicus.if.org Git - imagemagick/blobdiff - www/api/image.html
(no commit message)
[imagemagick] / www / api / image.html
index ac1d807488ca20d2e3af6a029e3fef0fe1c09ec7..4d63e3a97ece28e196926711bd907bb7cb4d33fe 100644 (file)
@@ -1,13 +1,13 @@
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">\r
 <head>\r
-  <meta http-equiv="Content-Type" value="application/xhtml+xml" />\r
+  <meta http-equiv="content-type" content="text/html; charset=utf-8"/>\r
   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
-  <style type="text/css" media="screen,projection"><!--\r
+  <style type="text/css" media="all">\r
     @import url("../../www/magick.css");\r
-  --></style>\r
+  </style>\r
   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
   <title>ImageMagick: MagickCore, C API for ImageMagick: Image Methods</title>
   <meta http-equiv="Content-Language" content="en-US"/>
 <div class="eastbar">\r
 \r
 <div class="menu">
-  <a href="../../index.html">About ImageMagick</a>
+  <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
 </div>
 <div class="sep"></div>\r
 <div class="menu">
-  <a href="../../www/command-line-tools.html">Command-line Tools</a>
+  <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
 </div>
 <div class="sub">
-    <a href="../../www/command-line-processing.html">Processing</a>
+    <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
 </div>
 <div class="sub">
-    <a href="../../www/command-line-options.html">Options</a>
+    <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
 </div>
 <div class="sub">
-    <a href="http://www.imagemagick.org/Usage/">Usage</a>
+    <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
 </div>
+<div class="sep"></div>\r
 <div class="menu">
-  <a href="../../www/api.html">Program Interfaces</a>
-</div>
-<div class="sub">
-    <a href="../../www/magick-wand.html">MagickWand</a>
+  <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
 </div>
 <div class="sub">
-    <a href="../../www/magick-core.html">MagickCore</a>
+    <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
 </div>
 <div class="sub">
-    <a href="../../www/perl-magick.html">PerlMagick</a>
+    <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
 </div>
 <div class="sub">
-    <a href="../../Magick++/">Magick++</a>
+    <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 </div>
 <div class="menu">
-  <a href="../../www/architecture.html">Architecture</a>
+  <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 </div>
-<div class="sep"></div>\r
-<div  class="menu">
-   <a href="../../www/install-source.html">Install from Source</a>
+<div class="sub">
+    <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 </div>
 <div class="sub">
-    <a href="../../www/install-source.html#unix">Unix</a>
+    <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 </div>
 <div class="sub">
-    <a href="../../www/install-source.html#windows">Windows</a>
- </div>
-<div class="menu">
-  <a href="../../www/binary-releases.html">Binary Releases</a>
+    <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 </div>
 <div class="sub">
-    <a href="../../www/binary-releases.html#unix">Unix</a>
+    <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
+</div>
+<div class="sep"></div>\r
+<div  class="menu">
+   <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 </div>
 <div class="sub">
-    <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
+    <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 </div>
 <div class="sub">
-    <a href="../../www/binary-releases.html#windows">Windows</a>
+    <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
+ </div>
+<div class="menu">
+  <a title="Resources" href="../../www/resources.html">Resources</a>
 </div>
 <div class="menu">
-  <a href="../../www/resources.html">Resources</a>
+  <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 </div>
-<div class="sep"></div>\r
 <div class="menu">
-  <a href="../../www/download.html">Download</a>
+  <a title="Download" href="../../www/download.html">Download</a>
 </div>
 <div class="sep"></div>\r
 <div class="menu">
-  <a href="../http://www.imagemagick.org/script/search.php">Search</a>
+  <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 </div>
 <div class="sep"></div>\r
 <div class="menu">
-  <a href="../../www/sitemap.html">Site Map</a>
+  <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 </div>
 <div  class="sub">
-    <a href="../../www/links.html">Links</a>
+    <a title="Site Map: Links"href="../../www/links.html">Links</a>
 </div>
 <div class="sep"></div>\r
 <div  class="menu">
-  <a href="../../www/sponsors.html">Sponsors:</a>
+  <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 
 <div class="sponsbox">
 <div  class="sponsor">
-   <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
-</div>
-<div  class="sponsor">
-  <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
+  <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 </div>
 <div  class="sponsor">
-  <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
+  <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 </div>
 <div  class="sponsor">
-  <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
+  <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 </div>
 <div  class="sponsor">
-  <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
+  <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 </div>
 <div  class="sponsor">
-   <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
+  <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 </div>
 <div  class="sponsor">
-   <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
+   <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 </div>
 <div  class="sponsor">
-  <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
+   <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/" title="Online-Magazin">Online-Magazin</a><!-- 20101101000200 -->
 </div>
 </div>
 </div>
 \r
 <div class="main">\r
 \r
-<p class="navigation-index">[<a href="#AcquireImage">AcquireImage</a> &bull; <a href="#AcquireImageColormap">AcquireImageColormap</a> &bull; <a href="#AcquireImageInfo">AcquireImageInfo</a> &bull; <a href="#AcquireNextImage">AcquireNextImage</a> &bull; <a href="#AppendImages">AppendImages</a> &bull; <a href="#CatchImageException">CatchImageException</a> &bull; <a href="#ClipImagePath">ClipImagePath</a> &bull; <a href="#CloneImage">CloneImage</a> &bull; <a href="#CloneImageInfo">CloneImageInfo</a> &bull; <a href="#CombineImages">CombineImages</a> &bull; <a href="#DestroyImage">DestroyImage</a> &bull; <a href="#DestroyImageInfo">DestroyImageInfo</a> &bull; <a href="#GetImageAlphaChannel">GetImageAlphaChannel</a> &bull; <a href="#GetImageClipMask">GetImageClipMask</a> &bull; <a href="#GetImageException">GetImageException</a> &bull; <a href="#GetImageInfo">GetImageInfo</a> &bull; <a href="#GetImageInfoFile">GetImageInfoFile</a> &bull; <a href="#GetImageMask">GetImageMask</a> &bull; <a href="#GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a> &bull; <a href="#InterpretImageFilename">InterpretImageFilename</a> &bull; <a href="#IsHighDynamicRangeImage">IsHighDynamicRangeImage</a> &bull; <a href="#IsImageObject">IsImageObject</a> &bull; <a href="#IsTaintImage">IsTaintImage</a> &bull; <a href="#ModifyImage">ModifyImage</a> &bull; <a href="#NewMagickImage">NewMagickImage</a> &bull; <a href="#ReferenceImage">ReferenceImage</a> &bull; <a href="#ResetImagePage">ResetImagePage</a> &bull; <a href="#SeparateImageChannel">SeparateImageChannel</a> &bull; <a href="#SeparateImages">SeparateImages</a> &bull; <a href="#SetImageAlphaChannel">SetImageAlphaChannel</a> &bull; <a href="#SetImageBackgroundColor">SetImageBackgroundColor</a> &bull; <a href="#SetImageStorageClass">SetImageStorageClass</a> &bull; <a href="#SetImageClipMask">SetImageClipMask</a> &bull; <a href="#SetImageExtent">SetImageExtent</a> &bull; <a href="#SetImageInfoBlob">SetImageInfoBlob</a> &bull; <a href="#SetImageInfoFile">SetImageInfoFile</a> &bull; <a href="#SetImageMask">SetImageMask</a> &bull; <a href="#SetImageOpacity">SetImageOpacity</a> &bull; <a href="#SetImageType">SetImageType</a> &bull; <a href="#SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a> &bull; <a href="#StripImage">StripImage</a> &bull; <a href="#SyncImageSettings">SyncImageSettings</a>]</p>
+<p class="navigation-index">[<a href="#AcquireImage">AcquireImage</a> &bull; <a href="#AcquireImageInfo">AcquireImageInfo</a> &bull; <a href="#AcquireNextImage">AcquireNextImage</a> &bull; <a href="#AppendImages">AppendImages</a> &bull; <a href="#CatchImageException">CatchImageException</a> &bull; <a href="#ClipImagePath">ClipImagePath</a> &bull; <a href="#CloneImage">CloneImage</a> &bull; <a href="#CloneImageInfo">CloneImageInfo</a> &bull; <a href="#CombineImages">CombineImages</a> &bull; <a href="#DestroyImage">DestroyImage</a> &bull; <a href="#DestroyImageInfo">DestroyImageInfo</a> &bull; <a href="#GetImageAlphaChannel">GetImageAlphaChannel</a> &bull; <a href="#GetImageClipMask">GetImageClipMask</a> &bull; <a href="#GetImageException">GetImageException</a> &bull; <a href="#GetImageInfo">GetImageInfo</a> &bull; <a href="#GetImageInfoFile">GetImageInfoFile</a> &bull; <a href="#GetImageMask">GetImageMask</a> &bull; <a href="#GetImageVirtualPixelMethod">GetImageVirtualPixelMethod</a> &bull; <a href="#InterpretImageFilename">InterpretImageFilename</a> &bull; <a href="#IsHighDynamicRangeImage">IsHighDynamicRangeImage</a> &bull; <a href="#IsImageObject">IsImageObject</a> &bull; <a href="#IsTaintImage">IsTaintImage</a> &bull; <a href="#ModifyImage">ModifyImage</a> &bull; <a href="#NewMagickImage">NewMagickImage</a> &bull; <a href="#ReferenceImage">ReferenceImage</a> &bull; <a href="#ResetImagePage">ResetImagePage</a> &bull; <a href="#SeparateImageChannel">SeparateImageChannel</a> &bull; <a href="#SeparateImages">SeparateImages</a> &bull; <a href="#SetImageAlphaChannel">SetImageAlphaChannel</a> &bull; <a href="#SetImageBackgroundColor">SetImageBackgroundColor</a> &bull; <a href="#SetImageColor">SetImageColor</a> &bull; <a href="#SetImageStorageClass">SetImageStorageClass</a> &bull; <a href="#SetImageClipMask">SetImageClipMask</a> &bull; <a href="#SetImageExtent">SetImageExtent</a> &bull; <a href="#SetImageInfoBlob">SetImageInfoBlob</a> &bull; <a href="#SetImageInfoFile">SetImageInfoFile</a> &bull; <a href="#SetImageMask">SetImageMask</a> &bull; <a href="#SetImageOpacity">SetImageOpacity</a> &bull; <a href="#SetImageType">SetImageType</a> &bull; <a href="#SetImageVirtualPixelMethod">SetImageVirtualPixelMethod</a> &bull; <a href="#StripImage">StripImage</a> &bull; <a href="#SyncImageSettings">SyncImageSettings</a>]</p>
 
 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
 _8c.html" target="source" name="AcquireImage">AcquireImage</a></h2>
@@ -176,28 +173,6 @@ _8c.html" target="source" name="AcquireImage">AcquireImage</a></h2>
 
  </div>
 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
-_8c.html" target="source" name="AcquireImageColormap">AcquireImageColormap</a></h2>
-<div class="doc-section">
-
-<p>AcquireImageColormap() allocates an image colormap and initializes it to a linear gray colorspace.  If the image already has a colormap, it is replaced.  AcquireImageColormap() returns MagickTrue if successful, otherwise MagickFalse if there is not enough memory.</p></ol>
-
-<p>The format of the AcquireImageColormap method is:</p>
-
-<pre class="code">
-  MagickBooleanType AcquireImageColormap(Image *image,
-    const unsigned long colors)
-</pre>
-
-<p>A description of each parameter follows:</p></ol>
-
-<h5>image</h5>
-<ol><p>the image.</p></ol>
-
-<h5>colors</h5>
-<ol><p>the number of colors in the image colormap.</p></ol>
-
- </div>
-<h2><a href="http://www.imagemagick.org/api/MagickCore/image
 _8c.html" target="source" name="AcquireImageInfo">AcquireImageInfo</a></h2>
 <div class="doc-section">
 
@@ -310,8 +285,8 @@ _8c.html" target="source" name="CloneImage">CloneImage</a></h2>
 <p>The format of the CloneImage method is:</p>
 
 <pre class="code">
-  Image *CloneImage(const Image *image,const unsigned long columns,
-    const unsigned long rows,const MagickBooleanType orphan,
+  Image *CloneImage(const Image *image,const size_t columns,
+    const size_t rows,const MagickBooleanType orphan,
     ExceptionInfo *exception)
 </pre>
 
@@ -658,7 +633,7 @@ _8c.html" target="source" name="NewMagickImage">NewMagickImage</a></h2>
 
 <pre class="code">
   Image *NewMagickImage(const ImageInfo *image_info,
-    const unsigned long width,const unsigned long height,
+    const size_t width,const size_t height,
     const MagickPixelPacket *background)
 </pre>
 
@@ -804,6 +779,28 @@ _8c.html" target="source" name="SetImageBackgroundColor">SetImageBackgroundColor
 
  </div>
 <h2><a href="http://www.imagemagick.org/api/MagickCore/image
+_8c.html" target="source" name="SetImageColor">SetImageColor</a></h2>
+<div class="doc-section">
+
+<p>SetImageColor() set the entire image canvas to the specified color.</p></ol>
+
+<p>The format of the SetImageColor method is:</p>
+
+<pre class="code">
+  MagickBooleanType SetImageColor(Image *image,
+    const MagickPixelPacket *color)
+</pre>
+
+<p>A description of each parameter follows:</p></ol>
+
+<h5>image</h5>
+<ol><p>the image.</p></ol>
+
+<h5>background</h5>
+<ol><p>the image color.</p></ol>
+
+ </div>
+<h2><a href="http://www.imagemagick.org/api/MagickCore/image
 _8c.html" target="source" name="SetImageStorageClass">SetImageStorageClass</a></h2>
 <div class="doc-section">
 
@@ -856,7 +853,7 @@ _8c.html" target="source" name="SetImageExtent">SetImageExtent</a></h2>
 
 <pre class="code">
   MagickBooleanType SetImageExtent(Image *image,
-    const unsigned long columns,const unsigned long rows)
+    const size_t columns,const size_t rows)
 </pre>
 
 <p>A description of each parameter follows:</p></ol>