From: cristy Date: Tue, 15 Feb 2011 00:52:58 +0000 (+0000) Subject: (no commit message) X-Git-Tag: 7.0.1-0~8177 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=2bd2a98029aa859a58c518b9bcd6e5c52d54c085;p=imagemagick --- diff --git a/index.html b/index.html index e7925f1e5..850eb8b67 100644 --- a/index.html +++ b/index.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -229,7 +233,7 @@
  • Morphology of shapes: extract features, describe shapes and recognize patterns in images.
  • Motion picture support: read and write the common image formats used in digital film work.
  • Image calculator: apply a mathematical expression to an image or image channels.
    • -
  • Discrete Fourier transform: implements the forward and inverse DFT.
    • +
  • Discrete Fourier transform: implements the forward and inverse DFT.
  • High dynamic-range images: accurately represent the wide range of intensity levels found in real scenes ranging from the brightest direct sunlight to the deepest darkest shadows.
  • Encipher or decipher an image: convert ordinary images into unintelligible gibberish and back again.
  • Virtual pixel support: convenient access to pixels outside the image region.
    • diff --git a/www/ImageMagickObject.html b/www/ImageMagickObject.html index 54c5f2f42..96ad54be7 100644 --- a/www/ImageMagickObject.html +++ b/www/ImageMagickObject.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings diff --git a/www/advanced-unix-installation.html b/www/advanced-unix-installation.html index b3668d6f3..2acf15107 100644 --- a/www/advanced-unix-installation.html +++ b/www/advanced-unix-installation.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/advanced-windows-installation.html b/www/advanced-windows-installation.html index 02d764feb..333da8474 100644 --- a/www/advanced-windows-installation.html +++ b/www/advanced-windows-installation.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -499,7 +503,7 @@

    The Windows binary distribution includes a number of demo projects that you can use as a template for your own custom project. For example, start with the Button project, generally located in the c:/Program Files/ImageMagick-6.5.5-0/Magick++_demos folder. If not, be sure to select Configuration Properties->C/C++->Preprocessor and set these definitions:

    -

    NDEBUG WIN32 diff --git a/www/animate.html b/www/animate.html index dc2b3f7a6..6b6930431 100644 --- a/www/animate.html +++ b/www/animate.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings
    @@ -186,32 +190,9 @@
    -

    Module animate - Methods

    -

    [AnimateImages]

    +

    Module Methods

    +

    []

    -

    AnimateImages

    -
    - -

    AnimateImages() repeatedly displays an image sequence to any X window screen. It returns a value other than 0 if successful. Check the exception member of image to determine the reason for any failure.

    - -

    The format of the AnimateImages method is:

    - -
    -  MagickBooleanType AnimateImages(const ImageInfo *image_info,
-    Image *images)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    image
    -

    the image.

    - -
    diff --git a/www/api/annotate.html b/www/api/annotate.html index fb89097a7..6923757ac 100644 --- a/www/api/annotate.html +++ b/www/api/annotate.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,174 +190,9 @@
    -

    Module annotate - Methods

    -

    [AnnotateImage • FormatMagickCaption • GetMultilineTypeMetrics • GetTypeMetrics]

    +

    Module Methods

    +

    []

    -

    AnnotateImage

    -
    - -

    AnnotateImage() annotates an image with text. Optionally you can include any of the following bits of information about the image by embedding the appropriate special characters:

    - -
    -      b   file size in bytes.
-      c   comment.
-      d   directory in which the image resides.
-      e   extension of the image file.
-      f   original filename of the image.
-      h   height of image.
-      i   filename of the image.
-      k   number of unique colors.
-      l   image label.
-      m   image file format.
-      n   number of images in a image sequence.
-      o   output image filename.
-      p   page number of the image.
-      q   image depth (8 or 16).
-      q   image depth (8 or 16).
-      s   image scene number.
-      t   image filename without any extension.
-      u   a unique temporary filename.
-      w   image width.
-      x   x resolution of the image.
-      y   y resolution of the image.
-
    - -

    The format of the AnnotateImage method is:

    - -
    -  MagickBooleanType AnnotateImage(Image *image,DrawInfo *draw_info)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    draw_info
    -

    the draw info.

    - -
    -

    FormatMagickCaption

    -
    - -

    FormatMagickCaption() formats a caption so that it fits within the image width. It returns the number of lines in the formatted caption.

    - -

    The format of the FormatMagickCaption method is:

    - -
    -  ssize_t FormatMagickCaption(Image *image,DrawInfo *draw_info,
-    const MagickBooleanType split,TypeMetric *metrics,char **caption)
-
    - -

    A description of each parameter follows.

    - -
    image
    -

    The image.

    - -
    draw_info
    -

    the draw info.

    - -
    split
    -

    when no convenient line breaks-- insert newline.

    - -
    metrics
    -

    Return the font metrics in this structure.

    - -
    caption
    -

    the caption.

    - -
    -

    GetMultilineTypeMetrics

    -
    - -

    GetMultilineTypeMetrics() returns the following information for the specified font and text:

    - -
    -      character width
-      character height
-      ascender
-      descender
-      text width
-      text height
-      maximum horizontal advance
-      bounds: x1
-      bounds: y1
-      bounds: x2
-      bounds: y2
-      origin: x
-      origin: y
-      underline position
-      underline thickness
-
    - -

    This method is like GetTypeMetrics() but it returns the maximum text width and height for multiple lines of text.

    - -

    The format of the GetMultilineTypeMetrics method is:

    - -
    -  MagickBooleanType GetMultilineTypeMetrics(Image *image,
-    const DrawInfo *draw_info,TypeMetric *metrics)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    draw_info
    -

    the draw info.

    - -
    metrics
    -

    Return the font metrics in this structure.

    - -
    -

    GetTypeMetrics

    -
    - -

    GetTypeMetrics() returns the following information for the specified font and text:

    - -
    -      character width
-      character height
-      ascender
-      descender
-      text width
-      text height
-      maximum horizontal advance
-      bounds: x1
-      bounds: y1
-      bounds: x2
-      bounds: y2
-      origin: x
-      origin: y
-      underline position
-      underline thickness
-
    - -

    The format of the GetTypeMetrics method is:

    - -
    -  MagickBooleanType GetTypeMetrics(Image *image,const DrawInfo *draw_info,
-    TypeMetric *metrics)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    draw_info
    -

    the draw info.

    - -
    metrics
    -

    Return the font metrics in this structure.

    - -
    diff --git a/www/api/attribute.html b/www/api/attribute.html index 8ed230b59..bca3f200d 100644 --- a/www/api/attribute.html +++ b/www/api/attribute.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,192 +190,9 @@
    -

    Module blob - Methods

    -

    [BlobToImage • FileToImage • GetBlobProperties • ImageToBlob • ImageToFile • ImagesToBlob • InjectImageBlob]

    +

    Module Methods

    +

    []

    -

    BlobToImage

    -
    - -

    BlobToImage() implements direct to memory image formats. It returns the blob as an image.

    - -

    The format of the BlobToImage method is:

    - -
    -  Image *BlobToImage(const ImageInfo *image_info,const void *blob,
-    const size_t length,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    blob
    -

    the address of a character stream in one of the image formats understood by ImageMagick.

    - -
    length
    -

    This size_t integer reflects the length in bytes of the blob.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    FileToImage

    -
    - -

    FileToImage() write the contents of a file to an image.

    - -

    The format of the FileToImage method is:

    - -
    -  MagickBooleanType FileToImage(Image *,const char *filename)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    filename
    -

    the filename.

    - -
    -

    GetBlobProperties

    -
    - -

    GetBlobProperties() returns information about an image blob.

    - -

    The format of the GetBlobProperties method is:

    - -
    -  const struct stat *GetBlobProperties(const Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    ImageToBlob

    -
    - -

    ImageToBlob() implements direct to memory image formats. It returns the image as a blob and its length. The magick member of the Image structure determines the format of the returned blob (GIF, JPEG, PNG, etc.). This method is the equivalent of WriteImage(), but writes the formatted "file" to a memory buffer rather than to an actual file.

    - -

    The format of the ImageToBlob method is:

    - -
    -  unsigned char *ImageToBlob(const ImageInfo *image_info,Image *image,
-    size_t *length,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    image
    -

    the image.

    - -
    length
    -

    This pointer to a size_t integer sets the initial length of the blob. On return, it reflects the actual length of the blob.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ImageToFile

    -
    - -

    ImageToFile() writes an image to a file. It returns MagickFalse if an error occurs otherwise MagickTrue.

    - -

    The format of the ImageToFile method is:

    - -
    -   MagickBooleanType ImageToFile(Image *image,char *filename,
-     ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    filename
    -

    Write the image to this file.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ImagesToBlob

    -
    - -

    ImagesToBlob() implements direct to memory image formats. It returns the image sequence as a blob and its length. The magick member of the ImageInfo structure determines the format of the returned blob (GIF, JPEG, PNG, etc.)

    - -

    Note, some image formats do not permit multiple images to the same image stream (e.g. JPEG). in this instance, just the first image of the sequence is returned as a blob.

    - -

    The format of the ImagesToBlob method is:

    - -
    -  unsigned char *ImagesToBlob(const ImageInfo *image_info,Image *images,
-    size_t *length,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    images
    -

    the image list.

    - -
    length
    -

    This pointer to a size_t integer sets the initial length of the blob. On return, it reflects the actual length of the blob.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    InjectImageBlob

    -
    - -

    InjectImageBlob() injects the image with a copy of itself in the specified format (e.g. inject JPEG into a PDF image).

    - -

    The format of the InjectImageBlob method is:

    - -
    -  MagickBooleanType InjectImageBlob(const ImageInfo *image_info,
-    Image *image,Image *inject_image,const char *format,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info..

    - -
    image
    -

    the image.

    - -
    inject_image
    -

    inject into the image stream.

    - -
    format
    -

    the image format.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/cache-view.html b/www/api/cache-view.html index e8258d317..846d845c0 100644 --- a/www/api/cache-view.html +++ b/www/api/cache-view.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,424 +190,9 @@
    -

    Module cache-view - Methods

    -

    [AcquireCacheView • CloneCacheView • DestroyCacheView • GetCacheViewColorspace • GetCacheViewException • GetCacheViewStorageClass • GetCacheViewAuthenticPixels • GetOneCacheViewAuthenticPixel • GetCacheViewAuthenticIndexQueue • GetCacheViewAuthenticPixelQueue • GetCacheViewVirtualIndexQueue • GetCacheViewVirtualPixelQueue • GetCacheViewVirtualPixels • GetOneCacheViewVirtualPixel • GetOneCacheViewVirtualMethodPixel • QueueCacheViewAuthenticPixels • SetCacheViewStorageClass • SetCacheViewVirtualPixelMethod • SyncCacheViewAuthenticPixels]

    +

    Module Methods

    +

    []

    -

    AcquireCacheView

    -
    - -

    AcquireCacheView() acquires a view into the pixel cache, using the VirtualPixelMethod that is defined within the given image itself.

    - -

    The format of the AcquireCacheView method is:

    - -
    -  CacheView *AcquireCacheView(const Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    CloneCacheView

    -
    - -

    CloneCacheView() makes an exact copy of the specified cache view.

    - -

    The format of the CloneCacheView method is:

    - -
    -  CacheView *CloneCacheView(const CacheView *cache_view)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    -

    DestroyCacheView

    -
    - -

    DestroyCacheView() destroys the specified view returned by a previous call to AcquireCacheView().

    - -

    The format of the DestroyCacheView method is:

    - -
    -  CacheView *DestroyCacheView(CacheView *cache_view)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    -

    GetCacheViewColorspace

    -
    - -

    GetCacheViewColorspace() returns the image colorspace associated with the specified view.

    - -

    The format of the GetCacheViewColorspace method is:

    - -
    -  ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    -

    GetCacheViewException

    -
    - -

    GetCacheViewException() returns the image exception associated with the specified view.

    - -

    The format of the GetCacheViewException method is:

    - -
    -  ExceptionInfo GetCacheViewException(const CacheView *cache_view)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    -

    GetCacheViewStorageClass

    -
    - -

    GetCacheViewStorageClass() returns the image storage class associated with the specified view.

    - -

    The format of the GetCacheViewStorageClass method is:

    - -
    -  ClassType GetCacheViewStorageClass(const CacheView *cache_view)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    -

    GetCacheViewAuthenticPixels

    -
    - -

    GetCacheViewAuthenticPixels() gets pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.

    - -

    The format of the GetCacheViewAuthenticPixels method is:

    - -
    -  PixelPacket *GetCacheViewAuthenticPixels(CacheView *cache_view,
-    const ssize_t x,const ssize_t y,const size_t columns,
-    const size_t rows,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    x,y,columns,rows
    -

    These values define the perimeter of a region of pixels.

    - -
    -

    GetOneCacheViewAuthenticPixel

    -
    - -

    GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.

    - -

    The format of the GetOneCacheViewAuthenticPixel method is:

    - -
    -  MagickBooleaNType GetOneCacheViewAuthenticPixel(
-    const CacheView *cache_view,const ssize_t x,const ssize_t y,
-    Pixelpacket *pixel,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    x,y
    -

    These values define the offset of the pixel.

    - -
    pixel
    -

    return a pixel at the specified (x,y) location.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    GetCacheViewAuthenticIndexQueue

    -
    - -

    GetCacheViewAuthenticIndexQueue() returns the indexes associated with the last call to SetCacheViewIndexes() or GetCacheViewAuthenticIndexQueue(). The indexes are authentic and can be updated.

    - -

    The format of the GetCacheViewAuthenticIndexQueue() method is:

    - -
    -  IndexPacket *GetCacheViewAuthenticIndexQueue(CacheView *cache_view)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    -

    GetCacheViewAuthenticPixelQueue

    -
    - -

    GetCacheViewAuthenticPixelQueue() returns the pixels associated with the last call to QueueCacheViewAuthenticPixels() or GetCacheViewAuthenticPixels(). The pixels are authentic and therefore can be updated.

    - -

    The format of the GetCacheViewAuthenticPixelQueue() method is:

    - -
    -  PixelPacket *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    -

    GetCacheViewVirtualIndexQueue

    -
    - -

    GetCacheViewVirtualIndexQueue() returns the indexes associated with the last call to GetCacheViewVirtualIndexQueue(). The indexes are virtual and therefore cannot be updated.

    - -

    The format of the GetCacheViewVirtualIndexQueue() method is:

    - -
    -  const IndexPacket *GetCacheViewVirtualIndexQueue(
-    const CacheView *cache_view)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    -

    GetCacheViewVirtualPixelQueue

    -
    - -

    GetCacheViewVirtualPixelQueue() returns the the pixels associated with the last call to GetCacheViewVirtualPixels(). The pixels are virtual and therefore cannot be updated.

    - -

    The format of the GetCacheViewVirtualPixelQueue() method is:

    - -
    -  const PixelPacket *GetCacheViewVirtualPixelQueue(
-    const CacheView *cache_view)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    -

    GetCacheViewVirtualPixels

    -
    - -

    GetCacheViewVirtualPixels() gets virtual pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.

    - -

    The format of the GetCacheViewVirtualPixels method is:

    - -
    -  const PixelPacket *GetCacheViewVirtualPixels(
-    const CacheView *cache_view,const ssize_t x,const ssize_t y,
-    const size_t columns,const size_t rows,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    x,y,columns,rows
    -

    These values define the perimeter of a region of pixels.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    GetOneCacheViewVirtualPixel

    -
    - -

    GetOneCacheViewVirtualPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOneCacheViewAuthenticPixel() instead.

    - -

    The format of the GetOneCacheViewVirtualPixel method is:

    - -
    -  MagickBooleanType GetOneCacheViewVirtualPixel(
-    const CacheView *cache_view,const ssize_t x,const ssize_t y,
-    PixelPacket *pixel,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    x,y
    -

    These values define the offset of the pixel.

    - -
    pixel
    -

    return a pixel at the specified (x,y) location.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    GetOneCacheViewVirtualMethodPixel

    -
    - -

    GetOneCacheViewVirtualMethodPixel() returns a single virtual pixel at the specified (x,y) location. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOneCacheViewAuthenticPixel() instead.

    - -

    The format of the GetOneCacheViewVirtualPixel method is:

    - -
    -  MagickBooleanType GetOneCacheViewVirtualMethodPixel(
-    const CacheView *cache_view,
-    const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
-    const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    virtual_pixel_method
    -

    the virtual pixel method.

    - -
    x,y
    -

    These values define the offset of the pixel.

    - -
    pixel
    -

    return a pixel at the specified (x,y) location.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    QueueCacheViewAuthenticPixels

    -
    - -

    QueueCacheViewAuthenticPixels() queues authentic pixels from the in-memory or disk pixel cache as defined by the geometry parameters. A pointer to the pixels is returned if the pixels are transferred, otherwise a NULL is returned.

    - -

    The format of the QueueCacheViewAuthenticPixels method is:

    - -
    -  PixelPacket *QueueCacheViewAuthenticPixels(CacheView *cache_view,
-    const ssize_t x,const ssize_t y,const size_t columns,
-    const size_t rows,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    x,y,columns,rows
    -

    These values define the perimeter of a region of pixels.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    SetCacheViewStorageClass

    -
    - -

    SetCacheViewStorageClass() sets the image storage class associated with the specified view.

    - -

    The format of the SetCacheViewStorageClass method is:

    - -
    -  MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
-    const ClassType storage_class)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    storage_class
    -

    the image storage class: PseudoClass or DirectClass.

    - -
    -

    SetCacheViewVirtualPixelMethod

    -
    - -

    SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated with the specified cache view.

    - -

    The format of the SetCacheViewVirtualPixelMethod method is:

    - -
    -  MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
-    const VirtualPixelMethod virtual_pixel_method)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    virtual_pixel_method
    -

    the virtual pixel method.

    - -
    -

    SyncCacheViewAuthenticPixels

    -
    - -

    SyncCacheViewAuthenticPixels() saves the cache view pixels to the in-memory or disk cache. It returns MagickTrue if the pixel region is flushed, otherwise MagickFalse.

    - -

    The format of the SyncCacheViewAuthenticPixels method is:

    - -
    -  MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    cache_view
    -

    the cache view.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/cache.html b/www/api/cache.html index 7bf2131b2..cb29a4318 100644 --- a/www/api/cache.html +++ b/www/api/cache.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,361 +190,9 @@
    -

    Module cache - Methods

    -

    [AcquirePixelCacheNexus • GetAuthenticIndexQueue • GetAuthenticPixelQueue • GetAuthenticPixels • GetOneAuthenticPixel • GetOneVirtualMagickPixel • GetOneVirtualMethodPixel • GetOneVirtualPixel • GetVirtualIndexQueue • VirtualPixelModulo • GetVirtualPixelQueue • GetVirtualPixels • QueueAuthenticPixels • SetPixelCacheVirtualMethod • SyncAuthenticPixels]

    +

    Module Methods

    +

    []

    -

    AcquirePixelCacheNexus

    -
    - -

    AcquirePixelCacheNexus() allocates the NexusInfo structure.

    - -

    The format of the AcquirePixelCacheNexus method is:

    - -
    -  NexusInfo **AcquirePixelCacheNexus(const size_t number_threads)
-
    - -

    A description of each parameter follows:

    - -
    number_threads
    -

    the number of nexus threads.

    - -
    -

    GetAuthenticIndexQueue

    -
    - -

    GetAuthenticIndexQueue() returns the authentic black channel or the colormap indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels(). NULL is returned if the black channel or colormap indexes are not available.

    - -

    The format of the GetAuthenticIndexQueue() method is:

    - -
    -  IndexPacket *GetAuthenticIndexQueue(const Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    GetAuthenticPixelQueue

    -
    - -

    GetAuthenticPixelQueue() returns the authentic pixels associated with the last call to QueueAuthenticPixels() or GetAuthenticPixels().

    - -

    The format of the GetAuthenticPixelQueue() method is:

    - -
    -  PixelPacket *GetAuthenticPixelQueue(const Image image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    GetAuthenticPixels

    -
    - -

    GetAuthenticPixels() obtains a pixel region for read/write access. If the region is successfully accessed, a pointer to a PixelPacket array representing the region is returned, otherwise NULL is returned.

    - -

    The returned pointer may point to a temporary working copy of the pixels or it may point to the original pixels in memory. Performance is maximized if the selected region is part of one row, or one or more full rows, since then there is opportunity to access the pixels in-place (without a copy) if the image is in memory, or in a memory-mapped file. The returned pointer must *never* be deallocated by the user.

    - -

    Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or if the storage class is PseduoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to obtain the black color component or colormap indexes (of type IndexPacket) corresponding to the region. Once the PixelPacket (and/or IndexPacket) array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.

    - -

    The format of the GetAuthenticPixels() method is:

    - -
    -  PixelPacket *GetAuthenticPixels(Image *image,const ssize_t x,
-    const ssize_t y,const size_t columns,const size_t rows,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    x,y,columns,rows
    -

    These values define the perimeter of a region of pixels.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    GetOneAuthenticPixel

    -
    - -

    GetOneAuthenticPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs.

    - -

    The format of the GetOneAuthenticPixel() method is:

    - -
    -  MagickBooleanType GetOneAuthenticPixel(const Image image,const ssize_t x,
-    const ssize_t y,PixelPacket *pixel,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    x,y
    -

    These values define the location of the pixel to return.

    - -
    pixel
    -

    return a pixel at the specified (x,y) location.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    GetOneVirtualMagickPixel

    -
    - -

    GetOneVirtualMagickPixel() returns a single pixel at the specified (x,y) location. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOneAuthenticPixel() instead.

    - -

    The format of the GetOneVirtualMagickPixel() method is:

    - -
    -  MagickBooleanType GetOneVirtualMagickPixel(const Image image,
-    const ssize_t x,const ssize_t y,MagickPixelPacket *pixel,
-    ExceptionInfo exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    x,y
    -

    these values define the location of the pixel to return.

    - -
    pixel
    -

    return a pixel at the specified (x,y) location.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    GetOneVirtualMethodPixel

    -
    - -

    GetOneVirtualMethodPixel() returns a single pixel at the specified (x,y) location as defined by specified pixel method. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOneAuthenticPixel() instead.

    - -

    The format of the GetOneVirtualMethodPixel() method is:

    - -
    -  MagickBooleanType GetOneVirtualMethodPixel(const Image image,
-    const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
-    const ssize_t y,Pixelpacket *pixel,ExceptionInfo exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    virtual_pixel_method
    -

    the virtual pixel method.

    - -
    x,y
    -

    These values define the location of the pixel to return.

    - -
    pixel
    -

    return a pixel at the specified (x,y) location.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    GetOneVirtualPixel

    -
    - -

    GetOneVirtualPixel() returns a single virtual pixel at the specified (x,y) location. The image background color is returned if an error occurs. If you plan to modify the pixel, use GetOneAuthenticPixel() instead.

    - -

    The format of the GetOneVirtualPixel() method is:

    - -
    -  MagickBooleanType GetOneVirtualPixel(const Image image,const ssize_t x,
-    const ssize_t y,PixelPacket *pixel,ExceptionInfo exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    x,y
    -

    These values define the location of the pixel to return.

    - -
    pixel
    -

    return a pixel at the specified (x,y) location.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    GetVirtualIndexQueue

    -
    - -

    GetVirtualIndexQueue() returns the virtual black channel or the colormap indexes associated with the last call to QueueAuthenticPixels() or GetVirtualPixels(). NULL is returned if the black channel or colormap indexes are not available.

    - -

    The format of the GetVirtualIndexQueue() method is:

    - -
    -  const IndexPacket *GetVirtualIndexQueue(const Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    VirtualPixelModulo

    -
    - -

    VirtualPixelModulo() computes the remainder of dividing offset by extent. It returns not only the quotient (tile the offset falls in) but also the positive remainer within that tile such that 0 <= remainder < extent. This method is essentially a ldiv() using a floored modulo division rather than the normal default truncated modulo division.

    -
    -

    GetVirtualPixelQueue

    -
    - -

    GetVirtualPixelQueue() returns the virtual pixels associated with the last call to QueueAuthenticPixels() or GetVirtualPixels().

    - -

    The format of the GetVirtualPixelQueue() method is:

    - -
    -  const PixelPacket *GetVirtualPixelQueue(const Image image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    GetVirtualPixels

    -
    - -

    GetVirtualPixels() returns an immutable pixel region. If the region is successfully accessed, a pointer to it is returned, otherwise NULL is returned. The returned pointer may point to a temporary working copy of the pixels or it may point to the original pixels in memory. Performance is maximized if the selected region is part of one row, or one or more full rows, since there is opportunity to access the pixels in-place (without a copy) if the image is in memory, or in a memory-mapped file. The returned pointer must *never* be deallocated by the user.

    - -

    Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or the storage class is PseudoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to access the black color component or to obtain the colormap indexes (of type IndexPacket) corresponding to the region.

    - -

    If you plan to modify the pixels, use GetAuthenticPixels() instead.

    - -

    Note, the GetVirtualPixels() and GetAuthenticPixels() methods are not thread- safe. In a threaded environment, use GetCacheViewVirtualPixels() or GetCacheViewAuthenticPixels() instead.

    - -

    The format of the GetVirtualPixels() method is:

    - -
    -  const PixelPacket *GetVirtualPixels(const Image *image,const ssize_t x,
-    const ssize_t y,const size_t columns,const size_t rows,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    x,y,columns,rows
    -

    These values define the perimeter of a region of pixels.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    QueueAuthenticPixels

    -
    - -

    QueueAuthenticPixels() queues a mutable pixel region. If the region is successfully intialized a pointer to a PixelPacket array representing the region is returned, otherwise NULL is returned. The returned pointer may point to a temporary working buffer for the pixels or it may point to the final location of the pixels in memory.

    - -

    Write-only access means that any existing pixel values corresponding to the region are ignored. This is useful if the initial image is being created from scratch, or if the existing pixel values are to be completely replaced without need to refer to their pre-existing values. The application is free to read and write the pixel buffer returned by QueueAuthenticPixels() any way it pleases. QueueAuthenticPixels() does not initialize the pixel array values. Initializing pixel array values is the application's responsibility.

    - -

    Performance is maximized if the selected region is part of one row, or one or more full rows, since then there is opportunity to access the pixels in-place (without a copy) if the image is in memory, or in a memory-mapped file. The returned pointer must *never* be deallocated by the user.

    - -

    Pixels accessed via the returned pointer represent a simple array of type PixelPacket. If the image type is CMYK or the storage class is PseudoClass, call GetAuthenticIndexQueue() after invoking GetAuthenticPixels() to obtain the black color component or the colormap indexes (of type IndexPacket) corresponding to the region. Once the PixelPacket (and/or IndexPacket) array has been updated, the changes must be saved back to the underlying image using SyncAuthenticPixels() or they may be lost.

    - -

    The format of the QueueAuthenticPixels() method is:

    - -
    -  PixelPacket *QueueAuthenticPixels(Image *image,const ssize_t x,
-    const ssize_t y,const size_t columns,const size_t rows,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    x,y,columns,rows
    -

    These values define the perimeter of a region of pixels.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    SetPixelCacheVirtualMethod

    -
    - -

    SetPixelCacheVirtualMethod() sets the "virtual pixels" method for the pixel cache and returns the previous setting. A virtual pixel is any pixel access that is outside the boundaries of the image cache.

    - -

    The format of the SetPixelCacheVirtualMethod() method is:

    - -
    -  VirtualPixelMethod SetPixelCacheVirtualMethod(const Image *image,
-    const VirtualPixelMethod virtual_pixel_method)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    virtual_pixel_method
    -

    choose the type of virtual pixel.

    - -
    -

    SyncAuthenticPixels

    -
    - -

    SyncAuthenticPixels() saves the image pixels to the in-memory or disk cache. The method returns MagickTrue if the pixel region is flushed, otherwise MagickFalse.

    - -

    The format of the SyncAuthenticPixels() method is:

    - -
    -  MagickBooleanType SyncAuthenticPixels(Image *image,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/cipher.html b/www/api/cipher.html index 70cd56a8b..1d718ba01 100644 --- a/www/api/cipher.html +++ b/www/api/cipher.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,204 +190,9 @@
    -

    Module cipher - Methods

    -

    [AcquireAESInfo • DestroyAESInfo • EncipherAESBlock • PasskeyDecipherImage • PasskeyEncipherImage • SetAESKey • PasskeyDecipherImage • PasskeyEncipherImage]

    +

    Module Methods

    +

    []

    -

    AcquireAESInfo

    -
    - -

    AcquireAESInfo() allocate the AESInfo structure.

    - -

    The format of the AcquireAESInfo method is:

    - -
    -  AESInfo *AcquireAESInfo(void)
-
    - -
    -

    DestroyAESInfo

    -
    - -

    DestroyAESInfo() zeros memory associated with the AESInfo structure.

    - -

    The format of the DestroyAESInfo method is:

    - -
    -  AESInfo *DestroyAESInfo(AESInfo *aes_info)
-
    - -

    A description of each parameter follows:

    - -
    aes_info
    -

    the cipher context.

    - -
    -

    EncipherAESBlock

    -
    - -

    EncipherAESBlock() enciphers a single block of plaintext to produce a block of ciphertext.

    - -

    The format of the EncipherAESBlock method is:

    - -
    -  void EncipherAES(AESInfo *aes_info,const unsigned char *plaintext,
-    unsigned char *ciphertext)
-
    - -

    A description of each parameter follows:

    - -
    aes_info
    -

    the cipher context.

    - -
    plaintext
    -

    the plain text.

    - -
    ciphertext
    -

    the cipher text.

    - -
    -

    PasskeyDecipherImage

    -
    - -

    PasskeyDecipherImage() converts cipher pixels to plain pixels.

    - -

    The format of the PasskeyDecipherImage method is:

    - -
    -  MagickBooleanType PasskeyDecipherImage(Image *image,
-    const StringInfo *passkey,ExceptionInfo *exception)
-  MagickBooleanType DecipherImage(Image *image,const char *passphrase,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    passphrase
    -

    decipher cipher pixels with this passphrase.

    - -
    passkey
    -

    decrypt cipher pixels with this passkey.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    PasskeyEncipherImage

    -
    - -

    PasskeyEncipherImage() converts pixels to cipher-pixels.

    - -

    The format of the PasskeyEncipherImage method is:

    - -
    -  MagickBooleanType PasskeyEncipherImage(Image *image,
-    const StringInfo *passkey,ExceptionInfo *exception)
-  MagickBooleanType EncipherImage(Image *image,const char *passphrase,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    passphrase
    -

    encipher pixels with this passphrase.

    - -
    passkey
    -

    decrypt cipher pixels with this passkey.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    SetAESKey

    -
    - -

    SetAESKey() sets the key for the AES cipher. The key length is specified in bits. Valid values are 128, 192, or 256 requiring a key buffer length in bytes of 16, 24, and 32 respectively.

    - -

    The format of the SetAESKey method is:

    - -
    -  SetAESKey(AESInfo *aes_info,const StringInfo *key)
-
    - -

    A description of each parameter follows:

    - -
    aes_info
    -

    the cipher context.

    - -
    key
    -

    the key.

    - -
    -

    PasskeyDecipherImage

    -
    - -

    PasskeyDecipherImage() converts cipher pixels to plain pixels.

    - -

    The format of the PasskeyDecipherImage method is:

    - -
    -  MagickBooleanType PasskeyDecipherImage(Image *image,
-    const StringInfo *passkey,ExceptionInfo *exception)
-  MagickBooleanType DecipherImage(Image *image,const char *passphrase,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    passphrase
    -

    decipher cipher pixels with this passphrase.

    - -
    passkey
    -

    decrypt cipher pixels with this passkey.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    PasskeyEncipherImage

    -
    - -

    PasskeyEncipherImage() converts pixels to cipher-pixels.

    - -

    The format of the PasskeyEncipherImage method is:

    - -
    -  MagickBooleanType PasskeyEncipherImage(Image *image,
-    const StringInfo *passkey,ExceptionInfo *exception)
-  MagickBooleanType EncipherImage(Image *image,const char *passphrase,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    passphrase
    -

    decipher cipher pixels with this passphrase.

    - -
    passkey
    -

    decrypt cipher pixels with this passkey.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/color.html b/www/api/color.html index aa3f4eff2..536322b83 100644 --- a/www/api/color.html +++ b/www/api/color.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,53 +190,9 @@
    -

    Module colormap - Methods

    -

    [AcquireImageColormap • CycleColormap]

    +

    Module Methods

    +

    []

    -

    AcquireImageColormap

    -
    - -

    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.

    - -

    The format of the AcquireImageColormap method is:

    - -
    -  MagickBooleanType AcquireImageColormap(Image *image,
-    const size_t colors)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    colors
    -

    the number of colors in the image colormap.

    - -
    -

    CycleColormap

    -
    - -

    CycleColormap() displaces an image's colormap by a given number of positions. If you cycle the colormap a number of times you can produce a psychodelic effect.

    - -

    The format of the CycleColormapImage method is:

    - -
    -  MagickBooleanType CycleColormapImage(Image *image,const ssize_t displace)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    displace
    -

    displace the colormap this amount.

    - -
    diff --git a/www/api/compare.html b/www/api/compare.html index 7d0cb0164..2de3f625d 100644 --- a/www/api/compare.html +++ b/www/api/compare.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,174 +190,9 @@
    -

    Module compare - Methods

    -

    [CompareImageChannels • GetImageChannelDistortion • GetImageChannelDistrortion • IsImagesEqual • SimilarityImage]

    +

    Module Methods

    +

    []

    -

    CompareImageChannels

    -
    - -

    CompareImageChannels() compares one or more image channels of an image to a reconstructed image and returns the difference image.

    - -

    The format of the CompareImageChannels method is:

    - -
    -  Image *CompareImageChannels(const Image *image,
-    const Image *reconstruct_image,const ChannelType channel,
-    const MetricType metric,double *distortion,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    reconstruct_image
    -

    the reconstruct image.

    - -
    channel
    -

    the channel.

    - -
    metric
    -

    the metric.

    - -
    distortion
    -

    the computed distortion between the images.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    GetImageChannelDistortion

    -
    - -

    GetImageChannelDistortion() compares one or more image channels of an image to a reconstructed image and returns the specified distortion metric.

    - -

    The format of the CompareImageChannels method is:

    - -
    -  MagickBooleanType GetImageChannelDistortion(const Image *image,
-    const Image *reconstruct_image,const ChannelType channel,
-    const MetricType metric,double *distortion,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    reconstruct_image
    -

    the reconstruct image.

    - -
    channel
    -

    the channel.

    - -
    metric
    -

    the metric.

    - -
    distortion
    -

    the computed distortion between the images.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    GetImageChannelDistrortion

    -
    - -

    GetImageChannelDistrortion() compares the image channels of an image to a reconstructed image and returns the specified distortion metric for each channel.

    - -

    The format of the CompareImageChannels method is:

    - -
    -  double *GetImageChannelDistortions(const Image *image,
-    const Image *reconstruct_image,const MetricType metric,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    reconstruct_image
    -

    the reconstruct image.

    - -
    metric
    -

    the metric.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    IsImagesEqual

    -
    - -

    IsImagesEqual() measures the difference between colors at each pixel location of two images. A value other than 0 means the colors match exactly. Otherwise an error measure is computed by summing over all pixels in an image the distance squared in RGB space between each image pixel and its corresponding pixel in the reconstruct image. The error measure is assigned to these image members:

    - -
    -      o mean_error_per_pixel:  The mean error for any single pixel in
-  the image.
-
    - -
    normalized_mean_error
    -

    The normalized mean quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in the image.

    - -
    normalized_maximum_error
    -

    The normalized maximum quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in your image.

    - -

    A small normalized mean square error, accessed as image->normalized_mean_error, suggests the images are very similar in spatial layout and color.

    - -

    The format of the IsImagesEqual method is:

    - -
    -  MagickBooleanType IsImagesEqual(Image *image,
-    const Image *reconstruct_image)
-
    - -

    A description of each parameter follows.

    - -
    image
    -

    the image.

    - -
    reconstruct_image
    -

    the reconstruct image.

    - -
    -

    SimilarityImage

    -
    - -

    SimilarityImage() compares the reference image of the image and returns the best match offset. In addition, it returns a similarity image such that an exact match location is completely white and if none of the pixels match, black, otherwise some gray level in-between.

    - -

    The format of the SimilarityImageImage method is:

    - -
    -  Image *SimilarityImage(const Image *image,const Image *reference,
-    RectangleInfo *offset,double *similarity,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    reference
    -

    find an area of the image that closely resembles this image.

    - -

    o the best match offset of the reference image within the image.

    - -
    similarity
    -

    the computed similarity between the images.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/composite.html b/www/api/composite.html index 3f1aa6aa6..8afd6dc04 100644 --- a/www/api/composite.html +++ b/www/api/composite.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,81 +190,9 @@
    -

    Module composite - Methods

    -

    [CompositeImageChannel • TextureImage]

    +

    Module Methods

    +

    []

    -

    CompositeImageChannel

    -
    - -

    CompositeImageChannel() returns the second image composited onto the first at the specified offset, using the specified composite method.

    - -

    The format of the CompositeImageChannel method is:

    - -
    -  MagickBooleanType CompositeImage(Image *image,
-    const CompositeOperator compose,Image *composite_image,
-    const ssize_t x_offset,const ssize_t y_offset)
-  MagickBooleanType CompositeImageChannel(Image *image,
-    const ChannelType channel,const CompositeOperator compose,
-    Image *composite_image,const ssize_t x_offset,const ssize_t y_offset)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the destination image, modified by he composition

    - -
    channel
    -

    the channel.

    - -
    compose
    -

    This operator affects how the composite is applied to the image. The operators and how they are utilized are listed here http://www.w3.org/TR/SVG12/#compositing.

    - -
    composite_image
    -

    the composite (source) image.

    - -
    x_offset
    -

    the column offset of the composited image.

    - -
    y_offset
    -

    the row offset of the composited image.

    - -

    Extra Controls from Image meta-data in 'composite_image' (artifacts)

    - -

    o "compose:args" A string containing extra numerical arguments for specific compose methods, generally expressed as a 'geometry' or a comma separated list of numbers.

    - -

    Compose methods needing such arguments include "BlendCompositeOp" and "DisplaceCompositeOp".

    - -

    o "compose:outside-overlay" Modify how the composition is to effect areas not directly covered by the 'composite_image' at the offset given. Normally this is dependant on the 'compose' method, especially Duff-Porter methods.

    - -

    If set to "false" then disable all normal handling of pixels not covered by the composite_image. Typically used for repeated tiling of the composite_image by the calling API.

    - -

    Previous to IM v6.5.3-3 this was called "modify-outside-overlay"

    - -
    -

    TextureImage

    -
    - -

    TextureImage() repeatedly tiles the texture image across and down the image canvas.

    - -

    The format of the TextureImage method is:

    - -
    -  MagickBooleanType TextureImage(Image *image,const Image *texture)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    texture
    -

    This image is the texture to layer on the background.

    - -
    diff --git a/www/api/constitute.html b/www/api/constitute.html index 147001d84..fac987fc4 100644 --- a/www/api/constitute.html +++ b/www/api/constitute.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,182 +190,9 @@
    -

    Module constitute - Methods

    -

    [ConstituteImage • PingImage • PingImages • ReadImage • ReadImages • WriteImage • WriteImages]

    +

    Module Methods

    +

    []

    -

    ConstituteImage

    -
    - -

    ConstituteImage() returns an image from the pixel data you supply. The pixel data must be in scanline order top-to-bottom. The data can be char, short int, int, float, or double. Float and double require the pixels to be normalized [0..1], otherwise [0..QuantumRange]. For example, to create a 640x480 image from unsigned red-green-blue character data, use:

    - -
    -  image = ConstituteImage(640,480,"RGB",CharPixel,pixels,&exception);
-
    - -

    The format of the ConstituteImage method is:

    - -
    -  Image *ConstituteImage(const size_t columns,const size_t rows,
-    const char *map,const StorageType storage,const void *pixels,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    columns
    -

    width in pixels of the image.

    - -
    rows
    -

    height in pixels of the image.

    - -
    map
    -

    This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.

    - -
    storage
    -

    Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel, LongPixel, QuantumPixel, or ShortPixel.

    - -
    pixels
    -

    This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    PingImage

    -
    - -

    PingImage() returns all the properties of an image or image sequence except for the pixels. It is much faster and consumes far less memory than ReadImage(). On failure, a NULL image is returned and exception describes the reason for the failure.

    - -

    The format of the PingImage method is:

    - -
    -  Image *PingImage(const ImageInfo *image_info,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    Ping the image defined by the file or filename members of this structure.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    PingImages

    -
    - -

    PingImages() pings one or more images and returns them as an image list.

    - -

    The format of the PingImage method is:

    - -
    -  Image *PingImages(const ImageInfo *image_info,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ReadImage

    -
    - -

    ReadImage() reads an image or image sequence from a file or file handle. The method returns a NULL if there is a memory shortage or if the image cannot be read. On failure, a NULL image is returned and exception describes the reason for the failure.

    - -

    The format of the ReadImage method is:

    - -
    -  Image *ReadImage(const ImageInfo *image_info,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    Read the image defined by the file or filename members of this structure.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ReadImages

    -
    - -

    ReadImages() reads one or more images and returns them as an image list.

    - -

    The format of the ReadImage method is:

    - -
    -  Image *ReadImages(const ImageInfo *image_info,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    WriteImage

    -
    - -

    WriteImage() writes an image or an image sequence to a file or file handle. If writing to a file is on disk, the name is defined by the filename member of the image structure. WriteImage() returns MagickFalse is there is a memory shortage or if the image cannot be written. Check the exception member of image to determine the cause for any failure.

    - -

    The format of the WriteImage method is:

    - -
    -  MagickBooleanType WriteImage(const ImageInfo *image_info,Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    image
    -

    the image.

    - -
    -

    WriteImages

    -
    - -

    WriteImages() writes an image sequence into one or more files. While WriteImage() can write an image sequence, it is limited to writing the sequence into a single file using a format which supports multiple frames. WriteImages(), however, does not have this limitation, instead it generates multiple output files if necessary (or when requested). When ImageInfo's adjoin flag is set to MagickFalse, the file name is expected to include a printf-style formatting string for the frame number (e.g. "image02d.png").

    - -

    The format of the WriteImages method is:

    - -
    -  MagickBooleanType WriteImages(const ImageInfo *image_info,Image *images,
-    const char *filename,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    images
    -

    the image list.

    - -
    filename
    -

    the image filename.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/decorate.html b/www/api/decorate.html index f46b3b0d2..bdfbc8da0 100644 --- a/www/api/decorate.html +++ b/www/api/decorate.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,85 +190,9 @@
    -

    Module decorate - Methods

    -

    [BorderImage • FrameImage • RaiseImage]

    +

    Module Methods

    +

    []

    -

    BorderImage

    -
    - -

    BorderImage() surrounds the image with a border of the color defined by the bordercolor member of the image structure. The width and height of the border are defined by the corresponding members of the border_info structure.

    - -

    The format of the BorderImage method is:

    - -
    -  Image *BorderImage(const Image *image,const RectangleInfo *border_info,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    border_info
    -

    Define the width and height of the border.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    FrameImage

    -
    - -

    FrameImage() adds a simulated three-dimensional border around the image. The color of the border is defined by the matte_color member of image. Members width and height of frame_info specify the border width of the vertical and horizontal sides of the frame. Members inner and outer indicate the width of the inner and outer shadows of the frame.

    - -

    The format of the FrameImage method is:

    - -
    -  Image *FrameImage(const Image *image,const FrameInfo *frame_info,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    frame_info
    -

    Define the width and height of the frame and its bevels.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    RaiseImage

    -
    - -

    RaiseImage() creates a simulated three-dimensional button-like effect by lightening and darkening the edges of the image. Members width and height of raise_info define the width of the vertical and horizontal edge of the effect.

    - -

    The format of the RaiseImage method is:

    - -
    -  MagickBooleanType RaiseImage(const Image *image,
-    const RectangleInfo *raise_info,const MagickBooleanType raise)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    raise_info
    -

    Define the width and height of the raise area.

    - -
    raise
    -

    A value other than zero creates a 3-D raise effect, otherwise it has a lowered effect.

    - -
    diff --git a/www/api/deprecate.html b/www/api/deprecate.html index 97d7d0eba..dba17a181 100644 --- a/www/api/deprecate.html +++ b/www/api/deprecate.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,106 +190,9 @@
    -

    Module distort - Methods

    -

    [DistortImage • SparseColorImage]

    +

    Module Methods

    +

    []

    -

    DistortImage

    -
    - -

    DistortImage() distorts an image using various distortion methods, by mapping color lookups of the source image to a new destination image usally of the same size as the source image, unless 'bestfit' is set to true.

    - -

    If 'bestfit' is enabled, and distortion allows it, the destination image is adjusted to ensure the whole source 'image' will just fit within the final destination image, which will be sized and offset accordingly. Also in many cases the virtual offset of the source image will be taken into account in the mapping.

    - -

    If the '-verbose' control option has been set print to standard error the equicelent '-fx' formula with coefficients for the function, if practical.

    - -

    The format of the DistortImage() method is:

    - -
    -  Image *DistortImage(const Image *image,const DistortImageMethod method,
-    const size_t number_arguments,const double *arguments,
-    MagickBooleanType bestfit, ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image to be distorted.

    - -
    method
    -

    the method of image distortion.

    - -

    ArcDistortion always ignores source image offset, and always 'bestfit' the destination image with the top left corner offset relative to the polar mapping center.

    - -

    Affine, Perspective, and Bilinear, do least squares fitting of the distrotion when more than the minimum number of control point pairs are provided.

    - -

    Perspective, and Bilinear, fall back to a Affine distortion when less than 4 control point pairs are provided. While Affine distortions let you use any number of control point pairs, that is Zero pairs is a No-Op (viewport only) distortion, one pair is a translation and two pairs of control points do a scale-rotate-translate, without any shearing.

    - -
    number_arguments
    -

    the number of arguments given.

    - -
    arguments
    -

    an array of floating point arguments for this method.

    - -
    bestfit
    -

    Attempt to 'bestfit' the size of the resulting image. This also forces the resulting image to be a 'layered' virtual canvas image. Can be overridden using 'distort:viewport' setting.

    - -
    exception
    -

    return any errors or warnings in this structure

    - -

    Extra Controls from Image meta-data (artifacts)...

    - -

    o "verbose" Output to stderr alternatives, internal coefficents, and FX equivelents for the distortion operation (if feasible). This forms an extra check of the distortion method, and allows users access to the internal constants IM calculates for the distortion.

    - -

    o "distort:viewport" Directly set the output image canvas area and offest to use for the resulting image, rather than use the original images canvas, or a calculated 'bestfit' canvas.

    - -

    o "distort:scale" Scale the size of the output canvas by this amount to provide a method of Zooming, and for super-sampling the results.

    - -

    Other settings that can effect results include

    - -

    o 'interpolate' For source image lookups (scale enlargements)

    - -

    o 'filter' Set filter to use for area-resampling (scale shrinking). Set to 'point' to turn off and use 'interpolate' lookup instead

    - -
    -

    SparseColorImage

    -
    - -

    SparseColorImage(), given a set of coordinates, interpolates the colors found at those coordinates, across the whole image, using various methods.

    - -

    The format of the SparseColorImage() method is:

    - -
    -  Image *SparseColorImage(const Image *image,const ChannelType channel,
-    const SparseColorMethod method,const size_t number_arguments,
-    const double *arguments,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image to be filled in.

    - -
    channel
    -

    Specify which color values (in RGBKA sequence) are being set. This also determines the number of color_values in above.

    - -
    method
    -

    the method to fill in the gradient between the control points.

    - -

    The methods used for SparseColor() are often simular to methods used for DistortImage(), and even share the same code for determination of the function coefficents, though with more dimensions (or resulting values).

    - -
    number_arguments
    -

    the number of arguments given.

    - -
    arguments
    -

    array of floating point arguments for this method-- x,y,color_values-- with color_values given as normalized values.

    - -
    exception
    -

    return any errors or warnings in this structure

    - -
    diff --git a/www/api/draw.html b/www/api/draw.html index 78b413e19..2305983c0 100644 --- a/www/api/draw.html +++ b/www/api/draw.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,227 +190,9 @@
    -

    Module draw - Methods

    -

    [AcquireDrawInfo • CloneDrawInfo • DestroyDrawInfo • DrawAffineImage • DrawClipPath • DrawImage • DrawGradientImage • DrawPatternPath • DrawPrimitive • GetAffineMatrix]

    +

    Module Methods

    +

    []

    -

    AcquireDrawInfo

    -
    - -

    AcquireDrawInfo() returns a DrawInfo structure properly initialized.

    - -

    The format of the AcquireDrawInfo method is:

    - -
    -  DrawInfo *AcquireDrawInfo(void)
-
    - -
    -

    CloneDrawInfo

    -
    - -

    CloneDrawInfo() makes a copy of the given draw info structure. If NULL is specified, a new image info structure is created initialized to default values.

    - -

    The format of the CloneDrawInfo method is:

    - -
    -  DrawInfo *CloneDrawInfo(const ImageInfo *image_info,
-    const DrawInfo *draw_info)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    draw_info
    -

    the draw info.

    - -
    -

    DestroyDrawInfo

    -
    - -

    DestroyDrawInfo() deallocates memory associated with an DrawInfo structure.

    - -

    The format of the DestroyDrawInfo method is:

    - -
    -  DrawInfo *DestroyDrawInfo(DrawInfo *draw_info)
-
    - -

    A description of each parameter follows:

    - -
    draw_info
    -

    the draw info.

    - -
    -

    DrawAffineImage

    -
    - -

    DrawAffineImage() composites the source over the destination image as dictated by the affine transform.

    - -

    The format of the DrawAffineImage method is:

    - -
    -  MagickBooleanType DrawAffineImage(Image *image,const Image *source,
-    const AffineMatrix *affine)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    source
    -

    the source image.

    - -
    affine
    -

    the affine transform.

    - -
    -

    DrawClipPath

    -
    - -

    DrawClipPath() draws the clip path on the image mask.

    - -

    The format of the DrawClipPath method is:

    - -
    -  MagickBooleanType DrawClipPath(Image *image,const DrawInfo *draw_info,
-    const char *name)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    draw_info
    -

    the draw info.

    - -
    name
    -

    the name of the clip path.

    - -
    -

    DrawImage

    -
    - -

    DrawImage() draws a graphic primitive on your image. The primitive may be represented as a string or filename. Precede the filename with an "at" sign (@) and the contents of the file are drawn on the image. You can affect how text is drawn by setting one or more members of the draw info structure.

    - -

    The format of the DrawImage method is:

    - -
    -  MagickBooleanType DrawImage(Image *image,const DrawInfo *draw_info)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    draw_info
    -

    the draw info.

    - -
    -

    DrawGradientImage

    -
    - -

    DrawGradientImage() draws a linear gradient on the image.

    - -

    The format of the DrawGradientImage method is:

    - -
    -  MagickBooleanType DrawGradientImage(Image *image,
-    const DrawInfo *draw_info)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    _info
    -

    the draw info.

    - -
    -

    DrawPatternPath

    -
    - -

    DrawPatternPath() draws a pattern.

    - -

    The format of the DrawPatternPath method is:

    - -
    -  MagickBooleanType DrawPatternPath(Image *image,const DrawInfo *draw_info,
-    const char *name,Image **pattern)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    draw_info
    -

    the draw info.

    - -
    name
    -

    the pattern name.

    - -
    image
    -

    the image.

    - -
    -

    DrawPrimitive

    -
    - -

    DrawPrimitive() draws a primitive (line, rectangle, ellipse) on the image.

    - -

    The format of the DrawPrimitive method is:

    - -
    -  MagickBooleanType DrawPrimitive(Image *image,const DrawInfo *draw_info,
-    PrimitiveInfo *primitive_info)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    draw_info
    -

    the draw info.

    - -
    primitive_info
    -

    Specifies a pointer to a PrimitiveInfo structure.

    - -
    -

    GetAffineMatrix

    -
    - -

    GetAffineMatrix() returns an AffineMatrix initialized to the identity matrix.

    - -

    The format of the GetAffineMatrix method is:

    - -
    -  void GetAffineMatrix(AffineMatrix *affine_matrix)
-
    - -

    A description of each parameter follows:

    - -
    affine_matrix
    -

    the affine matrix.

    - -
    diff --git a/www/api/drawing-wand.html b/www/api/drawing-wand.html index 86c85671e..4d409422a 100644 --- a/www/api/drawing-wand.html +++ b/www/api/drawing-wand.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,2966 +190,9 @@
    -

    Module drawing-wand - Methods

    -

    [ClearDrawingWand • CloneDrawingWand • DestroyDrawingWand • DrawAffine • DrawAnnotation • DrawArc • DrawBezier • DrawCircle • DrawClearException • DrawComposite • DrawColor • DrawComment • DrawEllipse • DrawGetBorderColor • DrawGetClipPath • DrawGetClipRule • DrawGetClipUnits • DrawGetException • DrawGetExceptionType • DrawGetFillColor • DrawGetFillOpacity • DrawGetFillRule • DrawGetFont • DrawGetFontFamily • DrawGetFontResolution • DrawGetFontSize • DrawGetFontStretch • DrawGetFontStyle • DrawGetFontWeight • DrawGetGravity • DrawGetOpacity • DrawGetStrokeAntialias • DrawGetStrokeColor • DrawGetStrokeDashArray • DrawGetStrokeDashOffset • DrawGetStrokeLineCap • DrawGetStrokeLineJoin • DrawGetStrokeMiterLimit • DrawGetStrokeOpacity • DrawGetStrokeWidth • DrawGetTextAlignment • DrawGetTextAntialias • DrawGetTextDecoration • DrawGetTextEncoding • DrawGetTextKerning • DrawGetTextInterwordSpacing • DrawGetTextInterwordSpacing • DrawGetVectorGraphics • DrawGetTextUnderColor • DrawLine • DrawMatte • DrawPathClose • DrawPathCurveToAbsolute • DrawPathCurveToRelative • DrawPathCurveToQuadraticBezierAbsolute • DrawPathCurveToQuadraticBezierRelative • DrawPathCurveToQuadraticBezierSmoothAbsolute • DrawPathCurveToQuadraticBezierSmoothAbsolute • DrawPathCurveToSmoothAbsolute • DrawPathCurveToSmoothRelative • DrawPathEllipticArcAbsolute • DrawPathEllipticArcRelative • DrawPathFinish • DrawPathLineToAbsolute • DrawPathLineToRelative • DrawPathLineToHorizontalAbsolute • DrawPathLineToHorizontalRelative • DrawPathLineToVerticalAbsolute • DrawPathLineToVerticalRelative • DrawPathMoveToAbsolute • DrawPathMoveToRelative • DrawPathStart • DrawPoint • DrawPolygon • DrawPolyline • DrawPopClipPath • DrawPopDefs • DrawPopPattern • DrawPushClipPath • DrawPushDefs • DrawPushPattern • DrawRectangle • DrawResetVectorGraphics • DrawRotate • DrawRoundRectangle • DrawScale • DrawSetBorderColor • DrawSetClipPath • DrawSetClipRule • DrawSetClipUnits • DrawSetFillColor • DrawSetFillOpacity • DrawSetFontResolution • DrawSetOpacity • DrawSetFillPatternURL • DrawSetFillRule • DrawSetFont • DrawSetFontFamily • DrawSetFontSize • DrawSetFontStretch • DrawSetFontStyle • DrawSetFontWeight • DrawSetGravity • DrawSetStrokeColor • DrawSetStrokePatternURL • DrawSetStrokeAntialias • DrawSetStrokeDashArray • DrawSetStrokeDashOffset • DrawSetStrokeLineCap • DrawSetStrokeLineJoin • DrawSetStrokeMiterLimit • DrawSetStrokeOpacity • DrawSetStrokeWidth • DrawSetTextAlignment • DrawSetTextAntialias • DrawSetTextDecoration • DrawSetTextEncoding • DrawSetTextKerning • DrawSetTextInterwordSpacing • DrawSetTextInterwordSpacing • DrawSetTextUnderColor • DrawSetVectorGraphics • DrawSkewX • DrawSkewY • DrawTranslate • DrawSetViewbox • IsDrawingWand • NewDrawingWand • PeekDrawingWand • PopDrawingWand • PushDrawingWand]

    +

    Module Methods

    +

    []

    -

    ClearDrawingWand

    -
    - -

    ClearDrawingWand() clear resources associated with the drawing wand.

    - -

    The format of the ClearDrawingWand method is:

    - -
    -  DrawingWand *ClearDrawingWand(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand. to destroy

    - -
    -

    CloneDrawingWand

    -
    - -

    CloneDrawingWand() makes an exact copy of the specified wand.

    - -

    The format of the CloneDrawingWand method is:

    - -
    -  DrawingWand *CloneDrawingWand(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    DestroyDrawingWand

    -
    - -

    DestroyDrawingWand() frees all resources associated with the drawing wand. Once the drawing wand has been freed, it should not be used and further unless it re-allocated.

    - -

    The format of the DestroyDrawingWand method is:

    - -
    -  DrawingWand *DestroyDrawingWand(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand. to destroy

    - -
    -

    DrawAffine

    -
    - -

    DrawAffine() adjusts the current affine transformation matrix with the specified affine transformation matrix. Note that the current affine transform is adjusted rather than replaced.

    - -

    The format of the DrawAffine method is:

    - -
    -  void DrawAffine(DrawingWand *wand,const AffineMatrix *affine)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    Drawing wand

    - -
    affine
    -

    Affine matrix parameters

    - -
    -

    DrawAnnotation

    -
    - -

    DrawAnnotation() draws text on the image.

    - -

    The format of the DrawAnnotation method is:

    - -
    -  void DrawAnnotation(DrawingWand *wand,const double x,
-    const double y,const unsigned char *text)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x
    -

    x ordinate to left of text

    - -
    y
    -

    y ordinate to text baseline

    - -
    text
    -

    text to draw

    - -
    -

    DrawArc

    -
    - -

    DrawArc() draws an arc falling within a specified bounding rectangle on the image.

    - -

    The format of the DrawArc method is:

    - -
    -  void DrawArc(DrawingWand *wand,const double sx,const double sy,
-    const double ex,const double ey,const double sd,const double ed)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    sx
    -

    starting x ordinate of bounding rectangle

    - -
    sy
    -

    starting y ordinate of bounding rectangle

    - -
    ex
    -

    ending x ordinate of bounding rectangle

    - -
    ey
    -

    ending y ordinate of bounding rectangle

    - -
    sd
    -

    starting degrees of rotation

    - -
    ed
    -

    ending degrees of rotation

    - -
    -

    DrawBezier

    -
    - -

    DrawBezier() draws a bezier curve through a set of points on the image.

    - -

    The format of the DrawBezier method is:

    - -
    -  void DrawBezier(DrawingWand *wand,
-    const size_t number_coordinates,const PointInfo *coordinates)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    number_coordinates
    -

    number of coordinates

    - -
    coordinates
    -

    coordinates

    - -
    -

    DrawCircle

    -
    - -

    DrawCircle() draws a circle on the image.

    - -

    The format of the DrawCircle method is:

    - -
    -  void DrawCircle(DrawingWand *wand,const double ox,
-    const double oy,const double px, const double py)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    ox
    -

    origin x ordinate

    - -
    oy
    -

    origin y ordinate

    - -
    px
    -

    perimeter x ordinate

    - -
    py
    -

    perimeter y ordinate

    - -
    -

    DrawClearException

    -
    - -

    DrawClearException() clear any exceptions associated with the wand.

    - -

    The format of the DrawClearException method is:

    - -
    -  MagickBooleanType DrawClearException(DrawWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawComposite

    -
    - -

    DrawComposite() composites an image onto the current image, using the specified composition operator, specified position, and at the specified size.

    - -

    The format of the DrawComposite method is:

    - -
    -  MagickBooleanType DrawComposite(DrawingWand *wand,
-    const CompositeOperator compose,const double x,
-    const double y,const double width,const double height,
-    MagickWand *magick_wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    compose
    -

    composition operator

    - -
    x
    -

    x ordinate of top left corner

    - -
    y
    -

    y ordinate of top left corner

    - -
    width
    -

    Width to resize image to prior to compositing. Specify zero to use existing width.

    - -
    height
    -

    Height to resize image to prior to compositing. Specify zero to use existing height.

    - -
    magick_wand
    -

    Image to composite is obtained from this wand.

    - -
    -

    DrawColor

    -
    - -

    DrawColor() draws color on image using the current fill color, starting at specified position, and using specified paint method. The available paint methods are:

    - -
    -      PointMethod: Recolors the target pixel
-      ReplaceMethod: Recolor any pixel that matches the target pixel.
-      FloodfillMethod: Recolors target pixels and matching neighbors.
-      ResetMethod: Recolor all pixels.
-
    - -

    The format of the DrawColor method is:

    - -
    -  void DrawColor(DrawingWand *wand,const double x,const double y,
-    const PaintMethod paint_method)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x
    -

    x ordinate.

    - -
    y
    -

    y ordinate.

    - -
    paint_method
    -

    paint method.

    - -
    -

    DrawComment

    -
    - -

    DrawComment() adds a comment to a vector output stream.

    - -

    The format of the DrawComment method is:

    - -
    -  void DrawComment(DrawingWand *wand,const char *comment)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    comment
    -

    comment text

    - -
    -

    DrawEllipse

    -
    - -

    DrawEllipse() draws an ellipse on the image.

    - -

    The format of the DrawEllipse method is:

    - -
    -   void DrawEllipse(DrawingWand *wand,const double ox,const double oy,
-     const double rx,const double ry,const double start,const double end)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    ox
    -

    origin x ordinate

    - -
    oy
    -

    origin y ordinate

    - -
    rx
    -

    radius in x

    - -
    ry
    -

    radius in y

    - -
    start
    -

    starting rotation in degrees

    - -
    end
    -

    ending rotation in degrees

    - -
    -

    DrawGetBorderColor

    -
    - -

    DrawGetBorderColor() returns the border color used for drawing bordered objects.

    - -

    The format of the DrawGetBorderColor method is:

    - -
    -  void DrawGetBorderColor(const DrawingWand *wand,
-    PixelWand *border_color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    border_color
    -

    Return the border color.

    - -
    -

    DrawGetClipPath

    -
    - -

    DrawGetClipPath() obtains the current clipping path ID. The value returned must be deallocated by the user when it is no longer needed.

    - -

    The format of the DrawGetClipPath method is:

    - -
    -  char *DrawGetClipPath(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetClipRule

    -
    - -

    DrawGetClipRule() returns the current polygon fill rule to be used by the clipping path.

    - -

    The format of the DrawGetClipRule method is:

    - -
    -       FillRule DrawGetClipRule(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetClipUnits

    -
    - -

    DrawGetClipUnits() returns the interpretation of clip path units.

    - -

    The format of the DrawGetClipUnits method is:

    - -
    -  ClipPathUnits DrawGetClipUnits(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetException

    -
    - -

    DrawGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.

    - -

    The format of the DrawGetException method is:

    - -
    -  char *DrawGetException(const DrawWand *wand,
-    ExceptionType *severity)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    severity
    -

    the severity of the error is returned here.

    - -
    -

    DrawGetExceptionType

    -
    - -

    DrawGetExceptionType() the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.

    - -

    The format of the DrawGetExceptionType method is:

    - -
    -  ExceptionType DrawGetExceptionType(const DrawWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    DrawGetFillColor

    -
    - -

    DrawGetFillColor() returns the fill color used for drawing filled objects.

    - -

    The format of the DrawGetFillColor method is:

    - -
    -  void DrawGetFillColor(const DrawingWand *wand,
-    PixelWand *fill_color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    fill_color
    -

    Return the fill color.

    - -
    -

    DrawGetFillOpacity

    -
    - -

    DrawGetFillOpacity() returns the opacity used when drawing using the fill color or fill texture. Fully opaque is 1.0.

    - -

    The format of the DrawGetFillOpacity method is:

    - -
    -  double DrawGetFillOpacity(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetFillRule

    -
    - -

    DrawGetFillRule() returns the fill rule used while drawing polygons.

    - -

    The format of the DrawGetFillRule method is:

    - -
    -  FillRule DrawGetFillRule(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetFont

    -
    - -

    DrawGetFont() returns a null-terminaged string specifying the font used when annotating with text. The value returned must be freed by the user when no longer needed.

    - -

    The format of the DrawGetFont method is:

    - -
    -  char *DrawGetFont(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetFontFamily

    -
    - -

    DrawGetFontFamily() returns the font family to use when annotating with text. The value returned must be freed by the user when it is no longer needed.

    - -

    The format of the DrawGetFontFamily method is:

    - -
    -  char *DrawGetFontFamily(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetFontResolution

    -
    - -

    DrawGetFontResolution() gets the image X and Y resolution.

    - -

    The format of the DrawGetFontResolution method is:

    - -
    -  DrawBooleanType DrawGetFontResolution(const DrawingWand *wand,
-    double *x,double *y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x
    -

    the x-resolution.

    - -
    y
    -

    the y-resolution.

    - -
    -

    DrawGetFontSize

    -
    - -

    DrawGetFontSize() returns the font pointsize used when annotating with text.

    - -

    The format of the DrawGetFontSize method is:

    - -
    -  double DrawGetFontSize(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetFontStretch

    -
    - -

    DrawGetFontStretch() returns the font stretch used when annotating with text.

    - -

    The format of the DrawGetFontStretch method is:

    - -
    -  StretchType DrawGetFontStretch(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetFontStyle

    -
    - -

    DrawGetFontStyle() returns the font style used when annotating with text.

    - -

    The format of the DrawGetFontStyle method is:

    - -
    -  StyleType DrawGetFontStyle(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetFontWeight

    -
    - -

    DrawGetFontWeight() returns the font weight used when annotating with text.

    - -

    The format of the DrawGetFontWeight method is:

    - -
    -  size_t DrawGetFontWeight(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetGravity

    -
    - -

    DrawGetGravity() returns the text placement gravity used when annotating with text.

    - -

    The format of the DrawGetGravity method is:

    - -
    -  GravityType DrawGetGravity(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetOpacity

    -
    - -

    DrawGetOpacity() returns the opacity used when drawing with the fill or stroke color or texture. Fully opaque is 1.0.

    - -

    The format of the DrawGetOpacity method is:

    - -
    -  double DrawGetOpacity(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetStrokeAntialias

    -
    - -

    DrawGetStrokeAntialias() returns the current stroke antialias setting. Stroked outlines are antialiased by default. When antialiasing is disabled stroked pixels are thresholded to determine if the stroke color or underlying canvas color should be used.

    - -

    The format of the DrawGetStrokeAntialias method is:

    - -
    -  MagickBooleanType DrawGetStrokeAntialias(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetStrokeColor

    -
    - -

    DrawGetStrokeColor() returns the color used for stroking object outlines.

    - -

    The format of the DrawGetStrokeColor method is:

    - -
    -  void DrawGetStrokeColor(const DrawingWand *wand,
-  $  PixelWand *stroke_color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    stroke_color
    -

    Return the stroke color.

    - -
    -

    DrawGetStrokeDashArray

    -
    - -

    DrawGetStrokeDashArray() returns an array representing the pattern of dashes and gaps used to stroke paths (see DrawSetStrokeDashArray). The array must be freed once it is no longer required by the user.

    - -

    The format of the DrawGetStrokeDashArray method is:

    - -
    -  double *DrawGetStrokeDashArray(const DrawingWand *wand,
-    size_t *number_elements)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    number_elements
    -

    address to place number of elements in dash array

    - -
    -

    DrawGetStrokeDashOffset

    -
    - -

    DrawGetStrokeDashOffset() returns the offset into the dash pattern to start the dash.

    - -

    The format of the DrawGetStrokeDashOffset method is:

    - -
    -  double DrawGetStrokeDashOffset(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetStrokeLineCap

    -
    - -

    DrawGetStrokeLineCap() returns the shape to be used at the end of open subpaths when they are stroked. Values of LineCap are UndefinedCap, ButtCap, RoundCap, and SquareCap.

    - -

    The format of the DrawGetStrokeLineCap method is:

    - -
    -  LineCap DrawGetStrokeLineCap(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetStrokeLineJoin

    -
    - -

    DrawGetStrokeLineJoin() returns the shape to be used at the corners of paths (or other vector shapes) when they are stroked. Values of LineJoin are UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin.

    - -

    The format of the DrawGetStrokeLineJoin method is:

    - -
    -  LineJoin DrawGetStrokeLineJoin(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetStrokeMiterLimit

    -
    - -

    DrawGetStrokeMiterLimit() returns the miter limit. When two line segments meet at a sharp angle and miter joins have been specified for 'lineJoin', it is possible for the miter to extend far beyond the thickness of the line stroking the path. The miterLimit' imposes a limit on the ratio of the miter length to the 'lineWidth'.

    - -

    The format of the DrawGetStrokeMiterLimit method is:

    - -
    -  size_t DrawGetStrokeMiterLimit(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetStrokeOpacity

    -
    - -

    DrawGetStrokeOpacity() returns the opacity of stroked object outlines.

    - -

    The format of the DrawGetStrokeOpacity method is:

    - -
    -  double DrawGetStrokeOpacity(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetStrokeWidth

    -
    - -

    DrawGetStrokeWidth() returns the width of the stroke used to draw object outlines.

    - -

    The format of the DrawGetStrokeWidth method is:

    - -
    -  double DrawGetStrokeWidth(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetTextAlignment

    -
    - -

    DrawGetTextAlignment() returns the alignment applied when annotating with text.

    - -

    The format of the DrawGetTextAlignment method is:

    - -
    -  AlignType DrawGetTextAlignment(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetTextAntialias

    -
    - -

    DrawGetTextAntialias() returns the current text antialias setting, which determines whether text is antialiased. Text is antialiased by default.

    - -

    The format of the DrawGetTextAntialias method is:

    - -
    -  MagickBooleanType DrawGetTextAntialias(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetTextDecoration

    -
    - -

    DrawGetTextDecoration() returns the decoration applied when annotating with text.

    - -

    The format of the DrawGetTextDecoration method is:

    - -
    -  DecorationType DrawGetTextDecoration(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetTextEncoding

    -
    - -

    DrawGetTextEncoding() returns a null-terminated string which specifies the code set used for text annotations. The string must be freed by the user once it is no longer required.

    - -

    The format of the DrawGetTextEncoding method is:

    - -
    -  char *DrawGetTextEncoding(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetTextKerning

    -
    - -

    DrawGetTextKerning() gets the spacing between characters in text.

    - -

    The format of the DrawSetFontKerning method is:

    - -
    -  double DrawGetTextKerning(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetTextInterwordSpacing

    -
    - -

    DrawGetTextInterwordSpacing() gets the spacing between lines in text.

    - -

    The format of the DrawSetFontKerning method is:

    - -
    -  double DrawGetTextInterwordSpacing(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetTextInterwordSpacing

    -
    - -

    DrawGetTextInterwordSpacing() gets the spacing between words in text.

    - -

    The format of the DrawSetFontKerning method is:

    - -
    -  double DrawGetTextInterwordSpacing(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetVectorGraphics

    -
    - -

    DrawGetVectorGraphics() returns a null-terminated string which specifies the vector graphics generated by any graphics calls made since the wand was instantiated. The string must be freed by the user once it is no longer required.

    - -

    The format of the DrawGetVectorGraphics method is:

    - -
    -  char *DrawGetVectorGraphics(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetTextUnderColor

    -
    - -

    DrawGetTextUnderColor() returns the color of a background rectangle to place under text annotations.

    - -

    The format of the DrawGetTextUnderColor method is:

    - -
    -  void DrawGetTextUnderColor(const DrawingWand *wand,
-    PixelWand *under_color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    under_color
    -

    Return the under color.

    - -
    -

    DrawLine

    -
    - -

    DrawLine() draws a line on the image using the current stroke color, stroke opacity, and stroke width.

    - -

    The format of the DrawLine method is:

    - -
    -  void DrawLine(DrawingWand *wand,const double sx,const double sy,
-    const double ex,const double ey)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    sx
    -

    starting x ordinate

    - -
    sy
    -

    starting y ordinate

    - -
    ex
    -

    ending x ordinate

    - -
    ey
    -

    ending y ordinate

    - -
    -

    DrawMatte

    -
    - -

    DrawMatte() paints on the image's opacity channel in order to set effected pixels to transparent. to influence the opacity of pixels. The available paint methods are:

    - -
    -      PointMethod: Select the target pixel
-      ReplaceMethod: Select any pixel that matches the target pixel.
-      FloodfillMethod: Select the target pixel and matching neighbors.
-      FillToBorderMethod: Select the target pixel and neighbors not matching
-  border color.
-      ResetMethod: Select all pixels.
-
    - -

    The format of the DrawMatte method is:

    - -
    -  void DrawMatte(DrawingWand *wand,const double x,const double y,
-    const PaintMethod paint_method)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x
    -

    x ordinate

    - -
    y
    -

    y ordinate

    - -
    paint_method
    -

    paint method.

    - -
    -

    DrawPathClose

    -
    - -

    DrawPathClose() adds a path element to the current path which closes the current subpath by drawing a straight line from the current point to the current subpath's most recent starting point (usually, the most recent moveto point).

    - -

    The format of the DrawPathClose method is:

    - -
    -  void DrawPathClose(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawPathCurveToAbsolute

    -
    - -

    DrawPathCurveToAbsolute() draws a cubic Bezier curve from the current point to (x,y) using (x1,y1) as the control point at the beginning of the curve and (x2,y2) as the control point at the end of the curve using absolute coordinates. At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier.

    - -

    The format of the DrawPathCurveToAbsolute method is:

    - -
    -  void DrawPathCurveToAbsolute(DrawingWand *wand,const double x1,
-    const double y1,const double x2,const double y2,const double x,
-    const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x1
    -

    x ordinate of control point for curve beginning

    - -
    y1
    -

    y ordinate of control point for curve beginning

    - -
    x2
    -

    x ordinate of control point for curve ending

    - -
    y2
    -

    y ordinate of control point for curve ending

    - -
    x
    -

    x ordinate of the end of the curve

    - -
    y
    -

    y ordinate of the end of the curve

    - -
    -

    DrawPathCurveToRelative

    -
    - -

    DrawPathCurveToRelative() draws a cubic Bezier curve from the current point to (x,y) using (x1,y1) as the control point at the beginning of the curve and (x2,y2) as the control point at the end of the curve using relative coordinates. At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier.

    - -

    The format of the DrawPathCurveToRelative method is:

    - -
    -  void DrawPathCurveToRelative(DrawingWand *wand,const double x1,
-    const double y1,const double x2,const double y2,const double x,
-    const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x1
    -

    x ordinate of control point for curve beginning

    - -
    y1
    -

    y ordinate of control point for curve beginning

    - -
    x2
    -

    x ordinate of control point for curve ending

    - -
    y2
    -

    y ordinate of control point for curve ending

    - -
    x
    -

    x ordinate of the end of the curve

    - -
    y
    -

    y ordinate of the end of the curve

    - -
    -

    DrawPathCurveToQuadraticBezierAbsolute

    -
    - -

    DrawPathCurveToQuadraticBezierAbsolute() draws a quadratic Bezier curve from the current point to (x,y) using (x1,y1) as the control point using absolute coordinates. At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier.

    - -

    The format of the DrawPathCurveToQuadraticBezierAbsolute method is:

    - -
    -  void DrawPathCurveToQuadraticBezierAbsolute(DrawingWand *wand,
-    const double x1,const double y1,onst double x,const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x1
    -

    x ordinate of the control point

    - -
    y1
    -

    y ordinate of the control point

    - -
    x
    -

    x ordinate of final point

    - -
    y
    -

    y ordinate of final point

    - -
    -

    DrawPathCurveToQuadraticBezierRelative

    -
    - -

    DrawPathCurveToQuadraticBezierRelative() draws a quadratic Bezier curve from the current point to (x,y) using (x1,y1) as the control point using relative coordinates. At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier.

    - -

    The format of the DrawPathCurveToQuadraticBezierRelative method is:

    - -
    -  void DrawPathCurveToQuadraticBezierRelative(DrawingWand *wand,
-    const double x1,const double y1,const double x,const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x1
    -

    x ordinate of the control point

    - -
    y1
    -

    y ordinate of the control point

    - -
    x
    -

    x ordinate of final point

    - -
    y
    -

    y ordinate of final point

    - -
    -

    DrawPathCurveToQuadraticBezierSmoothAbsolute

    -
    - -

    DrawPathCurveToQuadraticBezierSmoothAbsolute() draws a quadratic Bezier curve (using absolute coordinates) from the current point to (x,y). The control point is assumed to be the reflection of the control point on the previous command relative to the current point. (If there is no previous command or if the previous command was not a DrawPathCurveToQuadraticBezierAbsolute, DrawPathCurveToQuadraticBezierRelative, DrawPathCurveToQuadraticBezierSmoothAbsolute or DrawPathCurveToQuadraticBezierSmoothRelative, assume the control point is coincident with the current point.). At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier.

    - -

    The format of the DrawPathCurveToQuadraticBezierSmoothAbsolute method is:

    - -
    -  void DrawPathCurveToQuadraticBezierSmoothAbsolute(
-    DrawingWand *wand,const double x,const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x
    -

    x ordinate of final point

    - -
    y
    -

    y ordinate of final point

    - -
    -

    DrawPathCurveToQuadraticBezierSmoothAbsolute

    -
    - -

    DrawPathCurveToQuadraticBezierSmoothAbsolute() draws a quadratic Bezier curve (using relative coordinates) from the current point to (x,y). The control point is assumed to be the reflection of the control point on the previous command relative to the current point. (If there is no previous command or if the previous command was not a DrawPathCurveToQuadraticBezierAbsolute, DrawPathCurveToQuadraticBezierRelative, DrawPathCurveToQuadraticBezierSmoothAbsolute or DrawPathCurveToQuadraticBezierSmoothRelative, assume the control point is coincident with the current point.). At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier.

    - -

    The format of the DrawPathCurveToQuadraticBezierSmoothRelative method is:

    - -
    -  void DrawPathCurveToQuadraticBezierSmoothRelative(DrawingWand *wand,
-    const double x,const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x
    -

    x ordinate of final point

    - -
    y
    -

    y ordinate of final point

    - -
    -

    DrawPathCurveToSmoothAbsolute

    -
    - -

    DrawPathCurveToSmoothAbsolute() draws a cubic Bezier curve from the current point to (x,y) using absolute coordinates. The first control point is assumed to be the reflection of the second control point on the previous command relative to the current point. (If there is no previous command or if the previous command was not an DrawPathCurveToAbsolute, DrawPathCurveToRelative, DrawPathCurveToSmoothAbsolute or DrawPathCurveToSmoothRelative, assume the first control point is coincident with the current point.) (x2,y2) is the second control point (i.e., the control point at the end of the curve). At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier.

    - -

    The format of the DrawPathCurveToSmoothAbsolute method is:

    - -
    -  void DrawPathCurveToSmoothAbsolute(DrawingWand *wand,
-    const double x2const double y2,const double x,const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x2
    -

    x ordinate of second control point

    - -
    y2
    -

    y ordinate of second control point

    - -
    x
    -

    x ordinate of termination point

    - -
    y
    -

    y ordinate of termination point

    - -
    -

    DrawPathCurveToSmoothRelative

    -
    - -

    DrawPathCurveToSmoothRelative() draws a cubic Bezier curve from the current point to (x,y) using relative coordinates. The first control point is assumed to be the reflection of the second control point on the previous command relative to the current point. (If there is no previous command or if the previous command was not an DrawPathCurveToAbsolute, DrawPathCurveToRelative, DrawPathCurveToSmoothAbsolute or DrawPathCurveToSmoothRelative, assume the first control point is coincident with the current point.) (x2,y2) is the second control point (i.e., the control point at the end of the curve). At the end of the command, the new current point becomes the final (x,y) coordinate pair used in the polybezier.

    - -

    The format of the DrawPathCurveToSmoothRelative method is:

    - -
    -  void DrawPathCurveToSmoothRelative(DrawingWand *wand,
-    const double x2,const double y2,const double x,const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x2
    -

    x ordinate of second control point

    - -
    y2
    -

    y ordinate of second control point

    - -
    x
    -

    x ordinate of termination point

    - -
    y
    -

    y ordinate of termination point

    - -
    -

    DrawPathEllipticArcAbsolute

    -
    - -

    DrawPathEllipticArcAbsolute() draws an elliptical arc from the current point to (x, y) using absolute coordinates. The size and orientation of the ellipse are defined by two radii (rx, ry) and an xAxisRotation, which indicates how the ellipse as a whole is rotated relative to the current coordinate system. The center (cx, cy) of the ellipse is calculated automagically to satisfy the constraints imposed by the other parameters. largeArcFlag and sweepFlag contribute to the automatic calculations and help determine how the arc is drawn. If largeArcFlag is true then draw the larger of the available arcs. If sweepFlag is true, then draw the arc matching a clock-wise rotation.

    - -

    The format of the DrawPathEllipticArcAbsolute method is:

    - -
    -  void DrawPathEllipticArcAbsolute(DrawingWand *wand,
-    const double rx,const double ry,const double x_axis_rotation,
-    const MagickBooleanType large_arc_flag,
-    const MagickBooleanType sweep_flag,const double x,const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    rx
    -

    x radius

    - -
    ry
    -

    y radius

    - -
    x_axis_rotation
    -

    indicates how the ellipse as a whole is rotated relative to the current coordinate system

    - -
    large_arc_flag
    -

    If non-zero (true) then draw the larger of the available arcs

    - -
    sweep_flag
    -

    If non-zero (true) then draw the arc matching a clock-wise rotation

    - - -
    -

    DrawPathEllipticArcRelative

    -
    - -

    DrawPathEllipticArcRelative() draws an elliptical arc from the current point to (x, y) using relative coordinates. The size and orientation of the ellipse are defined by two radii (rx, ry) and an xAxisRotation, which indicates how the ellipse as a whole is rotated relative to the current coordinate system. The center (cx, cy) of the ellipse is calculated automagically to satisfy the constraints imposed by the other parameters. largeArcFlag and sweepFlag contribute to the automatic calculations and help determine how the arc is drawn. If largeArcFlag is true then draw the larger of the available arcs. If sweepFlag is true, then draw the arc matching a clock-wise rotation.

    - -

    The format of the DrawPathEllipticArcRelative method is:

    - -
    -  void DrawPathEllipticArcRelative(DrawingWand *wand,
-    const double rx,const double ry,const double x_axis_rotation,
-    const MagickBooleanType large_arc_flag,
-    const MagickBooleanType sweep_flag,const double x,const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    rx
    -

    x radius

    - -
    ry
    -

    y radius

    - -
    x_axis_rotation
    -

    indicates how the ellipse as a whole is rotated relative to the current coordinate system

    - -
    large_arc_flag
    -

    If non-zero (true) then draw the larger of the available arcs

    - -
    sweep_flag
    -

    If non-zero (true) then draw the arc matching a clock-wise rotation

    - -
    -

    DrawPathFinish

    -
    - -

    DrawPathFinish() terminates the current path.

    - -

    The format of the DrawPathFinish method is:

    - -
    -  void DrawPathFinish(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawPathLineToAbsolute

    -
    - -

    DrawPathLineToAbsolute() draws a line path from the current point to the given coordinate using absolute coordinates. The coordinate then becomes the new current point.

    - -

    The format of the DrawPathLineToAbsolute method is:

    - -
    -  void DrawPathLineToAbsolute(DrawingWand *wand,const double x,
-    const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x
    -

    target x ordinate

    - -
    y
    -

    target y ordinate

    - -
    -

    DrawPathLineToRelative

    -
    - -

    DrawPathLineToRelative() draws a line path from the current point to the given coordinate using relative coordinates. The coordinate then becomes the new current point.

    - -

    The format of the DrawPathLineToRelative method is:

    - -
    -  void DrawPathLineToRelative(DrawingWand *wand,const double x,
-    const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x
    -

    target x ordinate

    - -
    y
    -

    target y ordinate

    - -
    -

    DrawPathLineToHorizontalAbsolute

    -
    - -

    DrawPathLineToHorizontalAbsolute() draws a horizontal line path from the current point to the target point using absolute coordinates. The target point then becomes the new current point.

    - -

    The format of the DrawPathLineToHorizontalAbsolute method is:

    - -
    -  void DrawPathLineToHorizontalAbsolute(DrawingWand *wand,
-    const PathMode mode,const double x)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x
    -

    target x ordinate

    - -
    -

    DrawPathLineToHorizontalRelative

    -
    - -

    DrawPathLineToHorizontalRelative() draws a horizontal line path from the current point to the target point using relative coordinates. The target point then becomes the new current point.

    - -

    The format of the DrawPathLineToHorizontalRelative method is:

    - -
    -  void DrawPathLineToHorizontalRelative(DrawingWand *wand,
-    const double x)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x
    -

    target x ordinate

    - -
    -

    DrawPathLineToVerticalAbsolute

    -
    - -

    DrawPathLineToVerticalAbsolute() draws a vertical line path from the current point to the target point using absolute coordinates. The target point then becomes the new current point.

    - -

    The format of the DrawPathLineToVerticalAbsolute method is:

    - -
    -  void DrawPathLineToVerticalAbsolute(DrawingWand *wand,
-    const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    y
    -

    target y ordinate

    - -
    -

    DrawPathLineToVerticalRelative

    -
    - -

    DrawPathLineToVerticalRelative() draws a vertical line path from the current point to the target point using relative coordinates. The target point then becomes the new current point.

    - -

    The format of the DrawPathLineToVerticalRelative method is:

    - -
    -  void DrawPathLineToVerticalRelative(DrawingWand *wand,
-    const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    y
    -

    target y ordinate

    - -
    -

    DrawPathMoveToAbsolute

    -
    - -

    DrawPathMoveToAbsolute() starts a new sub-path at the given coordinate using absolute coordinates. The current point then becomes the specified coordinate.

    - -

    The format of the DrawPathMoveToAbsolute method is:

    - -
    -  void DrawPathMoveToAbsolute(DrawingWand *wand,const double x,
-    const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x
    -

    target x ordinate

    - -
    y
    -

    target y ordinate

    - -
    -

    DrawPathMoveToRelative

    -
    - -

    DrawPathMoveToRelative() starts a new sub-path at the given coordinate using relative coordinates. The current point then becomes the specified coordinate.

    - -

    The format of the DrawPathMoveToRelative method is:

    - -
    -  void DrawPathMoveToRelative(DrawingWand *wand,const double x,
-    const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x
    -

    target x ordinate

    - -
    y
    -

    target y ordinate

    - -
    -

    DrawPathStart

    -
    - -

    DrawPathStart() declares the start of a path drawing list which is terminated by a matching DrawPathFinish() command. All other DrawPath commands must be enclosed between a DrawPathStart() and a DrawPathFinish() command. This is because path drawing commands are subordinate commands and they do not function by themselves.

    - -

    The format of the DrawPathStart method is:

    - -
    -  void DrawPathStart(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawPoint

    -
    - -

    DrawPoint() draws a point using the current fill color.

    - -

    The format of the DrawPoint method is:

    - -
    -  void DrawPoint(DrawingWand *wand,const double x,const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x
    -

    target x coordinate

    - -
    y
    -

    target y coordinate

    - -
    -

    DrawPolygon

    -
    - -

    DrawPolygon() draws a polygon using the current stroke, stroke width, and fill color or texture, using the specified array of coordinates.

    - -

    The format of the DrawPolygon method is:

    - -
    -  void DrawPolygon(DrawingWand *wand,
-    const size_t number_coordinates,const PointInfo *coordinates)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    number_coordinates
    -

    number of coordinates

    - -
    coordinates
    -

    coordinate array

    - -
    -

    DrawPolyline

    -
    - -

    DrawPolyline() draws a polyline using the current stroke, stroke width, and fill color or texture, using the specified array of coordinates.

    - -

    The format of the DrawPolyline method is:

    - -
    -  void DrawPolyline(DrawingWand *wand,
-    const size_t number_coordinates,const PointInfo *coordinates)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    number_coordinates
    -

    number of coordinates

    - -
    coordinates
    -

    coordinate array

    - -
    -

    DrawPopClipPath

    -
    - -

    DrawPopClipPath() terminates a clip path definition.

    - -

    The format of the DrawPopClipPath method is:

    - -
    -  void DrawPopClipPath(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawPopDefs

    -
    - -

    DrawPopDefs() terminates a definition list.

    - -

    The format of the DrawPopDefs method is:

    - -
    -  void DrawPopDefs(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawPopPattern

    -
    - -

    DrawPopPattern() terminates a pattern definition.

    - -

    The format of the DrawPopPattern method is:

    - -
    -  MagickBooleanType DrawPopPattern(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawPushClipPath

    -
    - -

    DrawPushClipPath() starts a clip path definition which is comprized of any number of drawing commands and terminated by a DrawPopClipPath() command.

    - -

    The format of the DrawPushClipPath method is:

    - -
    -  void DrawPushClipPath(DrawingWand *wand,const char *clip_mask_id)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    clip_mask_id
    -

    string identifier to associate with the clip path for later use.

    - -
    -

    DrawPushDefs

    -
    - -

    DrawPushDefs() indicates that commands up to a terminating DrawPopDefs() command create named elements (e.g. clip-paths, textures, etc.) which may safely be processed earlier for the sake of efficiency.

    - -

    The format of the DrawPushDefs method is:

    - -
    -  void DrawPushDefs(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawPushPattern

    -
    - -

    DrawPushPattern() indicates that subsequent commands up to a DrawPopPattern() command comprise the definition of a named pattern. The pattern space is assigned top left corner coordinates, a width and height, and becomes its own drawing space. Anything which can be drawn may be used in a pattern definition. Named patterns may be used as stroke or brush definitions.

    - -

    The format of the DrawPushPattern method is:

    - -
    -  MagickBooleanType DrawPushPattern(DrawingWand *wand,
-    const char *pattern_id,const double x,const double y,
-    const double width,const double height)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    pattern_id
    -

    pattern identification for later reference

    - -
    x
    -

    x ordinate of top left corner

    - -
    y
    -

    y ordinate of top left corner

    - -
    width
    -

    width of pattern space

    - -
    height
    -

    height of pattern space

    - -
    -

    DrawRectangle

    -
    - -

    DrawRectangle() draws a rectangle given two coordinates and using the current stroke, stroke width, and fill settings.

    - -

    The format of the DrawRectangle method is:

    - -
    -  void DrawRectangle(DrawingWand *wand,const double x1,
-    const double y1,const double x2,const double y2)
-
    - -

    A description of each parameter follows:

    - -
    x1
    -

    x ordinate of first coordinate

    - -
    y1
    -

    y ordinate of first coordinate

    - -
    x2
    -

    x ordinate of second coordinate

    - -
    y2
    -

    y ordinate of second coordinate

    - -
    -

    DrawResetVectorGraphics

    -
    - -

    DrawResetVectorGraphics() resets the vector graphics associated with the specified wand.

    - -

    The format of the DrawResetVectorGraphics method is:

    - -
    -  void DrawResetVectorGraphics(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawRotate

    -
    - -

    DrawRotate() applies the specified rotation to the current coordinate space.

    - -

    The format of the DrawRotate method is:

    - -
    -  void DrawRotate(DrawingWand *wand,const double degrees)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    degrees
    -

    degrees of rotation

    - -
    -

    DrawRoundRectangle

    -
    - -

    DrawRoundRectangle() draws a rounted rectangle given two coordinates, x & y corner radiuses and using the current stroke, stroke width, and fill settings.

    - -

    The format of the DrawRoundRectangle method is:

    - -
    -  void DrawRoundRectangle(DrawingWand *wand,double x1,double y1,
-    double x2,double y2,double rx,double ry)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x1
    -

    x ordinate of first coordinate

    - -
    y1
    -

    y ordinate of first coordinate

    - -
    x2
    -

    x ordinate of second coordinate

    - -
    y2
    -

    y ordinate of second coordinate

    - -
    rx
    -

    radius of corner in horizontal direction

    - -
    ry
    -

    radius of corner in vertical direction

    - -
    -

    DrawScale

    -
    - -

    DrawScale() adjusts the scaling factor to apply in the horizontal and vertical directions to the current coordinate space.

    - -

    The format of the DrawScale method is:

    - -
    -  void DrawScale(DrawingWand *wand,const double x,const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x
    -

    horizontal scale factor

    - -
    y
    -

    vertical scale factor

    - -
    -

    DrawSetBorderColor

    -
    - -

    DrawSetBorderColor() sets the border color to be used for drawing bordered objects.

    - -

    The format of the DrawSetBorderColor method is:

    - -
    -  void DrawSetBorderColor(DrawingWand *wand,const PixelWand *border_wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    border_wand
    -

    border wand.

    - -
    -

    DrawSetClipPath

    -
    - -

    DrawSetClipPath() associates a named clipping path with the image. Only the areas drawn on by the clipping path will be modified as ssize_t as it remains in effect.

    - -

    The format of the DrawSetClipPath method is:

    - -
    -  MagickBooleanType DrawSetClipPath(DrawingWand *wand,
-    const char *clip_mask)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    clip_mask
    -

    name of clipping path to associate with image

    - -
    -

    DrawSetClipRule

    -
    - -

    DrawSetClipRule() set the polygon fill rule to be used by the clipping path.

    - -

    The format of the DrawSetClipRule method is:

    - -
    -  void DrawSetClipRule(DrawingWand *wand,const FillRule fill_rule)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    fill_rule
    -

    fill rule (EvenOddRule or NonZeroRule)

    - -
    -

    DrawSetClipUnits

    -
    - -

    DrawSetClipUnits() sets the interpretation of clip path units.

    - -

    The format of the DrawSetClipUnits method is:

    - -
    -  void DrawSetClipUnits(DrawingWand *wand,
-    const ClipPathUnits clip_units)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    clip_units
    -

    units to use (UserSpace, UserSpaceOnUse, or ObjectBoundingBox)

    - -
    -

    DrawSetFillColor

    -
    - -

    DrawSetFillColor() sets the fill color to be used for drawing filled objects.

    - -

    The format of the DrawSetFillColor method is:

    - -
    -  void DrawSetFillColor(DrawingWand *wand,const PixelWand *fill_wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    fill_wand
    -

    fill wand.

    - -
    -

    DrawSetFillOpacity

    -
    - -

    DrawSetFillOpacity() sets the opacity to use when drawing using the fill color or fill texture. Fully opaque is 1.0.

    - -

    The format of the DrawSetFillOpacity method is:

    - -
    -  void DrawSetFillOpacity(DrawingWand *wand,const double fill_opacity)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    fill_opacity
    -

    fill opacity

    - -
    -

    DrawSetFontResolution

    -
    - -

    DrawSetFontResolution() sets the image resolution.

    - -

    The format of the DrawSetFontResolution method is:

    - -
    -  DrawBooleanType DrawSetFontResolution(DrawingWand *wand,
-    const double x_resolution,const doubtl y_resolution)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x_resolution
    -

    the image x resolution.

    - -
    y_resolution
    -

    the image y resolution.

    - -
    -

    DrawSetOpacity

    -
    - -

    DrawSetOpacity() sets the opacity to use when drawing using the fill or stroke color or texture. Fully opaque is 1.0.

    - -

    The format of the DrawSetOpacity method is:

    - -
    -  void DrawSetOpacity(DrawingWand *wand,const double opacity)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    opacity
    -

    fill opacity

    - -
    -

    DrawSetFillPatternURL

    -
    - -

    DrawSetFillPatternURL() sets the URL to use as a fill pattern for filling objects. Only local URLs ("#identifier") are supported at this time. These local URLs are normally created by defining a named fill pattern with DrawPushPattern/DrawPopPattern.

    - -

    The format of the DrawSetFillPatternURL method is:

    - -
    -  MagickBooleanType DrawSetFillPatternURL(DrawingWand *wand,
-    const char *fill_url)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    fill_url
    -

    URL to use to obtain fill pattern.

    - -
    -

    DrawSetFillRule

    -
    - -

    DrawSetFillRule() sets the fill rule to use while drawing polygons.

    - -

    The format of the DrawSetFillRule method is:

    - -
    -  void DrawSetFillRule(DrawingWand *wand,const FillRule fill_rule)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    fill_rule
    -

    fill rule (EvenOddRule or NonZeroRule)

    - -
    -

    DrawSetFont

    -
    - -

    DrawSetFont() sets the fully-sepecified font to use when annotating with text.

    - -

    The format of the DrawSetFont method is:

    - -
    -  MagickBooleanType DrawSetFont(DrawingWand *wand,const char *font_name)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    font_name
    -

    font name

    - -
    -

    DrawSetFontFamily

    -
    - -

    DrawSetFontFamily() sets the font family to use when annotating with text.

    - -

    The format of the DrawSetFontFamily method is:

    - -
    -  MagickBooleanType DrawSetFontFamily(DrawingWand *wand,
-    const char *font_family)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    font_family
    -

    font family

    - -
    -

    DrawSetFontSize

    -
    - -

    DrawSetFontSize() sets the font pointsize to use when annotating with text.

    - -

    The format of the DrawSetFontSize method is:

    - -
    -  void DrawSetFontSize(DrawingWand *wand,const double pointsize)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    pointsize
    -

    text pointsize

    - -
    -

    DrawSetFontStretch

    -
    - -

    DrawSetFontStretch() sets the font stretch to use when annotating with text. The AnyStretch enumeration acts as a wild-card "don't care" option.

    - -

    The format of the DrawSetFontStretch method is:

    - -
    -  void DrawSetFontStretch(DrawingWand *wand,
-    const StretchType font_stretch)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    font_stretch
    -

    font stretch (NormalStretch, UltraCondensedStretch, CondensedStretch, SemiCondensedStretch, SemiExpandedStretch, ExpandedStretch, ExtraExpandedStretch, UltraExpandedStretch, AnyStretch)

    - -
    -

    DrawSetFontStyle

    -
    - -

    DrawSetFontStyle() sets the font style to use when annotating with text. The AnyStyle enumeration acts as a wild-card "don't care" option.

    - -

    The format of the DrawSetFontStyle method is:

    - -
    -  void DrawSetFontStyle(DrawingWand *wand,const StyleType style)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    style
    -

    font style (NormalStyle, ItalicStyle, ObliqueStyle, AnyStyle)

    - -
    -

    DrawSetFontWeight

    -
    - -

    DrawSetFontWeight() sets the font weight to use when annotating with text.

    - -

    The format of the DrawSetFontWeight method is:

    - -
    -  void DrawSetFontWeight(DrawingWand *wand,
-    const size_t font_weight)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    font_weight
    -

    font weight (valid range 100-900)

    - -
    -

    DrawSetGravity

    -
    - -

    DrawSetGravity() sets the text placement gravity to use when annotating with text.

    - -

    The format of the DrawSetGravity method is:

    - -
    -  void DrawSetGravity(DrawingWand *wand,const GravityType gravity)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    gravity
    -

    positioning gravity (NorthWestGravity, NorthGravity, NorthEastGravity, WestGravity, CenterGravity, EastGravity, SouthWestGravity, SouthGravity, SouthEastGravity)

    - -
    -

    DrawSetStrokeColor

    -
    - -

    DrawSetStrokeColor() sets the color used for stroking object outlines.

    - -

    The format of the DrawSetStrokeColor method is:

    - -
    -  void DrawSetStrokeColor(DrawingWand *wand,
-    const PixelWand *stroke_wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    stroke_wand
    -

    stroke wand.

    - -
    -

    DrawSetStrokePatternURL

    -
    - -

    DrawSetStrokePatternURL() sets the pattern used for stroking object outlines.

    - -

    The format of the DrawSetStrokePatternURL method is:

    - -
    -  MagickBooleanType DrawSetStrokePatternURL(DrawingWand *wand,
-    const char *stroke_url)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    stroke_url
    -

    URL specifying pattern ID (e.g. "#pattern_id")

    - -
    -

    DrawSetStrokeAntialias

    -
    - -

    DrawSetStrokeAntialias() controls whether stroked outlines are antialiased. Stroked outlines are antialiased by default. When antialiasing is disabled stroked pixels are thresholded to determine if the stroke color or underlying canvas color should be used.

    - -

    The format of the DrawSetStrokeAntialias method is:

    - -
    -  void DrawSetStrokeAntialias(DrawingWand *wand,
-    const MagickBooleanType stroke_antialias)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    stroke_antialias
    -

    set to false (zero) to disable antialiasing

    - -
    -

    DrawSetStrokeDashArray

    -
    - -

    DrawSetStrokeDashArray() specifies the pattern of dashes and gaps used to stroke paths. The stroke dash array represents an array of numbers that specify the lengths of alternating dashes and gaps in pixels. If an odd number of values is provided, then the list of values is repeated to yield an even number of values. To remove an existing dash array, pass a zero number_elements argument and null dash_array. A typical stroke dash array might contain the members 5 3 2.

    - -

    The format of the DrawSetStrokeDashArray method is:

    - -
    -  MagickBooleanType DrawSetStrokeDashArray(DrawingWand *wand,
-    const size_t number_elements,const double *dash_array)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    number_elements
    -

    number of elements in dash array

    - -
    dash_array
    -

    dash array values

    - -
    -

    DrawSetStrokeDashOffset

    -
    - -

    DrawSetStrokeDashOffset() specifies the offset into the dash pattern to start the dash.

    - -

    The format of the DrawSetStrokeDashOffset method is:

    - -
    -  void DrawSetStrokeDashOffset(DrawingWand *wand,
-    const double dash_offset)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    dash_offset
    -

    dash offset

    - -
    -

    DrawSetStrokeLineCap

    -
    - -

    DrawSetStrokeLineCap() specifies the shape to be used at the end of open subpaths when they are stroked. Values of LineCap are UndefinedCap, ButtCap, RoundCap, and SquareCap.

    - -

    The format of the DrawSetStrokeLineCap method is:

    - -
    -  void DrawSetStrokeLineCap(DrawingWand *wand,
-    const LineCap linecap)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    linecap
    -

    linecap style

    - -
    -

    DrawSetStrokeLineJoin

    -
    - -

    DrawSetStrokeLineJoin() specifies the shape to be used at the corners of paths (or other vector shapes) when they are stroked. Values of LineJoin are UndefinedJoin, MiterJoin, RoundJoin, and BevelJoin.

    - -

    The format of the DrawSetStrokeLineJoin method is:

    - -
    -  void DrawSetStrokeLineJoin(DrawingWand *wand,
-    const LineJoin linejoin)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    linejoin
    -

    line join style

    - -
    -

    DrawSetStrokeMiterLimit

    -
    - -

    DrawSetStrokeMiterLimit() specifies the miter limit. When two line segments meet at a sharp angle and miter joins have been specified for 'lineJoin', it is possible for the miter to extend far beyond the thickness of the line stroking the path. The miterLimit' imposes a limit on the ratio of the miter length to the 'lineWidth'.

    - -

    The format of the DrawSetStrokeMiterLimit method is:

    - -
    -  void DrawSetStrokeMiterLimit(DrawingWand *wand,
-    const size_t miterlimit)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    miterlimit
    -

    miter limit

    - -
    -

    DrawSetStrokeOpacity

    -
    - -

    DrawSetStrokeOpacity() specifies the opacity of stroked object outlines.

    - -

    The format of the DrawSetStrokeOpacity method is:

    - -
    -  void DrawSetStrokeOpacity(DrawingWand *wand,
-    const double stroke_opacity)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    stroke_opacity
    -

    stroke opacity. The value 1.0 is opaque.

    - -
    -

    DrawSetStrokeWidth

    -
    - -

    DrawSetStrokeWidth() sets the width of the stroke used to draw object outlines.

    - -

    The format of the DrawSetStrokeWidth method is:

    - -
    -  void DrawSetStrokeWidth(DrawingWand *wand,
-    const double stroke_width)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    stroke_width
    -

    stroke width

    - -
    -

    DrawSetTextAlignment

    -
    - -

    DrawSetTextAlignment() specifies a text alignment to be applied when annotating with text.

    - -

    The format of the DrawSetTextAlignment method is:

    - -
    -  void DrawSetTextAlignment(DrawingWand *wand,const AlignType alignment)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    alignment
    -

    text alignment. One of UndefinedAlign, LeftAlign, CenterAlign, or RightAlign.

    - -
    -

    DrawSetTextAntialias

    -
    - -

    DrawSetTextAntialias() controls whether text is antialiased. Text is antialiased by default.

    - -

    The format of the DrawSetTextAntialias method is:

    - -
    -  void DrawSetTextAntialias(DrawingWand *wand,
-    const MagickBooleanType text_antialias)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    text_antialias
    -

    antialias boolean. Set to false (0) to disable antialiasing.

    - -
    -

    DrawSetTextDecoration

    -
    - -

    DrawSetTextDecoration() specifies a decoration to be applied when annotating with text.

    - -

    The format of the DrawSetTextDecoration method is:

    - -
    -  void DrawSetTextDecoration(DrawingWand *wand,
-    const DecorationType decoration)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    decoration
    -

    text decoration. One of NoDecoration, UnderlineDecoration, OverlineDecoration, or LineThroughDecoration

    - -
    -

    DrawSetTextEncoding

    -
    - -

    DrawSetTextEncoding() specifies the code set to use for text annotations. The only character encoding which may be specified at this time is "UTF-8" for representing Unicode as a sequence of bytes. Specify an empty string to set text encoding to the system's default. Successful text annotation using Unicode may require fonts designed to support Unicode.

    - -

    The format of the DrawSetTextEncoding method is:

    - -
    -  void DrawSetTextEncoding(DrawingWand *wand,const char *encoding)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    encoding
    -

    character string specifying text encoding

    - -
    -

    DrawSetTextKerning

    -
    - -

    DrawSetTextKerning() sets the spacing between characters in text.

    - -

    The format of the DrawSetTextKerning method is:

    - -
    -  void DrawSetTextKerning(DrawingWand *wand,const double kerning)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    kerning
    -

    text kerning

    - -
    -

    DrawSetTextInterwordSpacing

    -
    - -

    DrawSetTextInterwordSpacing() sets the spacing between line in text.

    - -

    The format of the DrawSetInterwordSpacing method is:

    - -
    -  void DrawSetTextInterwordSpacing(DrawingWand *wand,
-    const double interline_spacing)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    interline_spacing
    -

    text line spacing

    - -
    -

    DrawSetTextInterwordSpacing

    -
    - -

    DrawSetTextInterwordSpacing() sets the spacing between words in text.

    - -

    The format of the DrawSetInterwordSpacing method is:

    - -
    -  void DrawSetTextInterwordSpacing(DrawingWand *wand,
-    const double interword_spacing)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    interword_spacing
    -

    text word spacing

    - -
    -

    DrawSetTextUnderColor

    -
    - -

    DrawSetTextUnderColor() specifies the color of a background rectangle to place under text annotations.

    - -

    The format of the DrawSetTextUnderColor method is:

    - -
    -  void DrawSetTextUnderColor(DrawingWand *wand,
-    const PixelWand *under_wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    under_wand
    -

    text under wand.

    - -
    -

    DrawSetVectorGraphics

    -
    - -

    DrawSetVectorGraphics() sets the vector graphics associated with the specified wand. Use this method with DrawGetVectorGraphics() as a method to persist the vector graphics state.

    - -

    The format of the DrawSetVectorGraphics method is:

    - -
    -  MagickBooleanType DrawSetVectorGraphics(DrawingWand *wand,
-    const char *xml)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    xml
    -

    the drawing wand XML.

    - -
    -

    DrawSkewX

    -
    - -

    DrawSkewX() skews the current coordinate system in the horizontal direction.

    - -

    The format of the DrawSkewX method is:

    - -
    -  void DrawSkewX(DrawingWand *wand,const double degrees)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    degrees
    -

    number of degrees to skew the coordinates

    - -
    -

    DrawSkewY

    -
    - -

    DrawSkewY() skews the current coordinate system in the vertical direction.

    - -

    The format of the DrawSkewY method is:

    - -
    -  void DrawSkewY(DrawingWand *wand,const double degrees)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    degrees
    -

    number of degrees to skew the coordinates

    - -
    -

    DrawTranslate

    -
    - -

    DrawTranslate() applies a translation to the current coordinate system which moves the coordinate system origin to the specified coordinate.

    - -

    The format of the DrawTranslate method is:

    - -
    -  void DrawTranslate(DrawingWand *wand,const double x,
-    const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x
    -

    new x ordinate for coordinate system origin

    - -
    y
    -

    new y ordinate for coordinate system origin

    - -
    -

    DrawSetViewbox

    -
    - -

    DrawSetViewbox() sets the overall canvas size to be recorded with the drawing vector data. Usually this will be specified using the same size as the canvas image. When the vector data is saved to SVG or MVG formats, the viewbox is use to specify the size of the canvas image that a viewer will render the vector data on.

    - -

    The format of the DrawSetViewbox method is:

    - -
    -  void DrawSetViewbox(DrawingWand *wand,size_t x1,
-    size_t y1,size_t x2,size_t y2)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    x1
    -

    left x ordinate

    - -
    y1
    -

    top y ordinate

    - -
    x2
    -

    right x ordinate

    - -
    y2
    -

    bottom y ordinate

    - -
    -

    IsDrawingWand

    -
    - -

    IsDrawingWand() returns MagickTrue if the wand is verified as a drawing wand.

    - -

    The format of the IsDrawingWand method is:

    - -
    -  MagickBooleanType IsDrawingWand(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    NewDrawingWand

    -
    - -

    NewDrawingWand() returns a drawing wand required for all other methods in the API.

    - -

    The format of the NewDrawingWand method is:

    - -
    -  DrawingWand NewDrawingWand(void)
-
    - -
    -

    PeekDrawingWand

    -
    - -

    PeekDrawingWand() returns the current drawing wand.

    - -

    The format of the PeekDrawingWand method is:

    - -
    -  DrawInfo *PeekDrawingWand(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    PopDrawingWand

    -
    - -

    PopDrawingWand() destroys the current drawing wand and returns to the previously pushed drawing wand. Multiple drawing wands may exist. It is an error to attempt to pop more drawing wands than have been pushed, and it is proper form to pop all drawing wands which have been pushed.

    - -

    The format of the PopDrawingWand method is:

    - -
    -  MagickBooleanType PopDrawingWand(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    PushDrawingWand

    -
    - -

    PushDrawingWand() clones the current drawing wand to create a new drawing wand. The original drawing wand(s) may be returned to by invoking PopDrawingWand(). The drawing wands are stored on a drawing wand stack. For every Pop there must have already been an equivalent Push.

    - -

    The format of the PushDrawingWand method is:

    - -
    -  MagickBooleanType PushDrawingWand(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    diff --git a/www/api/effect.html b/www/api/effect.html index dc19ab494..190f954e0 100644 --- a/www/api/effect.html +++ b/www/api/effect.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,600 +190,9 @@
    -

    Module effect - Methods

    -

    [AdaptiveBlurImage • AdaptiveSharpenImage • BlurImage • ConvolveImage • DespeckleImage • EdgeImage • EmbossImage • FilterImage • GaussianBlurImage • MedianFilterImage • MotionBlurImage • PreviewImage • RadialBlurImage • ReduceNoiseImage • SelectiveBlurImage • ShadeImage • SharpenImage • SpreadImage • UnsharpMaskImage]

    +

    Module Methods

    +

    []

    -

    AdaptiveBlurImage

    -
    - -

    AdaptiveBlurImage() adaptively blurs the image by blurring less intensely near image edges and more intensely far from edges. We blur the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and AdaptiveBlurImage() selects a suitable radius for you.

    - -

    The format of the AdaptiveBlurImage method is:

    - -
    -  Image *AdaptiveBlurImage(const Image *image,const double radius,
-    const double sigma,ExceptionInfo *exception)
-  Image *AdaptiveBlurImageChannel(const Image *image,
-    const ChannelType channel,double radius,const double sigma,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel type.

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Laplacian, in pixels.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    AdaptiveSharpenImage

    -
    - -

    AdaptiveSharpenImage() adaptively sharpens the image by sharpening more intensely near image edges and less intensely far from edges. We sharpen the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and AdaptiveSharpenImage() selects a suitable radius for you.

    - -

    The format of the AdaptiveSharpenImage method is:

    - -
    -  Image *AdaptiveSharpenImage(const Image *image,const double radius,
-    const double sigma,ExceptionInfo *exception)
-  Image *AdaptiveSharpenImageChannel(const Image *image,
-    const ChannelType channel,double radius,const double sigma,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel type.

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Laplacian, in pixels.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    BlurImage

    -
    - -

    BlurImage() blurs an image. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and BlurImage() selects a suitable radius for you.

    - -

    BlurImage() differs from GaussianBlurImage() in that it uses a separable kernel which is faster but mathematically equivalent to the non-separable kernel.

    - -

    The format of the BlurImage method is:

    - -
    -  Image *BlurImage(const Image *image,const double radius,
-    const double sigma,ExceptionInfo *exception)
-  Image *BlurImageChannel(const Image *image,const ChannelType channel,
-    const double radius,const double sigma,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel type.

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ConvolveImage

    -
    - -

    ConvolveImage() applies a custom convolution kernel to the image.

    - -

    The format of the ConvolveImage method is:

    - -
    -  Image *ConvolveImage(const Image *image,const size_t order,
-    const double *kernel,ExceptionInfo *exception)
-  Image *ConvolveImageChannel(const Image *image,const ChannelType channel,
-    const size_t order,const double *kernel,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel type.

    - -
    order
    -

    the number of columns and rows in the filter kernel.

    - -
    kernel
    -

    An array of double representing the convolution kernel.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    DespeckleImage

    -
    - -

    DespeckleImage() reduces the speckle noise in an image while perserving the edges of the original image.

    - -

    The format of the DespeckleImage method is:

    - -
    -  Image *DespeckleImage(const Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    EdgeImage

    -
    - -

    EdgeImage() finds edges in an image. Radius defines the radius of the convolution filter. Use a radius of 0 and EdgeImage() selects a suitable radius for you.

    - -

    The format of the EdgeImage method is:

    - -
    -  Image *EdgeImage(const Image *image,const double radius,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    radius
    -

    the radius of the pixel neighborhood.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    EmbossImage

    -
    - -

    EmbossImage() returns a grayscale image with a three-dimensional effect. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and Emboss() selects a suitable radius for you.

    - -

    The format of the EmbossImage method is:

    - -
    -  Image *EmbossImage(const Image *image,const double radius,
-    const double sigma,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    radius
    -

    the radius of the pixel neighborhood.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    FilterImage

    -
    - -

    FilterImage() applies a custom convolution kernel to the image.

    - -

    The format of the FilterImage method is:

    - -
    -  Image *FilterImage(const Image *image,const KernelInfo *kernel,
-    ExceptionInfo *exception)
-  Image *FilterImageChannel(const Image *image,const ChannelType channel,
-    const KernelInfo *kernel,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel type.

    - -
    kernel
    -

    the filtering kernel.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    GaussianBlurImage

    -
    - -

    GaussianBlurImage() blurs an image. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and GaussianBlurImage() selects a suitable radius for you

    - -

    The format of the GaussianBlurImage method is:

    - -
    -  Image *GaussianBlurImage(const Image *image,onst double radius,
-    const double sigma,ExceptionInfo *exception)
-  Image *GaussianBlurImageChannel(const Image *image,
-    const ChannelType channel,const double radius,const double sigma,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel type.

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    MedianFilterImage

    -
    - -

    MedianFilterImage() applies a digital filter that improves the quality of a noisy image. Each pixel is replaced by the median in a set of neighboring pixels as defined by radius.

    - -

    The algorithm was contributed by Mike Edmonds and implements an insertion sort for selecting median color-channel values. For more on this algorithm see "Skip Lists: A probabilistic Alternative to Balanced Trees" by William Pugh in the June 1990 of Communications of the ACM.

    - -

    The format of the MedianFilterImage method is:

    - -
    -  Image *MedianFilterImage(const Image *image,const double radius,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    radius
    -

    the radius of the pixel neighborhood.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    MotionBlurImage

    -
    - -

    MotionBlurImage() simulates motion blur. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and MotionBlurImage() selects a suitable radius for you. Angle gives the angle of the blurring motion.

    - -

    Andrew Protano contributed this effect.

    - -

    The format of the MotionBlurImage method is:

    - -
    -      Image *MotionBlurImage(const Image *image,const double radius,
-  const double sigma,const double angle,ExceptionInfo *exception)
-      Image *MotionBlurImageChannel(const Image *image,const ChannelType channel,
-  const double radius,const double sigma,const double angle,
-  ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel type.

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center

    -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    angle
    -

    Apply the effect along this angle.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    PreviewImage

    -
    - -

    PreviewImage() tiles 9 thumbnails of the specified image with an image processing operation applied with varying parameters. This may be helpful pin-pointing an appropriate parameter for a particular image processing operation.

    - -

    The format of the PreviewImages method is:

    - -
    -  Image *PreviewImages(const Image *image,const PreviewType preview,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    preview
    -

    the image processing operation.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    RadialBlurImage

    -
    - -

    RadialBlurImage() applies a radial blur to the image.

    - -

    Andrew Protano contributed this effect.

    - -

    The format of the RadialBlurImage method is:

    - -
    -      Image *RadialBlurImage(const Image *image,const double angle,
-  ExceptionInfo *exception)
-      Image *RadialBlurImageChannel(const Image *image,const ChannelType channel,
-  const double angle,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel type.

    - -
    angle
    -

    the angle of the radial blur.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ReduceNoiseImage

    -
    - -

    ReduceNoiseImage() smooths the contours of an image while still preserving edge information. The algorithm works by replacing each pixel with its neighbor closest in value. A neighbor is defined by radius. Use a radius of 0 and ReduceNoise() selects a suitable radius for you.

    - -

    The format of the ReduceNoiseImage method is:

    - -
    -  Image *ReduceNoiseImage(const Image *image,const double radius,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    radius
    -

    the radius of the pixel neighborhood.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    SelectiveBlurImage

    -
    - -

    SelectiveBlurImage() selectively blur pixels within a contrast threshold. It is similar to the unsharpen mask that sharpens everything with contrast above a certain threshold.

    - -

    The format of the SelectiveBlurImage method is:

    - -
    -  Image *SelectiveBlurImage(const Image *image,const double radius,
-    const double sigma,const double threshold,ExceptionInfo *exception)
-  Image *SelectiveBlurImageChannel(const Image *image,
-    const ChannelType channel,const double radius,const double sigma,
-    const double threshold,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel type.

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    threshold
    -

    only pixels within this contrast threshold are included in the blur operation.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ShadeImage

    -
    - -

    ShadeImage() shines a distant light on an image to create a three-dimensional effect. You control the positioning of the light with azimuth and elevation; azimuth is measured in degrees off the x axis and elevation is measured in pixels above the Z axis.

    - -

    The format of the ShadeImage method is:

    - -
    -  Image *ShadeImage(const Image *image,const MagickBooleanType gray,
-    const double azimuth,const double elevation,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    gray
    -

    A value other than zero shades the intensity of each pixel.

    - -
    azimuth, elevation
    -

    Define the light source direction.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    SharpenImage

    -
    - -

    SharpenImage() sharpens the image. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and SharpenImage() selects a suitable radius for you.

    - -

    Using a separable kernel would be faster, but the negative weights cancel out on the corners of the kernel producing often undesirable ringing in the filtered result; this can be avoided by using a 2D gaussian shaped image sharpening kernel instead.

    - -

    The format of the SharpenImage method is:

    - -
    -      Image *SharpenImage(const Image *image,const double radius,
-  const double sigma,ExceptionInfo *exception)
-      Image *SharpenImageChannel(const Image *image,const ChannelType channel,
-  const double radius,const double sigma,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel type.

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Laplacian, in pixels.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    SpreadImage

    -
    - -

    SpreadImage() is a special effects method that randomly displaces each pixel in a block defined by the radius parameter.

    - -

    The format of the SpreadImage method is:

    - -
    -  Image *SpreadImage(const Image *image,const double radius,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    radius
    -

    Choose a random pixel in a neighborhood of this extent.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    UnsharpMaskImage

    -
    - -

    UnsharpMaskImage() sharpens one or more image channels. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and UnsharpMaskImage() selects a suitable radius for you.

    - -

    The format of the UnsharpMaskImage method is:

    - -
    -      Image *UnsharpMaskImage(const Image *image,const double radius,
-  const double sigma,const double amount,const double threshold,
-  ExceptionInfo *exception)
-      Image *UnsharpMaskImageChannel(const Image *image,
-  const ChannelType channel,const double radius,const double sigma,
-  const double amount,const double threshold,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel type.

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    amount
    -

    the percentage of the difference between the original and the blur image that is added back into the original.

    - -
    threshold
    -

    the threshold in pixels needed to apply the diffence amount.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/enhance.html b/www/api/enhance.html index cf4ce0340..cd2a2e10d 100644 --- a/www/api/enhance.html +++ b/www/api/enhance.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,575 +190,9 @@
    -

    Module enhance - Methods

    -

    [AutoGammaImage • AutoLevelImage • Use BrightnessContrastImage • ColorDecisionListImage • ClutImage • ContrastImage • The ContrastStretchImage • EnhanceImage • EqualizeImage • GammaImage • HaldClutImage • LevelImage • LevelizeImage • LevelizeImageChannel • LevelImageColor • The LinearStretchImage • ModulateImage • NegateImage • The NormalizeImage • SigmoidalContrastImage]

    +

    Module Methods

    +

    []

    -

    AutoGammaImage

    -
    - -

    AutoGammaImage() extract the 'mean' from the image and adjust the image to try make set its gamma appropriatally.

    - -

    The format of the AutoGammaImage method is:

    - -
    -  MagickBooleanType AutoGammaImage(Image *image)
-  MagickBooleanType AutoGammaImageChannel(Image *image,
-    const ChannelType channel)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    The image to auto-level

    - -
    channel
    -

    The channels to auto-level. If the special 'SyncChannels' flag is set all given channels is adjusted in the same way using the mean average of those channels.

    - -
    -

    AutoLevelImage

    -
    - -

    AutoLevelImage() adjusts the levels of a particular image channel by scaling the minimum and maximum values to the full quantum range.

    - -

    The format of the LevelImage method is:

    - -
    -  MagickBooleanType AutoLevelImage(Image *image)
-  MagickBooleanType AutoLevelImageChannel(Image *image,
-    const ChannelType channel)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    The image to auto-level

    - -
    channel
    -

    The channels to auto-level. If the special 'SyncChannels' flag is set the min/max/mean value of all given channels is used for all given channels, to all channels in the same way.

    - -
    -

    Use BrightnessContrastImage

    -
    - -

    Use BrightnessContrastImage() to change the brightness and/or contrast of an image. It converts the brightness and contrast parameters into slope and intercept and calls a polynomical function to apply to the image.

    - -

    The format of the BrightnessContrastImage method is:

    - -
    -  MagickBooleanType BrightnessContrastImage(Image *image,
-    const double brightness,const double contrast)
-  MagickBooleanType BrightnessContrastImageChannel(Image *image,
-    const ChannelType channel,const double brightness,
-    const double contrast)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel.

    - -
    brightness
    -

    the brightness percent (-100 .. 100).

    - -
    contrast
    -

    the contrast percent (-100 .. 100).

    - -
    -

    ColorDecisionListImage

    -
    - -

    ColorDecisionListImage() accepts a lightweight Color Correction Collection (CCC) file which solely contains one or more color corrections and applies the correction to the image. Here is a sample CCC file:

    - -
    -      
-      
-            
-                  0.9 1.2 0.5 
-                  0.4 -0.5 0.6 
-                  1.0 0.8 1.5 
-            
-            
-                  0.85 
-            
-      
-      
-
    - -

    which includes the slop, offset, and power for each of the RGB channels as well as the saturation.

    - -

    The format of the ColorDecisionListImage method is:

    - -
    -  MagickBooleanType ColorDecisionListImage(Image *image,
-    const char *color_correction_collection)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    color_correction_collection
    -

    the color correction collection in XML.

    - -
    -

    ClutImage

    -
    - -

    ClutImage() replaces each color value in the given image, by using it as an index to lookup a replacement color value in a Color Look UP Table in the form of an image. The values are extracted along a diagonal of the CLUT image so either a horizontal or vertial gradient image can be used.

    - -

    Typically this is used to either re-color a gray-scale image according to a color gradient in the CLUT image, or to perform a freeform histogram (level) adjustment according to the (typically gray-scale) gradient in the CLUT image.

    - -

    When the 'channel' mask includes the matte/alpha transparency channel but one image has no such channel it is assumed that that image is a simple gray-scale image that will effect the alpha channel values, either for gray-scale coloring (with transparent or semi-transparent colors), or a histogram adjustment of existing alpha channel values. If both images have matte channels, direct and normal indexing is applied, which is rarely used.

    - -

    The format of the ClutImage method is:

    - -
    -  MagickBooleanType ClutImage(Image *image,Image *clut_image)
-  MagickBooleanType ClutImageChannel(Image *image,
-    const ChannelType channel,Image *clut_image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image, which is replaced by indexed CLUT values

    - -
    clut_image
    -

    the color lookup table image for replacement color values.

    - -
    channel
    -

    the channel.

    - -
    -

    ContrastImage

    -
    - -

    ContrastImage() enhances the intensity differences between the lighter and darker elements of the image. Set sharpen to a MagickTrue to increase the image contrast otherwise the contrast is reduced.

    - -

    The format of the ContrastImage method is:

    - -
    -  MagickBooleanType ContrastImage(Image *image,
-    const MagickBooleanType sharpen)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    sharpen
    -

    Increase or decrease image contrast.

    - -
    -

    The ContrastStretchImage

    -
    - -

    The ContrastStretchImage() is a simple image enhancement technique that attempts to improve the contrast in an image by `stretching' the range of intensity values it contains to span a desired range of values. It differs from the more sophisticated histogram equalization in that it can only apply a linear scaling function to the image pixel values. As a result the `enhancement' is less harsh.

    - -

    The format of the ContrastStretchImage method is:

    - -
    -  MagickBooleanType ContrastStretchImage(Image *image,
-    const char *levels)
-  MagickBooleanType ContrastStretchImageChannel(Image *image,
-    const size_t channel,const double black_point,
-    const double white_point)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel.

    - -
    black_point
    -

    the black point.

    - -
    white_point
    -

    the white point.

    - -
    levels
    -

    Specify the levels where the black and white points have the range of 0 to number-of-pixels (e.g. 1, 10x90, etc.).

    - -
    -

    EnhanceImage

    -
    - -

    EnhanceImage() applies a digital filter that improves the quality of a noisy image.

    - -

    The format of the EnhanceImage method is:

    - -
    -  Image *EnhanceImage(const Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    EqualizeImage

    -
    - -

    EqualizeImage() applies a histogram equalization to the image.

    - -

    The format of the EqualizeImage method is:

    - -
    -  MagickBooleanType EqualizeImage(Image *image)
-  MagickBooleanType EqualizeImageChannel(Image *image,
-    const ChannelType channel)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel.

    - -
    -

    GammaImage

    -
    - -

    GammaImage() gamma-corrects a particular image channel. The same image viewed on different devices will have perceptual differences in the way the image's intensities are represented on the screen. Specify individual gamma levels for the red, green, and blue channels, or adjust all three with the gamma parameter. Values typically range from 0.8 to 2.3.

    - -

    You can also reduce the influence of a particular channel with a gamma value of 0.

    - -

    The format of the GammaImage method is:

    - -
    -  MagickBooleanType GammaImage(Image *image,const double gamma)
-  MagickBooleanType GammaImageChannel(Image *image,
-    const ChannelType channel,const double gamma)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel.

    - -
    gamma
    -

    the image gamma.

    - -
    -

    HaldClutImage

    -
    - -

    HaldClutImage() applies a Hald color lookup table to the image. A Hald color lookup table is a 3-dimensional color cube mapped to 2 dimensions. Create it with the HALD coder. You can apply any color transformation to the Hald image and then use this method to apply the transform to the image.

    - -

    The format of the HaldClutImage method is:

    - -
    -  MagickBooleanType HaldClutImage(Image *image,Image *hald_image)
-  MagickBooleanType HaldClutImageChannel(Image *image,
-    const ChannelType channel,Image *hald_image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image, which is replaced by indexed CLUT values

    - -
    hald_image
    -

    the color lookup table image for replacement color values.

    - -
    channel
    -

    the channel.

    - -
    -

    LevelImage

    -
    - -

    LevelImage() adjusts the levels of a particular image channel by scaling the colors falling between specified white and black points to the full available quantum range.

    - -

    The parameters provided represent the black, and white points. The black point specifies the darkest color in the image. Colors darker than the black point are set to zero. White point specifies the lightest color in the image. Colors brighter than the white point are set to the maximum quantum value.

    - -

    If a '!' flag is given, map black and white colors to the given levels rather than mapping those levels to black and white. See LevelizeImageChannel() and LevelizeImageChannel(), below.

    - -

    Gamma specifies a gamma correction to apply to the image.

    - -

    The format of the LevelImage method is:

    - -
    -  MagickBooleanType LevelImage(Image *image,const char *levels)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    levels
    -

    Specify the levels where the black and white points have the range of 0-QuantumRange, and gamma has the range 0-10 (e.g. 10x90+2). A '!' flag inverts the re-mapping.

    - -
    -

    LevelizeImage

    -
    - -

    LevelizeImage() applies the normal level operation to the image, spreading out the values between the black and white points over the entire range of values. Gamma correction is also applied after the values has been mapped.

    - -

    It is typically used to improve image contrast, or to provide a controlled linear threshold for the image. If the black and white points are set to the minimum and maximum values found in the image, the image can be normalized. or by swapping black and white values, negate the image.

    - -

    The format of the LevelizeImage method is:

    - -
    -  MagickBooleanType LevelizeImage(Image *image,const double black_point,
-    const double white_point,const double gamma)
-  MagickBooleanType LevelizeImageChannel(Image *image,
-    const ChannelType channel,const double black_point,
-    const double white_point,const double gamma)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel.

    - -
    black_point
    -

    The level which is to be mapped to zero (black)

    - -
    white_point
    -

    The level which is to be mapped to QuantiumRange (white)

    - -
    gamma
    -

    adjust gamma by this factor before mapping values. use 1.0 for purely linear stretching of image color values

    - -
    -

    LevelizeImageChannel

    -
    - -

    LevelizeImageChannel() applies the reversed LevelImage() operation to just the specific channels specified. It compresses the full range of color values, so that they lie between the given black and white points. Gamma is applied before the values are mapped.

    - -

    LevelizeImageChannel() can be called with by using a +level command line API option, or using a '!' on a -level or LevelImage() geometry string.

    - -

    It can be used for example de-contrast a greyscale image to the exact levels specified. Or by using specific levels for each channel of an image you can convert a gray-scale image to any linear color gradient, according to those levels.

    - -

    The format of the LevelizeImageChannel method is:

    - -
    -  MagickBooleanType LevelizeImageChannel(Image *image,
-    const ChannelType channel,const char *levels)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel.

    - -
    black_point
    -

    The level to map zero (black) to.

    - -
    white_point
    -

    The level to map QuantiumRange (white) to.

    - -
    gamma
    -

    adjust gamma by this factor before mapping values.

    - -
    -

    LevelImageColor

    -
    - -

    LevelImageColor() maps the given color to "black" and "white" values, linearly spreading out the colors, and level values on a channel by channel bases, as per LevelImage(). The given colors allows you to specify different level ranges for each of the color channels seperatally.

    - -

    If the boolean 'invert' is set true the image values will modifyed in the reverse direction. That is any existing "black" and "white" colors in the image will become the color values given, with all other values compressed appropriatally. This effectivally maps a greyscale gradient into the given color gradient.

    - -

    The format of the LevelColorsImageChannel method is:

    - -
    -      MagickBooleanType LevelColorsImage(Image *image,
-  const MagickPixelPacket *black_color,
-  const MagickPixelPacket *white_color,const MagickBooleanType invert)
-      MagickBooleanType LevelColorsImageChannel(Image *image,
-  const ChannelType channel,const MagickPixelPacket *black_color,
-  const MagickPixelPacket *white_color,const MagickBooleanType invert)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel.

    - -
    black_color
    -

    The color to map black to/from

    - -
    white_point
    -

    The color to map white to/from

    - -
    invert
    -

    if true map the colors (levelize), rather than from (level)

    - -
    -

    The LinearStretchImage

    -
    - -

    The LinearStretchImage() discards any pixels below the black point and above the white point and levels the remaining pixels.

    - -

    The format of the LinearStretchImage method is:

    - -
    -  MagickBooleanType LinearStretchImage(Image *image,
-    const double black_point,const double white_point)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    black_point
    -

    the black point.

    - -
    white_point
    -

    the white point.

    - -
    -

    ModulateImage

    -
    - -

    ModulateImage() lets you control the brightness, saturation, and hue of an image. Modulate represents the brightness, saturation, and hue as one parameter (e.g. 90,150,100). If the image colorspace is HSL, the modulation is lightness, saturation, and hue. And if the colorspace is HWB, use blackness, whiteness, and hue.

    - -

    The format of the ModulateImage method is:

    - -
    -  MagickBooleanType ModulateImage(Image *image,const char *modulate)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    modulate
    -

    Define the percent change in brightness, saturation, and hue.

    - -
    -

    NegateImage

    -
    - -

    NegateImage() negates the colors in the reference image. The grayscale option means that only grayscale values within the image are negated.

    - -

    The format of the NegateImageChannel method is:

    - -
    -  MagickBooleanType NegateImage(Image *image,
-    const MagickBooleanType grayscale)
-  MagickBooleanType NegateImageChannel(Image *image,
-    const ChannelType channel,const MagickBooleanType grayscale)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel.

    - -
    grayscale
    -

    If MagickTrue, only negate grayscale pixels within the image.

    - -
    -

    The NormalizeImage

    -
    - -

    The NormalizeImage() method enhances the contrast of a color image by mapping the darkest 2 percent of all pixel to black and the brightest 1 percent to white.

    - -

    The format of the NormalizeImage method is:

    - -
    -  MagickBooleanType NormalizeImage(Image *image)
-  MagickBooleanType NormalizeImageChannel(Image *image,
-    const ChannelType channel)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel.

    - -
    -

    SigmoidalContrastImage

    -
    - -

    SigmoidalContrastImage() adjusts the contrast of an image with a non-linear sigmoidal contrast algorithm. Increase the contrast of the image using a sigmoidal transfer function without saturating highlights or shadows. Contrast indicates how much to increase the contrast (0 is none; 3 is typical; 20 is pushing it); mid-point indicates where midtones fall in the resultant image (0 is white; 50 is middle-gray; 100 is black). Set sharpen to MagickTrue to increase the image contrast otherwise the contrast is reduced.

    - -

    The format of the SigmoidalContrastImage method is:

    - -
    -  MagickBooleanType SigmoidalContrastImage(Image *image,
-    const MagickBooleanType sharpen,const char *levels)
-  MagickBooleanType SigmoidalContrastImageChannel(Image *image,
-    const ChannelType channel,const MagickBooleanType sharpen,
-    const double contrast,const double midpoint)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel.

    - -
    sharpen
    -

    Increase or decrease image contrast.

    - -
    alpha
    -

    strength of the contrast, the larger the number the more 'threshold-like' it becomes.

    - -
    beta
    -

    midpoint of the function as a color value 0 to QuantumRange.

    - -
    diff --git a/www/api/exception.html b/www/api/exception.html index 6e13d20b8..eb14f0e3e 100644 --- a/www/api/exception.html +++ b/www/api/exception.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,314 +190,9 @@
    -

    Module exception - Methods

    -

    [AcquireExceptionInfo • ClearMagickException • CatchException • DestroyExceptionInfo • GetExceptionInfo • GetExceptionMessage • GetLocaleExceptionMessage • InheritException • MagickError • MagickFatalError • MagickWarning • SetErrorHandler • SetFatalErrorHandler • SetWarningHandler • ThrowException]

    +

    Module Methods

    +

    []

    -

    AcquireExceptionInfo

    -
    - -

    AcquireExceptionInfo() allocates the ExceptionInfo structure.

    - -

    The format of the AcquireExceptionInfo method is:

    - -
    -  ExceptionInfo *AcquireExceptionInfo(void)
-
    - -
    -

    ClearMagickException

    -
    - -

    ClearMagickException() clears any exception that may not have been caught yet.

    - -

    The format of the ClearMagickException method is:

    - -
    -  ClearMagickException(ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    exception
    -

    the exception info.

    - -
    -

    CatchException

    -
    - -

    CatchException() returns if no exceptions is found otherwise it reports the exception as a warning, error, or fatal depending on the severity.

    - -

    The format of the CatchException method is:

    - -
    -  CatchException(ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    exception
    -

    the exception info.

    - -
    -

    DestroyExceptionInfo

    -
    - -

    DestroyExceptionInfo() deallocates memory associated with an exception.

    - -

    The format of the DestroyExceptionInfo method is:

    - -
    -  ExceptionInfo *DestroyExceptionInfo(ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    exception
    -

    the exception info.

    - -
    -

    GetExceptionInfo

    -
    - -

    GetExceptionInfo() initializes an exception to default values.

    - -

    The format of the GetExceptionInfo method is:

    - -
    -  GetExceptionInfo(ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    exception
    -

    the exception info.

    - -
    -

    GetExceptionMessage

    -
    - -

    GetExceptionMessage() returns the error message defined by the specified error code.

    - -

    The format of the GetExceptionMessage method is:

    - -
    -  char *GetExceptionMessage(const int error)
-
    - -

    A description of each parameter follows:

    - -
    error
    -

    the error code.

    - -
    -

    GetLocaleExceptionMessage

    -
    - -

    GetLocaleExceptionMessage() converts a enumerated exception severity and tag to a message in the current locale.

    - -

    The format of the GetLocaleExceptionMessage method is:

    - -
    -  const char *GetLocaleExceptionMessage(const ExceptionType severity,
-    const char *tag)
-
    - -

    A description of each parameter follows:

    - -
    severity
    -

    the severity of the exception.

    - -
    tag
    -

    the message tag.

    - -
    -

    InheritException

    -
    - -

    InheritException() inherits an exception from a related exception.

    - -

    The format of the InheritException method is:

    - -
    -  InheritException(ExceptionInfo *exception,const ExceptionInfo *relative)
-
    - -

    A description of each parameter follows:

    - -
    exception
    -

    the exception info.

    - -
    relative
    -

    the related exception info.

    - -
    -

    MagickError

    -
    - -

    MagickError() calls the exception handler methods with an error reason.

    - -

    The format of the MagickError method is:

    - -
    -  void MagickError(const ExceptionType error,const char *reason,
-    const char *description)
-
    - -

    A description of each parameter follows:

    - -
    exception
    -

    Specifies the numeric error category.

    - -
    reason
    -

    Specifies the reason to display before terminating the program.

    - -
    description
    -

    Specifies any description to the reason.

    - -
    -

    MagickFatalError

    -
    - -

    MagickFatalError() calls the fatal exception handler methods with an error reason.

    - -

    The format of the MagickError method is:

    - -
    -  void MagickFatalError(const ExceptionType error,const char *reason,
-    const char *description)
-
    - -

    A description of each parameter follows:

    - -
    exception
    -

    Specifies the numeric error category.

    - -
    reason
    -

    Specifies the reason to display before terminating the program.

    - -
    description
    -

    Specifies any description to the reason.

    - -
    -

    MagickWarning

    -
    - -

    MagickWarning() calls the warning handler methods with a warning reason.

    - -

    The format of the MagickWarning method is:

    - -
    -  void MagickWarning(const ExceptionType warning,const char *reason,
-    const char *description)
-
    - -

    A description of each parameter follows:

    - -
    warning
    -

    the warning severity.

    - -
    reason
    -

    Define the reason for the warning.

    - -
    description
    -

    Describe the warning.

    - -
    -

    SetErrorHandler

    -
    - -

    SetErrorHandler() sets the exception handler to the specified method and returns the previous exception handler.

    - -

    The format of the SetErrorHandler method is:

    - -
    -  ErrorHandler SetErrorHandler(ErrorHandler handler)
-
    - -

    A description of each parameter follows:

    - -
    handler
    -

    the method to handle errors.

    - -
    -

    SetFatalErrorHandler

    -
    - -

    SetFatalErrorHandler() sets the fatal exception handler to the specified method and returns the previous fatal exception handler.

    - -

    The format of the SetErrorHandler method is:

    - -
    -  ErrorHandler SetErrorHandler(ErrorHandler handler)
-
    - -

    A description of each parameter follows:

    - -
    handler
    -

    the method to handle errors.

    - -
    -

    SetWarningHandler

    -
    - -

    SetWarningHandler() sets the warning handler to the specified method and returns the previous warning handler.

    - -

    The format of the SetWarningHandler method is:

    - -
    -  ErrorHandler SetWarningHandler(ErrorHandler handler)
-
    - -

    A description of each parameter follows:

    - -
    handler
    -

    the method to handle warnings.

    - -
    -

    ThrowException

    -
    - -

    ThrowException() throws an exception with the specified severity code, reason, and optional description.

    - -

    The format of the ThrowException method is:

    - -
    -  MagickBooleanType ThrowException(ExceptionInfo *exception,
-    const ExceptionType severity,const char *reason,
-    const char *description)
-
    - -

    A description of each parameter follows:

    - -
    exception
    -

    the exception info.

    - -
    severity
    -

    the severity of the exception.

    - -
    reason
    -

    the reason for the exception.

    - -
    description
    -

    the exception description.

    - -
    diff --git a/www/api/feature.html b/www/api/feature.html index ed72a52bb..33821c80a 100644 --- a/www/api/feature.html +++ b/www/api/feature.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,42 +190,9 @@
    -

    Module feature - Methods

    -

    [GetImageChannelFeatures]

    +

    Module Methods

    +

    []

    -

    GetImageChannelFeatures

    -
    - -

    GetImageChannelFeatures() returns features for each channel in the image in each of four directions (horizontal, vertical, left and right diagonals) for the specified distance. The features include the angular second moment, contrast, correlation, sum of squares: variance, inverse difference moment, sum average, sum varience, sum entropy, entropy, difference variance, difference entropy, information measures of correlation 1, information measures of correlation 2, and maximum correlation coefficient. You can access the red channel contrast, for example, like this:

    - -
    -  channel_features=GetImageChannelFeatures(image,1,exception);
-  contrast=channel_features[RedChannel].contrast[0];
-
    - -

    Use MagickRelinquishMemory() to free the features buffer.

    - -

    The format of the GetImageChannelFeatures method is:

    - -
    -  ChannelFeatures *GetImageChannelFeatures(const Image *image,
-    const size_t distance,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    distance
    -

    the distance.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/fx.html b/www/api/fx.html index b752c8833..cf21e0171 100644 --- a/www/api/fx.html +++ b/www/api/fx.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,159 +190,9 @@
    -

    Module histogram - Methods

    -

    [GetImageHistogram • IsHistogramImage • IsPaletteImage • MinMaxStretchImage • GetNumberColors • UniqueImageColors]

    +

    Module Methods

    +

    []

    -

    GetImageHistogram

    -
    - -

    GetImageHistogram() returns the unique colors in an image.

    - -

    The format of the GetImageHistogram method is:

    - -
    -  size_t GetImageHistogram(const Image *image,
-    size_t *number_colors,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows.

    - -
    image
    -

    the image.

    - -
    file
    -

    Write a histogram of the color distribution to this file handle.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    IsHistogramImage

    -
    - -

    IsHistogramImage() returns MagickTrue if the image has 1024 unique colors or less.

    - -

    The format of the IsHistogramImage method is:

    - -
    -  MagickBooleanType IsHistogramImage(const Image *image,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows.

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    IsPaletteImage

    -
    - -

    IsPaletteImage() returns MagickTrue if the image is PseudoClass and has 256 unique colors or less.

    - -

    The format of the IsPaletteImage method is:

    - -
    -  MagickBooleanType IsPaletteImage(const Image *image,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows.

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    MinMaxStretchImage

    -
    - -

    MinMaxStretchImage() uses the exact minimum and maximum values found in each of the channels given, as the BlackPoint and WhitePoint to linearly stretch the colors (and histogram) of the image. The stretch points are also moved further inward by the adjustment values given.

    - -

    If the adjustment values are both zero this function is equivelent to a perfect normalization (or autolevel) of the image.

    - -

    Each channel is stretched independantally of each other (producing color distortion) unless the special 'SyncChannels' flag is also provided in the channels setting. If this flag is present the minimum and maximum point will be extracted from all the given channels, and those channels will be stretched by exactly the same amount (preventing color distortion).

    - -

    In the special case that only ONE value is found in a channel of the image that value is not stretched, that value is left as is.

    - -

    The 'SyncChannels' is turned on in the 'DefaultChannels' setting by default.

    - -

    The format of the MinMaxStretchImage method is:

    - -
    -  MagickBooleanType MinMaxStretchImage(Image *image,
-    const ChannelType channel, const double black_adjust,
-    const double white_adjust)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    The image to auto-level

    - -
    channel
    -

    The channels to auto-level. If the special 'SyncChannels' flag is set, all the given channels are stretched by the same amount.

    - -
    black_adjust, white_adjust
    -

    Move the Black/White Point inward from the minimum and maximum points by this color value.

    - -
    -

    GetNumberColors

    -
    - -

    GetNumberColors() returns the number of unique colors in an image.

    - -

    The format of the GetNumberColors method is:

    - -
    -  size_t GetNumberColors(const Image *image,FILE *file,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows.

    - -
    image
    -

    the image.

    - -
    file
    -

    Write a histogram of the color distribution to this file handle.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    UniqueImageColors

    -
    - -

    UniqueImageColors() returns the unique colors of an image.

    - -

    The format of the UniqueImageColors method is:

    - -
    -  Image *UniqueImageColors(const Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows.

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/image-view.html b/www/api/image-view.html index 59547646d..ed29fef3b 100644 --- a/www/api/image-view.html +++ b/www/api/image-view.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,929 +190,9 @@
    -

    Module image - Methods

    -

    [AcquireImage • AcquireImageInfo • AcquireNextImage • AppendImages • CatchImageException • ClipImagePath • CloneImage • CloneImageInfo • CombineImages • DestroyImage • DestroyImageInfo • GetImageAlphaChannel • GetImageClipMask • GetImageException • GetImageInfo • GetImageInfoFile • GetImageMask • GetImageVirtualPixelMethod • InterpretImageFilename • IsHighDynamicRangeImage • IsImageObject • IsTaintImage • ModifyImage • NewMagickImage • ReferenceImage • ResetImagePage • SeparateImageChannel • SeparateImages • SetImageAlphaChannel • SetImageBackgroundColor • SetImageColor • SetImageStorageClass • SetImageClipMask • SetImageExtent • SetImageInfoBlob • SetImageInfoFile • SetImageMask • SetImageOpacity • SetImageType • SetImageVirtualPixelMethod • SmushImages • StripImage • SyncImageSettings]

    +

    Module Methods

    +

    []

    -

    AcquireImage

    -
    - -

    AcquireImage() returns a pointer to an image structure initialized to default values.

    - -

    The format of the AcquireImage method is:

    - -
    -  Image *AcquireImage(const ImageInfo *image_info)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.

    - -
    -

    AcquireImageInfo

    -
    - -

    AcquireImageInfo() allocates the ImageInfo structure.

    - -

    The format of the AcquireImageInfo method is:

    - -
    -  ImageInfo *AcquireImageInfo(void)
-
    - -
    -

    AcquireNextImage

    -
    - -

    AcquireNextImage() initializes the next image in a sequence to default values. The next member of image points to the newly allocated image. If there is a memory shortage, next is assigned NULL.

    - -

    The format of the AcquireNextImage method is:

    - -
    -  void AcquireNextImage(const ImageInfo *image_info,Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    Many of the image default values are set from this structure. For example, filename, compression, depth, background color, and others.

    - -
    image
    -

    the image.

    - -
    -

    AppendImages

    -
    - -

    AppendImages() takes all images from the current image pointer to the end of the image list and appends them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right.

    - -

    The current gravity setting now effects how the image is justified in the final image.

    - -

    The format of the AppendImages method is:

    - -
    -  Image *AppendImages(const Image *images,const MagickBooleanType stack,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    images
    -

    the image sequence.

    - -
    stack
    -

    A value other than 0 stacks the images top-to-bottom.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    CatchImageException

    -
    - -

    CatchImageException() returns if no exceptions are found in the image sequence, otherwise it determines the most severe exception and reports it as a warning or error depending on the severity.

    - -

    The format of the CatchImageException method is:

    - -
    -  ExceptionType CatchImageException(Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    An image sequence.

    - -
    -

    ClipImagePath

    -
    - -

    ClipImagePath() sets the image clip mask based any clipping path information if it exists.

    - -

    The format of the ClipImagePath method is:

    - -
    -  MagickBooleanType ClipImagePath(Image *image,const char *pathname,
-    const MagickBooleanType inside)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    pathname
    -

    name of clipping path resource. If name is preceded by #, use clipping path numbered by name.

    - -
    inside
    -

    if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.

    - -
    -

    CloneImage

    -
    - -

    CloneImage() copies an image and returns the copy as a new image object. If the specified columns and rows is 0, an exact copy of the image is returned, otherwise the pixel data is undefined and must be initialized with the QueueAuthenticPixels() and SyncAuthenticPixels() methods. On failure, a NULL image is returned and exception describes the reason for the failure.

    - -

    The format of the CloneImage method is:

    - -
    -  Image *CloneImage(const Image *image,const size_t columns,
-    const size_t rows,const MagickBooleanType orphan,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    columns
    -

    the number of columns in the cloned image.

    - -
    rows
    -

    the number of rows in the cloned image.

    - -
    detach
    -

    With a value other than 0, the cloned image is detached from its parent I/O stream.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    CloneImageInfo

    -
    - -

    CloneImageInfo() makes a copy of the given image info structure. If NULL is specified, a new image info structure is created initialized to default values.

    - -

    The format of the CloneImageInfo method is:

    - -
    -  ImageInfo *CloneImageInfo(const ImageInfo *image_info)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    -

    CombineImages

    -
    - -

    CombineImages() combines one or more images into a single image. The grayscale value of the pixels of each image in the sequence is assigned in order to the specified channels of the combined image. The typical ordering would be image 1 => Red, 2 => Green, 3 => Blue, etc.

    - -

    The format of the CombineImages method is:

    - -
    -  Image *CombineImages(const Image *image,const ChannelType channel,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    DestroyImage

    -
    - -

    DestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.

    - -

    The format of the DestroyImage method is:

    - -
    -  Image *DestroyImage(Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    DestroyImageInfo

    -
    - -

    DestroyImageInfo() deallocates memory associated with an ImageInfo structure.

    - -

    The format of the DestroyImageInfo method is:

    - -
    -  ImageInfo *DestroyImageInfo(ImageInfo *image_info)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    -

    GetImageAlphaChannel

    -
    - -

    GetImageAlphaChannel() returns MagickFalse if the image alpha channel is not activated. That is, the image is RGB rather than RGBA or CMYK rather than CMYKA.

    - -

    The format of the GetImageAlphaChannel method is:

    - -
    -  MagickBooleanType GetImageAlphaChannel(const Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    GetImageClipMask

    -
    - -

    GetImageClipMask() returns the clip path associated with the image.

    - -

    The format of the GetImageClipMask method is:

    - -
    -  Image *GetImageClipMask(const Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    GetImageException

    -
    - -

    GetImageException() traverses an image sequence and returns any error more severe than noted by the exception parameter.

    - -

    The format of the GetImageException method is:

    - -
    -  void GetImageException(Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    Specifies a pointer to a list of one or more images.

    - -
    exception
    -

    return the highest severity exception.

    - -
    -

    GetImageInfo

    -
    - -

    GetImageInfo() initializes image_info to default values.

    - -

    The format of the GetImageInfo method is:

    - -
    -  void GetImageInfo(ImageInfo *image_info)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    -

    GetImageInfoFile

    -
    - -

    GetImageInfoFile() returns the image info file member.

    - -

    The format of the GetImageInfoFile method is:

    - -
    -  FILE *GetImageInfoFile(const ImageInfo *image_info)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    -

    GetImageMask

    -
    - -

    GetImageMask() returns the mask associated with the image.

    - -

    The format of the GetImageMask method is:

    - -
    -  Image *GetImageMask(const Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    GetImageVirtualPixelMethod

    -
    - -

    GetImageVirtualPixelMethod() gets the "virtual pixels" method for the image. A virtual pixel is any pixel access that is outside the boundaries of the image cache.

    - -

    The format of the GetImageVirtualPixelMethod() method is:

    - -
    -  VirtualPixelMethod GetImageVirtualPixelMethod(const Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    InterpretImageFilename

    -
    - -

    InterpretImageFilename() interprets embedded characters in an image filename. The filename length is returned.

    - -

    The format of the InterpretImageFilename method is:

    - -
    -  size_t InterpretImageFilename(const ImageInfo *image_info,
-    Image *image,const char *format,int value,char *filename)
-
    - -

    A description of each parameter follows.

    - -
    image_info
    -

    the image info..

    - -
    image
    -

    the image.

    - -
    format
    -

    A filename describing the format to use to write the numeric argument. Only the first numeric format identifier is replaced.

    - -
    value
    -

    Numeric value to substitute into format filename.

    - -
    filename
    -

    return the formatted filename in this character buffer.

    - -
    -

    IsHighDynamicRangeImage

    -
    - -

    IsHighDynamicRangeImage() returns MagickTrue if any pixel component is non-integer or exceeds the bounds of the quantum depth (e.g. for Q16 0..65535.

    - -

    The format of the IsHighDynamicRangeImage method is:

    - -
    -  MagickBooleanType IsHighDynamicRangeImage(const Image *image,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    IsImageObject

    -
    - -

    IsImageObject() returns MagickTrue if the image sequence contains a valid set of image objects.

    - -

    The format of the IsImageObject method is:

    - -
    -  MagickBooleanType IsImageObject(const Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    IsTaintImage

    -
    - -

    IsTaintImage() returns MagickTrue any pixel in the image has been altered since it was first constituted.

    - -

    The format of the IsTaintImage method is:

    - -
    -  MagickBooleanType IsTaintImage(const Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    ModifyImage

    -
    - -

    ModifyImage() ensures that there is only a single reference to the image to be modified, updating the provided image pointer to point to a clone of the original image if necessary.

    - -

    The format of the ModifyImage method is:

    - -
    -  MagickBooleanType ModifyImage(Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    NewMagickImage

    -
    - -

    NewMagickImage() creates a blank image canvas of the specified size and background color.

    - -

    The format of the NewMagickImage method is:

    - -
    -  Image *NewMagickImage(const ImageInfo *image_info,
-    const size_t width,const size_t height,
-    const MagickPixelPacket *background)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    width
    -

    the image width.

    - -
    height
    -

    the image height.

    - -
    background
    -

    the image color.

    - -
    -

    ReferenceImage

    -
    - -

    ReferenceImage() increments the reference count associated with an image returning a pointer to the image.

    - -

    The format of the ReferenceImage method is:

    - -
    -  Image *ReferenceImage(Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    ResetImagePage

    -
    - -

    ResetImagePage() resets the image page canvas and position.

    - -

    The format of the ResetImagePage method is:

    - -
    -  MagickBooleanType ResetImagePage(Image *image,const char *page)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    page
    -

    the relative page specification.

    - -
    -

    SeparateImageChannel

    -
    - -

    SeparateImageChannel() separates a channel from the image and returns it as a grayscale image. A channel is a particular color component of each pixel in the image.

    - -

    The format of the SeparateImageChannel method is:

    - -
    -  MagickBooleanType SeparateImageChannel(Image *image,
-    const ChannelType channel)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    Identify which channel to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.

    - -
    -

    SeparateImages

    -
    - -

    SeparateImages() returns a separate grayscale image for each channel specified.

    - -

    The format of the SeparateImages method is:

    - -
    -  MagickBooleanType SeparateImages(const Image *image,
-    const ChannelType channel,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    Identify which channels to extract: RedChannel, GreenChannel, BlueChannel, OpacityChannel, CyanChannel, MagentaChannel, YellowChannel, or BlackChannel.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    SetImageAlphaChannel

    -
    - -

    SetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.

    - -

    The format of the SetImageAlphaChannel method is:

    - -
    -  MagickBooleanType SetImageAlphaChannel(Image *image,
-    const AlphaChannelType alpha_type)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    alpha_type
    -

    The alpha channel type: ActivateAlphaChannel, CopyAlphaChannel, DeactivateAlphaChannel, ExtractAlphaChannel, OpaqueAlphaChannel, ResetAlphaChannel, SetAlphaChannel, ShapeAlphaChannel, and TransparentAlphaChannel.

    - -
    -

    SetImageBackgroundColor

    -
    - -

    SetImageBackgroundColor() initializes the image pixels to the image background color. The background color is defined by the background_color member of the image structure.

    - -

    The format of the SetImage method is:

    - -
    -  MagickBooleanType SetImageBackgroundColor(Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    SetImageColor

    -
    - -

    SetImageColor() set the entire image canvas to the specified color.

    - -

    The format of the SetImageColor method is:

    - -
    -  MagickBooleanType SetImageColor(Image *image,
-    const MagickPixelPacket *color)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    background
    -

    the image color.

    - -
    -

    SetImageStorageClass

    -
    - -

    SetImageStorageClass() sets the image class: DirectClass for true color images or PseudoClass for colormapped images.

    - -

    The format of the SetImageStorageClass method is:

    - -
    -  MagickBooleanType SetImageStorageClass(Image *image,
-    const ClassType storage_class)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    storage_class
    -

    The image class.

    - -
    -

    SetImageClipMask

    -
    - -

    SetImageClipMask() associates a clip path with the image. The clip path must be the same dimensions as the image. Set any pixel component of the clip path to TransparentOpacity to prevent that corresponding image pixel component from being updated when SyncAuthenticPixels() is applied.

    - -

    The format of the SetImageClipMask method is:

    - -
    -  MagickBooleanType SetImageClipMask(Image *image,const Image *clip_mask)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    clip_mask
    -

    the image clip path.

    - -
    -

    SetImageExtent

    -
    - -

    SetImageExtent() sets the image size (i.e. columns & rows).

    - -

    The format of the SetImageExtent method is:

    - -
    -  MagickBooleanType SetImageExtent(Image *image,
-    const size_t columns,const size_t rows)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    columns
    -

    The image width in pixels.

    - -
    rows
    -

    The image height in pixels.

    - -
    -

    SetImageInfoBlob

    -
    - -

    SetImageInfoBlob() sets the image info blob member.

    - -

    The format of the SetImageInfoBlob method is:

    - -
    -  void SetImageInfoBlob(ImageInfo *image_info,const void *blob,
-    const size_t length)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    blob
    -

    the blob.

    - -
    length
    -

    the blob length.

    - -
    -

    SetImageInfoFile

    -
    - -

    SetImageInfoFile() sets the image info file member.

    - -

    The format of the SetImageInfoFile method is:

    - -
    -  void SetImageInfoFile(ImageInfo *image_info,FILE *file)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    file
    -

    the file.

    - -
    -

    SetImageMask

    -
    - -

    SetImageMask() associates a mask with the image. The mask must be the same dimensions as the image.

    - -

    The format of the SetImageMask method is:

    - -
    -  MagickBooleanType SetImageMask(Image *image,const Image *mask)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    mask
    -

    the image mask.

    - -
    -

    SetImageOpacity

    -
    - -

    SetImageOpacity() sets the opacity levels of the image.

    - -

    The format of the SetImageOpacity method is:

    - -
    -  MagickBooleanType SetImageOpacity(Image *image,const Quantum opacity)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    opacity
    -

    the level of transparency: 0 is fully opaque and QuantumRange is fully transparent.

    - -
    -

    SetImageType

    -
    - -

    SetImageType() sets the type of image. Choose from these types:

    - -

    Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte OptimizeType

    - -

    The format of the SetImageType method is:

    - -
    -  MagickBooleanType SetImageType(Image *image,const ImageType type)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    type
    -

    Image type.

    - -
    -

    SetImageVirtualPixelMethod

    -
    - -

    SetImageVirtualPixelMethod() sets the "virtual pixels" method for the image and returns the previous setting. A virtual pixel is any pixel access that is outside the boundaries of the image cache.

    - -

    The format of the SetImageVirtualPixelMethod() method is:

    - -
    -  VirtualPixelMethod SetImageVirtualPixelMethod(const Image *image,
-    const VirtualPixelMethod virtual_pixel_method)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    virtual_pixel_method
    -

    choose the type of virtual pixel.

    - -
    -

    SmushImages

    -
    - -

    SmushImages() takes all images from the current image pointer to the end of the image list and smushes them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right.

    - -

    The current gravity setting now effects how the image is justified in the final image.

    - -

    The format of the SmushImages method is:

    - -
    -  Image *SmushImages(const Image *images,const MagickBooleanType stack,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    images
    -

    the image sequence.

    - -
    stack
    -

    A value other than 0 stacks the images top-to-bottom.

    - -
    offset
    -

    minimum distance in pixels between images.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    StripImage

    -
    - -

    StripImage() strips an image of all profiles and comments.

    - -

    The format of the StripImage method is:

    - -
    -  MagickBooleanType StripImage(Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    SyncImageSettings

    -
    - -

    SyncImageSettings() sync the image info options to the image.

    - -

    The format of the SyncImageSettings method is:

    - -
    -  MagickBooleanType SyncImageSettings(const ImageInfo *image_info,
-    Image *image)
-  MagickBooleanType SyncImagesSettings(const ImageInfo *image_info,
-    Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    image
    -

    the image.

    - -
    diff --git a/www/api/layer.html b/www/api/layer.html index 1b1ddaded..36fa0535b 100644 --- a/www/api/layer.html +++ b/www/api/layer.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,296 +190,9 @@
    -

    Module layer - Methods

    -

    [CoalesceImages • DisposeImages • CompareImageLayers • DeconstructImages • OptimizeImageLayers • OptimizeImagePlusLayers • OptimizeImageTransparency • RemoveDuplicateLayers • RemoveZeroDelayLayers • CompositeLayers • MergeImageLayers]

    +

    Module Methods

    +

    []

    -

    CoalesceImages

    -
    - -

    CoalesceImages() composites a set of images while respecting any page offsets and disposal methods. GIF, MIFF, and MNG animation sequences typically start with an image background and each subsequent image varies in size and offset. A new image sequence is returned with all images the same size as the first images virtual canvas and composited with the next image in the sequence.

    - -

    The format of the CoalesceImages method is:

    - -
    -  Image *CoalesceImages(Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image sequence.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    DisposeImages

    -
    - -

    DisposeImages() returns the coalesced frames of a GIF animation as it would appear after the GIF dispose method of that frame has been applied. That is it returned the appearance of each frame before the next is overlaid.

    - -

    The format of the DisposeImages method is:

    - -
    -  Image *DisposeImages(Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image sequence.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    CompareImageLayers

    -
    - -

    CompareImageLayers() compares each image with the next in a sequence and returns the minimum bounding region of all the pixel differences (of the ImageLayerMethod specified) it discovers.

    - -

    Images do NOT have to be the same size, though it is best that all the images are 'coalesced' (images are all the same size, on a flattened canvas, so as to represent exactly how an specific frame should look).

    - -

    No GIF dispose methods are applied, so GIF animations must be coalesced before applying this image operator to find differences to them.

    - -

    The format of the CompareImageLayers method is:

    - -
    -  Image *CompareImageLayers(const Image *images,
-    const ImageLayerMethod method,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    method
    -

    the layers type to compare images with. Must be one of... CompareAnyLayer, CompareClearLayer, CompareOverlayLayer.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    DeconstructImages

    -
    - -

    DeconstructImages() compares each image with the next in a sequence and returns the minimum bounding region of all differences from the first image.

    - -

    This function is deprecated in favor of the more universal CompareImageLayers() function.

    - -

    The format of the DeconstructImages method is:

    - -
    -  Image *DeconstructImages(const Image *images, ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    OptimizeImageLayers

    -
    - -

    OptimizeImageLayers() compares each image the GIF disposed forms of the previous image in the sequence. From this it attempts to select the smallest cropped image to replace each frame, while preserving the results of the GIF animation.

    - -

    The format of the OptimizeImageLayers method is:

    - -
    -  Image *OptimizeImageLayers(const Image *image,
-           ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    OptimizeImagePlusLayers

    -
    - -

    OptimizeImagePlusLayers() is exactly as OptimizeImageLayers(), but may also add or even remove extra frames in the animation, if it improves the total number of pixels in the resulting GIF animation.

    - -

    The format of the OptimizePlusImageLayers method is:

    - -
    -  Image *OptimizePlusImageLayers(const Image *image,
-           ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    OptimizeImageTransparency

    -
    - -

    OptimizeImageTransparency() takes a frame optimized GIF animation, and compares the overlayed pixels against the disposal image resulting from all the previous frames in the animation. Any pixel that does not change the disposal image (and thus does not effect the outcome of an overlay) is made transparent.

    - -

    WARNING: This modifies the current images directly, rather than generate a new image sequence.

    - -

    The format of the OptimizeImageTransperency method is:

    - -
    -  void OptimizeImageTransperency(Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image sequence

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    RemoveDuplicateLayers

    -
    - -

    RemoveDuplicateLayers() removes any image that is exactly the same as the next image in the given image list. Image size and virtual canvas offset must also match, though not the virtual canvas size itself.

    - -

    No check is made with regards to image disposal setting, though it is the dispose setting of later image that is kept. Also any time delays are also added together. As such coalesced image animations should still produce the same result, though with duplicte frames merged into a single frame.

    - -

    The format of the RemoveDuplicateLayers method is:

    - -
    -  void RemoveDuplicateLayers(Image **image, ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    images
    -

    the image list

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    RemoveZeroDelayLayers

    -
    - -

    RemoveZeroDelayLayers() removes any image that as a zero delay time. Such images generally represent intermediate or partial updates in GIF animations used for file optimization. They are not ment to be displayed to users of the animation. Viewable images in an animation should have a time delay of 3 or more centi-seconds (hundredths of a second).

    - -

    However if all the frames have a zero time delay, then either the animation is as yet incomplete, or it is not a GIF animation. This a non-sensible situation, so no image will be removed and a 'Zero Time Animation' warning (exception) given.

    - -

    No warning will be given if no image was removed because all images had an appropriate non-zero time delay set.

    - -

    Due to the special requirements of GIF disposal handling, GIF animations should be coalesced first, before calling this function, though that is not a requirement.

    - -

    The format of the RemoveZeroDelayLayers method is:

    - -
    -  void RemoveZeroDelayLayers(Image **image, ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    images
    -

    the image list

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    CompositeLayers

    -
    - -

    CompositeLayers() compose first image sequence (source) over the second image sequence (destination), using the given compose method and offsets.

    - -

    The pointers to the image list does not have to be the start of that image list, but may start somewhere in the middle. Each layer from the two image lists are composted together until the end of one of the image lists is reached. The offset of each composition is also adjusted to match the virtual canvas offsets of each layer. As such the given offset is relative to the virtual canvas, and not the actual image.

    - -

    No GIF disposal handling is performed, so GIF animations should be coalesced before use. However this not a requirement, and individual layer images may have any size or offset, for special compositions.

    - -

    Special case:- If one of the image sequences is just a single image that image is repeatally composed with all the images in the other image list. Either the source or destination lists may be the single image, for this situation.

    - -

    The destination list will be expanded as needed to match number of source image overlaid (from current position to end of list).

    - -

    The format of the CompositeLayers method is:

    - -
    -  void CompositeLayers(Image *destination,
-      const CompositeOperator compose, Image *source,
-      const ssize_t x_offset, const ssize_t y_offset,
-      ExceptionInfo *exception);
-
    - -

    A description of each parameter follows:

    - -
    destination
    -

    the destination images and results

    - -
    source
    -

    source image(s) for the layer composition

    - -
    compose, x_offset, y_offset
    -

    arguments passed on to CompositeImages()

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    MergeImageLayers

    -
    - -

    MergeImageLayers() composes all the image layers from the current given image onward to produce a single image of the merged layers.

    - -

    The inital canvas's size depends on the given ImageLayerMethod, and is initialized using the first images background color. The images are then compositied onto that image in sequence using the given composition that has been assigned to each individual image.

    - -

    The format of the MergeImageLayers is:

    - -
    -  Image *MergeImageLayers(const Image *image,
-    const ImageLayerMethod method, ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image list to be composited together

    - -
    method
    -

    the method of selecting the size of the initial canvas.

    - -

    MergeLayer: Merge all layers onto a canvas just large enough to hold all the actual images. The virtual canvas of the first image is preserved but otherwise ignored.

    - -

    FlattenLayer: Use the virtual canvas size of first image. Images which fall outside this canvas is clipped. This can be used to 'fill out' a given virtual canvas.

    - -

    MosaicLayer: Start with the virtual canvas of the first image, enlarging left and right edges to contain all images. Images with negative offsets will be clipped.

    - -

    TrimBoundsLayer: Determine the overall bounds of all the image layers just as in "MergeLayer", then adjust the the canvas and offsets to be relative to those bounds, without overlaying the images.

    - -

    WARNING: a new image is not returned, the original image sequence page data is modified instead.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/list.html b/www/api/list.html index f25ee88c8..f33b4d3d2 100644 --- a/www/api/list.html +++ b/www/api/list.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,1234 +190,9 @@
    -

    Module deprecate - Methods

    -

    [MagickAverageImages • ClonePixelView • DestroyPixelView • DuplexTransferPixelViewIterator • GetPixelViewException • GetPixelViewHeight • GetPixelViewIterator • GetPixelViewPixels • GetPixelViewWand • GetPixelViewWidth • GetPixelViewX • GetPixelViewY • IsPixelView • MagickClipPathImage • DrawGetFillAlpha • DrawGetStrokeAlpha • DrawPeekGraphicWand • DrawPopGraphicContext • DrawPushGraphicContext • DrawSetFillAlpha • DrawSetStrokeAlpha • MagickColorFloodfillImage • MagickDescribeImage • MagickFlattenImages • MagickGetImageAttribute • MagickGetImageMatte • MagickGetImagePixels • MagickGetImageSize • MagickMapImage • MagickMatteFloodfillImage • MagickMaximumImages • MagickMinimumImages • MagickMosaicImages • MagickOpaqueImage • MagickPaintFloodfillImage • MagickPaintOpaqueImage • MagickPaintTransparentImage • MagickRecolorImage • MagickSetImageAttribute • MagickSetImageIndex • MagickTransparentImage • MagickRegionOfInterestImage • MagickSetImagePixels • MagickWriteImageBlob • NewPixelView • NewPixelViewRegion • PixelGetNextRow • PixelIteratorGetException • SetPixelViewIterator • TransferPixelViewIterator • UpdatePixelViewIterator]

    +

    Module Methods

    +

    []

    -

    MagickAverageImages

    -
    - -

    MagickAverageImages() average a set of images.

    - -

    The format of the MagickAverageImages method is:

    - -
    -  MagickWand *MagickAverageImages(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    ClonePixelView

    -
    - -

    ClonePixelView() makes a copy of the specified pixel view.

    - -

    The format of the ClonePixelView method is:

    - -
    -  PixelView *ClonePixelView(const PixelView *pixel_view)
-
    - -

    A description of each parameter follows:

    - -
    pixel_view
    -

    the pixel view.

    - -
    -

    DestroyPixelView

    -
    - -

    DestroyPixelView() deallocates memory associated with a pixel view.

    - -

    The format of the DestroyPixelView method is:

    - -
    -  PixelView *DestroyPixelView(PixelView *pixel_view,
-    const size_t number_wands,const size_t number_threads)
-
    - -

    A description of each parameter follows:

    - -
    pixel_view
    -

    the pixel view.

    - -
    number_wand
    -

    the number of pixel wands.

    - -
    number_threads
    -

    number of threads.

    - -
    -

    DuplexTransferPixelViewIterator

    -
    - -

    DuplexTransferPixelViewIterator() iterates over three pixel views in parallel and calls your transfer method for each scanline of the view. The source and duplex pixel region is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. However, the destination pixel view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.

    - -

    Use this pragma:

    - -
    -      #pragma omp critical
-
    - -

    to define a section of code in your callback transfer method that must be executed by a single thread at a time.

    - -

    The format of the DuplexTransferPixelViewIterator method is:

    - -
    -  MagickBooleanType DuplexTransferPixelViewIterator(PixelView *source,
-    PixelView *duplex,PixelView *destination,
-    DuplexTransferPixelViewMethod transfer,void *context)
-
    - -

    A description of each parameter follows:

    - -
    source
    -

    the source pixel view.

    - -
    duplex
    -

    the duplex pixel view.

    - -
    destination
    -

    the destination pixel view.

    - -
    transfer
    -

    the transfer callback method.

    - -
    context
    -

    the user defined context.

    - -
    -

    GetPixelViewException

    -
    - -

    GetPixelViewException() returns the severity, reason, and description of any error that occurs when utilizing a pixel view.

    - -

    The format of the GetPixelViewException method is:

    - -
    -  char *GetPixelViewException(const PixelWand *pixel_view,
-    ExceptionType *severity)
-
    - -

    A description of each parameter follows:

    - -
    pixel_view
    -

    the pixel pixel_view.

    - -
    severity
    -

    the severity of the error is returned here.

    - -
    -

    GetPixelViewHeight

    -
    - -

    GetPixelViewHeight() returns the pixel view height.

    - -

    The format of the GetPixelViewHeight method is:

    - -
    -  size_t GetPixelViewHeight(const PixelView *pixel_view)
-
    - -

    A description of each parameter follows:

    - -
    pixel_view
    -

    the pixel view.

    - -
    -

    GetPixelViewIterator

    -
    - -

    GetPixelViewIterator() iterates over the pixel view in parallel and calls your get method for each scanline of the view. The pixel region is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. Any updates to the pixels in your callback are ignored.

    - -

    Use this pragma:

    - -
    -      #pragma omp critical
-
    - -

    to define a section of code in your callback get method that must be executed by a single thread at a time.

    - -

    The format of the GetPixelViewIterator method is:

    - -
    -  MagickBooleanType GetPixelViewIterator(PixelView *source,
-    GetPixelViewMethod get,void *context)
-
    - -

    A description of each parameter follows:

    - -
    source
    -

    the source pixel view.

    - -
    get
    -

    the get callback method.

    - -
    context
    -

    the user defined context.

    - -
    -

    GetPixelViewPixels

    -
    - -

    GetPixelViewPixels() returns the pixel view pixel_wands.

    - -

    The format of the GetPixelViewPixels method is:

    - -
    -  PixelWand *GetPixelViewPixels(const PixelView *pixel_view)
-
    - -

    A description of each parameter follows:

    - -
    pixel_view
    -

    the pixel view.

    - -
    -

    GetPixelViewWand

    -
    - -

    GetPixelViewWand() returns the magick wand associated with the pixel view.

    - -

    The format of the GetPixelViewWand method is:

    - -
    -  MagickWand *GetPixelViewWand(const PixelView *pixel_view)
-
    - -

    A description of each parameter follows:

    - -
    pixel_view
    -

    the pixel view.

    - -
    -

    GetPixelViewWidth

    -
    - -

    GetPixelViewWidth() returns the pixel view width.

    - -

    The format of the GetPixelViewWidth method is:

    - -
    -  size_t GetPixelViewWidth(const PixelView *pixel_view)
-
    - -

    A description of each parameter follows:

    - -
    pixel_view
    -

    the pixel view.

    - -
    -

    GetPixelViewX

    -
    - -

    GetPixelViewX() returns the pixel view x offset.

    - -

    The format of the GetPixelViewX method is:

    - -
    -  ssize_t GetPixelViewX(const PixelView *pixel_view)
-
    - -

    A description of each parameter follows:

    - -
    pixel_view
    -

    the pixel view.

    - -
    -

    GetPixelViewY

    -
    - -

    GetPixelViewY() returns the pixel view y offset.

    - -

    The format of the GetPixelViewY method is:

    - -
    -  ssize_t GetPixelViewY(const PixelView *pixel_view)
-
    - -

    A description of each parameter follows:

    - -
    pixel_view
    -

    the pixel view.

    - -
    -

    IsPixelView

    -
    - -

    IsPixelView() returns MagickTrue if the the parameter is verified as a pixel view container.

    - -

    The format of the IsPixelView method is:

    - -
    -  MagickBooleanType IsPixelView(const PixelView *pixel_view)
-
    - -

    A description of each parameter follows:

    - -
    pixel_view
    -

    the pixel view.

    - -
    -

    MagickClipPathImage

    -
    - -

    MagickClipPathImage() clips along the named paths from the 8BIM profile, if present. Later operations take effect inside the path. Id may be a number if preceded with #, to work on a numbered path, e.g., "#1" to use the first path.

    - -

    The format of the MagickClipPathImage method is:

    - -
    -  MagickBooleanType MagickClipPathImage(MagickWand *wand,
-    const char *pathname,const MagickBooleanType inside)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    pathname
    -

    name of clipping path resource. If name is preceded by #, use clipping path numbered by name.

    - -
    inside
    -

    if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.

    - -
    -

    DrawGetFillAlpha

    -
    - -

    DrawGetFillAlpha() returns the alpha used when drawing using the fill color or fill texture. Fully opaque is 1.0.

    - -

    The format of the DrawGetFillAlpha method is:

    - -
    -  double DrawGetFillAlpha(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawGetStrokeAlpha

    -
    - -

    DrawGetStrokeAlpha() returns the alpha of stroked object outlines.

    - -

    The format of the DrawGetStrokeAlpha method is:

    - -
    -  double DrawGetStrokeAlpha(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    -
    -

    DrawPeekGraphicWand

    -
    - -

    DrawPeekGraphicWand() returns the current drawing wand.

    - -

    The format of the PeekDrawingWand method is:

    - -
    -  DrawInfo *DrawPeekGraphicWand(const DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawPopGraphicContext

    -
    - -

    DrawPopGraphicContext() destroys the current drawing wand and returns to the previously pushed drawing wand. Multiple drawing wands may exist. It is an error to attempt to pop more drawing wands than have been pushed, and it is proper form to pop all drawing wands which have been pushed.

    - -

    The format of the DrawPopGraphicContext method is:

    - -
    -  MagickBooleanType DrawPopGraphicContext(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawPushGraphicContext

    -
    - -

    DrawPushGraphicContext() clones the current drawing wand to create a new drawing wand. The original drawing wand(s) may be returned to by invoking PopDrawingWand(). The drawing wands are stored on a drawing wand stack. For every Pop there must have already been an equivalent Push.

    - -

    The format of the DrawPushGraphicContext method is:

    - -
    -  MagickBooleanType DrawPushGraphicContext(DrawingWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    -

    DrawSetFillAlpha

    -
    - -

    DrawSetFillAlpha() sets the alpha to use when drawing using the fill color or fill texture. Fully opaque is 1.0.

    - -

    The format of the DrawSetFillAlpha method is:

    - -
    -  void DrawSetFillAlpha(DrawingWand *wand,const double fill_alpha)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    fill_alpha
    -

    fill alpha

    - -
    -

    DrawSetStrokeAlpha

    -
    - -

    DrawSetStrokeAlpha() specifies the alpha of stroked object outlines.

    - -

    The format of the DrawSetStrokeAlpha method is:

    - -
    -  void DrawSetStrokeAlpha(DrawingWand *wand,const double stroke_alpha)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the drawing wand.

    - -
    stroke_alpha
    -

    stroke alpha. The value 1.0 is opaque.

    - -
    -

    MagickColorFloodfillImage

    -
    - -

    MagickColorFloodfillImage() changes the color value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image.

    - -

    The format of the MagickColorFloodfillImage method is:

    - -
    -  MagickBooleanType MagickColorFloodfillImage(MagickWand *wand,
-    const PixelWand *fill,const double fuzz,const PixelWand *bordercolor,
-    const ssize_t x,const ssize_t y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    fill
    -

    the floodfill color pixel wand.

    - -
    fuzz
    -

    By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.

    - -
    bordercolor
    -

    the border color pixel wand.

    - -
    x,y
    -

    the starting location of the operation.

    - -
    -

    MagickDescribeImage

    -
    - -

    MagickDescribeImage() identifies an image by printing its attributes to the file. Attributes include the image width, height, size, and others.

    - -

    The format of the MagickDescribeImage method is:

    - -
    -  const char *MagickDescribeImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickFlattenImages

    -
    - -

    MagickFlattenImages() merges a sequence of images. This useful for combining Photoshop layers into a single image.

    - -

    The format of the MagickFlattenImages method is:

    - -
    -  MagickWand *MagickFlattenImages(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageAttribute

    -
    - -

    MagickGetImageAttribute() returns a value associated with the specified property. Use MagickRelinquishMemory() to free the value when you are finished with it.

    - -

    The format of the MagickGetImageAttribute method is:

    - -
    -  char *MagickGetImageAttribute(MagickWand *wand,const char *property)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    property
    -

    the property.

    - -
    -

    MagickGetImageMatte

    -
    - -

    MagickGetImageMatte() returns MagickTrue if the image has a matte channel otherwise MagickFalse.

    - -

    The format of the MagickGetImageMatte method is:

    - -
    -  size_t MagickGetImageMatte(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImagePixels

    -
    - -

    MagickGetImagePixels() extracts pixel data from an image and returns it to you. The method returns MagickTrue on success otherwise MagickFalse if an error is encountered. The data is returned as char, short int, int, ssize_t, float, or double in the order specified by map.

    - -

    Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:

    - -
    -  MagickGetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
-
    - -

    The format of the MagickGetImagePixels method is:

    - -
    -  MagickBooleanType MagickGetImagePixels(MagickWand *wand,
-    const ssize_t x,const ssize_t y,const size_t columns,
-    const size_t rows,const char *map,const StorageType storage,
-    void *pixels)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x, y, columns, rows
    -

    These values define the perimeter of a region of pixels you want to extract.

    - -
    map
    -

    This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.

    - -
    storage
    -

    Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel, LongPixel, QuantumPixel, or ShortPixel.

    - -
    pixels
    -

    This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.

    - -
    -

    MagickGetImageSize

    -
    - -

    MagickGetImageSize() returns the image length in bytes.

    - -

    The format of the MagickGetImageSize method is:

    - -
    -  MagickBooleanType MagickGetImageSize(MagickWand *wand,
-    MagickSizeType *length)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    length
    -

    the image length in bytes.

    - -
    -

    MagickMapImage

    -
    - -

    MagickMapImage() replaces the colors of an image with the closest color from a reference image.

    - -

    The format of the MagickMapImage method is:

    - -
    -  MagickBooleanType MagickMapImage(MagickWand *wand,
-    const MagickWand *map_wand,const MagickBooleanType dither)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    map
    -

    the map wand.

    - -
    dither
    -

    Set this integer value to something other than zero to dither the mapped image.

    - -
    -

    MagickMatteFloodfillImage

    -
    - -

    MagickMatteFloodfillImage() changes the transparency value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the transparency value is changed for any neighbor pixel that does not match the bordercolor member of image.

    - -

    The format of the MagickMatteFloodfillImage method is:

    - -
    -  MagickBooleanType MagickMatteFloodfillImage(MagickWand *wand,
-    const double alpha,const double fuzz,const PixelWand *bordercolor,
-    const ssize_t x,const ssize_t y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    alpha
    -

    the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.

    - -
    fuzz
    -

    By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.

    - -
    bordercolor
    -

    the border color pixel wand.

    - -
    x,y
    -

    the starting location of the operation.

    - -
    -

    MagickMaximumImages

    -
    - -

    MagickMaximumImages() returns the maximum intensity of an image sequence.

    - -

    The format of the MagickMaximumImages method is:

    - -
    -  MagickWand *MagickMaximumImages(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickMinimumImages

    -
    - -

    MagickMinimumImages() returns the minimum intensity of an image sequence.

    - -

    The format of the MagickMinimumImages method is:

    - -
    -  MagickWand *MagickMinimumImages(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickMosaicImages

    -
    - -

    MagickMosaicImages() inlays an image sequence to form a single coherent picture. It returns a wand with each image in the sequence composited at the location defined by the page offset of the image.

    - -

    The format of the MagickMosaicImages method is:

    - -
    -  MagickWand *MagickMosaicImages(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickOpaqueImage

    -
    - -

    MagickOpaqueImage() changes any pixel that matches color with the color defined by fill.

    - -

    The format of the MagickOpaqueImage method is:

    - -
    -  MagickBooleanType MagickOpaqueImage(MagickWand *wand,
-    const PixelWand *target,const PixelWand *fill,const double fuzz)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the channel(s).

    - -
    target
    -

    Change this target color to the fill color within the image.

    - -
    fill
    -

    the fill pixel wand.

    - -
    fuzz
    -

    By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.

    - -
    -

    MagickPaintFloodfillImage

    -
    - -

    MagickPaintFloodfillImage() changes the color value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image.

    - -

    The format of the MagickPaintFloodfillImage method is:

    - -
    -  MagickBooleanType MagickPaintFloodfillImage(MagickWand *wand,
-    const ChannelType channel,const PixelWand *fill,const double fuzz,
-    const PixelWand *bordercolor,const ssize_t x,const ssize_t y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the channel(s).

    - -
    fill
    -

    the floodfill color pixel wand.

    - -
    fuzz
    -

    By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.

    - -
    bordercolor
    -

    the border color pixel wand.

    - -
    x,y
    -

    the starting location of the operation.

    - -
    -

    MagickPaintOpaqueImage

    -
    - -

    MagickPaintOpaqueImage() changes any pixel that matches color with the color defined by fill.

    - -

    The format of the MagickPaintOpaqueImage method is:

    - -
    -  MagickBooleanType MagickPaintOpaqueImage(MagickWand *wand,
-    const PixelWand *target,const PixelWand *fill,const double fuzz)
-  MagickBooleanType MagickPaintOpaqueImageChannel(MagickWand *wand,
-    const ChannelType channel,const PixelWand *target,
-    const PixelWand *fill,const double fuzz)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the channel(s).

    - -
    target
    -

    Change this target color to the fill color within the image.

    - -
    fill
    -

    the fill pixel wand.

    - -
    fuzz
    -

    By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.

    - -
    -

    MagickPaintTransparentImage

    -
    - -

    MagickPaintTransparentImage() changes any pixel that matches color with the color defined by fill.

    - -

    The format of the MagickPaintTransparentImage method is:

    - -
    -  MagickBooleanType MagickPaintTransparentImage(MagickWand *wand,
-    const PixelWand *target,const double alpha,const double fuzz)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    target
    -

    Change this target color to specified opacity value within the image.

    - -
    alpha
    -

    the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.

    - -
    fuzz
    -

    By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.

    - -
    -

    MagickRecolorImage

    -
    - -

    MagickRecolorImage() apply color transformation to an image. The method permits saturation changes, hue rotation, luminance to alpha, and various other effects. Although variable-sized transformation matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with offsets). The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255).

    - -

    The format of the MagickRecolorImage method is:

    - -
    -  MagickBooleanType MagickRecolorImage(MagickWand *wand,
-    const size_t order,const double *color_matrix)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    order
    -

    the number of columns and rows in the color matrix.

    - -
    color_matrix
    -

    An array of doubles representing the color matrix.

    - -
    -

    MagickSetImageAttribute

    -
    - -

    MagickSetImageAttribute() associates a property with an image.

    - -

    The format of the MagickSetImageAttribute method is:

    - -
    -  MagickBooleanType MagickSetImageAttribute(MagickWand *wand,
-    const char *property,const char *value)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    property
    -

    the property.

    - -
    value
    -

    the value.

    - -
    -

    MagickSetImageIndex

    -
    - -

    MagickSetImageIndex() set the current image to the position of the list specified with the index parameter.

    - -

    The format of the MagickSetImageIndex method is:

    - -
    -  MagickBooleanType MagickSetImageIndex(MagickWand *wand,const ssize_t index)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    index
    -

    the scene number.

    - -
    -

    MagickTransparentImage

    -
    - -

    MagickTransparentImage() changes any pixel that matches color with the color defined by fill.

    - -

    The format of the MagickTransparentImage method is:

    - -
    -  MagickBooleanType MagickTransparentImage(MagickWand *wand,
-    const PixelWand *target,const double alpha,const double fuzz)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    target
    -

    Change this target color to specified opacity value within the image.

    - -
    alpha
    -

    the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.

    - -
    fuzz
    -

    By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.

    - -
    -

    MagickRegionOfInterestImage

    -
    - -

    MagickRegionOfInterestImage() extracts a region of the image and returns it as a new wand.

    - -

    The format of the MagickRegionOfInterestImage method is:

    - -
    -  MagickWand *MagickRegionOfInterestImage(MagickWand *wand,
-    const size_t width,const size_t height,const ssize_t x,
-    const ssize_t y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    width
    -

    the region width.

    - -
    height
    -

    the region height.

    - -
    x
    -

    the region x offset.

    - -
    y
    -

    the region y offset.

    - -
    -

    MagickSetImagePixels

    -
    - -

    MagickSetImagePixels() accepts pixel datand stores it in the image at the location you specify. The method returns MagickFalse on success otherwise MagickTrue if an error is encountered. The pixel data can be either char, short int, int, ssize_t, float, or double in the order specified by map.

    - -

    Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:

    - -
    -  MagickSetImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
-
    - -

    The format of the MagickSetImagePixels method is:

    - -
    -  MagickBooleanType MagickSetImagePixels(MagickWand *wand,
-    const ssize_t x,const ssize_t y,const size_t columns,
-    const size_t rows,const char *map,const StorageType storage,
-    const void *pixels)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x, y, columns, rows
    -

    These values define the perimeter of a region of pixels you want to define.

    - -
    map
    -

    This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.

    - -
    storage
    -

    Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, ShortPixel, IntegerPixel, LongPixel, FloatPixel, or DoublePixel.

    - -
    pixels
    -

    This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.

    - -
    -

    MagickWriteImageBlob

    -
    - -

    MagickWriteImageBlob() implements direct to memory image formats. It returns the image as a blob and its length. Use MagickSetFormat() to set the format of the returned blob (GIF, JPEG, PNG, etc.).

    - -

    Use MagickRelinquishMemory() to free the blob when you are done with it.

    - -

    The format of the MagickWriteImageBlob method is:

    - -
    -  unsigned char *MagickWriteImageBlob(MagickWand *wand,size_t *length)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    length
    -

    the length of the blob.

    - -
    -

    NewPixelView

    -
    - -

    NewPixelView() returns a pixel view required for all other methods in the Pixel View API.

    - -

    The format of the NewPixelView method is:

    - -
    -  PixelView *NewPixelView(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the wand.

    - -
    -

    NewPixelViewRegion

    -
    - -

    NewPixelViewRegion() returns a pixel view required for all other methods in the Pixel View API.

    - -

    The format of the NewPixelViewRegion method is:

    - -
    -  PixelView *NewPixelViewRegion(MagickWand *wand,const ssize_t x,
-    const ssize_t y,const size_t width,const size_t height)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x,y,columns,rows
    -

    These values define the perimeter of a region of pixel_wands view.

    - -
    -

    PixelGetNextRow

    -
    - -

    PixelGetNextRow() returns the next row as an array of pixel wands from the pixel iterator.

    - -

    The format of the PixelGetNextRow method is:

    - -
    -  PixelWand **PixelGetNextRow(PixelIterator *iterator,
-    size_t *number_wands)
-
    - -

    A description of each parameter follows:

    - -
    iterator
    -

    the pixel iterator.

    - -
    number_wands
    -

    the number of pixel wands.

    - -
    -

    PixelIteratorGetException

    -
    - -

    PixelIteratorGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.

    - -

    The format of the PixelIteratorGetException method is:

    - -
    -  char *PixelIteratorGetException(const Pixeliterator *iterator,
-    ExceptionType *severity)
-
    - -

    A description of each parameter follows:

    - -
    iterator
    -

    the pixel iterator.

    - -
    severity
    -

    the severity of the error is returned here.

    - -
    -

    SetPixelViewIterator

    -
    - -

    SetPixelViewIterator() iterates over the pixel view in parallel and calls your set method for each scanline of the view. The pixel region is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension. The pixels are initiallly undefined and any settings you make in the callback method are automagically synced back to your image.

    - -

    Use this pragma:

    - -
    -      #pragma omp critical
-
    - -

    to define a section of code in your callback set method that must be executed by a single thread at a time.

    - -

    The format of the SetPixelViewIterator method is:

    - -
    -  MagickBooleanType SetPixelViewIterator(PixelView *destination,
-    SetPixelViewMethod set,void *context)
-
    - -

    A description of each parameter follows:

    - -
    destination
    -

    the pixel view.

    - -
    set
    -

    the set callback method.

    - -
    context
    -

    the user defined context.

    - -
    -

    TransferPixelViewIterator

    -
    - -

    TransferPixelViewIterator() iterates over two pixel views in parallel and calls your transfer method for each scanline of the view. The source pixel region is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. However, the destination pixel view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.

    - -

    Use this pragma:

    - -
    -      #pragma omp critical
-
    - -

    to define a section of code in your callback transfer method that must be executed by a single thread at a time.

    - -

    The format of the TransferPixelViewIterator method is:

    - -
    -  MagickBooleanType TransferPixelViewIterator(PixelView *source,
-    PixelView *destination,TransferPixelViewMethod transfer,void *context)
-
    - -

    A description of each parameter follows:

    - -
    source
    -

    the source pixel view.

    - -
    destination
    -

    the destination pixel view.

    - -
    transfer
    -

    the transfer callback method.

    - -
    context
    -

    the user defined context.

    - -
    -

    UpdatePixelViewIterator

    -
    - -

    UpdatePixelViewIterator() iterates over the pixel view in parallel and calls your update method for each scanline of the view. The pixel region is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted. Updates to pixels in your callback are automagically synced back to the image.

    - -

    Use this pragma:

    - -
    -      #pragma omp critical
-
    - -

    to define a section of code in your callback update method that must be executed by a single thread at a time.

    - -

    The format of the UpdatePixelViewIterator method is:

    - -
    -  MagickBooleanType UpdatePixelViewIterator(PixelView *source,
-    UpdatePixelViewMethod update,void *context)
-
    - -

    A description of each parameter follows:

    - -
    source
    -

    the source pixel view.

    - -
    update
    -

    the update callback method.

    - -
    context
    -

    the user defined context.

    - -
    diff --git a/www/api/magick-image.html b/www/api/magick-image.html index 3c7970e33..839fa61ae 100644 --- a/www/api/magick-image.html +++ b/www/api/magick-image.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,6336 +190,9 @@
    -

    Module magick-image - Methods

    -

    [GetImageFromMagickWand • MagickAdaptiveBlurImage • MagickAdaptiveResizeImage • MagickAdaptiveSharpenImage • MagickAdaptiveThresholdImage • MagickAddImage • MagickAddNoiseImage • MagickAffineTransformImage • MagickAnnotateImage • MagickAnimateImages • MagickAppendImages • MagickAutoGammaImage • MagickAutoLevelImage • MagickBlackThresholdImage • MagickBlueShiftImage • MagickBlurImage • MagickBorderImage • Use MagickBrightnessContrastImage • MagickCharcoalImage • MagickChopImage • MagickClampImage • MagickClipImage • MagickClipImagePath • MagickClutImage • MagickCoalesceImages • MagickColorDecisionListImage • MagickColorizeImage • MagickColorMatrixImage • MagickCombineImages • MagickCommentImage • MagickCompareImageChannels • MagickCompareImageLayers • MagickCompareImages • MagickCompositeImage • MagickContrastImage • MagickContrastStretchImage • MagickConvolveImage • MagickCropImage • MagickCycleColormapImage • MagickConstituteImage • MagickDecipherImage • MagickDeconstructImages • MagickDeskewImage • MagickDespeckleImage • MagickDestroyImage • MagickDisplayImage • MagickDisplayImages • MagickDistortImage • MagickDrawImage • MagickEdgeImage • MagickEmbossImage • MagickEncipherImage • MagickEnhanceImage • MagickEqualizeImage • MagickEvaluateImage • MagickExportImagePixels • MagickExtentImage • MagickFilterImage • MagickFlipImage • MagickFloodfillPaintImage • MagickFlopImage • MagickForwardFourierTransformImage • MagickFrameImage • MagickFunctionImage • MagickFxImage • MagickGammaImage • MagickGaussianBlurImage • MagickGetImage • MagickGetImageAlphaChannel • MagickGetImageClipMask • MagickGetImageBackgroundColor • MagickGetImageBlob • MagickGetImageBlob • MagickGetImageBluePrimary • MagickGetImageBorderColor • MagickGetImageChannelDepth • MagickGetImageChannelDistortion • MagickGetImageChannelDistortions • MagickGetImageChannelFeatures • MagickGetImageChannelKurtosis • MagickGetImageChannelMean • MagickGetImageChannelRange • MagickGetImageChannelStatistics • MagickGetImageColormapColor • MagickGetImageColors • MagickGetImageColorspace • MagickGetImageCompose • MagickGetImageCompression • MagickGetImageCompression • MagickGetImageDelay • MagickGetImageDepth • MagickGetImageDistortion • MagickGetImageDispose • MagickGetImageFilename • MagickGetImageFormat • MagickGetImageFuzz • MagickGetImageGamma • MagickGetImageGravity • MagickGetImageGreenPrimary • MagickGetImageHeight • MagickGetImageHistogram • MagickGetImageInterlaceScheme • MagickGetImageInterpolateMethod • MagickGetImageIterations • MagickGetImageLength • MagickGetImageMatteColor • MagickGetImageOrientation • MagickGetImagePage • MagickGetImagePixelColor • MagickGetImageRedPrimary • MagickGetImageRegion • MagickGetImageRenderingIntent • MagickGetImageResolution • MagickGetImageScene • MagickGetImageSignature • MagickGetImageTicksPerSecond • MagickGetImageType • MagickGetImageUnits • MagickGetImageVirtualPixelMethod • MagickGetImageWhitePoint • MagickGetImageWidth • MagickGetNumberImages • MagickGetImageTotalInkDensity • MagickHaldClutImage • MagickHasNextImage • MagickHasPreviousImage • MagickIdentifyImage • MagickImplodeImage • MagickImportImagePixels • MagickInverseFourierTransformImage • MagickLabelImage • MagickLevelImage • MagickLinearStretchImage • MagickLiquidRescaleImage • MagickMagnifyImage • MagickMedianFilterImage • MagickMergeImageLayers • MagickMinifyImage • MagickModulateImage • MagickMontageImage • MagickMorphImages • MagickMorphologyImage • MagickMotionBlurImage • MagickNegateImage • MagickNewImage • MagickNextImage • MagickNormalizeImage • MagickOilPaintImage • MagickOpaquePaintImage • MagickOptimizeImageLayers • MagickOrderedPosterizeImage • MagickPingImage • MagickPingImageBlob • MagickPingImageFile • MagickPolaroidImage • MagickPosterizeImage • MagickPreviewImages • MagickPreviousImage • MagickQuantizeImage • MagickQuantizeImages • MagickRadialBlurImage • MagickRaiseImage • MagickRandomThresholdImage • MagickReadImage • MagickReadImageBlob • MagickReadImageFile • MagickReduceNoiseImage • MagickRemapImage • MagickRemoveImage • MagickResampleImage • MagickResetImagePage • MagickResizeImage • MagickRollImage • MagickRotateImage • MagickSampleImage • MagickScaleImage • MagickSegmentImage • MagickSelectiveBlurImage • MagickSeparateImageChannel • MagickSepiaToneImage • MagickSetImage • MagickSetImageAlphaChannel • MagickSetImageBackgroundColor • MagickSetImageBias • MagickSetImageBluePrimary • MagickSetImageBorderColor • MagickSetImageChannelDepth • MagickSetImageClipMask • MagickSetImageColor • MagickSetImageColormapColor • MagickSetImageColorspace • MagickSetImageCompose • MagickSetImageCompression • MagickSetImageCompressionQuality • MagickSetImageDelay • MagickSetImageDepth • MagickSetImageDispose • MagickSetImageExtent • MagickSetImageFilename • MagickSetImageFormat • MagickSetImageFuzz • MagickSetImageGamma • MagickSetImageGravity • MagickSetImageGreenPrimary • MagickSetImageInterlaceScheme • MagickSetImageInterpolateMethod • MagickSetImageIterations • MagickSetImageMatte • MagickSetImageMatteColor • MagickSetImageOpacity • MagickSetImageOrientation • MagickSetImagePage • MagickSetImageProgressMonitor • MagickSetImageRedPrimary • MagickSetImageRenderingIntent • MagickSetImageResolution • MagickSetImageScene • MagickSetImageTicksPerSecond • MagickSetImageType • MagickSetImageUnits • MagickSetImageVirtualPixelMethod • MagickSetImageWhitePoint • MagickShadeImage • MagickShadowImage • MagickSharpenImage • MagickShaveImage • MagickShearImage • MagickSigmoidalContrastImage • MagickSimilarityImage • MagickSketchImage • MagickSmushImages • MagickSolarizeImage • MagickSparseColorImage • MagickSpliceImage • MagickSpreadImage • MagickSteganoImage • MagickStereoImage • MagickStripImage • MagickSwirlImage • MagickTextureImage • MagickThresholdImage • MagickThumbnailImage • MagickTintImage • MagickTransformImage • MagickTransformImageColorspace • MagickTransparentPaintImage • MagickTransposeImage • MagickTransverseImage • MagickTrimImage • MagickUniqueImageColors • MagickUnsharpMaskImage • MagickVignetteImage • MagickWaveImage • MagickWhiteThresholdImage • MagickWriteImage • MagickWriteImageFile • MagickWriteImages • MagickWriteImagesFile]

    +

    Module Methods

    +

    []

    -

    GetImageFromMagickWand

    -
    - -

    GetImageFromMagickWand() returns the current image from the magick wand.

    - -

    The format of the GetImageFromMagickWand method is:

    - -
    -  Image *GetImageFromMagickWand(const MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickAdaptiveBlurImage

    -
    - -

    MagickAdaptiveBlurImage() adaptively blurs the image by blurring less intensely near image edges and more intensely far from edges. We blur the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and MagickAdaptiveBlurImage() selects a suitable radius for you.

    - -

    The format of the MagickAdaptiveBlurImage method is:

    - -
    -  MagickBooleanType MagickAdaptiveBlurImage(MagickWand *wand,
-    const double radius,const double sigma)
-  MagickBooleanType MagickAdaptiveBlurImageChannel(MagickWand *wand,
-    const ChannelType channel,const double radius,const double sigma)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    -

    MagickAdaptiveResizeImage

    -
    - -

    MagickAdaptiveResizeImage() adaptively resize image with data dependent triangulation.

    - -

    MagickBooleanType MagickAdaptiveResizeImage(MagickWand *wand, const size_t columns,const size_t rows)

    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    columns
    -

    the number of columns in the scaled image.

    - -
    rows
    -

    the number of rows in the scaled image.

    - -
    -

    MagickAdaptiveSharpenImage

    -
    - -

    MagickAdaptiveSharpenImage() adaptively sharpens the image by sharpening more intensely near image edges and less intensely far from edges. We sharpen the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and MagickAdaptiveSharpenImage() selects a suitable radius for you.

    - -

    The format of the MagickAdaptiveSharpenImage method is:

    - -
    -  MagickBooleanType MagickAdaptiveSharpenImage(MagickWand *wand,
-    const double radius,const double sigma)
-  MagickBooleanType MagickAdaptiveSharpenImageChannel(MagickWand *wand,
-    const ChannelType channel,const double radius,const double sigma)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    -

    MagickAdaptiveThresholdImage

    -
    - -

    MagickAdaptiveThresholdImage() selects an individual threshold for each pixel based on the range of intensity values in its local neighborhood. This allows for thresholding of an image whose global intensity histogram doesn't contain distinctive peaks.

    - -

    The format of the AdaptiveThresholdImage method is:

    - -
    -  MagickBooleanType MagickAdaptiveThresholdImage(MagickWand *wand,
-    const size_t width,const size_t height,const ssize_t offset)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    width
    -

    the width of the local neighborhood.

    - -
    height
    -

    the height of the local neighborhood.

    - -
    offset
    -

    the mean offset.

    - -
    -

    MagickAddImage

    -
    - -

    MagickAddImage() adds the specified images at the current image location.

    - -

    The format of the MagickAddImage method is:

    - -
    -  MagickBooleanType MagickAddImage(MagickWand *wand,
-    const MagickWand *add_wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    add_wand
    -

    A wand that contains images to add at the current image location.

    - -
    -

    MagickAddNoiseImage

    -
    - -

    MagickAddNoiseImage() adds random noise to the image.

    - -

    The format of the MagickAddNoiseImage method is:

    - -
    -  MagickBooleanType MagickAddNoiseImage(MagickWand *wand,
-    const NoiseType noise_type)
-  MagickBooleanType MagickAddNoiseImageChannel(MagickWand *wand,
-    const ChannelType channel,const NoiseType noise_type)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    noise_type
    -

    The type of noise: Uniform, Gaussian, Multiplicative, Impulse, Laplacian, or Poisson.

    - -
    -

    MagickAffineTransformImage

    -
    - -

    MagickAffineTransformImage() transforms an image as dictated by the affine matrix of the drawing wand.

    - -

    The format of the MagickAffineTransformImage method is:

    - -
    -  MagickBooleanType MagickAffineTransformImage(MagickWand *wand,
-    const DrawingWand *drawing_wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    drawing_wand
    -

    the draw wand.

    - -
    -

    MagickAnnotateImage

    -
    - -

    MagickAnnotateImage() annotates an image with text.

    - -

    The format of the MagickAnnotateImage method is:

    - -
    -  MagickBooleanType MagickAnnotateImage(MagickWand *wand,
-    const DrawingWand *drawing_wand,const double x,const double y,
-    const double angle,const char *text)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    drawing_wand
    -

    the draw wand.

    - -
    x
    -

    x ordinate to left of text

    - -
    y
    -

    y ordinate to text baseline

    - -
    angle
    -

    rotate text relative to this angle.

    - -
    text
    -

    text to draw

    - -
    -

    MagickAnimateImages

    -
    - -

    MagickAnimateImages() animates an image or image sequence.

    - -

    The format of the MagickAnimateImages method is:

    - -
    -  MagickBooleanType MagickAnimateImages(MagickWand *wand,
-    const char *server_name)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    server_name
    -

    the X server name.

    - -
    -

    MagickAppendImages

    -
    - -

    MagickAppendImages() append a set of images.

    - -

    The format of the MagickAppendImages method is:

    - -
    -  MagickWand *MagickAppendImages(MagickWand *wand,
-    const MagickBooleanType stack)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    stack
    -

    By default, images are stacked left-to-right. Set stack to MagickTrue to stack them top-to-bottom.

    - -
    -

    MagickAutoGammaImage

    -
    - -

    MagickAutoGammaImage() extracts the 'mean' from the image and adjust the image to try make set its gamma appropriatally.

    - -

    The format of the MagickAutoGammaImage method is:

    - -
    -  MagickBooleanType MagickAutoGammaImage(MagickWand *wand)
-  MagickBooleanType MagickAutoGammaImageChannel(MagickWand *wand,
-    const ChannelType channel)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    -

    MagickAutoLevelImage

    -
    - -

    MagickAutoLevelImage() adjusts the levels of a particular image channel by scaling the minimum and maximum values to the full quantum range.

    - -

    The format of the MagickAutoLevelImage method is:

    - -
    -  MagickBooleanType MagickAutoLevelImage(MagickWand *wand)
-  MagickBooleanType MagickAutoLevelImageChannel(MagickWand *wand,
-    const ChannelType channel)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    -

    MagickBlackThresholdImage

    -
    - -

    MagickBlackThresholdImage() is like MagickThresholdImage() but forces all pixels below the threshold into black while leaving all pixels above the threshold unchanged.

    - -

    The format of the MagickBlackThresholdImage method is:

    - -
    -  MagickBooleanType MagickBlackThresholdImage(MagickWand *wand,
-    const PixelWand *threshold)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    threshold
    -

    the pixel wand.

    - -
    -

    MagickBlueShiftImage

    -
    - -

    MagickBlueShiftImage() mutes the colors of the image to simulate a scene at nighttime in the moonlight.

    - -

    The format of the MagickBlueShiftImage method is:

    - -
    -  MagickBooleanType MagickBlueShiftImage(MagickWand *wand,
-    const double factor)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    factor
    -

    the blue shift factor (default 1.5)

    - -
    -

    MagickBlurImage

    -
    - -

    MagickBlurImage() blurs an image. We convolve the image with a gaussian operator of the given radius and standard deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and BlurImage() selects a suitable radius for you.

    - -

    The format of the MagickBlurImage method is:

    - -
    -  MagickBooleanType MagickBlurImage(MagickWand *wand,const double radius,
-    const double sigma)
-  MagickBooleanType MagickBlurImageChannel(MagickWand *wand,
-    const ChannelType channel,const double radius,const double sigma)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    radius
    -

    the radius of the , in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the , in pixels.

    - -
    -

    MagickBorderImage

    -
    - -

    MagickBorderImage() surrounds the image with a border of the color defined by the bordercolor pixel wand.

    - -

    The format of the MagickBorderImage method is:

    - -
    -  MagickBooleanType MagickBorderImage(MagickWand *wand,
-    const PixelWand *bordercolor,const size_t width,
-    const size_t height)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    bordercolor
    -

    the border color pixel wand.

    - -
    width
    -

    the border width.

    - -
    height
    -

    the border height.

    - -
    -

    Use MagickBrightnessContrastImage

    -
    - -

    Use MagickBrightnessContrastImage() to change the brightness and/or contrast of an image. It converts the brightness and contrast parameters into slope and intercept and calls a polynomical function to apply to the image.

    - - -

    The format of the MagickBrightnessContrastImage method is:

    - -
    -  MagickBooleanType MagickBrightnessContrastImage(MagickWand *wand,
-    const double brightness,const double contrast)
-  MagickBooleanType MagickBrightnessContrastImageChannel(MagickWand *wand,
-    const ChannelType channel,const double brightness,
-    const double contrast)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    brightness
    -

    the brightness percent (-100 .. 100).

    - -
    contrast
    -

    the contrast percent (-100 .. 100).

    - -
    -

    MagickCharcoalImage

    -
    - -

    MagickCharcoalImage() simulates a charcoal drawing.

    - -

    The format of the MagickCharcoalImage method is:

    - -
    -  MagickBooleanType MagickCharcoalImage(MagickWand *wand,
-    const double radius,const double sigma)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    -

    MagickChopImage

    -
    - -

    MagickChopImage() removes a region of an image and collapses the image to occupy the removed portion

    - -

    The format of the MagickChopImage method is:

    - -
    -  MagickBooleanType MagickChopImage(MagickWand *wand,
-    const size_t width,const size_t height,const ssize_t x,
-    const ssize_t y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    width
    -

    the region width.

    - -
    height
    -

    the region height.

    - -
    x
    -

    the region x offset.

    - -
    y
    -

    the region y offset.

    - - -
    -

    MagickClampImage

    -
    - -

    MagickClampImage() restricts the color range from 0 to the quantum depth.

    - -

    The format of the MagickClampImage method is:

    - -
    -  MagickBooleanType MagickClampImage(MagickWand *wand)
-  MagickBooleanType MagickClampImageChannel(MagickWand *wand,
-    const ChannelType channel)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the channel.

    - -
    -

    MagickClipImage

    -
    - -

    MagickClipImage() clips along the first path from the 8BIM profile, if present.

    - -

    The format of the MagickClipImage method is:

    - -
    -  MagickBooleanType MagickClipImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickClipImagePath

    -
    - -

    MagickClipImagePath() clips along the named paths from the 8BIM profile, if present. Later operations take effect inside the path. Id may be a number if preceded with #, to work on a numbered path, e.g., "#1" to use the first path.

    - -

    The format of the MagickClipImagePath method is:

    - -
    -  MagickBooleanType MagickClipImagePath(MagickWand *wand,
-    const char *pathname,const MagickBooleanType inside)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    pathname
    -

    name of clipping path resource. If name is preceded by #, use clipping path numbered by name.

    - -
    inside
    -

    if non-zero, later operations take effect inside clipping path. Otherwise later operations take effect outside clipping path.

    - -
    -

    MagickClutImage

    -
    - -

    MagickClutImage() replaces colors in the image from a color lookup table.

    - -

    The format of the MagickClutImage method is:

    - -
    -  MagickBooleanType MagickClutImage(MagickWand *wand,
-    const MagickWand *clut_wand)
-  MagickBooleanType MagickClutImageChannel(MagickWand *wand,
-    const ChannelType channel,const MagickWand *clut_wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    clut_image
    -

    the clut image.

    - -
    -

    MagickCoalesceImages

    -
    - -

    MagickCoalesceImages() composites a set of images while respecting any page offsets and disposal methods. GIF, MIFF, and MNG animation sequences typically start with an image background and each subsequent image varies in size and offset. MagickCoalesceImages() returns a new sequence where each image in the sequence is the same size as the first and composited with the next image in the sequence.

    - -

    The format of the MagickCoalesceImages method is:

    - -
    -  MagickWand *MagickCoalesceImages(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickColorDecisionListImage

    -
    - -

    MagickColorDecisionListImage() accepts a lightweight Color Correction Collection (CCC) file which solely contains one or more color corrections and applies the color correction to the image. Here is a sample CCC file:

    - -
    -      
-      
-            
-                  0.9 1.2 0.5 
-                  0.4 -0.5 0.6 
-                  1.0 0.8 1.5 
-            
-            
-                  0.85 
-            
-      
-      
-
    - -

    which includes the offset, slope, and power for each of the RGB channels as well as the saturation.

    - -

    The format of the MagickColorDecisionListImage method is:

    - -
    -  MagickBooleanType MagickColorDecisionListImage(MagickWand *wand,
-    const double gamma)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    color_correction_collection
    -

    the color correction collection in XML.

    - -
    -

    MagickColorizeImage

    -
    - -

    MagickColorizeImage() blends the fill color with each pixel in the image.

    - -

    The format of the MagickColorizeImage method is:

    - -
    -  MagickBooleanType MagickColorizeImage(MagickWand *wand,
-    const PixelWand *colorize,const PixelWand *opacity)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    colorize
    -

    the colorize pixel wand.

    - -
    opacity
    -

    the opacity pixel wand.

    - -
    -

    MagickColorMatrixImage

    -
    - -

    MagickColorMatrixImage() apply color transformation to an image. The method permits saturation changes, hue rotation, luminance to alpha, and various other effects. Although variable-sized transformation matrices can be used, typically one uses a 5x5 matrix for an RGBA image and a 6x6 for CMYKA (or RGBA with offsets). The matrix is similar to those used by Adobe Flash except offsets are in column 6 rather than 5 (in support of CMYKA images) and offsets are normalized (divide Flash offset by 255).

    - -

    The format of the MagickColorMatrixImage method is:

    - -
    -  MagickBooleanType MagickColorMatrixImage(MagickWand *wand,
-    const KernelInfo *color_matrix)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    color_matrix
    -

    the color matrix.

    - -
    -

    MagickCombineImages

    -
    - -

    MagickCombineImages() combines one or more images into a single image. The grayscale value of the pixels of each image in the sequence is assigned in order to the specified hannels of the combined image. The typical ordering would be image 1 => Red, 2 => Green, 3 => Blue, etc.

    - -

    The format of the MagickCombineImages method is:

    - -
    -  MagickWand *MagickCombineImages(MagickWand *wand,
-    const ChannelType channel)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the channel.

    - -
    -

    MagickCommentImage

    -
    - -

    MagickCommentImage() adds a comment to your image.

    - -

    The format of the MagickCommentImage method is:

    - -
    -  MagickBooleanType MagickCommentImage(MagickWand *wand,
-    const char *comment)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    comment
    -

    the image comment.

    - -
    -

    MagickCompareImageChannels

    -
    - -

    MagickCompareImageChannels() compares one or more image channels of an image to a reconstructed image and returns the difference image.

    - -

    The format of the MagickCompareImageChannels method is:

    - -
    -  MagickWand *MagickCompareImageChannels(MagickWand *wand,
-    const MagickWand *reference,const ChannelType channel,
-    const MetricType metric,double *distortion)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    reference
    -

    the reference wand.

    - -
    channel
    -

    the channel.

    - -
    metric
    -

    the metric.

    - -
    distortion
    -

    the computed distortion between the images.

    - -
    -

    MagickCompareImageLayers

    -
    - -

    MagickCompareImageLayers() compares each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers.

    - -

    The format of the MagickCompareImageLayers method is:

    - -
    -  MagickWand *MagickCompareImageLayers(MagickWand *wand,
-    const ImageLayerMethod method)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    method
    -

    the compare method.

    - -
    -

    MagickCompareImages

    -
    - -

    MagickCompareImages() compares an image to a reconstructed image and returns the specified difference image.

    - -

    The format of the MagickCompareImages method is:

    - -
    -  MagickWand *MagickCompareImages(MagickWand *wand,
-    const MagickWand *reference,const MetricType metric,
-    double *distortion)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    reference
    -

    the reference wand.

    - -
    metric
    -

    the metric.

    - -
    distortion
    -

    the computed distortion between the images.

    - -
    -

    MagickCompositeImage

    -
    - -

    MagickCompositeImage() composite one image onto another at the specified offset.

    - -

    The format of the MagickCompositeImage method is:

    - -
    -  MagickBooleanType MagickCompositeImage(MagickWand *wand,
-    const MagickWand *composite_wand,const CompositeOperator compose,
-    const ssize_t x,const ssize_t y)
-  MagickBooleanType MagickCompositeImageChannel(MagickWand *wand,
-    const ChannelType channel,const MagickWand *composite_wand,
-    const CompositeOperator compose,const ssize_t x,const ssize_t y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    composite_image
    -

    the composite image.

    - -
    compose
    -

    This operator affects how the composite is applied to the image. The default is Over. Choose from these operators:

    - -
    -    OverCompositeOp       InCompositeOp         OutCompositeOp
-    AtopCompositeOp       XorCompositeOp        PlusCompositeOp
-    MinusCompositeOp      AddCompositeOp        SubtractCompositeOp
-    DifferenceCompositeOp BumpmapCompositeOp    CopyCompositeOp
-    DisplaceCompositeOp
-
    - -
    x
    -

    the column offset of the composited image.

    - -
    y
    -

    the row offset of the composited image.

    - -
    -

    MagickContrastImage

    -
    - -

    MagickContrastImage() enhances the intensity differences between the lighter and darker elements of the image. Set sharpen to a value other than 0 to increase the image contrast otherwise the contrast is reduced.

    - -

    The format of the MagickContrastImage method is:

    - -
    -  MagickBooleanType MagickContrastImage(MagickWand *wand,
-    const MagickBooleanType sharpen)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    sharpen
    -

    Increase or decrease image contrast.

    - - -
    -

    MagickContrastStretchImage

    -
    - -

    MagickContrastStretchImage() enhances the contrast of a color image by adjusting the pixels color to span the entire range of colors available. You can also reduce the influence of a particular channel with a gamma value of 0.

    - -

    The format of the MagickContrastStretchImage method is:

    - -
    -  MagickBooleanType MagickContrastStretchImage(MagickWand *wand,
-    const double black_point,const double white_point)
-  MagickBooleanType MagickContrastStretchImageChannel(MagickWand *wand,
-    const ChannelType channel,const double black_point,
-    const double white_point)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    black_point
    -

    the black point.

    - -
    white_point
    -

    the white point.

    - -
    -

    MagickConvolveImage

    -
    - -

    MagickConvolveImage() applies a custom convolution kernel to the image.

    - -

    The format of the MagickConvolveImage method is:

    - -
    -  MagickBooleanType MagickConvolveImage(MagickWand *wand,
-    const size_t order,const double *kernel)
-  MagickBooleanType MagickConvolveImageChannel(MagickWand *wand,
-    const ChannelType channel,const size_t order,
-    const double *kernel)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    order
    -

    the number of columns and rows in the filter kernel.

    - -
    kernel
    -

    An array of doubles representing the convolution kernel.

    - -
    -

    MagickCropImage

    -
    - -

    MagickCropImage() extracts a region of the image.

    - -

    The format of the MagickCropImage method is:

    - -
    -  MagickBooleanType MagickCropImage(MagickWand *wand,
-    const size_t width,const size_t height,const ssize_t x,const ssize_t y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    width
    -

    the region width.

    - -
    height
    -

    the region height.

    - -
    x
    -

    the region x-offset.

    - -
    y
    -

    the region y-offset.

    - -
    -

    MagickCycleColormapImage

    -
    - -

    MagickCycleColormapImage() displaces an image's colormap by a given number of positions. If you cycle the colormap a number of times you can produce a psychodelic effect.

    - -

    The format of the MagickCycleColormapImage method is:

    - -
    -  MagickBooleanType MagickCycleColormapImage(MagickWand *wand,
-    const ssize_t displace)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    pixel_wand
    -

    the pixel wand.

    - -
    -

    MagickConstituteImage

    -
    - -

    MagickConstituteImage() adds an image to the wand comprised of the pixel data you supply. The pixel data must be in scanline order top-to-bottom. The data can be char, short int, int, float, or double. Float and double require the pixels to be normalized [0..1], otherwise [0..Max], where Max is the maximum value the type can accomodate (e.g. 255 for char). For example, to create a 640x480 image from unsigned red-green-blue character data, use

    - -

    MagickConstituteImage(wand,640,640,"RGB",CharPixel,pixels);

    - -

    The format of the MagickConstituteImage method is:

    - -
    -  MagickBooleanType MagickConstituteImage(MagickWand *wand,
-    const size_t columns,const size_t rows,const char *map,
-    const StorageType storage,void *pixels)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    columns
    -

    width in pixels of the image.

    - -
    rows
    -

    height in pixels of the image.

    - -
    map
    -

    This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.

    - -
    storage
    -

    Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel, LongPixel, QuantumPixel, or ShortPixel.

    - -
    pixels
    -

    This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.

    - - -
    -

    MagickDecipherImage

    -
    - -

    MagickDecipherImage() converts cipher pixels to plain pixels.

    - -

    The format of the MagickDecipherImage method is:

    - -
    -  MagickBooleanType MagickDecipherImage(MagickWand *wand,
-    const char *passphrase)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    passphrase
    -

    the passphrase.

    - -
    -

    MagickDeconstructImages

    -
    - -

    MagickDeconstructImages() compares each image with the next in a sequence and returns the maximum bounding region of any pixel differences it discovers.

    - -

    The format of the MagickDeconstructImages method is:

    - -
    -  MagickWand *MagickDeconstructImages(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickDeskewImage

    -
    - -

    MagickDeskewImage() removes skew from the image. Skew is an artifact that occurs in scanned images because of the camera being misaligned, imperfections in the scanning or surface, or simply because the paper was not placed completely flat when scanned.

    - -

    The format of the MagickDeskewImage method is:

    - -
    -  MagickBooleanType MagickDeskewImage(MagickWand *wand,
-    const double threshold)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    threshold
    -

    separate background from foreground.

    - -
    -

    MagickDespeckleImage

    -
    - -

    MagickDespeckleImage() reduces the speckle noise in an image while perserving the edges of the original image.

    - -

    The format of the MagickDespeckleImage method is:

    - -
    -  MagickBooleanType MagickDespeckleImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickDestroyImage

    -
    - -

    MagickDestroyImage() dereferences an image, deallocating memory associated with the image if the reference count becomes zero.

    - -

    The format of the MagickDestroyImage method is:

    - -
    -  Image *MagickDestroyImage(Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    MagickDisplayImage

    -
    - -

    MagickDisplayImage() displays an image.

    - -

    The format of the MagickDisplayImage method is:

    - -
    -  MagickBooleanType MagickDisplayImage(MagickWand *wand,
-    const char *server_name)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    server_name
    -

    the X server name.

    - -
    -

    MagickDisplayImages

    -
    - -

    MagickDisplayImages() displays an image or image sequence.

    - -

    The format of the MagickDisplayImages method is:

    - -
    -  MagickBooleanType MagickDisplayImages(MagickWand *wand,
-    const char *server_name)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    server_name
    -

    the X server name.

    - -
    -

    MagickDistortImage

    -
    - -

    MagickDistortImage() distorts an image using various distortion methods, by mapping color lookups of the source image to a new destination image usally of the same size as the source image, unless 'bestfit' is set to true.

    - -

    If 'bestfit' is enabled, and distortion allows it, the destination image is adjusted to ensure the whole source 'image' will just fit within the final destination image, which will be sized and offset accordingly. Also in many cases the virtual offset of the source image will be taken into account in the mapping.

    - -

    The format of the MagickDistortImage method is:

    - -
    -  MagickBooleanType MagickDistortImage(MagickWand *wand,
-    const DistortImageMethod method,const size_t number_arguments,
-    const double *arguments,const MagickBooleanType bestfit)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image to be distorted.

    - -
    method
    -

    the method of image distortion.

    - -

    ArcDistortion always ignores the source image offset, and always 'bestfit' the destination image with the top left corner offset relative to the polar mapping center.

    - -

    Bilinear has no simple inverse mapping so it does not allow 'bestfit' style of image distortion.

    - -

    Affine, Perspective, and Bilinear, do least squares fitting of the distortion when more than the minimum number of control point pairs are provided.

    - -

    Perspective, and Bilinear, falls back to a Affine distortion when less that 4 control point pairs are provided. While Affine distortions let you use any number of control point pairs, that is Zero pairs is a no-Op (viewport only) distrotion, one pair is a translation and two pairs of control points do a scale-rotate-translate, without any shearing.

    - -
    number_arguments
    -

    the number of arguments given for this distortion method.

    - -
    arguments
    -

    the arguments for this distortion method.

    - -
    bestfit
    -

    Attempt to resize destination to fit distorted source.

    - -
    -

    MagickDrawImage

    -
    - -

    MagickDrawImage() renders the drawing wand on the current image.

    - -

    The format of the MagickDrawImage method is:

    - -
    -  MagickBooleanType MagickDrawImage(MagickWand *wand,
-    const DrawingWand *drawing_wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    drawing_wand
    -

    the draw wand.

    - -
    -

    MagickEdgeImage

    -
    - -

    MagickEdgeImage() enhance edges within the image with a convolution filter of the given radius. Use a radius of 0 and Edge() selects a suitable radius for you.

    - -

    The format of the MagickEdgeImage method is:

    - -
    -  MagickBooleanType MagickEdgeImage(MagickWand *wand,const double radius)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    radius
    -

    the radius of the pixel neighborhood.

    - -
    -

    MagickEmbossImage

    -
    - -

    MagickEmbossImage() returns a grayscale image with a three-dimensional effect. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and Emboss() selects a suitable radius for you.

    - -

    The format of the MagickEmbossImage method is:

    - -
    -  MagickBooleanType MagickEmbossImage(MagickWand *wand,const double radius,
-    const double sigma)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    -

    MagickEncipherImage

    -
    - -

    MagickEncipherImage() converts plaint pixels to cipher pixels.

    - -

    The format of the MagickEncipherImage method is:

    - -
    -  MagickBooleanType MagickEncipherImage(MagickWand *wand,
-    const char *passphrase)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    passphrase
    -

    the passphrase.

    - -
    -

    MagickEnhanceImage

    -
    - -

    MagickEnhanceImage() applies a digital filter that improves the quality of a noisy image.

    - -

    The format of the MagickEnhanceImage method is:

    - -
    -  MagickBooleanType MagickEnhanceImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickEqualizeImage

    -
    - -

    MagickEqualizeImage() equalizes the image histogram.

    - -

    The format of the MagickEqualizeImage method is:

    - -
    -  MagickBooleanType MagickEqualizeImage(MagickWand *wand)
-  MagickBooleanType MagickEqualizeImageChannel(MagickWand *wand,
-    const ChannelType channel)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    -

    MagickEvaluateImage

    -
    - -

    MagickEvaluateImage() applys an arithmetic, relational, or logical expression to an image. Use these operators to lighten or darken an image, to increase or decrease contrast in an image, or to produce the "negative" of an image.

    - -

    The format of the MagickEvaluateImage method is:

    - -
    -  MagickBooleanType MagickEvaluateImage(MagickWand *wand,
-    const MagickEvaluateOperator operator,const double value)
-  MagickBooleanType MagickEvaluateImages(MagickWand *wand,
-    const MagickEvaluateOperator operator)
-  MagickBooleanType MagickEvaluateImageChannel(MagickWand *wand,
-    const ChannelType channel,const MagickEvaluateOperator op,
-    const double value)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the channel(s).

    - -
    op
    -

    A channel operator.

    - -
    value
    -

    A value value.

    - -
    -

    MagickExportImagePixels

    -
    - -

    MagickExportImagePixels() extracts pixel data from an image and returns it to you. The method returns MagickTrue on success otherwise MagickFalse if an error is encountered. The data is returned as char, short int, int, ssize_t, float, or double in the order specified by map.

    - -

    Suppose you want to extract the first scanline of a 640x480 image as character data in red-green-blue order:

    - -
    -  MagickExportImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
-
    - -

    The format of the MagickExportImagePixels method is:

    - -
    -  MagickBooleanType MagickExportImagePixels(MagickWand *wand,
-    const ssize_t x,const ssize_t y,const size_t columns,
-    const size_t rows,const char *map,const StorageType storage,
-    void *pixels)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x, y, columns, rows
    -

    These values define the perimeter of a region of pixels you want to extract.

    - -
    map
    -

    This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.

    - -
    storage
    -

    Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, DoublePixel, FloatPixel, IntegerPixel, LongPixel, QuantumPixel, or ShortPixel.

    - -
    pixels
    -

    This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.

    - -
    -

    MagickExtentImage

    -
    - -

    MagickExtentImage() extends the image as defined by the geometry, gravity, and wand background color. Set the (x,y) offset of the geometry to move the original wand relative to the extended wand.

    - -

    The format of the MagickExtentImage method is:

    - -
    -  MagickBooleanType MagickExtentImage(MagickWand *wand,
-    const size_t width,const size_t height,const ssize_t x,
-    const ssize_t y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    width
    -

    the region width.

    - -
    height
    -

    the region height.

    - -
    x
    -

    the region x offset.

    - -
    y
    -

    the region y offset.

    - -
    -

    MagickFilterImage

    -
    - -

    MagickFilterImage() applies a custom convolution kernel to the image.

    - -

    The format of the MagickFilterImage method is:

    - -
    -  MagickBooleanType MagickFilterImage(MagickWand *wand,
-    const KernelInfo *kernel)
-  MagickBooleanType MagickFilterImageChannel(MagickWand *wand,
-    const ChannelType channel,const KernelInfo *kernel)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    kernel
    -

    An array of doubles representing the convolution kernel.

    - -
    -

    MagickFlipImage

    -
    - -

    MagickFlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.

    - -

    The format of the MagickFlipImage method is:

    - -
    -  MagickBooleanType MagickFlipImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickFloodfillPaintImage

    -
    - -

    MagickFloodfillPaintImage() changes the color value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image.

    - -

    The format of the MagickFloodfillPaintImage method is:

    - -
    -  MagickBooleanType MagickFloodfillPaintImage(MagickWand *wand,
-    const ChannelType channel,const PixelWand *fill,const double fuzz,
-    const PixelWand *bordercolor,const ssize_t x,const ssize_t y,
-    const MagickBooleanType invert)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the channel(s).

    - -
    fill
    -

    the floodfill color pixel wand.

    - -
    fuzz
    -

    By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.

    - -
    bordercolor
    -

    the border color pixel wand.

    - -
    x,y
    -

    the starting location of the operation.

    - -
    invert
    -

    paint any pixel that does not match the target color.

    - -
    -

    MagickFlopImage

    -
    - -

    MagickFlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.

    - -

    The format of the MagickFlopImage method is:

    - -
    -  MagickBooleanType MagickFlopImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickForwardFourierTransformImage

    -
    - -

    MagickForwardFourierTransformImage() implements the discrete Fourier transform (DFT) of the image either as a magnitude / phase or real / imaginary image pair.

    - -

    The format of the MagickForwardFourierTransformImage method is:

    - -
    -  MagickBooleanType MagickForwardFourierTransformImage(MagickWand *wand,
-    const MagickBooleanType magnitude)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    magnitude
    -

    if true, return as magnitude / phase pair otherwise a real / imaginary image pair.

    - -
    -

    MagickFrameImage

    -
    - -

    MagickFrameImage() adds a simulated three-dimensional border around the image. The width and height specify the border width of the vertical and horizontal sides of the frame. The inner and outer bevels indicate the width of the inner and outer shadows of the frame.

    - -

    The format of the MagickFrameImage method is:

    - -
    -  MagickBooleanType MagickFrameImage(MagickWand *wand,
-    const PixelWand *matte_color,const size_t width,
-    const size_t height,const ssize_t inner_bevel,
-    const ssize_t outer_bevel)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    matte_color
    -

    the frame color pixel wand.

    - -
    width
    -

    the border width.

    - -
    height
    -

    the border height.

    - -
    inner_bevel
    -

    the inner bevel width.

    - -
    outer_bevel
    -

    the outer bevel width.

    - -
    -

    MagickFunctionImage

    -
    - -

    MagickFunctionImage() applys an arithmetic, relational, or logical expression to an image. Use these operators to lighten or darken an image, to increase or decrease contrast in an image, or to produce the "negative" of an image.

    - -

    The format of the MagickFunctionImage method is:

    - -
    -  MagickBooleanType MagickFunctionImage(MagickWand *wand,
-    const MagickFunction function,const size_t number_arguments,
-    const double *arguments)
-  MagickBooleanType MagickFunctionImageChannel(MagickWand *wand,
-    const ChannelType channel,const MagickFunction function,
-    const size_t number_arguments,const double *arguments)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the channel(s).

    - -
    function
    -

    the image function.

    - -
    number_arguments
    -

    the number of function arguments.

    - -
    arguments
    -

    the function arguments.

    - -
    -

    MagickFxImage

    -
    - -

    MagickFxImage() evaluate expression for each pixel in the image.

    - -

    The format of the MagickFxImage method is:

    - -
    -  MagickWand *MagickFxImage(MagickWand *wand,const char *expression)
-  MagickWand *MagickFxImageChannel(MagickWand *wand,
-    const ChannelType channel,const char *expression)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    expression
    -

    the expression.

    - -
    -

    MagickGammaImage

    -
    - -

    MagickGammaImage() gamma-corrects an image. The same image viewed on different devices will have perceptual differences in the way the image's intensities are represented on the screen. Specify individual gamma levels for the red, green, and blue channels, or adjust all three with the gamma parameter. Values typically range from 0.8 to 2.3.

    - -

    You can also reduce the influence of a particular channel with a gamma value of 0.

    - -

    The format of the MagickGammaImage method is:

    - -
    -  MagickBooleanType MagickGammaImage(MagickWand *wand,const double gamma)
-  MagickBooleanType MagickGammaImageChannel(MagickWand *wand,
-    const ChannelType channel,const double gamma)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the channel.

    - -
    level
    -

    Define the level of gamma correction.

    - -
    -

    MagickGaussianBlurImage

    -
    - -

    MagickGaussianBlurImage() blurs an image. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and MagickGaussianBlurImage() selects a suitable radius for you.

    - -

    The format of the MagickGaussianBlurImage method is:

    - -
    -  MagickBooleanType MagickGaussianBlurImage(MagickWand *wand,
-    const double radius,const double sigma)
-  MagickBooleanType MagickGaussianBlurImageChannel(MagickWand *wand,
-    const ChannelType channel,const double radius,const double sigma)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    -

    MagickGetImage

    -
    - -

    MagickGetImage() gets the image at the current image index.

    - -

    The format of the MagickGetImage method is:

    - -
    -  MagickWand *MagickGetImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageAlphaChannel

    -
    - -

    MagickGetImageAlphaChannel() returns MagickFalse if the image alpha channel is not activated. That is, the image is RGB rather than RGBA or CMYK rather than CMYKA.

    - -

    The format of the MagickGetImageAlphaChannel method is:

    - -
    -  size_t MagickGetImageAlphaChannel(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageClipMask

    -
    - -

    MagickGetImageClipMask() gets the image clip mask at the current image index.

    - -

    The format of the MagickGetImageClipMask method is:

    - -
    -  MagickWand *MagickGetImageClipMask(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageBackgroundColor

    -
    - -

    MagickGetImageBackgroundColor() returns the image background color.

    - -

    The format of the MagickGetImageBackgroundColor method is:

    - -
    -  MagickBooleanType MagickGetImageBackgroundColor(MagickWand *wand,
-    PixelWand *background_color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    background_color
    -

    Return the background color.

    - -
    -

    MagickGetImageBlob

    -
    - -

    MagickGetImageBlob() implements direct to memory image formats. It returns the image as a blob and its length. Use MagickSetFormat() to set the format of the returned blob (GIF, JPEG, PNG, etc.).

    - -

    Use MagickRelinquishMemory() to free the blob when you are done with it.

    - -

    The format of the MagickGetImageBlob method is:

    - -
    -  unsigned char *MagickGetImageBlob(MagickWand *wand,size_t *length)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    length
    -

    the length of the blob.

    - -
    -

    MagickGetImageBlob

    -
    - -

    MagickGetImageBlob() implements direct to memory image formats. It returns the image sequence as a blob and its length. The format of the image determines the format of the returned blob (GIF, JPEG, PNG, etc.). To return a different image format, use MagickSetImageFormat().

    - -

    Note, some image formats do not permit multiple images to the same image stream (e.g. JPEG). in this instance, just the first image of the sequence is returned as a blob.

    - -

    The format of the MagickGetImagesBlob method is:

    - -
    -  unsigned char *MagickGetImagesBlob(MagickWand *wand,size_t *length)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    length
    -

    the length of the blob.

    - -
    -

    MagickGetImageBluePrimary

    -
    - -

    MagickGetImageBluePrimary() returns the chromaticy blue primary point for the image.

    - -

    The format of the MagickGetImageBluePrimary method is:

    - -
    -  MagickBooleanType MagickGetImageBluePrimary(MagickWand *wand,double *x,
-    double *y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x
    -

    the chromaticity blue primary x-point.

    - -
    y
    -

    the chromaticity blue primary y-point.

    - -
    -

    MagickGetImageBorderColor

    -
    - -

    MagickGetImageBorderColor() returns the image border color.

    - -

    The format of the MagickGetImageBorderColor method is:

    - -
    -  MagickBooleanType MagickGetImageBorderColor(MagickWand *wand,
-    PixelWand *border_color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    border_color
    -

    Return the border color.

    - -
    -

    MagickGetImageChannelDepth

    -
    - -

    MagickGetImageChannelDepth() gets the depth for one or more image channels.

    - -

    The format of the MagickGetImageChannelDepth method is:

    - -
    -  size_t MagickGetImageChannelDepth(MagickWand *wand,
-    const ChannelType channel)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    -

    MagickGetImageChannelDistortion

    -
    - -

    MagickGetImageChannelDistortion() compares one or more image channels of an image to a reconstructed image and returns the specified distortion metric.

    - -

    The format of the MagickGetImageChannelDistortion method is:

    - -
    -  MagickBooleanType MagickGetImageChannelDistortion(MagickWand *wand,
-    const MagickWand *reference,const ChannelType channel,
-    const MetricType metric,double *distortion)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    reference
    -

    the reference wand.

    - -
    channel
    -

    the channel.

    - -
    metric
    -

    the metric.

    - -
    distortion
    -

    the computed distortion between the images.

    - -
    -

    MagickGetImageChannelDistortions

    -
    - -

    MagickGetImageChannelDistortions() compares one or more image channels of an image to a reconstructed image and returns the specified distortion metrics.

    - -

    Use MagickRelinquishMemory() to free the metrics when you are done with them.

    - -

    The format of the MagickGetImageChannelDistortion method is:

    - -
    -  double *MagickGetImageChannelDistortion(MagickWand *wand,
-    const MagickWand *reference,const MetricType metric)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    reference
    -

    the reference wand.

    - -
    metric
    -

    the metric.

    - -
    -

    MagickGetImageChannelFeatures

    -
    - -

    MagickGetImageChannelFeatures() returns features for each channel in the image in each of four directions (horizontal, vertical, left and right diagonals) for the specified distance. The features include the angular second moment, contrast, correlation, sum of squares: variance, inverse difference moment, sum average, sum varience, sum entropy, entropy, difference variance, difference entropy, information measures of correlation 1, information measures of correlation 2, and maximum correlation coefficient. You can access the red channel contrast, for example, like this:

    - -
    -  channel_features=MagickGetImageChannelFeatures(wand,1);
-  contrast=channel_features[RedChannel].contrast[0];
-
    - -

    Use MagickRelinquishMemory() to free the statistics buffer.

    - -

    The format of the MagickGetImageChannelFeatures method is:

    - -
    -  ChannelFeatures *MagickGetImageChannelFeatures(MagickWand *wand,
-    const size_t distance)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    distance
    -

    the distance.

    - -
    -

    MagickGetImageChannelKurtosis

    -
    - -

    MagickGetImageChannelKurtosis() gets the kurtosis and skewness of one or more image channels.

    - -

    The format of the MagickGetImageChannelKurtosis method is:

    - -
    -  MagickBooleanType MagickGetImageChannelKurtosis(MagickWand *wand,
-    const ChannelType channel,double *kurtosis,double *skewness)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    kurtosis
    -

    The kurtosis for the specified channel(s).

    - -
    skewness
    -

    The skewness for the specified channel(s).

    - -
    -

    MagickGetImageChannelMean

    -
    - -

    MagickGetImageChannelMean() gets the mean and standard deviation of one or more image channels.

    - -

    The format of the MagickGetImageChannelMean method is:

    - -
    -  MagickBooleanType MagickGetImageChannelMean(MagickWand *wand,
-    const ChannelType channel,double *mean,double *standard_deviation)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    mean
    -

    The mean pixel value for the specified channel(s).

    - -
    standard_deviation
    -

    The standard deviation for the specified channel(s).

    - -
    -

    MagickGetImageChannelRange

    -
    - -

    MagickGetImageChannelRange() gets the range for one or more image channels.

    - -

    The format of the MagickGetImageChannelRange method is:

    - -
    -  MagickBooleanType MagickGetImageChannelRange(MagickWand *wand,
-    const ChannelType channel,double *minima,double *maxima)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    minima
    -

    The minimum pixel value for the specified channel(s).

    - -
    maxima
    -

    The maximum pixel value for the specified channel(s).

    - -
    -

    MagickGetImageChannelStatistics

    -
    - -

    MagickGetImageChannelStatistics() returns statistics for each channel in the image. The statistics include the channel depth, its minima and maxima, the mean, the standard deviation, the kurtosis and the skewness. You can access the red channel mean, for example, like this:

    - -
    -  channel_statistics=MagickGetImageChannelStatistics(wand);
-  red_mean=channel_statistics[RedChannel].mean;
-
    - -

    Use MagickRelinquishMemory() to free the statistics buffer.

    - -

    The format of the MagickGetImageChannelStatistics method is:

    - -
    -  ChannelStatistics *MagickGetImageChannelStatistics(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageColormapColor

    -
    - -

    MagickGetImageColormapColor() returns the color of the specified colormap index.

    - -

    The format of the MagickGetImageColormapColor method is:

    - -
    -  MagickBooleanType MagickGetImageColormapColor(MagickWand *wand,
-    const size_t index,PixelWand *color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    index
    -

    the offset into the image colormap.

    - -
    color
    -

    Return the colormap color in this wand.

    - -
    -

    MagickGetImageColors

    -
    - -

    MagickGetImageColors() gets the number of unique colors in the image.

    - -

    The format of the MagickGetImageColors method is:

    - -
    -  size_t MagickGetImageColors(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageColorspace

    -
    - -

    MagickGetImageColorspace() gets the image colorspace.

    - -

    The format of the MagickGetImageColorspace method is:

    - -
    -  ColorspaceType MagickGetImageColorspace(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageCompose

    -
    - -

    MagickGetImageCompose() returns the composite operator associated with the image.

    - -

    The format of the MagickGetImageCompose method is:

    - -
    -  CompositeOperator MagickGetImageCompose(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageCompression

    -
    - -

    MagickGetImageCompression() gets the image compression.

    - -

    The format of the MagickGetImageCompression method is:

    - -
    -  CompressionType MagickGetImageCompression(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageCompression

    -
    - -

    MagickGetImageCompression() gets the image compression quality.

    - -

    The format of the MagickGetImageCompression method is:

    - -
    -  size_t MagickGetImageCompression(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageDelay

    -
    - -

    MagickGetImageDelay() gets the image delay.

    - -

    The format of the MagickGetImageDelay method is:

    - -
    -  size_t MagickGetImageDelay(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageDepth

    -
    - -

    MagickGetImageDepth() gets the image depth.

    - -

    The format of the MagickGetImageDepth method is:

    - -
    -  size_t MagickGetImageDepth(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageDistortion

    -
    - -

    MagickGetImageDistortion() compares an image to a reconstructed image and returns the specified distortion metric.

    - -

    The format of the MagickGetImageDistortion method is:

    - -
    -  MagickBooleanType MagickGetImageDistortion(MagickWand *wand,
-    const MagickWand *reference,const MetricType metric,
-    double *distortion)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    reference
    -

    the reference wand.

    - -
    metric
    -

    the metric.

    - -
    distortion
    -

    the computed distortion between the images.

    - -
    -

    MagickGetImageDispose

    -
    - -

    MagickGetImageDispose() gets the image disposal method.

    - -

    The format of the MagickGetImageDispose method is:

    - -
    -  DisposeType MagickGetImageDispose(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageFilename

    -
    - -

    MagickGetImageFilename() returns the filename of a particular image in a sequence.

    - -

    The format of the MagickGetImageFilename method is:

    - -
    -  char *MagickGetImageFilename(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageFormat

    -
    - -

    MagickGetImageFormat() returns the format of a particular image in a sequence.

    - -

    The format of the MagickGetImageFormat method is:

    - -
    -  const char *MagickGetImageFormat(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageFuzz

    -
    - -

    MagickGetImageFuzz() gets the image fuzz.

    - -

    The format of the MagickGetImageFuzz method is:

    - -
    -  double MagickGetImageFuzz(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageGamma

    -
    - -

    MagickGetImageGamma() gets the image gamma.

    - -

    The format of the MagickGetImageGamma method is:

    - -
    -  double MagickGetImageGamma(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageGravity

    -
    - -

    MagickGetImageGravity() gets the image gravity.

    - -

    The format of the MagickGetImageGravity method is:

    - -
    -  GravityType MagickGetImageGravity(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageGreenPrimary

    -
    - -

    MagickGetImageGreenPrimary() returns the chromaticy green primary point.

    - -

    The format of the MagickGetImageGreenPrimary method is:

    - -
    -  MagickBooleanType MagickGetImageGreenPrimary(MagickWand *wand,double *x,
-    double *y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x
    -

    the chromaticity green primary x-point.

    - -
    y
    -

    the chromaticity green primary y-point.

    - -
    -

    MagickGetImageHeight

    -
    - -

    MagickGetImageHeight() returns the image height.

    - -

    The format of the MagickGetImageHeight method is:

    - -
    -  size_t MagickGetImageHeight(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageHistogram

    -
    - -

    MagickGetImageHistogram() returns the image histogram as an array of PixelWand wands.

    - -

    The format of the MagickGetImageHistogram method is:

    - -
    -  PixelWand **MagickGetImageHistogram(MagickWand *wand,
-    size_t *number_colors)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    number_colors
    -

    the number of unique colors in the image and the number of pixel wands returned.

    - -
    -

    MagickGetImageInterlaceScheme

    -
    - -

    MagickGetImageInterlaceScheme() gets the image interlace scheme.

    - -

    The format of the MagickGetImageInterlaceScheme method is:

    - -
    -  InterlaceType MagickGetImageInterlaceScheme(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageInterpolateMethod

    -
    - -

    MagickGetImageInterpolateMethod() returns the interpolation method for the sepcified image.

    - -

    The format of the MagickGetImageInterpolateMethod method is:

    - -
    -  InterpolatePixelMethod MagickGetImageInterpolateMethod(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageIterations

    -
    - -

    MagickGetImageIterations() gets the image iterations.

    - -

    The format of the MagickGetImageIterations method is:

    - -
    -  size_t MagickGetImageIterations(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageLength

    -
    - -

    MagickGetImageLength() returns the image length in bytes.

    - -

    The format of the MagickGetImageLength method is:

    - -
    -  MagickBooleanType MagickGetImageLength(MagickWand *wand,
-    MagickSizeType *length)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    length
    -

    the image length in bytes.

    - -
    -

    MagickGetImageMatteColor

    -
    - -

    MagickGetImageMatteColor() returns the image matte color.

    - -

    The format of the MagickGetImageMatteColor method is:

    - -
    -  MagickBooleanType MagickGetImagematteColor(MagickWand *wand,
-    PixelWand *matte_color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    matte_color
    -

    Return the matte color.

    - -
    -

    MagickGetImageOrientation

    -
    - -

    MagickGetImageOrientation() returns the image orientation.

    - -

    The format of the MagickGetImageOrientation method is:

    - -
    -  OrientationType MagickGetImageOrientation(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImagePage

    -
    - -

    MagickGetImagePage() returns the page geometry associated with the image.

    - -

    The format of the MagickGetImagePage method is:

    - -
    -  MagickBooleanType MagickGetImagePage(MagickWand *wand,
-    size_t *width,size_t *height,ssize_t *x,ssize_t *y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    width
    -

    the page width.

    - -
    height
    -

    the page height.

    - -
    x
    -

    the page x-offset.

    - -
    y
    -

    the page y-offset.

    - -
    -

    MagickGetImagePixelColor

    -
    - -

    MagickGetImagePixelColor() returns the color of the specified pixel.

    - -

    The format of the MagickGetImagePixelColor method is:

    - -
    -  MagickBooleanType MagickGetImagePixelColor(MagickWand *wand,
-    const ssize_t x,const ssize_t y,PixelWand *color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x,y
    -

    the pixel offset into the image.

    - -
    color
    -

    Return the colormap color in this wand.

    - -
    -

    MagickGetImageRedPrimary

    -
    - -

    MagickGetImageRedPrimary() returns the chromaticy red primary point.

    - -

    The format of the MagickGetImageRedPrimary method is:

    - -
    -  MagickBooleanType MagickGetImageRedPrimary(MagickWand *wand,double *x,
-    double *y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x
    -

    the chromaticity red primary x-point.

    - -
    y
    -

    the chromaticity red primary y-point.

    - -
    -

    MagickGetImageRegion

    -
    - -

    MagickGetImageRegion() extracts a region of the image and returns it as a a new wand.

    - -

    The format of the MagickGetImageRegion method is:

    - -
    -  MagickWand *MagickGetImageRegion(MagickWand *wand,
-    const size_t width,const size_t height,const ssize_t x,
-    const ssize_t y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    width
    -

    the region width.

    - -
    height
    -

    the region height.

    - -
    x
    -

    the region x offset.

    - -
    y
    -

    the region y offset.

    - -
    -

    MagickGetImageRenderingIntent

    -
    - -

    MagickGetImageRenderingIntent() gets the image rendering intent.

    - -

    The format of the MagickGetImageRenderingIntent method is:

    - -
    -  RenderingIntent MagickGetImageRenderingIntent(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageResolution

    -
    - -

    MagickGetImageResolution() gets the image X and Y resolution.

    - -

    The format of the MagickGetImageResolution method is:

    - -
    -  MagickBooleanType MagickGetImageResolution(MagickWand *wand,double *x,
-    double *y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x
    -

    the image x-resolution.

    - -
    y
    -

    the image y-resolution.

    - -
    -

    MagickGetImageScene

    -
    - -

    MagickGetImageScene() gets the image scene.

    - -

    The format of the MagickGetImageScene method is:

    - -
    -  size_t MagickGetImageScene(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageSignature

    -
    - -

    MagickGetImageSignature() generates an SHA-256 message digest for the image pixel stream.

    - -

    The format of the MagickGetImageSignature method is:

    - -
    -  const char MagickGetImageSignature(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageTicksPerSecond

    -
    - -

    MagickGetImageTicksPerSecond() gets the image ticks-per-second.

    - -

    The format of the MagickGetImageTicksPerSecond method is:

    - -
    -  size_t MagickGetImageTicksPerSecond(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageType

    -
    - -

    MagickGetImageType() gets the potential image type:

    - -

    Bilevel Grayscale GrayscaleMatte Palette PaletteMatte TrueColor TrueColorMatte ColorSeparation ColorSeparationMatte

    - -

    To ensure the image type matches its potential, use MagickSetImageType():

    - -
    -      (void) MagickSetImageType(wand,MagickGetImageType(wand));
-
    - -

    The format of the MagickGetImageType method is:

    - -
    -  ImageType MagickGetImageType(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageUnits

    -
    - -

    MagickGetImageUnits() gets the image units of resolution.

    - -

    The format of the MagickGetImageUnits method is:

    - -
    -  ResolutionType MagickGetImageUnits(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageVirtualPixelMethod

    -
    - -

    MagickGetImageVirtualPixelMethod() returns the virtual pixel method for the sepcified image.

    - -

    The format of the MagickGetImageVirtualPixelMethod method is:

    - -
    -  VirtualPixelMethod MagickGetImageVirtualPixelMethod(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageWhitePoint

    -
    - -

    MagickGetImageWhitePoint() returns the chromaticy white point.

    - -

    The format of the MagickGetImageWhitePoint method is:

    - -
    -  MagickBooleanType MagickGetImageWhitePoint(MagickWand *wand,double *x,
-    double *y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x
    -

    the chromaticity white x-point.

    - -
    y
    -

    the chromaticity white y-point.

    - -
    -

    MagickGetImageWidth

    -
    - -

    MagickGetImageWidth() returns the image width.

    - -

    The format of the MagickGetImageWidth method is:

    - -
    -  size_t MagickGetImageWidth(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetNumberImages

    -
    - -

    MagickGetNumberImages() returns the number of images associated with a magick wand.

    - -

    The format of the MagickGetNumberImages method is:

    - -
    -  size_t MagickGetNumberImages(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetImageTotalInkDensity

    -
    - -

    MagickGetImageTotalInkDensity() gets the image total ink density.

    - -

    The format of the MagickGetImageTotalInkDensity method is:

    - -
    -  double MagickGetImageTotalInkDensity(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickHaldClutImage

    -
    - -

    MagickHaldClutImage() replaces colors in the image from a Hald color lookup table. A Hald color lookup table is a 3-dimensional color cube mapped to 2 dimensions. Create it with the HALD coder. You can apply any color transformation to the Hald image and then use this method to apply the transform to the image.

    - -

    The format of the MagickHaldClutImage method is:

    - -
    -  MagickBooleanType MagickHaldClutImage(MagickWand *wand,
-    const MagickWand *hald_wand)
-  MagickBooleanType MagickHaldClutImageChannel(MagickWand *wand,
-    const ChannelType channel,const MagickWand *hald_wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    hald_image
    -

    the hald CLUT image.

    - -
    -

    MagickHasNextImage

    -
    - -

    MagickHasNextImage() returns MagickTrue if the wand has more images when traversing the list in the forward direction

    - -

    The format of the MagickHasNextImage method is:

    - -
    -  MagickBooleanType MagickHasNextImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickHasPreviousImage

    -
    - -

    MagickHasPreviousImage() returns MagickTrue if the wand has more images when traversing the list in the reverse direction

    - -

    The format of the MagickHasPreviousImage method is:

    - -
    -  MagickBooleanType MagickHasPreviousImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickIdentifyImage

    -
    - -

    MagickIdentifyImage() identifies an image by printing its attributes to the file. Attributes include the image width, height, size, and others.

    - -

    The format of the MagickIdentifyImage method is:

    - -
    -  const char *MagickIdentifyImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickImplodeImage

    -
    - -

    MagickImplodeImage() creates a new image that is a copy of an existing one with the image pixels "implode" by the specified percentage. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

    - -

    The format of the MagickImplodeImage method is:

    - -
    -  MagickBooleanType MagickImplodeImage(MagickWand *wand,
-    const double radius)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    amount
    -

    Define the extent of the implosion.

    - -
    -

    MagickImportImagePixels

    -
    - -

    MagickImportImagePixels() accepts pixel datand stores it in the image at the location you specify. The method returns MagickFalse on success otherwise MagickTrue if an error is encountered. The pixel data can be either char, short int, int, ssize_t, float, or double in the order specified by map.

    - -

    Suppose your want to upload the first scanline of a 640x480 image from character data in red-green-blue order:

    - -
    -  MagickImportImagePixels(wand,0,0,640,1,"RGB",CharPixel,pixels);
-
    - -

    The format of the MagickImportImagePixels method is:

    - -
    -  MagickBooleanType MagickImportImagePixels(MagickWand *wand,
-    const ssize_t x,const ssize_t y,const size_t columns,
-    const size_t rows,const char *map,const StorageType storage,
-    const void *pixels)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x, y, columns, rows
    -

    These values define the perimeter of a region of pixels you want to define.

    - -
    map
    -

    This string reflects the expected ordering of the pixel array. It can be any combination or order of R = red, G = green, B = blue, A = alpha (0 is transparent), O = opacity (0 is opaque), C = cyan, Y = yellow, M = magenta, K = black, I = intensity (for grayscale), P = pad.

    - -
    storage
    -

    Define the data type of the pixels. Float and double types are expected to be normalized [0..1] otherwise [0..QuantumRange]. Choose from these types: CharPixel, ShortPixel, IntegerPixel, LongPixel, FloatPixel, or DoublePixel.

    - -
    pixels
    -

    This array of values contain the pixel components as defined by map and type. You must preallocate this array where the expected length varies depending on the values of width, height, map, and type.

    - -
    -

    MagickInverseFourierTransformImage

    -
    - -

    MagickInverseFourierTransformImage() implements the inverse discrete Fourier transform (DFT) of the image either as a magnitude / phase or real / imaginary image pair.

    - -

    The format of the MagickInverseFourierTransformImage method is:

    - -
    -  MagickBooleanType MagickInverseFourierTransformImage(
-    MagickWand *magnitude_wand,MagickWand *phase_wand,
-    const MagickBooleanType magnitude)
-
    - -

    A description of each parameter follows:

    - -
    magnitude_wand
    -

    the magnitude or real wand.

    - -
    phase_wand
    -

    the phase or imaginary wand.

    - -
    magnitude
    -

    if true, return as magnitude / phase pair otherwise a real / imaginary image pair.

    - -
    -

    MagickLabelImage

    -
    - -

    MagickLabelImage() adds a label to your image.

    - -

    The format of the MagickLabelImage method is:

    - -
    -  MagickBooleanType MagickLabelImage(MagickWand *wand,const char *label)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    label
    -

    the image label.

    - -
    -

    MagickLevelImage

    -
    - -

    MagickLevelImage() adjusts the levels of an image by scaling the colors falling between specified white and black points to the full available quantum range. The parameters provided represent the black, mid, and white points. The black point specifies the darkest color in the image. Colors darker than the black point are set to zero. Mid point specifies a gamma correction to apply to the image. White point specifies the lightest color in the image. Colors brighter than the white point are set to the maximum quantum value.

    - -

    The format of the MagickLevelImage method is:

    - -
    -  MagickBooleanType MagickLevelImage(MagickWand *wand,
-    const double black_point,const double gamma,const double white_point)
-  MagickBooleanType MagickLevelImageChannel(MagickWand *wand,
-    const ChannelType channel,const double black_point,const double gamma,
-    const double white_point)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    Identify which channel to level: RedChannel, GreenChannel,

    - -
    black_point
    -

    the black point.

    - -
    gamma
    -

    the gamma.

    - -
    white_point
    -

    the white point.

    - -
    -

    MagickLinearStretchImage

    -
    - -

    MagickLinearStretchImage() stretches with saturation the image intensity.

    - -

    You can also reduce the influence of a particular channel with a gamma value of 0.

    - -

    The format of the MagickLinearStretchImage method is:

    - -
    -  MagickBooleanType MagickLinearStretchImage(MagickWand *wand,
-    const double black_point,const double white_point)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    black_point
    -

    the black point.

    - -
    white_point
    -

    the white point.

    - -
    -

    MagickLiquidRescaleImage

    -
    - -

    MagickLiquidRescaleImage() rescales image with seam carving.

    - -

    MagickBooleanType MagickLiquidRescaleImage(MagickWand *wand, const size_t columns,const size_t rows, const double delta_x,const double rigidity)

    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    columns
    -

    the number of columns in the scaled image.

    - -
    rows
    -

    the number of rows in the scaled image.

    - -
    delta_x
    -

    maximum seam transversal step (0 means straight seams).

    - -
    rigidity
    -

    introduce a bias for non-straight seams (typically 0).

    - -
    -

    MagickMagnifyImage

    -
    - -

    MagickMagnifyImage() is a convenience method that scales an image proportionally to twice its original size.

    - -

    The format of the MagickMagnifyImage method is:

    - -
    -  MagickBooleanType MagickMagnifyImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickMedianFilterImage

    -
    - -

    MagickMedianFilterImage() applies a digital filter that improves the quality of a noisy image. Each pixel is replaced by the median in a set of neighboring pixels as defined by radius.

    - -

    The format of the MagickMedianFilterImage method is:

    - -
    -  MagickBooleanType MagickMedianFilterImage(MagickWand *wand,
-    const double radius)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    radius
    -

    the radius of the pixel neighborhood.

    - -
    -

    MagickMergeImageLayers

    -
    - -

    MagickMergeImageLayers() composes all the image layers from the current given image onward to produce a single image of the merged layers.

    - -

    The inital canvas's size depends on the given ImageLayerMethod, and is initialized using the first images background color. The images are then compositied onto that image in sequence using the given composition that has been assigned to each individual image.

    - -

    The format of the MagickMergeImageLayers method is:

    - -
    -  MagickWand *MagickMergeImageLayers(MagickWand *wand,
-    const ImageLayerMethod method)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    method
    -

    the method of selecting the size of the initial canvas.

    - -

    MergeLayer: Merge all layers onto a canvas just large enough to hold all the actual images. The virtual canvas of the first image is preserved but otherwise ignored.

    - -

    FlattenLayer: Use the virtual canvas size of first image. Images which fall outside this canvas is clipped. This can be used to 'fill out' a given virtual canvas.

    - -

    MosaicLayer: Start with the virtual canvas of the first image, enlarging left and right edges to contain all images. Images with negative offsets will be clipped.

    - -
    -

    MagickMinifyImage

    -
    - -

    MagickMinifyImage() is a convenience method that scales an image proportionally to one-half its original size

    - -

    The format of the MagickMinifyImage method is:

    - -
    -  MagickBooleanType MagickMinifyImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickModulateImage

    -
    - -

    MagickModulateImage() lets you control the brightness, saturation, and hue of an image. Hue is the percentage of absolute rotation from the current position. For example 50 results in a counter-clockwise rotation of 90 degrees, 150 results in a clockwise rotation of 90 degrees, with 0 and 200 both resulting in a rotation of 180 degrees.

    - -

    To increase the color brightness by 20 and decrease the color saturation by 10 and leave the hue unchanged, use: 120,90,100.

    - -

    The format of the MagickModulateImage method is:

    - -
    -  MagickBooleanType MagickModulateImage(MagickWand *wand,
-    const double brightness,const double saturation,const double hue)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    brightness
    -

    the percent change in brighness.

    - -
    saturation
    -

    the percent change in saturation.

    - -
    hue
    -

    the percent change in hue.

    - -
    -

    MagickMontageImage

    -
    - -

    MagickMontageImage() creates a composite image by combining several separate images. The images are tiled on the composite image with the name of the image optionally appearing just below the individual tile.

    - -

    The format of the MagickMontageImage method is:

    - -
    -  MagickWand *MagickMontageImage(MagickWand *wand,
-    const DrawingWand drawing_wand,const char *tile_geometry,
-    const char *thumbnail_geometry,const MontageMode mode,
-    const char *frame)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    drawing_wand
    -

    the drawing wand. The font name, size, and color are obtained from this wand.

    - -
    tile_geometry
    -

    the number of tiles per row and page (e.g. 6x4+0+0).

    - -
    thumbnail_geometry
    -

    Preferred image size and border size of each thumbnail (e.g. 120x120+4+3>).

    - -
    mode
    -

    Thumbnail framing mode: Frame, Unframe, or Concatenate.

    - -
    frame
    -

    Surround the image with an ornamental border (e.g. 15x15+3+3). The frame color is that of the thumbnail's matte color.

    - -
    -

    MagickMorphImages

    -
    - -

    MagickMorphImages() method morphs a set of images. Both the image pixels and size are linearly interpolated to give the appearance of a meta-morphosis from one image to the next.

    - -

    The format of the MagickMorphImages method is:

    - -
    -  MagickWand *MagickMorphImages(MagickWand *wand,
-    const size_t number_frames)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    number_frames
    -

    the number of in-between images to generate.

    - -
    -

    MagickMorphologyImage

    -
    - -

    MagickMorphologyImage() applies a user supplied kernel to the image according to the given mophology method.

    - -

    The format of the MagickMorphologyImage method is:

    - -
    -  MagickBooleanType MagickMorphologyImage(MagickWand *wand,
-    MorphologyMethod method,const ssize_t iterations,KernelInfo *kernel)
-  MagickBooleanType MagickMorphologyImageChannel(MagickWand *wand,
-    ChannelType channel,MorphologyMethod method,const ssize_t iterations,
-    KernelInfo *kernel)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    method
    -

    the morphology method to be applied.

    - -
    iterations
    -

    apply the operation this many times (or no change). A value of -1 means loop until no change found. How this is applied may depend on the morphology method. Typically this is a value of 1.

    - -
    kernel
    -

    An array of doubles representing the morphology kernel.

    - -
    -

    MagickMotionBlurImage

    -
    - -

    MagickMotionBlurImage() simulates motion blur. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and MotionBlurImage() selects a suitable radius for you. Angle gives the angle of the blurring motion.

    - -

    The format of the MagickMotionBlurImage method is:

    - -
    -  MagickBooleanType MagickMotionBlurImage(MagickWand *wand,
-    const double radius,const double sigma,const double angle)
-  MagickBooleanType MagickMotionBlurImageChannel(MagickWand *wand,
-    const ChannelType channel,const double radius,const double sigma,
-    const double angle)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    angle
    -

    Apply the effect along this angle.

    - -
    -

    MagickNegateImage

    -
    - -

    MagickNegateImage() negates the colors in the reference image. The Grayscale option means that only grayscale values within the image are negated.

    - -

    You can also reduce the influence of a particular channel with a gamma value of 0.

    - -

    The format of the MagickNegateImage method is:

    - -
    -  MagickBooleanType MagickNegateImage(MagickWand *wand,
-    const MagickBooleanType gray)
-  MagickBooleanType MagickNegateImage(MagickWand *wand,
-    const ChannelType channel,const MagickBooleanType gray)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    gray
    -

    If MagickTrue, only negate grayscale pixels within the image.

    - -
    -

    MagickNewImage

    -
    - -

    MagickNewImage() adds a blank image canvas of the specified size and background color to the wand.

    - -

    The format of the MagickNewImage method is:

    - -
    -  MagickBooleanType MagickNewImage(MagickWand *wand,
-    const size_t columns,const size_t rows,
-    const PixelWand *background)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    width
    -

    the image width.

    - -
    height
    -

    the image height.

    - -
    background
    -

    the image color.

    - -
    -

    MagickNextImage

    -
    - -

    MagickNextImage() associates the next image in the image list with a magick wand.

    - -

    The format of the MagickNextImage method is:

    - -
    -  MagickBooleanType MagickNextImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickNormalizeImage

    -
    - -

    MagickNormalizeImage() enhances the contrast of a color image by adjusting the pixels color to span the entire range of colors available

    - -

    You can also reduce the influence of a particular channel with a gamma value of 0.

    - -

    The format of the MagickNormalizeImage method is:

    - -
    -  MagickBooleanType MagickNormalizeImage(MagickWand *wand)
-  MagickBooleanType MagickNormalizeImageChannel(MagickWand *wand,
-    const ChannelType channel)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    -

    MagickOilPaintImage

    -
    - -

    MagickOilPaintImage() applies a special effect filter that simulates an oil painting. Each pixel is replaced by the most frequent color occurring in a circular region defined by radius.

    - -

    The format of the MagickOilPaintImage method is:

    - -
    -  MagickBooleanType MagickOilPaintImage(MagickWand *wand,
-    const double radius)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    radius
    -

    the radius of the circular neighborhood.

    - -
    -

    MagickOpaquePaintImage

    -
    - -

    MagickOpaquePaintImage() changes any pixel that matches color with the color defined by fill.

    - -

    The format of the MagickOpaquePaintImage method is:

    - -
    -  MagickBooleanType MagickOpaquePaintImage(MagickWand *wand,
-    const PixelWand *target,const PixelWand *fill,const double fuzz,
-    const MagickBooleanType invert)
-  MagickBooleanType MagickOpaquePaintImageChannel(MagickWand *wand,
-    const ChannelType channel,const PixelWand *target,
-    const PixelWand *fill,const double fuzz,const MagickBooleanType invert)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the channel(s).

    - -
    target
    -

    Change this target color to the fill color within the image.

    - -
    fill
    -

    the fill pixel wand.

    - -
    fuzz
    -

    By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.

    - -
    invert
    -

    paint any pixel that does not match the target color.

    - -
    -

    MagickOptimizeImageLayers

    -
    - -

    MagickOptimizeImageLayers() compares each image the GIF disposed forms of the previous image in the sequence. From this it attempts to select the smallest cropped image to replace each frame, while preserving the results of the animation.

    - -

    The format of the MagickOptimizeImageLayers method is:

    - -
    -  MagickWand *MagickOptimizeImageLayers(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickOrderedPosterizeImage

    -
    - -

    MagickOrderedPosterizeImage() performs an ordered dither based on a number of pre-defined dithering threshold maps, but over multiple intensity levels, which can be different for different channels, according to the input arguments.

    - -

    The format of the MagickOrderedPosterizeImage method is:

    - -
    -  MagickBooleanType MagickOrderedPosterizeImage(MagickWand *wand,
-    const char *threshold_map)
-  MagickBooleanType MagickOrderedPosterizeImageChannel(MagickWand *wand,
-    const ChannelType channel,const char *threshold_map)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel or channels to be thresholded.

    - -
    threshold_map
    -

    A string containing the name of the threshold dither map to use, followed by zero or more numbers representing the number of color levels tho dither between.

    - -

    Any level number less than 2 is equivelent to 2, and means only binary dithering will be applied to each color channel.

    - -

    No numbers also means a 2 level (bitmap) dither will be applied to all channels, while a single number is the number of levels applied to each channel in sequence. More numbers will be applied in turn to each of the color channels.

    - -

    For example: "o3x3,6" generates a 6 level posterization of the image with a ordered 3x3 diffused pixel dither being applied between each level. While checker,8,8,4 will produce a 332 colormaped image with only a single checkerboard hash pattern (50 grey) between each color level, to basically double the number of color levels with a bare minimim of dithering.

    - -
    -

    MagickPingImage

    -
    - -

    MagickPingImage() is like MagickReadImage() except the only valid information returned is the image width, height, size, and format. It is designed to efficiently obtain this information from a file without reading the entire image sequence into memory.

    - -

    The format of the MagickPingImage method is:

    - -
    -  MagickBooleanType MagickPingImage(MagickWand *wand,const char *filename)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    filename
    -

    the image filename.

    - -
    -

    MagickPingImageBlob

    -
    - -

    MagickPingImageBlob() pings an image or image sequence from a blob.

    - -

    The format of the MagickPingImageBlob method is:

    - -
    -  MagickBooleanType MagickPingImageBlob(MagickWand *wand,
-    const void *blob,const size_t length)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    blob
    -

    the blob.

    - -
    length
    -

    the blob length.

    - -
    -

    MagickPingImageFile

    -
    - -

    MagickPingImageFile() pings an image or image sequence from an open file descriptor.

    - -

    The format of the MagickPingImageFile method is:

    - -
    -  MagickBooleanType MagickPingImageFile(MagickWand *wand,FILE *file)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    file
    -

    the file descriptor.

    - -
    -

    MagickPolaroidImage

    -
    - -

    MagickPolaroidImage() simulates a Polaroid picture.

    - -

    The format of the MagickPolaroidImage method is:

    - -
    -  MagickBooleanType MagickPolaroidImage(MagickWand *wand,
-    const DrawingWand *drawing_wand,const double angle)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    drawing_wand
    -

    the draw wand.

    - -
    angle
    -

    Apply the effect along this angle.

    - -
    -

    MagickPosterizeImage

    -
    - -

    MagickPosterizeImage() reduces the image to a limited number of color level.

    - -

    The format of the MagickPosterizeImage method is:

    - -
    -  MagickBooleanType MagickPosterizeImage(MagickWand *wand,
-    const unsigned levels,const MagickBooleanType dither)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    levels
    -

    Number of color levels allowed in each channel. Very low values (2, 3, or 4) have the most visible effect.

    - -
    dither
    -

    Set this integer value to something other than zero to dither the mapped image.

    - -
    -

    MagickPreviewImages

    -
    - -

    MagickPreviewImages() tiles 9 thumbnails of the specified image with an image processing operation applied at varying strengths. This helpful to quickly pin-point an appropriate parameter for an image processing operation.

    - -

    The format of the MagickPreviewImages method is:

    - -
    -  MagickWand *MagickPreviewImages(MagickWand *wand,
-    const PreviewType preview)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    preview
    -

    the preview type.

    - -
    -

    MagickPreviousImage

    -
    - -

    MagickPreviousImage() assocates the previous image in an image list with the magick wand.

    - -

    The format of the MagickPreviousImage method is:

    - -
    -  MagickBooleanType MagickPreviousImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickQuantizeImage

    -
    - -

    MagickQuantizeImage() analyzes the colors within a reference image and chooses a fixed number of colors to represent the image. The goal of the algorithm is to minimize the color difference between the input and output image while minimizing the processing time.

    - -

    The format of the MagickQuantizeImage method is:

    - -
    -  MagickBooleanType MagickQuantizeImage(MagickWand *wand,
-    const size_t number_colors,const ColorspaceType colorspace,
-    const size_t treedepth,const MagickBooleanType dither,
-    const MagickBooleanType measure_error)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    number_colors
    -

    the number of colors.

    - -
    colorspace
    -

    Perform color reduction in this colorspace, typically RGBColorspace.

    - -
    treedepth
    -

    Normally, this integer value is zero or one. A zero or one tells Quantize to choose a optimal tree depth of Log4(number_colors). A tree of this depth generally allows the best representation of the reference image with the least amount of memory and the fastest computational speed. In some cases, such as an image with low color dispersion (a few number of colors), a value other than Log4(number_colors) is required. To expand the color tree completely, use a value of 8.

    - -
    dither
    -

    A value other than zero distributes the difference between an original image and the corresponding color reduced image to neighboring pixels along a Hilbert curve.

    - -
    measure_error
    -

    A value other than zero measures the difference between the original and quantized images. This difference is the total quantization error. The error is computed by summing over all pixels in an image the distance squared in RGB space between each reference pixel value and its quantized value.

    - -
    -

    MagickQuantizeImages

    -
    - -

    MagickQuantizeImages() analyzes the colors within a sequence of images and chooses a fixed number of colors to represent the image. The goal of the algorithm is to minimize the color difference between the input and output image while minimizing the processing time.

    - -

    The format of the MagickQuantizeImages method is:

    - -
    -  MagickBooleanType MagickQuantizeImages(MagickWand *wand,
-    const size_t number_colors,const ColorspaceType colorspace,
-    const size_t treedepth,const MagickBooleanType dither,
-    const MagickBooleanType measure_error)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    number_colors
    -

    the number of colors.

    - -
    colorspace
    -

    Perform color reduction in this colorspace, typically RGBColorspace.

    - -
    treedepth
    -

    Normally, this integer value is zero or one. A zero or one tells Quantize to choose a optimal tree depth of Log4(number_colors). A tree of this depth generally allows the best representation of the reference image with the least amount of memory and the fastest computational speed. In some cases, such as an image with low color dispersion (a few number of colors), a value other than Log4(number_colors) is required. To expand the color tree completely, use a value of 8.

    - -
    dither
    -

    A value other than zero distributes the difference between an original image and the corresponding color reduced algorithm to neighboring pixels along a Hilbert curve.

    - -
    measure_error
    -

    A value other than zero measures the difference between the original and quantized images. This difference is the total quantization error. The error is computed by summing over all pixels in an image the distance squared in RGB space between each reference pixel value and its quantized value.

    - -
    -

    MagickRadialBlurImage

    -
    - -

    MagickRadialBlurImage() radial blurs an image.

    - -

    The format of the MagickRadialBlurImage method is:

    - -
    -  MagickBooleanType MagickRadialBlurImage(MagickWand *wand,
-    const double angle)
-  MagickBooleanType MagickRadialBlurImageChannel(MagickWand *wand,
-    const ChannelType channel,const double angle)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    angle
    -

    the angle of the blur in degrees.

    - -
    -

    MagickRaiseImage

    -
    - -

    MagickRaiseImage() creates a simulated three-dimensional button-like effect by lightening and darkening the edges of the image. Members width and height of raise_info define the width of the vertical and horizontal edge of the effect.

    - -

    The format of the MagickRaiseImage method is:

    - -
    -  MagickBooleanType MagickRaiseImage(MagickWand *wand,
-    const size_t width,const size_t height,const ssize_t x,
-    const ssize_t y,const MagickBooleanType raise)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    width,height,x,y
    -

    Define the dimensions of the area to raise.

    - -
    raise
    -

    A value other than zero creates a 3-D raise effect, otherwise it has a lowered effect.

    - -
    -

    MagickRandomThresholdImage

    -
    - -

    MagickRandomThresholdImage() changes the value of individual pixels based on the intensity of each pixel compared to threshold. The result is a high-contrast, two color image.

    - -

    The format of the MagickRandomThresholdImage method is:

    - -
    -  MagickBooleanType MagickRandomThresholdImage(MagickWand *wand,
-    const double low,const double high)
-  MagickBooleanType MagickRandomThresholdImageChannel(MagickWand *wand,
-    const ChannelType channel,const double low,const double high)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    low,high
    -

    Specify the high and low thresholds. These values range from 0 to QuantumRange.

    - -
    -

    MagickReadImage

    -
    - -

    MagickReadImage() reads an image or image sequence. The images are inserted at the current image pointer position. Use MagickSetFirstIterator(), MagickSetLastIterator, or MagickSetImageIndex() to specify the current image pointer position at the beginning of the image list, the end, or anywhere in-between respectively.

    - -

    The format of the MagickReadImage method is:

    - -
    -  MagickBooleanType MagickReadImage(MagickWand *wand,const char *filename)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    filename
    -

    the image filename.

    - -
    -

    MagickReadImageBlob

    -
    - -

    MagickReadImageBlob() reads an image or image sequence from a blob.

    - -

    The format of the MagickReadImageBlob method is:

    - -
    -  MagickBooleanType MagickReadImageBlob(MagickWand *wand,
-    const void *blob,const size_t length)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    blob
    -

    the blob.

    - -
    length
    -

    the blob length.

    - -
    -

    MagickReadImageFile

    -
    - -

    MagickReadImageFile() reads an image or image sequence from an open file descriptor.

    - -

    The format of the MagickReadImageFile method is:

    - -
    -  MagickBooleanType MagickReadImageFile(MagickWand *wand,FILE *file)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    file
    -

    the file descriptor.

    - -
    -

    MagickReduceNoiseImage

    -
    - -

    MagickReduceNoiseImage() smooths the contours of an image while still preserving edge information. The algorithm works by replacing each pixel with its neighbor closest in value. A neighbor is defined by radius. Use a radius of 0 and ReduceNoise() selects a suitable radius for you.

    - -

    The format of the MagickReduceNoiseImage method is:

    - -
    -  MagickBooleanType MagickReduceNoiseImage(MagickWand *wand,
-    const double radius)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    radius
    -

    the radius of the pixel neighborhood.

    - -
    -

    MagickRemapImage

    -
    - -

    MagickRemapImage() replaces the colors of an image with the closest color from a reference image.

    - -

    The format of the MagickRemapImage method is:

    - -
    -  MagickBooleanType MagickRemapImage(MagickWand *wand,
-    const MagickWand *remap_wand,const DitherMethod method)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    affinity
    -

    the affinity wand.

    - -
    method
    -

    choose from these dither methods: NoDitherMethod, RiemersmaDitherMethod, or FloydSteinbergDitherMethod.

    - -
    -

    MagickRemoveImage

    -
    - -

    MagickRemoveImage() removes an image from the image list.

    - -

    The format of the MagickRemoveImage method is:

    - -
    -  MagickBooleanType MagickRemoveImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    insert
    -

    the splice wand.

    - -
    -

    MagickResampleImage

    -
    - -

    MagickResampleImage() resample image to desired resolution.

    - -

    Bessel Blackman Box Catrom Cubic Gaussian Hanning Hermite Lanczos Mitchell Point Quandratic Sinc Triangle

    - -

    Most of the filters are FIR (finite impulse response), however, Bessel, Gaussian, and Sinc are IIR (infinite impulse response). Bessel and Sinc are windowed (brought down to zero) with the Blackman filter.

    - -

    The format of the MagickResampleImage method is:

    - -
    -  MagickBooleanType MagickResampleImage(MagickWand *wand,
-    const double x_resolution,const double y_resolution,
-    const FilterTypes filter,const double blur)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x_resolution
    -

    the new image x resolution.

    - -
    y_resolution
    -

    the new image y resolution.

    - -
    filter
    -

    Image filter to use.

    - -
    blur
    -

    the blur factor where > 1 is blurry, < 1 is sharp.

    - -
    -

    MagickResetImagePage

    -
    - -

    MagickResetImagePage() resets the Wand page canvas and position.

    - -

    The format of the MagickResetImagePage method is:

    - -
    -  MagickBooleanType MagickResetImagePage(MagickWand *wand,
-    const char *page)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    page
    -

    the relative page specification.

    - -
    -

    MagickResizeImage

    -
    - -

    MagickResizeImage() scales an image to the desired dimensions with one of these filters:

    - -
    -      Bessel   Blackman   Box
-      Catrom   CubicGaussian
-      Hanning  Hermite    Lanczos
-      Mitchell PointQuandratic
-      Sinc     Triangle
-
    - -

    Most of the filters are FIR (finite impulse response), however, Bessel, Gaussian, and Sinc are IIR (infinite impulse response). Bessel and Sinc are windowed (brought down to zero) with the Blackman filter.

    - -

    The format of the MagickResizeImage method is:

    - -
    -  MagickBooleanType MagickResizeImage(MagickWand *wand,
-    const size_t columns,const size_t rows,
-    const FilterTypes filter,const double blur)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    columns
    -

    the number of columns in the scaled image.

    - -
    rows
    -

    the number of rows in the scaled image.

    - -
    filter
    -

    Image filter to use.

    - -
    blur
    -

    the blur factor where > 1 is blurry, < 1 is sharp.

    - -
    -

    MagickRollImage

    -
    - -

    MagickRollImage() offsets an image as defined by x and y.

    - -

    The format of the MagickRollImage method is:

    - -
    -  MagickBooleanType MagickRollImage(MagickWand *wand,const ssize_t x,
-    const size_t y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x
    -

    the x offset.

    - -
    y
    -

    the y offset.

    - - -
    -

    MagickRotateImage

    -
    - -

    MagickRotateImage() rotates an image the specified number of degrees. Empty triangles left over from rotating the image are filled with the background color.

    - -

    The format of the MagickRotateImage method is:

    - -
    -  MagickBooleanType MagickRotateImage(MagickWand *wand,
-    const PixelWand *background,const double degrees)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    background
    -

    the background pixel wand.

    - -
    degrees
    -

    the number of degrees to rotate the image.

    - - -
    -

    MagickSampleImage

    -
    - -

    MagickSampleImage() scales an image to the desired dimensions with pixel sampling. Unlike other scaling methods, this method does not introduce any additional color into the scaled image.

    - -

    The format of the MagickSampleImage method is:

    - -
    -  MagickBooleanType MagickSampleImage(MagickWand *wand,
-    const size_t columns,const size_t rows)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    columns
    -

    the number of columns in the scaled image.

    - -
    rows
    -

    the number of rows in the scaled image.

    - - -
    -

    MagickScaleImage

    -
    - -

    MagickScaleImage() scales the size of an image to the given dimensions.

    - -

    The format of the MagickScaleImage method is:

    - -
    -  MagickBooleanType MagickScaleImage(MagickWand *wand,
-    const size_t columns,const size_t rows)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    columns
    -

    the number of columns in the scaled image.

    - -
    rows
    -

    the number of rows in the scaled image.

    - - -
    -

    MagickSegmentImage

    -
    - -

    MagickSegmentImage() segments an image by analyzing the histograms of the color components and identifying units that are homogeneous with the fuzzy C-means technique.

    - -

    The format of the SegmentImage method is:

    - -
    -  MagickBooleanType MagickSegmentImage(MagickWand *wand,
-    const ColorspaceType colorspace,const MagickBooleanType verbose,
-    const double cluster_threshold,const double smooth_threshold)
-
    - -

    A description of each parameter follows.

    - -
    wand
    -

    the wand.

    - -
    colorspace
    -

    the image colorspace.

    - -
    verbose
    -

    Set to MagickTrue to print detailed information about the identified classes.

    - -
    cluster_threshold
    -

    This represents the minimum number of pixels contained in a hexahedra before it can be considered valid (expressed as a percentage).

    - -
    smooth_threshold
    -

    the smoothing threshold eliminates noise in the second derivative of the histogram. As the value is increased, you can expect a smoother second derivative.

    - -
    -

    MagickSelectiveBlurImage

    -
    - -

    MagickSelectiveBlurImage() selectively blur an image within a contrast threshold. It is similar to the unsharpen mask that sharpens everything with contrast above a certain threshold.

    - -

    The format of the MagickSelectiveBlurImage method is:

    - -
    -  MagickBooleanType MagickSelectiveBlurImage(MagickWand *wand,
-    const double radius,const double sigma,const double threshold)
-  MagickBooleanType MagickSelectiveBlurImageChannel(MagickWand *wand,
-    const ChannelType channel,const double radius,const double sigma,
-    const double threshold)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    radius
    -

    the radius of the gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the gaussian, in pixels.

    - -
    threshold
    -

    only pixels within this contrast threshold are included in the blur operation.

    - -
    -

    MagickSeparateImageChannel

    -
    - -

    MagickSeparateImageChannel() separates a channel from the image and returns a grayscale image. A channel is a particular color component of each pixel in the image.

    - -

    The format of the MagickSeparateImageChannel method is:

    - -
    -  MagickBooleanType MagickSeparateImageChannel(MagickWand *wand,
-    const ChannelType channel)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    -

    MagickSepiaToneImage

    -
    - -

    MagickSepiaToneImage() applies a special effect to the image, similar to the effect achieved in a photo darkroom by sepia toning. Threshold ranges from 0 to QuantumRange and is a measure of the extent of the sepia toning. A threshold of 80 is a good starting point for a reasonable tone.

    - -

    The format of the MagickSepiaToneImage method is:

    - -
    -  MagickBooleanType MagickSepiaToneImage(MagickWand *wand,
-    const double threshold)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    threshold
    -

    Define the extent of the sepia toning.

    - -
    -

    MagickSetImage

    -
    - -

    MagickSetImage() replaces the last image returned by MagickSetImageIndex(), MagickNextImage(), MagickPreviousImage() with the images from the specified wand.

    - -

    The format of the MagickSetImage method is:

    - -
    -  MagickBooleanType MagickSetImage(MagickWand *wand,
-    const MagickWand *set_wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    set_wand
    -

    the set_wand wand.

    - -
    -

    MagickSetImageAlphaChannel

    -
    - -

    MagickSetImageAlphaChannel() activates, deactivates, resets, or sets the alpha channel.

    - -

    The format of the MagickSetImageAlphaChannel method is:

    - -
    -  MagickBooleanType MagickSetImageAlphaChannel(MagickWand *wand,
-    const AlphaChannelType alpha_type)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    alpha_type
    -

    the alpha channel type: ActivateAlphaChannel, DeactivateAlphaChannel, OpaqueAlphaChannel, or SetAlphaChannel.

    - -
    -

    MagickSetImageBackgroundColor

    -
    - -

    MagickSetImageBackgroundColor() sets the image background color.

    - -

    The format of the MagickSetImageBackgroundColor method is:

    - -
    -  MagickBooleanType MagickSetImageBackgroundColor(MagickWand *wand,
-    const PixelWand *background)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    background
    -

    the background pixel wand.

    - -
    -

    MagickSetImageBias

    -
    - -

    MagickSetImageBias() sets the image bias for any method that convolves an image (e.g. MagickConvolveImage()).

    - -

    The format of the MagickSetImageBias method is:

    - -
    -  MagickBooleanType MagickSetImageBias(MagickWand *wand,
-    const double bias)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    bias
    -

    the image bias.

    - -
    -

    MagickSetImageBluePrimary

    -
    - -

    MagickSetImageBluePrimary() sets the image chromaticity blue primary point.

    - -

    The format of the MagickSetImageBluePrimary method is:

    - -
    -  MagickBooleanType MagickSetImageBluePrimary(MagickWand *wand,
-    const double x,const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x
    -

    the blue primary x-point.

    - -
    y
    -

    the blue primary y-point.

    - -
    -

    MagickSetImageBorderColor

    -
    - -

    MagickSetImageBorderColor() sets the image border color.

    - -

    The format of the MagickSetImageBorderColor method is:

    - -
    -  MagickBooleanType MagickSetImageBorderColor(MagickWand *wand,
-    const PixelWand *border)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    border
    -

    the border pixel wand.

    - -
    -

    MagickSetImageChannelDepth

    -
    - -

    MagickSetImageChannelDepth() sets the depth of a particular image channel.

    - -

    The format of the MagickSetImageChannelDepth method is:

    - -
    -  MagickBooleanType MagickSetImageChannelDepth(MagickWand *wand,
-    const ChannelType channel,const size_t depth)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    depth
    -

    the image depth in bits.

    - -
    -

    MagickSetImageClipMask

    -
    - -

    MagickSetImageClipMask() sets image clip mask.

    - -

    The format of the MagickSetImageClipMask method is:

    - -
    -  MagickBooleanType MagickSetImageClipMask(MagickWand *wand,
-    const MagickWand *clip_mask)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    clip_mask
    -

    the clip_mask wand.

    - -
    -

    MagickSetImageColor

    -
    - -

    MagickSetImageColor() set the entire wand canvas to the specified color.

    - -

    The format of the MagickSetImageColor method is:

    - -
    -  MagickBooleanType MagickSetImageColor(MagickWand *wand,
-    const PixelWand *color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    background
    -

    the image color.

    - -
    -

    MagickSetImageColormapColor

    -
    - -

    MagickSetImageColormapColor() sets the color of the specified colormap index.

    - -

    The format of the MagickSetImageColormapColor method is:

    - -
    -  MagickBooleanType MagickSetImageColormapColor(MagickWand *wand,
-    const size_t index,const PixelWand *color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    index
    -

    the offset into the image colormap.

    - -
    color
    -

    Return the colormap color in this wand.

    - -
    -

    MagickSetImageColorspace

    -
    - -

    MagickSetImageColorspace() sets the image colorspace.

    - -

    The format of the MagickSetImageColorspace method is:

    - -
    -  MagickBooleanType MagickSetImageColorspace(MagickWand *wand,
-    const ColorspaceType colorspace)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    colorspace
    -

    the image colorspace: UndefinedColorspace, RGBColorspace, GRAYColorspace, TransparentColorspace, OHTAColorspace, XYZColorspace, YCbCrColorspace, YCCColorspace, YIQColorspace, YPbPrColorspace, YPbPrColorspace, YUVColorspace, CMYKColorspace, sRGBColorspace, HSLColorspace, or HWBColorspace.

    - -
    -

    MagickSetImageCompose

    -
    - -

    MagickSetImageCompose() sets the image composite operator, useful for specifying how to composite the image thumbnail when using the MagickMontageImage() method.

    - -

    The format of the MagickSetImageCompose method is:

    - -
    -  MagickBooleanType MagickSetImageCompose(MagickWand *wand,
-    const CompositeOperator compose)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    compose
    -

    the image composite operator.

    - -
    -

    MagickSetImageCompression

    -
    - -

    MagickSetImageCompression() sets the image compression.

    - -

    The format of the MagickSetImageCompression method is:

    - -
    -  MagickBooleanType MagickSetImageCompression(MagickWand *wand,
-    const CompressionType compression)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    compression
    -

    the image compression type.

    - -
    -

    MagickSetImageCompressionQuality

    -
    - -

    MagickSetImageCompressionQuality() sets the image compression quality.

    - -

    The format of the MagickSetImageCompressionQuality method is:

    - -
    -  MagickBooleanType MagickSetImageCompressionQuality(MagickWand *wand,
-    const size_t quality)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    quality
    -

    the image compression tlityype.

    - -
    -

    MagickSetImageDelay

    -
    - -

    MagickSetImageDelay() sets the image delay.

    - -

    The format of the MagickSetImageDelay method is:

    - -
    -  MagickBooleanType MagickSetImageDelay(MagickWand *wand,
-    const size_t delay)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    delay
    -

    the image delay in ticks-per-second units.

    - -
    -

    MagickSetImageDepth

    -
    - -

    MagickSetImageDepth() sets the image depth.

    - -

    The format of the MagickSetImageDepth method is:

    - -
    -  MagickBooleanType MagickSetImageDepth(MagickWand *wand,
-    const size_t depth)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    depth
    -

    the image depth in bits: 8, 16, or 32.

    - -
    -

    MagickSetImageDispose

    -
    - -

    MagickSetImageDispose() sets the image disposal method.

    - -

    The format of the MagickSetImageDispose method is:

    - -
    -  MagickBooleanType MagickSetImageDispose(MagickWand *wand,
-    const DisposeType dispose)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    dispose
    -

    the image disposeal type.

    - -
    -

    MagickSetImageExtent

    -
    - -

    MagickSetImageExtent() sets the image size (i.e. columns & rows).

    - -

    The format of the MagickSetImageExtent method is:

    - -
    -  MagickBooleanType MagickSetImageExtent(MagickWand *wand,
-    const size_t columns,const unsigned rows)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    columns
    -

    The image width in pixels.

    - -
    rows
    -

    The image height in pixels.

    - -
    -

    MagickSetImageFilename

    -
    - -

    MagickSetImageFilename() sets the filename of a particular image in a sequence.

    - -

    The format of the MagickSetImageFilename method is:

    - -
    -  MagickBooleanType MagickSetImageFilename(MagickWand *wand,
-    const char *filename)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    filename
    -

    the image filename.

    - -
    -

    MagickSetImageFormat

    -
    - -

    MagickSetImageFormat() sets the format of a particular image in a sequence.

    - -

    The format of the MagickSetImageFormat method is:

    - -
    -  MagickBooleanType MagickSetImageFormat(MagickWand *wand,
-    const char *format)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    format
    -

    the image format.

    - -
    -

    MagickSetImageFuzz

    -
    - -

    MagickSetImageFuzz() sets the image fuzz.

    - -

    The format of the MagickSetImageFuzz method is:

    - -
    -  MagickBooleanType MagickSetImageFuzz(MagickWand *wand,
-    const double fuzz)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    fuzz
    -

    the image fuzz.

    - -
    -

    MagickSetImageGamma

    -
    - -

    MagickSetImageGamma() sets the image gamma.

    - -

    The format of the MagickSetImageGamma method is:

    - -
    -  MagickBooleanType MagickSetImageGamma(MagickWand *wand,
-    const double gamma)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    gamma
    -

    the image gamma.

    - -
    -

    MagickSetImageGravity

    -
    - -

    MagickSetImageGravity() sets the image gravity type.

    - -

    The format of the MagickSetImageGravity method is:

    - -
    -  MagickBooleanType MagickSetImageGravity(MagickWand *wand,
-    const GravityType gravity)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    gravity
    -

    the image interlace scheme: NoInterlace, LineInterlace, PlaneInterlace, PartitionInterlace.

    - -
    -

    MagickSetImageGreenPrimary

    -
    - -

    MagickSetImageGreenPrimary() sets the image chromaticity green primary point.

    - -

    The format of the MagickSetImageGreenPrimary method is:

    - -
    -  MagickBooleanType MagickSetImageGreenPrimary(MagickWand *wand,
-    const double x,const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x
    -

    the green primary x-point.

    - -
    y
    -

    the green primary y-point.

    - - -
    -

    MagickSetImageInterlaceScheme

    -
    - -

    MagickSetImageInterlaceScheme() sets the image interlace scheme.

    - -

    The format of the MagickSetImageInterlaceScheme method is:

    - -
    -  MagickBooleanType MagickSetImageInterlaceScheme(MagickWand *wand,
-    const InterlaceType interlace)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    interlace
    -

    the image interlace scheme: NoInterlace, LineInterlace, PlaneInterlace, PartitionInterlace.

    - -
    -

    MagickSetImageInterpolateMethod

    -
    - -

    MagickSetImageInterpolateMethod() sets the image interpolate pixel method.

    - -

    The format of the MagickSetImageInterpolateMethod method is:

    - -
    -  MagickBooleanType MagickSetImageInterpolateMethod(MagickWand *wand,
-    const InterpolatePixelMethod method)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    method
    -

    the image interpole pixel methods: choose from Undefined, Average, Bicubic, Bilinear, Filter, Integer, Mesh, NearestNeighbor.

    - -
    -

    MagickSetImageIterations

    -
    - -

    MagickSetImageIterations() sets the image iterations.

    - -

    The format of the MagickSetImageIterations method is:

    - -
    -  MagickBooleanType MagickSetImageIterations(MagickWand *wand,
-    const size_t iterations)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    delay
    -

    the image delay in 1/100th of a second.

    - -
    -

    MagickSetImageMatte

    -
    - -

    MagickSetImageMatte() sets the image matte channel.

    - -

    The format of the MagickSetImageMatteColor method is:

    - -
    -  MagickBooleanType MagickSetImageMatteColor(MagickWand *wand,
-    const MagickBooleanType *matte)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    matte
    -

    Set to MagickTrue to enable the image matte channel otherwise MagickFalse.

    - -
    -

    MagickSetImageMatteColor

    -
    - -

    MagickSetImageMatteColor() sets the image matte color.

    - -

    The format of the MagickSetImageMatteColor method is:

    - -
    -  MagickBooleanType MagickSetImageMatteColor(MagickWand *wand,
-    const PixelWand *matte)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    matte
    -

    the matte pixel wand.

    - -
    -

    MagickSetImageOpacity

    -
    - -

    MagickSetImageOpacity() sets the image to the specified opacity level.

    - -

    The format of the MagickSetImageOpacity method is:

    - -
    -  MagickBooleanType MagickSetImageOpacity(MagickWand *wand,
-    const double alpha)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    alpha
    -

    the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.

    - -
    -

    MagickSetImageOrientation

    -
    - -

    MagickSetImageOrientation() sets the image orientation.

    - -

    The format of the MagickSetImageOrientation method is:

    - -
    -  MagickBooleanType MagickSetImageOrientation(MagickWand *wand,
-    const OrientationType orientation)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    orientation
    -

    the image orientation type.

    - -
    -

    MagickSetImagePage

    -
    - -

    MagickSetImagePage() sets the page geometry of the image.

    - -

    The format of the MagickSetImagePage method is:

    - -
    -  MagickBooleanType MagickSetImagePage(MagickWand *wand,
-    const size_t width,const size_t height,const ssize_t x,
-    const ssize_t y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    width
    -

    the page width.

    - -
    height
    -

    the page height.

    - -
    x
    -

    the page x-offset.

    - -
    y
    -

    the page y-offset.

    - -
    -

    MagickSetImageProgressMonitor

    -
    - -

    MagickSetImageProgressMonitor() sets the wand image progress monitor to the specified method and returns the previous progress monitor if any. The progress monitor method looks like this:

    - -
    -      MagickBooleanType MagickProgressMonitor(const char *text,
-  const MagickOffsetType offset,const MagickSizeType span,
-  void *client_data)
-
    - -

    If the progress monitor returns MagickFalse, the current operation is interrupted.

    - -

    The format of the MagickSetImageProgressMonitor method is:

    - -
    -  MagickProgressMonitor MagickSetImageProgressMonitor(MagickWand *wand
-    const MagickProgressMonitor progress_monitor,void *client_data)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    progress_monitor
    -

    Specifies a pointer to a method to monitor progress of an image operation.

    - -
    client_data
    -

    Specifies a pointer to any client data.

    - -
    -

    MagickSetImageRedPrimary

    -
    - -

    MagickSetImageRedPrimary() sets the image chromaticity red primary point.

    - -

    The format of the MagickSetImageRedPrimary method is:

    - -
    -  MagickBooleanType MagickSetImageRedPrimary(MagickWand *wand,
-    const double x,const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x
    -

    the red primary x-point.

    - -
    y
    -

    the red primary y-point.

    - -
    -

    MagickSetImageRenderingIntent

    -
    - -

    MagickSetImageRenderingIntent() sets the image rendering intent.

    - -

    The format of the MagickSetImageRenderingIntent method is:

    - -
    -  MagickBooleanType MagickSetImageRenderingIntent(MagickWand *wand,
-    const RenderingIntent rendering_intent)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    rendering_intent
    -

    the image rendering intent: UndefinedIntent, SaturationIntent, PerceptualIntent, AbsoluteIntent, or RelativeIntent.

    - -
    -

    MagickSetImageResolution

    -
    - -

    MagickSetImageResolution() sets the image resolution.

    - -

    The format of the MagickSetImageResolution method is:

    - -
    -  MagickBooleanType MagickSetImageResolution(MagickWand *wand,
-    const double x_resolution,const doubtl y_resolution)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x_resolution
    -

    the image x resolution.

    - -
    y_resolution
    -

    the image y resolution.

    - -
    -

    MagickSetImageScene

    -
    - -

    MagickSetImageScene() sets the image scene.

    - -

    The format of the MagickSetImageScene method is:

    - -
    -  MagickBooleanType MagickSetImageScene(MagickWand *wand,
-    const size_t scene)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    delay
    -

    the image scene number.

    - -
    -

    MagickSetImageTicksPerSecond

    -
    - -

    MagickSetImageTicksPerSecond() sets the image ticks-per-second.

    - -

    The format of the MagickSetImageTicksPerSecond method is:

    - -
    -  MagickBooleanType MagickSetImageTicksPerSecond(MagickWand *wand,
-    const ssize_t ticks_per-second)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    ticks_per_second
    -

    the units to use for the image delay.

    - -
    -

    MagickSetImageType

    -
    - -

    MagickSetImageType() sets the image type.

    - -

    The format of the MagickSetImageType method is:

    - -
    -  MagickBooleanType MagickSetImageType(MagickWand *wand,
-    const ImageType image_type)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    image_type
    -

    the image type: UndefinedType, BilevelType, GrayscaleType, GrayscaleMatteType, PaletteType, PaletteMatteType, TrueColorType, TrueColorMatteType, ColorSeparationType, ColorSeparationMatteType, or OptimizeType.

    - -
    -

    MagickSetImageUnits

    -
    - -

    MagickSetImageUnits() sets the image units of resolution.

    - -

    The format of the MagickSetImageUnits method is:

    - -
    -  MagickBooleanType MagickSetImageUnits(MagickWand *wand,
-    const ResolutionType units)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    units
    -

    the image units of resolution : UndefinedResolution, PixelsPerInchResolution, or PixelsPerCentimeterResolution.

    - -
    -

    MagickSetImageVirtualPixelMethod

    -
    - -

    MagickSetImageVirtualPixelMethod() sets the image virtual pixel method.

    - -

    The format of the MagickSetImageVirtualPixelMethod method is:

    - -
    -  VirtualPixelMethod MagickSetImageVirtualPixelMethod(MagickWand *wand,
-    const VirtualPixelMethod method)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    method
    -

    the image virtual pixel method : UndefinedVirtualPixelMethod, ConstantVirtualPixelMethod, EdgeVirtualPixelMethod, MirrorVirtualPixelMethod, or TileVirtualPixelMethod.

    - -
    -

    MagickSetImageWhitePoint

    -
    - -

    MagickSetImageWhitePoint() sets the image chromaticity white point.

    - -

    The format of the MagickSetImageWhitePoint method is:

    - -
    -  MagickBooleanType MagickSetImageWhitePoint(MagickWand *wand,
-    const double x,const double y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x
    -

    the white x-point.

    - -
    y
    -

    the white y-point.

    - -
    -

    MagickShadeImage

    -
    - -

    MagickShadeImage() shines a distant light on an image to create a three-dimensional effect. You control the positioning of the light with azimuth and elevation; azimuth is measured in degrees off the x axis and elevation is measured in pixels above the Z axis.

    - -

    The format of the MagickShadeImage method is:

    - -
    -  MagickBooleanType MagickShadeImage(MagickWand *wand,
-    const MagickBooleanType gray,const double azimuth,
-    const double elevation)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    gray
    -

    A value other than zero shades the intensity of each pixel.

    - -
    azimuth, elevation
    -

    Define the light source direction.

    - -
    -

    MagickShadowImage

    -
    - -

    MagickShadowImage() simulates an image shadow.

    - -

    The format of the MagickShadowImage method is:

    - -
    -  MagickBooleanType MagickShadowImage(MagickWand *wand,
-    const double opacity,const double sigma,const ssize_t x,const ssize_t y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    opacity
    -

    percentage transparency.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    x
    -

    the shadow x-offset.

    - -
    y
    -

    the shadow y-offset.

    - -
    -

    MagickSharpenImage

    -
    - -

    MagickSharpenImage() sharpens an image. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, the radius should be larger than sigma. Use a radius of 0 and MagickSharpenImage() selects a suitable radius for you.

    - -

    The format of the MagickSharpenImage method is:

    - -
    -  MagickBooleanType MagickSharpenImage(MagickWand *wand,
-    const double radius,const double sigma)
-  MagickBooleanType MagickSharpenImageChannel(MagickWand *wand,
-    const ChannelType channel,const double radius,const double sigma)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    -

    MagickShaveImage

    -
    - -

    MagickShaveImage() shaves pixels from the image edges. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

    - -

    The format of the MagickShaveImage method is:

    - -
    -  MagickBooleanType MagickShaveImage(MagickWand *wand,
-    const size_t columns,const size_t rows)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    columns
    -

    the number of columns in the scaled image.

    - -
    rows
    -

    the number of rows in the scaled image.

    - - -
    -

    MagickShearImage

    -
    - -

    MagickShearImage() slides one edge of an image along the X or Y axis, creating a parallelogram. An X direction shear slides an edge along the X axis, while a Y direction shear slides an edge along the Y axis. The amount of the shear is controlled by a shear angle. For X direction shears, x_shear is measured relative to the Y axis, and similarly, for Y direction shears y_shear is measured relative to the X axis. Empty triangles left over from shearing the image are filled with the background color.

    - -

    The format of the MagickShearImage method is:

    - -
    -  MagickBooleanType MagickShearImage(MagickWand *wand,
-    const PixelWand *background,const double x_shear,onst double y_shear)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    background
    -

    the background pixel wand.

    - -
    x_shear
    -

    the number of degrees to shear the image.

    - -
    y_shear
    -

    the number of degrees to shear the image.

    - -
    -

    MagickSigmoidalContrastImage

    -
    - -

    MagickSigmoidalContrastImage() adjusts the contrast of an image with a non-linear sigmoidal contrast algorithm. Increase the contrast of the image using a sigmoidal transfer function without saturating highlights or shadows. Contrast indicates how much to increase the contrast (0 is none; 3 is typical; 20 is pushing it); mid-point indicates where midtones fall in the resultant image (0 is white; 50 is middle-gray; 100 is black). Set sharpen to MagickTrue to increase the image contrast otherwise the contrast is reduced.

    - -

    The format of the MagickSigmoidalContrastImage method is:

    - -
    -  MagickBooleanType MagickSigmoidalContrastImage(MagickWand *wand,
-    const MagickBooleanType sharpen,const double alpha,const double beta)
-  MagickBooleanType MagickSigmoidalContrastImageChannel(MagickWand *wand,
-    const ChannelType channel,const MagickBooleanType sharpen,
-    const double alpha,const double beta)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    Identify which channel to level: RedChannel, GreenChannel,

    - -
    sharpen
    -

    Increase or decrease image contrast.

    - -
    alpha
    -

    strength of the contrast, the larger the number the more 'threshold-like' it becomes.

    - -
    beta
    -

    midpoint of the function as a color value 0 to QuantumRange.

    - -
    -

    MagickSimilarityImage

    -
    - -

    MagickSimilarityImage() compares the reference image of the image and returns the best match offset. In addition, it returns a similarity image such that an exact match location is completely white and if none of the pixels match, black, otherwise some gray level in-between.

    - -

    The format of the MagickSimilarityImage method is:

    - -
    -  MagickWand *MagickSimilarityImage(MagickWand *wand,
-    const MagickWand *reference,RectangeInfo *offset,double *similarity)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    reference
    -

    the reference wand.

    - -
    offset
    -

    the best match offset of the reference image within the image.

    - -
    similarity
    -

    the computed similarity between the images.

    - -
    -

    MagickSketchImage

    -
    - -

    MagickSketchImage() simulates a pencil sketch. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and SketchImage() selects a suitable radius for you. Angle gives the angle of the blurring motion.

    - -

    The format of the MagickSketchImage method is:

    - -
    -  MagickBooleanType MagickSketchImage(MagickWand *wand,
-    const double radius,const double sigma,const double angle)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    angle
    -

    Apply the effect along this angle.

    - -
    -

    MagickSmushImages

    -
    - -

    MagickSmushImages() takes all images from the current image pointer to the end of the image list and smushs them to each other top-to-bottom if the stack parameter is true, otherwise left-to-right.

    - -

    The format of the MagickSmushImages method is:

    - -
    -  MagickWand *MagickSmushImages(MagickWand *wand,
-    const MagickBooleanType stack,const ssize_t offset)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    stack
    -

    By default, images are stacked left-to-right. Set stack to MagickTrue to stack them top-to-bottom.

    - -
    offset
    -

    minimum distance in pixels between images.

    - -
    -

    MagickSolarizeImage

    -
    - -

    MagickSolarizeImage() applies a special effect to the image, similar to the effect achieved in a photo darkroom by selectively exposing areas of photo sensitive paper to light. Threshold ranges from 0 to QuantumRange and is a measure of the extent of the solarization.

    - -

    The format of the MagickSolarizeImage method is:

    - -
    -  MagickBooleanType MagickSolarizeImage(MagickWand *wand,
-    const double threshold)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    threshold
    -

    Define the extent of the solarization.

    - -
    -

    MagickSparseColorImage

    -
    - -

    MagickSparseColorImage(), given a set of coordinates, interpolates the colors found at those coordinates, across the whole image, using various methods.

    - -

    The format of the MagickSparseColorImage method is:

    - -
    -  MagickBooleanType MagickSparseColorImage(MagickWand *wand,
-    const ChannelType channel,const SparseColorMethod method,
-    const size_t number_arguments,const double *arguments)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image to be sparseed.

    - -
    method
    -

    the method of image sparseion.

    - -

    ArcSparseColorion will always ignore source image offset, and always 'bestfit' the destination image with the top left corner offset relative to the polar mapping center.

    - -

    Bilinear has no simple inverse mapping so will not allow 'bestfit' style of image sparseion.

    - -

    Affine, Perspective, and Bilinear, will do least squares fitting of the distrotion when more than the minimum number of control point pairs are provided.

    - -

    Perspective, and Bilinear, will fall back to a Affine sparseion when less than 4 control point pairs are provided. While Affine sparseions will let you use any number of control point pairs, that is Zero pairs is a No-Op (viewport only) distrotion, one pair is a translation and two pairs of control points will do a scale-rotate-translate, without any shearing.

    - -
    number_arguments
    -

    the number of arguments given for this sparseion method.

    - -
    arguments
    -

    the arguments for this sparseion method.

    - -
    -

    MagickSpliceImage

    -
    - -

    MagickSpliceImage() splices a solid color into the image.

    - -

    The format of the MagickSpliceImage method is:

    - -
    -  MagickBooleanType MagickSpliceImage(MagickWand *wand,
-    const size_t width,const size_t height,const ssize_t x,
-    const ssize_t y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    width
    -

    the region width.

    - -
    height
    -

    the region height.

    - -
    x
    -

    the region x offset.

    - -
    y
    -

    the region y offset.

    - -
    -

    MagickSpreadImage

    -
    - -

    MagickSpreadImage() is a special effects method that randomly displaces each pixel in a block defined by the radius parameter.

    - -

    The format of the MagickSpreadImage method is:

    - -
    -  MagickBooleanType MagickSpreadImage(MagickWand *wand,const double radius)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    radius
    -

    Choose a random pixel in a neighborhood of this extent.

    - -
    -

    MagickSteganoImage

    -
    - -

    MagickSteganoImage() hides a digital watermark within the image. Recover the hidden watermark later to prove that the authenticity of an image. Offset defines the start position within the image to hide the watermark.

    - -

    The format of the MagickSteganoImage method is:

    - -
    -  MagickWand *MagickSteganoImage(MagickWand *wand,
-    const MagickWand *watermark_wand,const ssize_t offset)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    watermark_wand
    -

    the watermark wand.

    - -
    offset
    -

    Start hiding at this offset into the image.

    - -
    -

    MagickStereoImage

    -
    - -

    MagickStereoImage() composites two images and produces a single image that is the composite of a left and right image of a stereo pair

    - -

    The format of the MagickStereoImage method is:

    - -
    -  MagickWand *MagickStereoImage(MagickWand *wand,
-    const MagickWand *offset_wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    offset_wand
    -

    Another image wand.

    - -
    -

    MagickStripImage

    -
    - -

    MagickStripImage() strips an image of all profiles and comments.

    - -

    The format of the MagickStripImage method is:

    - -
    -  MagickBooleanType MagickStripImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickSwirlImage

    -
    - -

    MagickSwirlImage() swirls the pixels about the center of the image, where degrees indicates the sweep of the arc through which each pixel is moved. You get a more dramatic effect as the degrees move from 1 to 360.

    - -

    The format of the MagickSwirlImage method is:

    - -
    -  MagickBooleanType MagickSwirlImage(MagickWand *wand,const double degrees)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    degrees
    -

    Define the tightness of the swirling effect.

    - -
    -

    MagickTextureImage

    -
    - -

    MagickTextureImage() repeatedly tiles the texture image across and down the image canvas.

    - -

    The format of the MagickTextureImage method is:

    - -
    -  MagickWand *MagickTextureImage(MagickWand *wand,
-    const MagickWand *texture_wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    texture_wand
    -

    the texture wand

    - -
    -

    MagickThresholdImage

    -
    - -

    MagickThresholdImage() changes the value of individual pixels based on the intensity of each pixel compared to threshold. The result is a high-contrast, two color image.

    - -

    The format of the MagickThresholdImage method is:

    - -
    -  MagickBooleanType MagickThresholdImage(MagickWand *wand,
-    const double threshold)
-  MagickBooleanType MagickThresholdImageChannel(MagickWand *wand,
-    const ChannelType channel,const double threshold)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    threshold
    -

    Define the threshold value.

    - -
    -

    MagickThumbnailImage

    -
    - -

    MagickThumbnailImage() changes the size of an image to the given dimensions and removes any associated profiles. The goal is to produce small low cost thumbnail images suited for display on the Web.

    - -

    The format of the MagickThumbnailImage method is:

    - -
    -  MagickBooleanType MagickThumbnailImage(MagickWand *wand,
-    const size_t columns,const size_t rows)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    columns
    -

    the number of columns in the scaled image.

    - -
    rows
    -

    the number of rows in the scaled image.

    - -
    -

    MagickTintImage

    -
    - -

    MagickTintImage() applies a color vector to each pixel in the image. The length of the vector is 0 for black and white and at its maximum for the midtones. The vector weighting function is f(x)=(1-(4.0*((x-0.5)*(x-0.5)))).

    - -

    The format of the MagickTintImage method is:

    - -
    -  MagickBooleanType MagickTintImage(MagickWand *wand,
-    const PixelWand *tint,const PixelWand *opacity)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    tint
    -

    the tint pixel wand.

    - -
    opacity
    -

    the opacity pixel wand.

    - -
    -

    MagickTransformImage

    -
    - -

    MagickTransformImage() is a convenience method that behaves like MagickResizeImage() or MagickCropImage() but accepts scaling and/or cropping information as a region geometry specification. If the operation fails, a NULL image handle is returned.

    - -

    The format of the MagickTransformImage method is:

    - -
    -  MagickWand *MagickTransformImage(MagickWand *wand,const char *crop,
-    const char *geometry)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    crop
    -

    A crop geometry string. This geometry defines a subregion of the image to crop.

    - -
    geometry
    -

    An image geometry string. This geometry defines the final size of the image.

    - -
    -

    MagickTransformImageColorspace

    -
    - -

    MagickTransformImageColorspace() transform the image colorspace.

    - -

    The format of the MagickTransformImageColorspace method is:

    - -
    -  MagickBooleanType MagickTransformImageColorspace(MagickWand *wand,
-    const ColorspaceType colorspace)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    colorspace
    -

    the image colorspace: UndefinedColorspace, RGBColorspace, GRAYColorspace, TransparentColorspace, OHTAColorspace, XYZColorspace, YCbCrColorspace, YCCColorspace, YIQColorspace, YPbPrColorspace, YPbPrColorspace, YUVColorspace, CMYKColorspace, sRGBColorspace, HSLColorspace, or HWBColorspace.

    - -
    -

    MagickTransparentPaintImage

    -
    - -

    MagickTransparentPaintImage() changes any pixel that matches color with the color defined by fill.

    - -

    The format of the MagickTransparentPaintImage method is:

    - -
    -  MagickBooleanType MagickTransparentPaintImage(MagickWand *wand,
-    const PixelWand *target,const double alpha,const double fuzz,
-    const MagickBooleanType invert)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    target
    -

    Change this target color to specified opacity value within the image.

    - -
    alpha
    -

    the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.

    - -
    fuzz
    -

    By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.

    - -
    invert
    -

    paint any pixel that does not match the target color.

    - -
    -

    MagickTransposeImage

    -
    - -

    MagickTransposeImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them 90-degrees.

    - -

    The format of the MagickTransposeImage method is:

    - -
    -  MagickBooleanType MagickTransposeImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickTransverseImage

    -
    - -

    MagickTransverseImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them 270-degrees.

    - -

    The format of the MagickTransverseImage method is:

    - -
    -  MagickBooleanType MagickTransverseImage(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickTrimImage

    -
    - -

    MagickTrimImage() remove edges that are the background color from the image.

    - -

    The format of the MagickTrimImage method is:

    - -
    -  MagickBooleanType MagickTrimImage(MagickWand *wand,const double fuzz)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    fuzz
    -

    By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.

    - -
    -

    MagickUniqueImageColors

    -
    - -

    MagickUniqueImageColors() discards all but one of any pixel color.

    - -

    The format of the MagickUniqueImageColors method is:

    - -
    -  MagickBooleanType MagickUniqueImageColors(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickUnsharpMaskImage

    -
    - -

    MagickUnsharpMaskImage() sharpens an image. We convolve the image with a Gaussian operator of the given radius and standard deviation (sigma). For reasonable results, radius should be larger than sigma. Use a radius of 0 and UnsharpMaskImage() selects a suitable radius for you.

    - -

    The format of the MagickUnsharpMaskImage method is:

    - -
    -  MagickBooleanType MagickUnsharpMaskImage(MagickWand *wand,
-    const double radius,const double sigma,const double amount,
-    const double threshold)
-  MagickBooleanType MagickUnsharpMaskImageChannel(MagickWand *wand,
-    const ChannelType channel,const double radius,const double sigma,
-    const double amount,const double threshold)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    channel
    -

    the image channel(s).

    - -
    radius
    -

    the radius of the Gaussian, in pixels, not counting the center pixel.

    - -
    sigma
    -

    the standard deviation of the Gaussian, in pixels.

    - -
    amount
    -

    the percentage of the difference between the original and the blur image that is added back into the original.

    - -
    threshold
    -

    the threshold in pixels needed to apply the diffence amount.

    - -
    -

    MagickVignetteImage

    -
    - -

    MagickVignetteImage() softens the edges of the image in vignette style.

    - -

    The format of the MagickVignetteImage method is:

    - -
    -  MagickBooleanType MagickVignetteImage(MagickWand *wand,
-    const double black_point,const double white_point,const ssize_t x,
-    const ssize_t y)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    black_point
    -

    the black point.

    - -
    white_point
    -

    the white point.

    - -
    x, y
    -

    Define the x and y ellipse offset.

    - -
    -

    MagickWaveImage

    -
    - -

    MagickWaveImage() creates a "ripple" effect in the image by shifting the pixels vertically along a sine wave whose amplitude and wavelength is specified by the given parameters.

    - -

    The format of the MagickWaveImage method is:

    - -
    -  MagickBooleanType MagickWaveImage(MagickWand *wand,const double amplitude,
-    const double wave_length)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    amplitude, wave_length
    -

    Define the amplitude and wave length of the sine wave.

    - -
    -

    MagickWhiteThresholdImage

    -
    - -

    MagickWhiteThresholdImage() is like ThresholdImage() but force all pixels above the threshold into white while leaving all pixels below the threshold unchanged.

    - -

    The format of the MagickWhiteThresholdImage method is:

    - -
    -  MagickBooleanType MagickWhiteThresholdImage(MagickWand *wand,
-    const PixelWand *threshold)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    threshold
    -

    the pixel wand.

    - -
    -

    MagickWriteImage

    -
    - -

    MagickWriteImage() writes an image to the specified filename. If the filename parameter is NULL, the image is written to the filename set by MagickReadImage() or MagickSetImageFilename().

    - -

    The format of the MagickWriteImage method is:

    - -
    -  MagickBooleanType MagickWriteImage(MagickWand *wand,
-    const char *filename)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    filename
    -

    the image filename.

    - - -
    -

    MagickWriteImageFile

    -
    - -

    MagickWriteImageFile() writes an image to an open file descriptor.

    - -

    The format of the MagickWriteImageFile method is:

    - -
    -  MagickBooleanType MagickWriteImageFile(MagickWand *wand,FILE *file)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    file
    -

    the file descriptor.

    - -
    -

    MagickWriteImages

    -
    - -

    MagickWriteImages() writes an image or image sequence.

    - -

    The format of the MagickWriteImages method is:

    - -
    -  MagickBooleanType MagickWriteImages(MagickWand *wand,
-    const char *filename,const MagickBooleanType adjoin)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    filename
    -

    the image filename.

    - -
    adjoin
    -

    join images into a single multi-image file.

    - -
    -

    MagickWriteImagesFile

    -
    - -

    MagickWriteImagesFile() writes an image sequence to an open file descriptor.

    - -

    The format of the MagickWriteImagesFile method is:

    - -
    -  MagickBooleanType MagickWriteImagesFile(MagickWand *wand,FILE *file)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    file
    -

    the file descriptor.

    - -
    diff --git a/www/api/magick-property.html b/www/api/magick-property.html index 27a426319..4f2ac4f55 100644 --- a/www/api/magick-property.html +++ b/www/api/magick-property.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,481 +190,9 @@
    -

    Module magick-wand - Methods

    -

    [ClearMagickWand • CloneMagickWand • DestroyMagickWand • IsMagickWand • MagickClearException • MagickGetException • MagickGetExceptionType • MagickGetIteratorIndex • MagickQueryConfigureOption • MagickQueryConfigureOptions • MagickQueryFontMetrics • MagickQueryMultilineFontMetrics • MagickQueryFonts • MagickQueryFonts • MagickRelinquishMemory • MagickResetIterator • MagickSetFirstIterator • MagickSetIteratorIndex • MagickSetLastIterator • MagickWandGenesis • MagickWandTerminus • NewMagickWand • NewMagickWandFromImage]

    +

    Module Methods

    +

    []

    -

    ClearMagickWand

    -
    - -

    ClearMagickWand() clears resources associated with the wand.

    - -

    The format of the ClearMagickWand method is:

    - -
    -  void ClearMagickWand(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    CloneMagickWand

    -
    - -

    CloneMagickWand() makes an exact copy of the specified wand.

    - -

    The format of the CloneMagickWand method is:

    - -
    -  MagickWand *CloneMagickWand(const MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    DestroyMagickWand

    -
    - -

    DestroyMagickWand() deallocates memory associated with an MagickWand.

    - -

    The format of the DestroyMagickWand method is:

    - -
    -  MagickWand *DestroyMagickWand(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    IsMagickWand

    -
    - -

    IsMagickWand() returns MagickTrue if the wand is verified as a magick wand.

    - -

    The format of the IsMagickWand method is:

    - -
    -  MagickBooleanType IsMagickWand(const MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickClearException

    -
    - -

    MagickClearException() clears any exceptions associated with the wand.

    - -

    The format of the MagickClearException method is:

    - -
    -  MagickBooleanType MagickClearException(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetException

    -
    - -

    MagickGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.

    - -

    The format of the MagickGetException method is:

    - -
    -  char *MagickGetException(const MagickWand *wand,ExceptionType *severity)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    severity
    -

    the severity of the error is returned here.

    - -
    -

    MagickGetExceptionType

    -
    - -

    MagickGetExceptionType() returns the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.

    - -

    The format of the MagickGetExceptionType method is:

    - -
    -  ExceptionType MagickGetExceptionType(const MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickGetIteratorIndex

    -
    - -

    MagickGetIteratorIndex() returns the position of the iterator in the image list.

    - -

    The format of the MagickGetIteratorIndex method is:

    - -
    -  ssize_t MagickGetIteratorIndex(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickQueryConfigureOption

    -
    - -

    MagickQueryConfigureOption() returns the value associated with the specified configure option.

    - -

    The format of the MagickQueryConfigureOption function is:

    - -
    -  char *MagickQueryConfigureOption(const char *option)
-
    - -

    A description of each parameter follows:

    - -
    option
    -

    the option name.

    - -
    -

    MagickQueryConfigureOptions

    -
    - -

    MagickQueryConfigureOptions() returns any configure options that match the specified pattern (e.g. "*" for all). Options include NAME, VERSION, LIB_VERSION, etc.

    - -

    The format of the MagickQueryConfigureOptions function is:

    - -
    -  char **MagickQueryConfigureOptions(const char *pattern,
-    size_t *number_options)
-
    - -

    A description of each parameter follows:

    - -
    pattern
    -

    Specifies a pointer to a text string containing a pattern.

    - -
    number_options
    -

    Returns the number of configure options in the list.

    - - -
    -

    MagickQueryFontMetrics

    -
    - -

    MagickQueryFontMetrics() returns a 13 element array representing the following font metrics:

    - -
    -      Element Description
-      -------------------------------------------------
-      0 character width
-      1 character height
-      2 ascender
-      3 descender
-      4 text width
-      5 text height
-      6 maximum horizontal advance
-      7 bounding box: x1
-      8 bounding box: y1
-      9 bounding box: x2
-     10 bounding box: y2
-     11 origin: x
-     12 origin: y
-
    - -

    The format of the MagickQueryFontMetrics method is:

    - -
    -  double *MagickQueryFontMetrics(MagickWand *wand,
-    const DrawingWand *drawing_wand,const char *text)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the Magick wand.

    - -
    drawing_wand
    -

    the drawing wand.

    - -
    text
    -

    the text.

    - -
    -

    MagickQueryMultilineFontMetrics

    -
    - -

    MagickQueryMultilineFontMetrics() returns a 13 element array representing the following font metrics:

    - -
    -      Element Description
-      -------------------------------------------------
-      0 character width
-      1 character height
-      2 ascender
-      3 descender
-      4 text width
-      5 text height
-      6 maximum horizontal advance
-      7 bounding box: x1
-      8 bounding box: y1
-      9 bounding box: x2
-     10 bounding box: y2
-     11 origin: x
-     12 origin: y
-
    - -

    This method is like MagickQueryFontMetrics() but it returns the maximum text width and height for multiple lines of text.

    - -

    The format of the MagickQueryFontMetrics method is:

    - -
    -  double *MagickQueryMultilineFontMetrics(MagickWand *wand,
-    const DrawingWand *drawing_wand,const char *text)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the Magick wand.

    - -
    drawing_wand
    -

    the drawing wand.

    - -
    text
    -

    the text.

    - -
    -

    MagickQueryFonts

    -
    - -

    MagickQueryFonts() returns any font that match the specified pattern (e.g. "*" for all).

    - -

    The format of the MagickQueryFonts function is:

    - -
    -  char **MagickQueryFonts(const char *pattern,size_t *number_fonts)
-
    - -

    A description of each parameter follows:

    - -
    pattern
    -

    Specifies a pointer to a text string containing a pattern.

    - -
    number_fonts
    -

    Returns the number of fonts in the list.

    - - -
    -

    MagickQueryFonts

    -
    - -

    MagickQueryFonts() returns any image formats that match the specified pattern (e.g. "*" for all).

    - -

    The format of the MagickQueryFonts function is:

    - -
    -  char **MagickQueryFonts(const char *pattern,
-    size_t *number_formats)
-
    - -

    A description of each parameter follows:

    - -
    pattern
    -

    Specifies a pointer to a text string containing a pattern.

    - -
    number_formats
    -

    This integer returns the number of image formats in the list.

    - -
    -

    MagickRelinquishMemory

    -
    - -

    MagickRelinquishMemory() relinquishes memory resources returned by such methods as MagickIdentifyImage(), MagickGetException(), etc.

    - -

    The format of the MagickRelinquishMemory method is:

    - -
    -  void *MagickRelinquishMemory(void *resource)
-
    - -

    A description of each parameter follows:

    - -
    resource
    -

    Relinquish the memory associated with this resource.

    - -
    -

    MagickResetIterator

    -
    - -

    MagickResetIterator() resets the wand iterator. Use it in conjunction with MagickNextImage() to iterate over all the images in a wand container.

    - -

    The format of the MagickResetIterator method is:

    - -
    -  void MagickResetIterator(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickSetFirstIterator

    -
    - -

    MagickSetFirstIterator() sets the wand iterator to the first image.

    - -

    The format of the MagickSetFirstIterator method is:

    - -
    -  void MagickSetFirstIterator(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickSetIteratorIndex

    -
    - -

    MagickSetIteratorIndex() set the iterator to the position in the image list specified with the index parameter.

    - -

    The format of the MagickSetIteratorIndex method is:

    - -
    -  MagickBooleanType MagickSetIteratorIndex(MagickWand *wand,
-    const ssize_t index)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    index
    -

    the scene number.

    - -
    -

    MagickSetLastIterator

    -
    - -

    MagickSetLastIterator() sets the wand iterator to the last image.

    - -

    The format of the MagickSetLastIterator method is:

    - -
    -  void MagickSetLastIterator(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    MagickWandGenesis

    -
    - -

    MagickWandGenesis() initializes the MagickWand environment.

    - -

    The format of the MagickWandGenesis method is:

    - -
    -  void MagickWandGenesis(void)
-
    - -
    -

    MagickWandTerminus

    -
    - -

    MagickWandTerminus() terminates the MagickWand environment.

    - -

    The format of the MaickWandTerminus method is:

    - -
    -  void MagickWandTerminus(void)
-
    - -
    -

    NewMagickWand

    -
    - -

    NewMagickWand() returns a wand required for all other methods in the API.

    - -

    The format of the NewMagickWand method is:

    - -
    -  MagickWand *NewMagickWand(void)
-
    - -
    -

    NewMagickWandFromImage

    -
    - -

    NewMagickWandFromImage() returns a wand with an image.

    - -

    The format of the NewMagickWandFromImage method is:

    - -
    -  MagickWand *NewMagickWandFromImage(const Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    diff --git a/www/api/magick.html b/www/api/magick.html index 5f2d0e632..54f1e3077 100644 --- a/www/api/magick.html +++ b/www/api/magick.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,89 +190,9 @@
    -

    Module magick - Methods

    -

    [GetMagickPrecision • IsMagickInstantiated • MagickCoreGenesis • MagickCoreTerminus • SetMagickPrecision]

    +

    Module Methods

    +

    []

    -

    GetMagickPrecision

    -
    - -

    GetMagickPrecision() returns the maximum number of significant digits to be printed.

    - -

    The format of the GetMagickPrecision method is:

    - -
    -  int GetMagickPrecision(void)
-
    - -
    -

    IsMagickInstantiated

    -
    - -

    IsMagickInstantiated() returns MagickTrue if the ImageMagick environment is currently instantiated: MagickCoreGenesis() has been called but MagickDestroy() has not.

    - -

    The format of the IsMagickInstantiated method is:

    - -
    -  MagickBooleanType IsMagickInstantiated(void)
-
    - -
    -

    MagickCoreGenesis

    -
    - -

    MagickCoreGenesis() initializes the MagickCore environment.

    - -

    The format of the MagickCoreGenesis function is:

    - -
    -  MagickCoreGenesis(const char *path,
-    const MagickBooleanType establish_signal_handlers)
-
    - -

    A description of each parameter follows:

    - -
    path
    -

    the execution path of the current ImageMagick client.

    - -
    establish_signal_handlers
    -

    set to MagickTrue to use MagickCore's own signal handlers for common signals.

    - -
    -

    MagickCoreTerminus

    -
    - -

    MagickCoreTerminus() destroys the MagickCore environment.

    - -

    The format of the MagickCoreTerminus function is:

    - -
    -  MagickCoreTerminus(void)
-
    - -
    -

    SetMagickPrecision

    -
    - -

    SetMagickPrecision() sets the maximum number of significant digits to be printed and returns it.

    - -

    The format of the SetMagickPrecision method is:

    - -
    -  int SetMagickPrecision(const int precision)
-
    - -

    A description of each parameter follows:

    - -
    precision
    -

    set the maximum number of significant digits to be printed.

    - -
    diff --git a/www/api/memory.html b/www/api/memory.html index ffce79299..4700faa4b 100644 --- a/www/api/memory.html +++ b/www/api/memory.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,253 +190,9 @@
    -

    Module memory - Methods

    -

    [AcquireAlignedMemory • AcquireMagickMemory • AcquireQuantumMemory • CopyMagickMemory • GetMagickMemoryMethods • RelinquishAlignedMemory • RelinquishMagickMemory • ResetMagickMemory • ResizeMagickMemory • ResizeQuantumMemory • SetMagickMemoryMethods]

    +

    Module Methods

    +

    []

    -

    AcquireAlignedMemory

    -
    - -

    AcquireAlignedMemory() returns a pointer to a block of memory at least size bytes whose address is a multiple of 16*sizeof(void *).

    - -

    The format of the AcquireAlignedMemory method is:

    - -
    -  void *AcquireAlignedMemory(const size_t count,const size_t quantum)
-
    - -

    A description of each parameter follows:

    - -
    count
    -

    the number of quantum elements to allocate.

    - -
    quantum
    -

    the number of bytes in each quantum.

    - -
    -

    AcquireMagickMemory

    -
    - -

    AcquireMagickMemory() returns a pointer to a block of memory at least size bytes suitably aligned for any use.

    - -

    The format of the AcquireMagickMemory method is:

    - -
    -  void *AcquireMagickMemory(const size_t size)
-
    - -

    A description of each parameter follows:

    - -
    size
    -

    the size of the memory in bytes to allocate.

    - -
    -

    AcquireQuantumMemory

    -
    - -

    AcquireQuantumMemory() returns a pointer to a block of memory at least count * quantum bytes suitably aligned for any use.

    - -

    The format of the AcquireQuantumMemory method is:

    - -
    -  void *AcquireQuantumMemory(const size_t count,const size_t quantum)
-
    - -

    A description of each parameter follows:

    - -
    count
    -

    the number of quantum elements to allocate.

    - -
    quantum
    -

    the number of bytes in each quantum.

    - -
    -

    CopyMagickMemory

    -
    - -

    CopyMagickMemory() copies size bytes from memory area source to the destination. Copying between objects that overlap will take place correctly. It returns destination.

    - -

    The format of the CopyMagickMemory method is:

    - -
    -  void *CopyMagickMemory(void *destination,const void *source,
-    const size_t size)
-
    - -

    A description of each parameter follows:

    - -
    destination
    -

    the destination.

    - -
    source
    -

    the source.

    - -
    size
    -

    the size of the memory in bytes to allocate.

    - -
    -

    GetMagickMemoryMethods

    -
    - -

    GetMagickMemoryMethods() gets the methods to acquire, resize, and destroy memory.

    - -

    The format of the GetMagickMemoryMethods() method is:

    - -
    -  void GetMagickMemoryMethods(AcquireMemoryHandler *acquire_memory_handler,
-    ResizeMemoryHandler *resize_memory_handler,
-    DestroyMemoryHandler *destroy_memory_handler)
-
    - -

    A description of each parameter follows:

    - -
    acquire_memory_handler
    -

    method to acquire memory (e.g. malloc).

    - -
    resize_memory_handler
    -

    method to resize memory (e.g. realloc).

    - -
    destroy_memory_handler
    -

    method to destroy memory (e.g. free).

    - -
    -

    RelinquishAlignedMemory

    -
    - -

    RelinquishAlignedMemory() frees memory acquired with AcquireAlignedMemory() or reuse.

    - -

    The format of the RelinquishAlignedMemory method is:

    - -
    -  void *RelinquishAlignedMemory(void *memory)
-
    - -

    A description of each parameter follows:

    - -
    memory
    -

    A pointer to a block of memory to free for reuse.

    - -
    -

    RelinquishMagickMemory

    -
    - -

    RelinquishMagickMemory() frees memory acquired with AcquireMagickMemory() or AcquireQuantumMemory() for reuse.

    - -

    The format of the RelinquishMagickMemory method is:

    - -
    -  void *RelinquishMagickMemory(void *memory)
-
    - -

    A description of each parameter follows:

    - -
    memory
    -

    A pointer to a block of memory to free for reuse.

    - -
    -

    ResetMagickMemory

    -
    - -

    ResetMagickMemory() fills the first size bytes of the memory area pointed to by memory with the constant byte c.

    - -

    The format of the ResetMagickMemory method is:

    - -
    -  void *ResetMagickMemory(void *memory,int byte,const size_t size)
-
    - -

    A description of each parameter follows:

    - -
    memory
    -

    A pointer to a memory allocation.

    - -
    byte
    -

    Set the memory to this value.

    - -
    size
    -

    Size of the memory to reset.

    - -
    -

    ResizeMagickMemory

    -
    - -

    ResizeMagickMemory() changes the size of the memory and returns a pointer to the (possibly moved) block. The contents will be unchanged up to the lesser of the new and old sizes.

    - -

    The format of the ResizeMagickMemory method is:

    - -
    -  void *ResizeMagickMemory(void *memory,const size_t size)
-
    - -

    A description of each parameter follows:

    - -
    memory
    -

    A pointer to a memory allocation.

    - -
    size
    -

    the new size of the allocated memory.

    - -
    -

    ResizeQuantumMemory

    -
    - -

    ResizeQuantumMemory() changes the size of the memory and returns a pointer to the (possibly moved) block. The contents will be unchanged up to the lesser of the new and old sizes.

    - -

    The format of the ResizeQuantumMemory method is:

    - -
    -  void *ResizeQuantumMemory(void *memory,const size_t count,
-    const size_t quantum)
-
    - -

    A description of each parameter follows:

    - -
    memory
    -

    A pointer to a memory allocation.

    - -
    count
    -

    the number of quantum elements to allocate.

    - -
    quantum
    -

    the number of bytes in each quantum.

    - -
    -

    SetMagickMemoryMethods

    -
    - -

    SetMagickMemoryMethods() sets the methods to acquire, resize, and destroy memory.

    - -

    The format of the SetMagickMemoryMethods() method is:

    - -
    -  SetMagickMemoryMethods(AcquireMemoryHandler acquire_memory_handler,
-    ResizeMemoryHandler resize_memory_handler,
-    DestroyMemoryHandler destroy_memory_handler)
-
    - -

    A description of each parameter follows:

    - -
    acquire_memory_handler
    -

    method to acquire memory (e.g. malloc).

    - -
    resize_memory_handler
    -

    method to resize memory (e.g. realloc).

    - -
    destroy_memory_handler
    -

    method to destroy memory (e.g. free).

    - -
    diff --git a/www/api/module.html b/www/api/module.html index 0bf0263ab..2c38240e8 100644 --- a/www/api/module.html +++ b/www/api/module.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,368 +190,9 @@
    -

    Module module - Methods

    -

    [AcquireModuleInfo • DestroyModuleList • GetModuleInfo • GetModuleInfoList • GetModuleList • GetMagickModulePath • InitializeModuleList • InvokeDynamicImageFilter • ListModuleInfo • OpenModule • OpenModules • RegisterModule • TagToCoderModuleName • TagToFilterModuleName • TagToModuleName • UnregisterModule]

    +

    Module Methods

    +

    []

    -

    AcquireModuleInfo

    -
    - -

    AcquireModuleInfo() allocates the ModuleInfo structure.

    - -

    The format of the AcquireModuleInfo method is:

    - -
    -  ModuleInfo *AcquireModuleInfo(const char *path,const char *tag)
-
    - -

    A description of each parameter follows:

    - -
    path
    -

    the path associated with the tag.

    - -
    tag
    -

    a character string that represents the image format we are looking for.

    - -
    -

    DestroyModuleList

    -
    - -

    DestroyModuleList() unregisters any previously loaded modules and exits the module loaded environment.

    - -

    The format of the DestroyModuleList module is:

    - -
    -  void DestroyModuleList(void)
-
    - -
    -

    GetModuleInfo

    -
    - -

    GetModuleInfo() returns a pointer to a ModuleInfo structure that matches the specified tag. If tag is NULL, the head of the module list is returned. If no modules are loaded, or the requested module is not found, NULL is returned.

    - -

    The format of the GetModuleInfo module is:

    - -
    -  ModuleInfo *GetModuleInfo(const char *tag,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    tag
    -

    a character string that represents the image format we are looking for.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    GetModuleInfoList

    -
    - -

    GetModuleInfoList() returns any modules that match the specified pattern.

    - -

    The format of the GetModuleInfoList function is:

    - -
    -  const ModuleInfo **GetModuleInfoList(const char *pattern,
-    size_t *number_modules,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    pattern
    -

    Specifies a pointer to a text string containing a pattern.

    - -
    number_modules
    -

    This integer returns the number of modules in the list.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    GetModuleList

    -
    - -

    GetModuleList() returns any image format modules that match the specified pattern.

    - -

    The format of the GetModuleList function is:

    - -
    -  char **GetModuleList(const char *pattern,const MagickModuleType type,
-    size_t *number_modules,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    pattern
    -

    Specifies a pointer to a text string containing a pattern.

    - -
    type
    -

    choose from MagickImageCoderModule or MagickImageFilterModule.

    - -
    number_modules
    -

    This integer returns the number of modules in the list.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    GetMagickModulePath

    -
    - -

    GetMagickModulePath() finds a module with the specified module type and filename.

    - -

    The format of the GetMagickModulePath module is:

    - -
    -  MagickBooleanType GetMagickModulePath(const char *filename,
-    MagickModuleType module_type,char *path,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    filename
    -

    the module file name.

    - -
    module_type
    -

    the module type: MagickImageCoderModule or MagickImageFilterModule.

    - -
    path
    -

    the path associated with the filename.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    InitializeModuleList

    -
    - -

    InitializeModuleList() initializes the module loader.

    - -

    The format of the InitializeModuleList() method is:

    - -
    -  InitializeModuleList(Exceptioninfo *exception)
-
    - -

    A description of each parameter follows.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    InvokeDynamicImageFilter

    -
    - -

    InvokeDynamicImageFilter() invokes a dynamic image filter.

    - -

    The format of the InvokeDynamicImageFilter module is:

    - -
    -  MagickBooleanType InvokeDynamicImageFilter(const char *tag,Image **image,
-    const int argc,const char **argv,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    tag
    -

    a character string that represents the name of the particular module.

    - -
    image
    -

    the image.

    - -
    argc
    -

    a pointer to an integer describing the number of elements in the argument vector.

    - -
    argv
    -

    a pointer to a text array containing the command line arguments.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ListModuleInfo

    -
    - -

    ListModuleInfo() lists the module info to a file.

    - -

    The format of the ListModuleInfo module is:

    - -
    -  MagickBooleanType ListModuleInfo(FILE *file,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows.

    - -
    file
    -

    An pointer to a FILE.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    OpenModule

    -
    - -

    OpenModule() loads a module, and invokes its registration module. It returns MagickTrue on success, and MagickFalse if there is an error.

    - -

    The format of the OpenModule module is:

    - -
    -  MagickBooleanType OpenModule(const char *module,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    module
    -

    a character string that indicates the module to load.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    OpenModules

    -
    - -

    OpenModules() loads all available modules.

    - -

    The format of the OpenModules module is:

    - -
    -  MagickBooleanType OpenModules(ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    RegisterModule

    -
    - -

    RegisterModule() adds an entry to the module list. It returns a pointer to the registered entry on success.

    - -

    The format of the RegisterModule module is:

    - -
    -  ModuleInfo *RegisterModule(const ModuleInfo *module_info,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    info
    -

    a pointer to the registered entry is returned.

    - -
    module_info
    -

    a pointer to the ModuleInfo structure to register.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    TagToCoderModuleName

    -
    - -

    TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module.

    - -

    The format of the TagToCoderModuleName module is:

    - -
    -  char *TagToCoderModuleName(const char *tag,char *name)
-
    - -

    A description of each parameter follows:

    - -
    tag
    -

    a character string representing the module tag.

    - -
    name
    -

    return the module name here.

    - -
    -

    TagToFilterModuleName

    -
    - -

    TagToFilterModuleName() munges a module tag and returns the filename of the corresponding filter module.

    - -

    The format of the TagToFilterModuleName module is:

    - -
    -  void TagToFilterModuleName(const char *tag,char name)
-
    - -

    A description of each parameter follows:

    - -
    tag
    -

    a character string representing the module tag.

    - -
    name
    -

    return the filter name here.

    - -
    -

    TagToModuleName

    -
    - -

    TagToModuleName() munges the module tag name and returns an upper-case tag name as the input string, and a user-provided format.

    - -

    The format of the TagToModuleName module is:

    - -
    -  TagToModuleName(const char *tag,const char *format,char *module)
-
    - -

    A description of each parameter follows:

    - -
    tag
    -

    the module tag.

    - -
    format
    -

    a sprintf-compatible format string containing s where the upper-case tag name is to be inserted.

    - -
    module
    -

    pointer to a destination buffer for the formatted result.

    - -
    -

    UnregisterModule

    -
    - -

    UnregisterModule() unloads a module, and invokes its de-registration module. Returns MagickTrue on success, and MagickFalse if there is an error.

    - -

    The format of the UnregisterModule module is:

    - -
    -  MagickBooleanType UnregisterModule(const ModuleInfo *module_info,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    module_info
    -

    the module info.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/mogrify.html b/www/api/mogrify.html index 18ef8d2f3..b8c7706e6 100644 --- a/www/api/mogrify.html +++ b/www/api/mogrify.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,45 +190,9 @@
    -

    Module mogrify - Methods

    -

    [MagickCommandGenesis]

    +

    Module Methods

    +

    []

    -

    MagickCommandGenesis

    -
    - -

    MagickCommandGenesis() applies image processing options to an image as prescribed by command line options.

    - -

    The format of the MagickCommandGenesis method is:

    - -
    -  MagickBooleanType MagickCommandGenesis(ImageInfo *image_info,
-    MagickCommand command,int argc,char **argv,char **metadata,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    command
    -

    Choose from ConvertImageCommand, IdentifyImageCommand, MogrifyImageCommand, CompositeImageCommand, CompareImageCommand, ConjureImageCommand, StreamImageCommand, ImportImageCommand, DisplayImageCommand, or AnimateImageCommand.

    - -
    argc
    -

    Specifies a pointer to an integer describing the number of elements in the argument vector.

    - -
    argv
    -

    Specifies a pointer to a text array containing the command line arguments.

    - -
    metadata
    -

    any metadata is returned here.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/monitor.html b/www/api/monitor.html index 3a847605f..79596b9ae 100644 --- a/www/api/monitor.html +++ b/www/api/monitor.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,76 +190,9 @@
    -

    Module monitor - Methods

    -

    [SetImageProgressMonitor • SetImageInfoProgressMonitor]

    +

    Module Methods

    +

    []

    -

    SetImageProgressMonitor

    -
    - -

    SetImageProgressMonitor() sets the image progress monitor to the specified method and returns the previous progress monitor if any. The progress monitor method looks like this:

    - -
    -      MagickBooleanType MagickProgressMonitor(const char *text,
-  const MagickOffsetType offset,const MagickSizeType extent,
-  void *client_data)
-
    - -

    If the progress monitor returns MagickFalse, the current operation is interrupted.

    - -

    The format of the SetImageProgressMonitor method is:

    - -
    -  MagickProgressMonitor SetImageProgressMonitor(Image *image,
-    const MagickProgressMonitor progress_monitor,void *client_data)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    progress_monitor
    -

    Specifies a pointer to a method to monitor progress of an image operation.

    - -
    client_data
    -

    Specifies a pointer to any client data.

    - -
    -

    SetImageInfoProgressMonitor

    -
    - -

    SetImageInfoProgressMonitor() sets the image_info progress monitor to the specified method and returns the previous progress monitor if any. The progress monitor method looks like this:

    - -
    -      MagickBooleanType MagickProgressMonitor(const char *text,
-  const MagickOffsetType offset,const MagickSizeType extent,
-  void *client_data)
-
    - -

    If the progress monitor returns MagickFalse, the current operation is interrupted.

    - -

    The format of the SetImageInfoProgressMonitor method is:

    - -
    -  MagickProgressMonitor SetImageInfoProgressMonitor(ImageInfo *image_info,
-    const MagickProgressMonitor progress_monitor,void *client_data)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    progress_monitor
    -

    Specifies a pointer to a method to monitor progress of an image operation.

    - -
    client_data
    -

    Specifies a pointer to any client data.

    - -
    diff --git a/www/api/montage.html b/www/api/montage.html index 5186cae3a..4330ca0e9 100644 --- a/www/api/montage.html +++ b/www/api/montage.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,102 +190,9 @@
    -

    Module montage - Methods

    -

    [CloneMontageInfo • DestroyMontageInfo • GetMontageInfo • MontageImageList]

    +

    Module Methods

    +

    []

    -

    CloneMontageInfo

    -
    - -

    CloneMontageInfo() makes a copy of the given montage info structure. If NULL is specified, a new image info structure is created initialized to default values.

    - -

    The format of the CloneMontageInfo method is:

    - -
    -  MontageInfo *CloneMontageInfo(const ImageInfo *image_info,
-    const MontageInfo *montage_info)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    montage_info
    -

    the montage info.

    - -
    -

    DestroyMontageInfo

    -
    - -

    DestroyMontageInfo() deallocates memory associated with montage_info.

    - -

    The format of the DestroyMontageInfo method is:

    - -
    -  MontageInfo *DestroyMontageInfo(MontageInfo *montage_info)
-
    - -

    A description of each parameter follows:

    - -
    montage_info
    -

    Specifies a pointer to an MontageInfo structure.

    - - -
    -

    GetMontageInfo

    -
    - -

    GetMontageInfo() initializes montage_info to default values.

    - -

    The format of the GetMontageInfo method is:

    - -
    -  void GetMontageInfo(const ImageInfo *image_info,
-    MontageInfo *montage_info)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    a structure of type ImageInfo.

    - -
    montage_info
    -

    Specifies a pointer to a MontageInfo structure.

    - -
    -

    MontageImageList

    -
    - -

    MontageImageList() is a layout manager that lets you tile one or more thumbnails across an image canvas.

    - -

    The format of the MontageImageList method is:

    - -
    -  Image *MontageImageList(const ImageInfo *image_info,
-    const MontageInfo *montage_info,Image *images,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    montage_info
    -

    Specifies a pointer to a MontageInfo structure.

    - -
    images
    -

    Specifies a pointer to an array of Image structures.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/morphology.html b/www/api/morphology.html index febb9e04b..3d8c26525 100644 --- a/www/api/morphology.html +++ b/www/api/morphology.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,491 +190,9 @@
    -

    Module morphology - Methods

    -

    [** This macro IsNaN • AcquireKernelInfo • AcquireKernelBuiltIn • CloneKernelInfo • DestroyKernelInfo • MorphologyApply • MorphologyImageChannel • ScaleGeometryKernelInfo • ScaleKernelInfo • ShowKernelInfo • UnityAddKernelInfo • ZeroKernelNans]

    +

    Module Methods

    +

    []

    -

    ** This macro IsNaN

    -
    - -

    ** This macro IsNaN() is thus is only true if the value given is NaN.

    -
    -

    AcquireKernelInfo

    -
    - -

    AcquireKernelInfo() takes the given string (generally supplied by the user) and converts it into a Morphology/Convolution Kernel. This allows users to specify a kernel from a number of pre-defined kernels, or to fully specify their own kernel for a specific Convolution or Morphology Operation.

    - -

    The kernel so generated can be any rectangular array of floating point values (doubles) with the 'control point' or 'pixel being affected' anywhere within that array of values.

    - -

    Previously IM was restricted to a square of odd size using the exact center as origin, this is no longer the case, and any rectangular kernel with any value being declared the origin. This in turn allows the use of highly asymmetrical kernels.

    - -

    The floating point values in the kernel can also include a special value known as 'nan' or 'not a number' to indicate that this value is not part of the kernel array. This allows you to shaped the kernel within its rectangular area. That is 'nan' values provide a 'mask' for the kernel shape. However at least one non-nan value must be provided for correct working of a kernel.

    - -

    The returned kernel should be freed using the DestroyKernelInfo() when you are finished with it. Do not free this memory yourself.

    - -

    Input kernel defintion strings can consist of any of three types.

    - -

    "name:args[[@><]" Select from one of the built in kernels, using the name and geometry arguments supplied. See AcquireKernelBuiltIn()

    - -

    "WxH[+X+Y][@><]:num, num, num ..." a kernel of size W by H, with W*H floating point numbers following. the 'center' can be optionally be defined at +X+Y (such that +0+0 is top left corner). If not defined the pixel in the center, for odd sizes, or to the immediate top or left of center for even sizes is automatically selected.

    - -

    "num, num, num, num, ..." list of floating point numbers defining an 'old style' odd sized square kernel. At least 9 values should be provided for a 3x3 square kernel, 25 for a 5x5 square kernel, 49 for 7x7, etc. Values can be space or comma separated. This is not recommended.

    - -

    You can define a 'list of kernels' which can be used by some morphology operators A list is defined as a semi-colon seperated list kernels.

    - -

    " kernel ; kernel ; kernel ; "

    - -

    Any extra ';' characters, at start, end or between kernel defintions are simply ignored.

    - -

    The special flags will expand a single kernel, into a list of rotated kernels. A '@' flag will expand a 3x3 kernel into a list of 45-degree cyclic rotations, while a '>' will generate a list of 90-degree rotations. The '<' also exands using 90-degree rotates, but giving a 180-degree reflected kernel before the +/- 90-degree rotations, which can be important for Thinning operations.

    - -

    Note that 'name' kernels will start with an alphabetic character while the new kernel specification has a ':' character in its specification string. If neither is the case, it is assumed an old style of a simple list of numbers generating a odd-sized square kernel has been given.

    - -

    The format of the AcquireKernal method is:

    - -
    -  KernelInfo *AcquireKernelInfo(const char *kernel_string)
-
    - -

    A description of each parameter follows:

    - -
    kernel_string
    -

    the Morphology/Convolution kernel wanted.

    - -
    -

    AcquireKernelBuiltIn

    -
    - -

    AcquireKernelBuiltIn() returned one of the 'named' built-in types of kernels used for special purposes such as gaussian blurring, skeleton pruning, and edge distance determination.

    - -

    They take a KernelType, and a set of geometry style arguments, which were typically decoded from a user supplied string, or from a more complex Morphology Method that was requested.

    - -

    The format of the AcquireKernalBuiltIn method is:

    - -
    -  KernelInfo *AcquireKernelBuiltIn(const KernelInfoType type,
-       const GeometryInfo args)
-
    - -

    A description of each parameter follows:

    - -
    type
    -

    the pre-defined type of kernel wanted

    - -
    args
    -

    arguments defining or modifying the kernel

    - -

    Convolution Kernels

    - -

    Unity the No-Op kernel, also requivelent to Gaussian of sigma zero. Basically a 3x3 kernel of a 1 surrounded by zeros.

    - -

    Gaussian:{radius},{sigma} Generate a two-dimentional gaussian kernel, as used by -gaussian. The sigma for the curve is required. The resulting kernel is normalized,

    - -

    If 'sigma' is zero, you get a single pixel on a field of zeros.

    - -

    NOTE: that the 'radius' is optional, but if provided can limit (clip) the final size of the resulting kernel to a square 2*radius+1 in size. The radius should be at least 2 times that of the sigma value, or sever clipping and aliasing may result. If not given or set to 0 the radius will be determined so as to produce the best minimal error result, which is usally much larger than is normally needed.

    - -

    LoG:{radius},{sigma} "Laplacian of a Gaussian" or "Mexician Hat" Kernel. The supposed ideal edge detection, zero-summing kernel.

    - -

    An alturnative to this kernel is to use a "DoG" with a sigma ratio of approx 1.6 (according to wikipedia).

    - -

    DoG:{radius},{sigma1},{sigma2} "Difference of Gaussians" Kernel. As "Gaussian" but with a gaussian produced by 'sigma2' subtracted from the gaussian produced by 'sigma1'. Typically sigma2 > sigma1. The result is a zero-summing kernel.

    - -

    Blur:{radius},{sigma}[,{angle}] Generates a 1 dimensional or linear gaussian blur, at the angle given (current restricted to orthogonal angles). If a 'radius' is given the kernel is clipped to a width of 2*radius+1. Kernel can be rotated by a 90 degree angle.

    - -

    If 'sigma' is zero, you get a single pixel on a field of zeros.

    - -

    Note that two convolutions with two "Blur" kernels perpendicular to each other, is equivelent to a far larger "Gaussian" kernel with the same sigma value, However it is much faster to apply. This is how the "-blur" operator actually works.

    - -

    Comet:{width},{sigma},{angle} Blur in one direction only, much like how a bright object leaves a comet like trail. The Kernel is actually half a gaussian curve, Adding two such blurs in opposite directions produces a Blur Kernel. Angle can be rotated in multiples of 90 degrees.

    - -

    Note that the first argument is the width of the kernel and not the radius of the kernel.

    - -

    # Still to be implemented... # # Filter2D # Filter1D # Set kernel values using a resize filter, and given scale (sigma) # Cylindrical or Linear. Is this posible with an image? #

    - -

    Named Constant Convolution Kernels

    - -

    All these are unscaled, zero-summing kernels by default. As such for non-HDRI version of ImageMagick some form of normalization, user scaling, and biasing the results is recommended, to prevent the resulting image being 'clipped'.

    - -

    The 3x3 kernels (most of these) can be circularly rotated in multiples of 45 degrees to generate the 8 angled varients of each of the kernels.

    - -

    Laplacian:{type} Discrete Lapacian Kernels, (without normalization) Type 0 : 3x3 with center:8 surounded by -1 (8 neighbourhood) Type 1 : 3x3 with center:4 edge:-1 corner:0 (4 neighbourhood) Type 2 : 3x3 with center:4 edge:1 corner:-2 Type 3 : 3x3 with center:4 edge:-2 corner:1 Type 5 : 5x5 laplacian Type 7 : 7x7 laplacian Type 15 : 5x5 LoG (sigma approx 1.4) Type 19 : 9x9 LoG (sigma approx 1.4)

    - -

    Sobel:{angle} Sobel 'Edge' convolution kernel (3x3) | -1, 0, 1 | | -2, 0,-2 | | -1, 0, 1 |

    - -

    Sobel:{type},{angle} Type 0: default un-nomalized version shown above.

    - -

    Type 1: As default but pre-normalized | 1, 0, -1 | | 2, 0, -2 | / 4 | 1, 0, -1 |

    - -

    Type 2: Diagonal version with same normalization as 1 | 1, 0, -1 | | 2, 0, -2 | / 4 | 1, 0, -1 |

    - -

    Roberts:{angle} Roberts convolution kernel (3x3) | 0, 0, 0 | | -1, 1, 0 | | 0, 0, 0 |

    - -

    Prewitt:{angle} Prewitt Edge convolution kernel (3x3) | -1, 0, 1 | | -1, 0, 1 | | -1, 0, 1 |

    - -

    Compass:{angle} Prewitt's "Compass" convolution kernel (3x3) | -1, 1, 1 | | -1,-2, 1 | | -1, 1, 1 |

    - -

    Kirsch:{angle} Kirsch's "Compass" convolution kernel (3x3) | -3,-3, 5 | | -3, 0, 5 | | -3,-3, 5 |

    - -

    FreiChen:{angle} Frei-Chen Edge Detector is based on a kernel that is similar to the Sobel Kernel, but is designed to be isotropic. That is it takes into account the distance of the diagonal in the kernel.

    - -

    | 1, 0, -1 | | sqrt(2), 0, -sqrt(2) | | 1, 0, -1 |

    - -

    FreiChen:{type},{angle}

    - -

    Frei-Chen Pre-weighted kernels...

    - -

    Type 0: default un-nomalized version shown above.

    - -

    Type 1: Orthogonal Kernel (same as type 11 below) | 1, 0, -1 | | sqrt(2), 0, -sqrt(2) | / 2*sqrt(2) | 1, 0, -1 |

    - -

    Type 2: Diagonal form of Kernel... | 1, sqrt(2), 0 | | sqrt(2), 0, -sqrt(2) | / 2*sqrt(2) | 0, -sqrt(2) -1 |

    - -

    However this kernel is als at the heart of the FreiChen Edge Detection Process which uses a set of 9 specially weighted kernel. These 9 kernels not be normalized, but directly applied to the image. The results is then added together, to produce the intensity of an edge in a specific direction. The square root of the pixel value can then be taken as the cosine of the edge, and at least 2 such runs at 90 degrees from each other, both the direction and the strength of the edge can be determined.

    - -

    Type 10: All 9 of the following pre-weighted kernels...

    - -

    Type 11: | 1, 0, -1 | | sqrt(2), 0, -sqrt(2) | / 2*sqrt(2) | 1, 0, -1 |

    - -

    Type 12: | 1, sqrt(2), 1 | | 0, 0, 0 | / 2*sqrt(2) | 1, sqrt(2), 1 |

    - -

    Type 13: | sqrt(2), -1, 0 | | -1, 0, 1 | / 2*sqrt(2) | 0, 1, -sqrt(2) |

    - -

    Type 14: | 0, 1, -sqrt(2) | | -1, 0, 1 | / 2*sqrt(2) | sqrt(2), -1, 0 |

    - -

    Type 15: | 0, -1, 0 | | 1, 0, 1 | / 2 | 0, -1, 0 |

    - -

    Type 16: | 1, 0, -1 | | 0, 0, 0 | / 2 | -1, 0, 1 |

    - -

    Type 17: | 1, -2, 1 | | -2, 4, -2 | / 6 | -1, -2, 1 |

    - -

    Type 18: | -2, 1, -2 | | 1, 4, 1 | / 6 | -2, 1, -2 |

    - -

    Type 19: | 1, 1, 1 | | 1, 1, 1 | / 3 | 1, 1, 1 |

    - -

    The first 4 are for edge detection, the next 4 are for line detection and the last is to add a average component to the results.

    - -

    Using a special type of '-1' will return all 9 pre-weighted kernels as a multi-kernel list, so that you can use them directly (without normalization) with the special "-set option:morphology:compose Plus" setting to apply the full FreiChen Edge Detection Technique.

    - -

    If 'type' is large it will be taken to be an actual rotation angle for the default FreiChen (type 0) kernel. As such FreiChen:45 will look like a Sobel:45 but with 'sqrt(2)' instead of '2' values.

    - -

    WARNING: The above was layed out as per http://www.math.tau.ac.il/~turkel/notes/edge_detectors.pdf But rotated 90 degrees so direction is from left rather than the top. I have yet to find any secondary confirmation of the above. The only other source found was actual source code at http://ltswww.epfl.ch/~courstiv/exos_labos/sol3.pdf Neigher paper defineds the kernels in a way that looks locical or correct when taken as a whole.

    - -

    Boolean Kernels

    - -

    Diamond:[{radius}[,{scale}]] Generate a diamond shaped kernel with given radius to the points. Kernel size will again be radius*2+1 square and defaults to radius 1, generating a 3x3 kernel that is slightly larger than a square.

    - -

    Square:[{radius}[,{scale}]] Generate a square shaped kernel of size radius*2+1, and defaulting to a 3x3 (radius 1).

    - -

    Note that using a larger radius for the "Square" or the "Diamond" is also equivelent to iterating the basic morphological method that many times. However iterating with the smaller radius is actually faster than using a larger kernel radius.

    - -

    Rectangle:{geometry} Simply generate a rectangle of 1's with the size given. You can also specify the location of the 'control point', otherwise the closest pixel to the center of the rectangle is selected.

    - -

    Properly centered and odd sized rectangles work the best.

    - -

    Disk:[{radius}[,{scale}]] Generate a binary disk of the radius given, radius may be a float. Kernel size will be ceil(radius)*2+1 square. NOTE: Here are some disk shapes of specific interest "Disk:1" => "diamond" or "cross:1" "Disk:1.5" => "square" "Disk:2" => "diamond:2" "Disk:2.5" => a general disk shape of radius 2 "Disk:2.9" => "square:2" "Disk:3.5" => default - octagonal/disk shape of radius 3 "Disk:4.2" => roughly octagonal shape of radius 4 "Disk:4.3" => a general disk shape of radius 4 After this all the kernel shape becomes more and more circular.

    - -

    Because a "disk" is more circular when using a larger radius, using a larger radius is preferred over iterating the morphological operation.

    - -

    Symbol Dilation Kernels

    - -

    These kernel is not a good general morphological kernel, but is used more for highlighting and marking any single pixels in an image using, a "Dilate" method as appropriate.

    - -

    For the same reasons iterating these kernels does not produce the same result as using a larger radius for the symbol.

    - -

    Plus:[{radius}[,{scale}]] Cross:[{radius}[,{scale}]] Generate a kernel in the shape of a 'plus' or a 'cross' with a each arm the length of the given radius (default 2).

    - -

    NOTE: "plus:1" is equivelent to a "Diamond" kernel.

    - -

    Ring:{radius1},{radius2}[,{scale}] A ring of the values given that falls between the two radii. Defaults to a ring of approximataly 3 radius in a 7x7 kernel. This is the 'edge' pixels of the default "Disk" kernel, More specifically, "Ring" -> "Ring:2.5,3.5,1.0"

    - -

    Hit and Miss Kernels

    - -

    Peak:radius1,radius2 Find any peak larger than the pixels the fall between the two radii. The default ring of pixels is as per "Ring". Edges Find flat orthogonal edges of a binary shape Corners Find 90 degree corners of a binary shape LineEnds:type Find end points of lines (for pruning a skeletion) Two types of lines ends (default to both) can be searched for Type 0: All line ends Type 1: single kernel for 4-conneected line ends Type 2: single kernel for simple line ends LineJunctions Find three line junctions (within a skeletion) Type 0: all line junctions Type 1: Y Junction kernel Type 2: Diagonal T Junction kernel Type 3: Orthogonal T Junction kernel Type 4: Diagonal X Junction kernel Type 5: Orthogonal + Junction kernel Ridges:type Find single pixel ridges or thin lines Type 1: Fine single pixel thick lines and ridges Type 2: Find two pixel thick lines and ridges ConvexHull Octagonal thicken kernel, to generate convex hulls of 45 degrees Skeleton:type Traditional skeleton generating kernels. Type 1: Tradional Skeleton kernel (4 connected skeleton) Type 2: HIPR2 Skeleton kernel (8 connected skeleton) Type 3: Experimental Variation to try to present left-right symmetry Type 4: Experimental Variation to preserve left-right symmetry

    - -

    Distance Measuring Kernels

    - -

    Different types of distance measuring methods, which are used with the a 'Distance' morphology method for generating a gradient based on distance from an edge of a binary shape, though there is a technique for handling a anti-aliased shape.

    - -

    See the 'Distance' Morphological Method, for information of how it is applied.

    - -

    Chebyshev:[{radius}][x{scale}[!]] Chebyshev Distance (also known as Tchebychev Distance) is a value of one to any neighbour, orthogonal or diagonal. One why of thinking of it is the number of squares a 'King' or 'Queen' in chess needs to traverse reach any other position on a chess board. It results in a 'square' like distance function, but one where diagonals are closer than expected.

    - -

    Manhattan:[{radius}][x{scale}[!]] Manhattan Distance (also known as Rectilinear Distance, or the Taxi Cab metric), is the distance needed when you can only travel in orthogonal (horizontal or vertical) only. It is the distance a 'Rook' in chess would travel. It results in a diamond like distances, where diagonals are further than expected.

    - -

    Euclidean:[{radius}][x{scale}[!]] Euclidean Distance is the 'direct' or 'as the crow flys distance. However by default the kernel size only has a radius of 1, which limits the distance to 'Knight' like moves, with only orthogonal and diagonal measurements being correct. As such for the default kernel you will get octagonal like distance function, which is reasonally accurate.

    - -

    However if you use a larger radius such as "Euclidean:4" you will get a much smoother distance gradient from the edge of the shape. Of course a larger kernel is slower to use, and generally not needed.

    - -

    To allow the use of fractional distances that you get with diagonals the actual distance is scaled by a fixed value which the user can provide. This is not actually nessary for either ""Chebyshev" or "Manhattan" distance kernels, but is done for all three distance kernels. If no scale is provided it is set to a value of 100, allowing for a maximum distance measurement of 655 pixels using a Q16 version of IM, from any edge. However for small images this can result in quite a dark gradient.

    - -
    -

    CloneKernelInfo

    -
    - -

    CloneKernelInfo() creates a new clone of the given Kernel List so that its can be modified without effecting the original. The cloned kernel should be destroyed using DestoryKernelInfo() when no longer needed.

    - -

    The format of the CloneKernelInfo method is:

    - -
    -  KernelInfo *CloneKernelInfo(const KernelInfo *kernel)
-
    - -

    A description of each parameter follows:

    - -
    kernel
    -

    the Morphology/Convolution kernel to be cloned

    - -
    -

    DestroyKernelInfo

    -
    - -

    DestroyKernelInfo() frees the memory used by a Convolution/Morphology kernel.

    - -

    The format of the DestroyKernelInfo method is:

    - -
    -  KernelInfo *DestroyKernelInfo(KernelInfo *kernel)
-
    - -

    A description of each parameter follows:

    - -
    kernel
    -

    the Morphology/Convolution kernel to be destroyed

    - -
    -

    MorphologyApply

    -
    - -

    MorphologyApply() applies a morphological method, multiple times using a list of multiple kernels.

    - -

    It is basically equivelent to as MorphologyImageChannel() (see below) but without any user controls. This allows internel programs to use this function, to actually perform a specific task without posible interference by any API user supplied settings.

    - -

    It is MorphologyImageChannel() task to extract any such user controls, and pass them to this function for processing.

    - -

    More specifically kernels are not normalized/scaled/blended by the 'convolve:scale' Image Artifact (setting), nor is the convolve bias (-bias setting or image->bias) loooked at, but must be supplied from the function arguments.

    - -

    The format of the MorphologyApply method is:

    - -
    -  Image *MorphologyApply(const Image *image,MorphologyMethod method,
-    const ssize_t iterations,const KernelInfo *kernel,
-    const CompositeMethod compose, const double bias,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the source image

    - -
    method
    -

    the morphology method to be applied.

    - -
    iterations
    -

    apply the operation this many times (or no change). A value of -1 means loop until no change found. How this is applied may depend on the morphology method. Typically this is a value of 1.

    - -
    channel
    -

    the channel type.

    - -
    kernel
    -

    An array of double representing the morphology kernel.

    - -
    compose
    -

    How to handle or merge multi-kernel results. If 'UndefinedCompositeOp' use default for the Morphology method. If 'NoCompositeOp' force image to be re-iterated by each kernel. Otherwise merge the results using the compose method given.

    - -
    bias
    -

    Convolution Output Bias.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    MorphologyImageChannel

    -
    - -

    MorphologyImageChannel() applies a user supplied kernel to the image according to the given mophology method.

    - -

    This function applies any and all user defined settings before calling the above internal function MorphologyApply().

    - -

    User defined settings include... * Output Bias for Convolution and correlation ("-bias") * Kernel Scale/normalize settings ("-set 'option:convolve:scale'") This can also includes the addition of a scaled unity kernel. * Show Kernel being applied ("-set option:showkernel 1")

    - -

    The format of the MorphologyImage method is:

    - -
    -  Image *MorphologyImage(const Image *image,MorphologyMethod method,
-    const ssize_t iterations,KernelInfo *kernel,ExceptionInfo *exception)
-
    - -

    Image *MorphologyImageChannel(const Image *image, const ChannelType channel,MorphologyMethod method,const ssize_t iterations, KernelInfo *kernel,ExceptionInfo *exception)

    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    method
    -

    the morphology method to be applied.

    - -
    iterations
    -

    apply the operation this many times (or no change). A value of -1 means loop until no change found. How this is applied may depend on the morphology method. Typically this is a value of 1.

    - -
    channel
    -

    the channel type.

    - -
    kernel
    -

    An array of double representing the morphology kernel. Warning: kernel may be normalized for the Convolve method.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ScaleGeometryKernelInfo

    -
    - -

    ScaleGeometryKernelInfo() takes a geometry argument string, typically provided as a "-set option:convolve:scale {geometry}" user setting, and modifies the kernel according to the parsed arguments of that setting.

    - -

    The first argument (and any normalization flags) are passed to ScaleKernelInfo() to scale/normalize the kernel. The second argument is then passed to UnityAddKernelInfo() to add a scled unity kernel into the scaled/normalized kernel.

    - -

    The format of the ScaleGeometryKernelInfo method is:

    - -
    -  void ScaleGeometryKernelInfo(KernelInfo *kernel,
-    const double scaling_factor,const MagickStatusType normalize_flags)
-
    - -

    A description of each parameter follows:

    - -
    kernel
    -

    the Morphology/Convolution kernel to modify

    - -

    o geometry:

    - -
    -         "-set option:convolve:scale {geometry}" setting.
-
    - -
    -

    ScaleKernelInfo

    -
    - -

    ScaleKernelInfo() scales the given kernel list by the given amount, with or without normalization of the sum of the kernel values (as per given flags).

    - -

    By default (no flags given) the values within the kernel is scaled directly using given scaling factor without change.

    - -

    If either of the two 'normalize_flags' are given the kernel will first be normalized and then further scaled by the scaling factor value given.

    - -

    Kernel normalization ('normalize_flags' given) is designed to ensure that any use of the kernel scaling factor with 'Convolve' or 'Correlate' morphology methods will fall into -1.0 to +1.0 range. Note that for non-HDRI versions of IM this may cause images to have any negative results clipped, unless some 'bias' is used.

    - -

    More specifically. Kernels which only contain positive values (such as a 'Gaussian' kernel) will be scaled so that those values sum to +1.0, ensuring a 0.0 to +1.0 output range for non-HDRI images.

    - -

    For Kernels that contain some negative values, (such as 'Sharpen' kernels) the kernel will be scaled by the absolute of the sum of kernel values, so that it will generally fall within the +/- 1.0 range.

    - -

    For kernels whose values sum to zero, (such as 'Laplician' kernels) kernel will be scaled by just the sum of the postive values, so that its output range will again fall into the +/- 1.0 range.

    - -

    For special kernels designed for locating shapes using 'Correlate', (often only containing +1 and -1 values, representing foreground/brackground matching) a special normalization method is provided to scale the positive values seperatally to those of the negative values, so the kernel will be forced to become a zero-sum kernel better suited to such searches.

    - -

    WARNING: Correct normalization of the kernel assumes that the '*_range' attributes within the kernel structure have been correctly set during the kernels creation.

    - -

    NOTE: The values used for 'normalize_flags' have been selected specifically to match the use of geometry options, so that '!' means NormalizeValue, '^' means CorrelateNormalizeValue. All other GeometryFlags values are ignored.

    - -

    The format of the ScaleKernelInfo method is:

    - -
    -  void ScaleKernelInfo(KernelInfo *kernel, const double scaling_factor,
-           const MagickStatusType normalize_flags )
-
    - -

    A description of each parameter follows:

    - -
    kernel
    -

    the Morphology/Convolution kernel

    - -

    o scaling_factor:

    - -
    -         zero.  If the kernel is normalized regardless of any flags.
-
    - -

    o normalize_flags:

    - -
    -         specifically: NormalizeValue, CorrelateNormalizeValue,
-                       and/or PercentValue
-
    - -
    -

    ShowKernelInfo

    -
    - -

    ShowKernelInfo() outputs the details of the given kernel defination to standard error, generally due to a users 'showkernel' option request.

    - -

    The format of the ShowKernel method is:

    - -
    -  void ShowKernelInfo(KernelInfo *kernel)
-
    - -

    A description of each parameter follows:

    - -
    kernel
    -

    the Morphology/Convolution kernel

    - -
    -

    UnityAddKernelInfo

    -
    - -

    UnityAddKernelInfo() Adds a given amount of the 'Unity' Convolution Kernel to the given pre-scaled and normalized Kernel. This in effect adds that amount of the original image into the resulting convolution kernel. This value is usually provided by the user as a percentage value in the 'convolve:scale' setting.

    - -

    The resulting effect is to convert the defined kernels into blended soft-blurs, unsharp kernels or into sharpening kernels.

    - -

    The format of the UnityAdditionKernelInfo method is:

    - -
    -  void UnityAdditionKernelInfo(KernelInfo *kernel, const double scale )
-
    - -

    A description of each parameter follows:

    - -
    kernel
    -

    the Morphology/Convolution kernel

    - -

    o scale:

    - -
    -         the given kernel.
-
    - -
    -

    ZeroKernelNans

    -
    - -

    ZeroKernelNans() replaces any special 'nan' value that may be present in the kernel with a zero value. This is typically done when the kernel will be used in special hardware (GPU) convolution processors, to simply matters.

    - -

    The format of the ZeroKernelNans method is:

    - -
    -  void ZeroKernelNans (KernelInfo *kernel)
-
    - -

    A description of each parameter follows:

    - -
    kernel
    -

    the Morphology/Convolution kernel

    - -
    diff --git a/www/api/paint.html b/www/api/paint.html index 0ec6fe206..2317bf174 100644 --- a/www/api/paint.html +++ b/www/api/paint.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,175 +190,9 @@
    -

    Module paint - Methods

    -

    [FloodfillPaintImage • OilPaintImage • OpaquePaintImage • TransparentPaintImage • TransparentPaintImageChroma]

    +

    Module Methods

    +

    []

    -

    FloodfillPaintImage

    -
    - -

    FloodfillPaintImage() changes the color value of any pixel that matches target and is an immediate neighbor. If the method FillToBorderMethod is specified, the color value is changed for any neighbor pixel that does not match the bordercolor member of image.

    - -

    By default target must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. The fuzz member of image defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color for the purposes of the floodfill.

    - -

    The format of the FloodfillPaintImage method is:

    - -
    -  MagickBooleanType FloodfillPaintImage(Image *image,
-    const ChannelType channel,const DrawInfo *draw_info,
-    const MagickPixelPacket target,const ssize_t x_offset,
-    const ssize_t y_offset,const MagickBooleanType invert)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel(s).

    - -
    draw_info
    -

    the draw info.

    - -
    target
    -

    the RGB value of the target color.

    - -
    x_offset,y_offset
    -

    the starting location of the operation.

    - -
    invert
    -

    paint any pixel that does not match the target color.

    - -
    -

    OilPaintImage

    -
    - -

    OilPaintImage() applies a special effect filter that simulates an oil painting. Each pixel is replaced by the most frequent color occurring in a circular region defined by radius.

    - -

    The format of the OilPaintImage method is:

    - -
    -  Image *OilPaintImage(const Image *image,const double radius,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    radius
    -

    the radius of the circular neighborhood.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    OpaquePaintImage

    -
    - -

    OpaquePaintImage() changes any pixel that matches color with the color defined by fill.

    - -

    By default color must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.

    - -

    The format of the OpaquePaintImage method is:

    - -
    -  MagickBooleanType OpaquePaintImage(Image *image,
-    const PixelPacket *target,const PixelPacket *fill,
-    const MagickBooleanType invert)
-  MagickBooleanType OpaquePaintImageChannel(Image *image,
-    const ChannelType channel,const PixelPacket *target,
-    const PixelPacket *fill,const MagickBooleanType invert)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    channel
    -

    the channel(s).

    - -
    target
    -

    the RGB value of the target color.

    - -
    fill
    -

    the replacement color.

    - -
    invert
    -

    paint any pixel that does not match the target color.

    - -
    -

    TransparentPaintImage

    -
    - -

    TransparentPaintImage() changes the opacity value associated with any pixel that matches color to the value defined by opacity.

    - -

    By default color must match a particular pixel color exactly. However, in many cases two colors may differ by a small amount. Fuzz defines how much tolerance is acceptable to consider two colors as the same. For example, set fuzz to 10 and the color red at intensities of 100 and 102 respectively are now interpreted as the same color.

    - -

    The format of the TransparentPaintImage method is:

    - -
    -  MagickBooleanType TransparentPaintImage(Image *image,
-    const MagickPixelPacket *target,const Quantum opacity,
-    const MagickBooleanType invert)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    target
    -

    the target color.

    - -
    opacity
    -

    the replacement opacity value.

    - -
    invert
    -

    paint any pixel that does not match the target color.

    - -
    -

    TransparentPaintImageChroma

    -
    - -

    TransparentPaintImageChroma() changes the opacity value associated with any pixel that matches color to the value defined by opacity.

    - -

    As there is one fuzz value for the all the channels, the TransparentPaintImage() API is not suitable for the operations like chroma, where the tolerance for similarity of two color component (RGB) can be different, Thus we define this method take two target pixels (one low and one hight) and all the pixels of an image which are lying between these two pixels are made transparent.

    - -

    The format of the TransparentPaintImage method is:

    - -
    -  MagickBooleanType TransparentPaintImage(Image *image,
-    const MagickPixelPacket *low,const MagickPixelPacket *hight,
-    const Quantum opacity,const MagickBooleanType invert)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    low
    -

    the low target color.

    - -
    high
    -

    the high target color.

    - -
    opacity
    -

    the replacement opacity value.

    - -
    invert
    -

    paint any pixel that does not match the target color.

    - -
    diff --git a/www/api/pixel-iterator.html b/www/api/pixel-iterator.html index 590a3313f..322ce4ac8 100644 --- a/www/api/pixel-iterator.html +++ b/www/api/pixel-iterator.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,1267 +190,9 @@
    -

    Module pixel-wand - Methods

    -

    [ClearPixelWand • ClonePixelWand • ClonePixelWands • DestroyPixelWand • DestroyPixelWands • IsPixelWandSimilar • IsPixelWand • NewPixelWand • NewPixelWands • PixelClearException • PixelGetAlpha • PixelGetAlphaQuantum • PixelGetBlack • PixelGetBlackQuantum • PixelGetBlue • PixelGetBlueQuantum • PixelGetColorAsString • PixelGetColorAsNormalizedString • PixelGetColorCount • PixelGetCyan • PixelGetCyanQuantum • PixelGetException • PixelGetExceptionType • PixelGetFuzz • PixelGetGreen • PixelGetGreenQuantum • PixelGetHSL • PixelGetIndex • PixelGetMagenta • PixelGetMagentaQuantum • PixelGetMagickColor • PixelGetOpacity • PixelGetOpacityQuantum • PixelGetQuantumColor • PixelGetRed • PixelGetRedQuantum • PixelGetYellow • PixelGetYellowQuantum • PixelSetAlpha • PixelSetAlphaQuantum • PixelSetBlack • PixelSetBlackQuantum • PixelSetBlue • PixelSetBlueQuantum • PixelSetColor • PixelSetColorCount • PixelSetColorFromWand • PixelSetCyan • PixelSetCyanQuantum • PixelSetFuzz • PixelSetGreen • PixelSetGreenQuantum • PixelSetHSL • PixelSetIndex • PixelSetMagenta • PixelSetMagentaQuantum • PixelSetMagickColor • PixelSetOpacity • PixelSetOpacityQuantum • PixelSetQuantumColor • PixelSetRed • PixelSetRedQuantum • PixelSetYellow • PixelSetYellowQuantum]

    +

    Module Methods

    +

    []

    -

    ClearPixelWand

    -
    - -

    ClearPixelWand() clears resources associated with the wand.

    - -

    The format of the ClearPixelWand method is:

    - -
    -  void ClearPixelWand(PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    ClonePixelWand

    -
    - -

    ClonePixelWand() makes an exact copy of the specified wand.

    - -

    The format of the ClonePixelWand method is:

    - -
    -  PixelWand *ClonePixelWand(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    ClonePixelWands

    -
    - -

    ClonePixelWands() makes an exact copy of the specified wands.

    - -

    The format of the ClonePixelWands method is:

    - -
    -  PixelWand **ClonePixelWands(const PixelWand **wands,
-    const size_t number_wands)
-
    - -

    A description of each parameter follows:

    - -
    wands
    -

    the magick wands.

    - -
    number_wands
    -

    the number of wands.

    - -
    -

    DestroyPixelWand

    -
    - -

    DestroyPixelWand() deallocates resources associated with a PixelWand.

    - -

    The format of the DestroyPixelWand method is:

    - -
    -  PixelWand *DestroyPixelWand(PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    DestroyPixelWands

    -
    - -

    DestroyPixelWands() deallocates resources associated with an array of pixel wands.

    - -

    The format of the DestroyPixelWands method is:

    - -
    -  PixelWand **DestroyPixelWands(PixelWand **wand,
-    const size_t number_wands)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    number_wands
    -

    the number of wands.

    - -
    -

    IsPixelWandSimilar

    -
    - -

    IsPixelWandSimilar() returns MagickTrue if the distance between two colors is less than the specified distance.

    - -

    The format of the IsPixelWandSimilar method is:

    - -
    -  MagickBooleanType IsPixelWandSimilar(PixelWand *p,PixelWand *q,
-    const double fuzz)
-
    - -

    A description of each parameter follows:

    - -
    p
    -

    the pixel wand.

    - -
    q
    -

    the pixel wand.

    - -
    fuzz
    -

    any two colors that are less than or equal to this distance squared are consider similar.

    - -
    -

    IsPixelWand

    -
    - -

    IsPixelWand() returns MagickTrue if the wand is verified as a pixel wand.

    - -

    The format of the IsPixelWand method is:

    - -
    -  MagickBooleanType IsPixelWand(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    NewPixelWand

    -
    - -

    NewPixelWand() returns a new pixel wand.

    - -

    The format of the NewPixelWand method is:

    - -
    -  PixelWand *NewPixelWand(void)
-
    - -
    -

    NewPixelWands

    -
    - -

    NewPixelWands() returns an array of pixel wands.

    - -

    The format of the NewPixelWands method is:

    - -
    -  PixelWand **NewPixelWands(const size_t number_wands)
-
    - -

    A description of each parameter follows:

    - -
    number_wands
    -

    the number of wands.

    - -
    -

    PixelClearException

    -
    - -

    PixelClearException() clear any exceptions associated with the iterator.

    - -

    The format of the PixelClearException method is:

    - -
    -  MagickBooleanType PixelClearException(PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetAlpha

    -
    - -

    PixelGetAlpha() returns the normalized alpha color of the pixel wand.

    - -

    The format of the PixelGetAlpha method is:

    - -
    -  double PixelGetAlpha(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetAlphaQuantum

    -
    - -

    PixelGetAlphaQuantum() returns the alpha value of the pixel wand.

    - -

    The format of the PixelGetAlphaQuantum method is:

    - -
    -  Quantum PixelGetAlphaQuantum(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetBlack

    -
    - -

    PixelGetBlack() returns the normalized black color of the pixel wand.

    - -

    The format of the PixelGetBlack method is:

    - -
    -  double PixelGetBlack(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetBlackQuantum

    -
    - -

    PixelGetBlackQuantum() returns the black color of the pixel wand.

    - -

    The format of the PixelGetBlackQuantum method is:

    - -
    -  Quantum PixelGetBlackQuantum(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetBlue

    -
    - -

    PixelGetBlue() returns the normalized blue color of the pixel wand.

    - -

    The format of the PixelGetBlue method is:

    - -
    -  double PixelGetBlue(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetBlueQuantum

    -
    - -

    PixelGetBlueQuantum() returns the blue color of the pixel wand.

    - -

    The format of the PixelGetBlueQuantum method is:

    - -
    -  Quantum PixelGetBlueQuantum(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetColorAsString

    -
    - -

    PixelGetColorAsString() returnsd the color of the pixel wand as a string.

    - -

    The format of the PixelGetColorAsString method is:

    - -
    -  char *PixelGetColorAsString(PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetColorAsNormalizedString

    -
    - -

    PixelGetColorAsNormalizedString() returns the normalized color of the pixel wand as a string.

    - -

    The format of the PixelGetColorAsNormalizedString method is:

    - -
    -  char *PixelGetColorAsNormalizedString(PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetColorCount

    -
    - -

    PixelGetColorCount() returns the color count associated with this color.

    - -

    The format of the PixelGetColorCount method is:

    - -
    -  size_t PixelGetColorCount(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetCyan

    -
    - -

    PixelGetCyan() returns the normalized cyan color of the pixel wand.

    - -

    The format of the PixelGetCyan method is:

    - -
    -  double PixelGetCyan(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetCyanQuantum

    -
    - -

    PixelGetCyanQuantum() returns the cyan color of the pixel wand.

    - -

    The format of the PixelGetCyanQuantum method is:

    - -
    -  Quantum PixelGetCyanQuantum(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetException

    -
    - -

    PixelGetException() returns the severity, reason, and description of any error that occurs when using other methods in this API.

    - -

    The format of the PixelGetException method is:

    - -
    -  char *PixelGetException(const PixelWand *wand,ExceptionType *severity)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    severity
    -

    the severity of the error is returned here.

    - -
    -

    PixelGetExceptionType

    -
    - -

    PixelGetExceptionType() the exception type associated with the wand. If no exception has occurred, UndefinedExceptionType is returned.

    - -

    The format of the PixelGetExceptionType method is:

    - -
    -  ExceptionType PixelGetExceptionType(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    -

    PixelGetFuzz

    -
    - -

    PixelGetFuzz() returns the normalized fuzz value of the pixel wand.

    - -

    The format of the PixelGetFuzz method is:

    - -
    -  double PixelGetFuzz(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetGreen

    -
    - -

    PixelGetGreen() returns the normalized green color of the pixel wand.

    - -

    The format of the PixelGetGreen method is:

    - -
    -  double PixelGetGreen(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetGreenQuantum

    -
    - -

    PixelGetGreenQuantum() returns the green color of the pixel wand.

    - -

    The format of the PixelGetGreenQuantum method is:

    - -
    -  Quantum PixelGetGreenQuantum(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetHSL

    -
    - -

    PixelGetHSL() returns the normalized HSL color of the pixel wand.

    - -

    The format of the PixelGetHSL method is:

    - -
    -  void PixelGetHSL(const PixelWand *wand,double *hue,double *saturation,
-    double *lightness)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    hue,saturation,lightness
    -

    Return the pixel hue, saturation, and brightness.

    - -
    -

    PixelGetIndex

    -
    - -

    PixelGetIndex() returns the colormap index from the pixel wand.

    - -

    The format of the PixelGetIndex method is:

    - -
    -  IndexPacket PixelGetIndex(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetMagenta

    -
    - -

    PixelGetMagenta() returns the normalized magenta color of the pixel wand.

    - -

    The format of the PixelGetMagenta method is:

    - -
    -  double PixelGetMagenta(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetMagentaQuantum

    -
    - -

    PixelGetMagentaQuantum() returns the magenta color of the pixel wand.

    - -

    The format of the PixelGetMagentaQuantum method is:

    - -
    -  Quantum PixelGetMagentaQuantum(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetMagickColor

    -
    - -

    PixelGetMagickColor() gets the magick color of the pixel wand.

    - -

    The format of the PixelGetMagickColor method is:

    - -
    -  void PixelGetMagickColor(PixelWand *wand,MagickPixelPacket *color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    color
    -

    The pixel wand color is returned here.

    - -
    -

    PixelGetOpacity

    -
    - -

    PixelGetOpacity() returns the normalized opacity color of the pixel wand.

    - -

    The format of the PixelGetOpacity method is:

    - -
    -  double PixelGetOpacity(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetOpacityQuantum

    -
    - -

    PixelGetOpacityQuantum() returns the opacity color of the pixel wand.

    - -

    The format of the PixelGetOpacityQuantum method is:

    - -
    -  Quantum PixelGetOpacityQuantum(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetQuantumColor

    -
    - -

    PixelGetQuantumColor() gets the color of the pixel wand as a PixelPacket.

    - -

    The format of the PixelGetQuantumColor method is:

    - -
    -  void PixelGetQuantumColor(PixelWand *wand,PixelPacket *color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    color
    -

    The pixel wand color is returned here.

    - -
    -

    PixelGetRed

    -
    - -

    PixelGetRed() returns the normalized red color of the pixel wand.

    - -

    The format of the PixelGetRed method is:

    - -
    -  double PixelGetRed(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetRedQuantum

    -
    - -

    PixelGetRedQuantum() returns the red color of the pixel wand.

    - -

    The format of the PixelGetRedQuantum method is:

    - -
    -  Quantum PixelGetRedQuantum(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetYellow

    -
    - -

    PixelGetYellow() returns the normalized yellow color of the pixel wand.

    - -

    The format of the PixelGetYellow method is:

    - -
    -  double PixelGetYellow(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelGetYellowQuantum

    -
    - -

    PixelGetYellowQuantum() returns the yellow color of the pixel wand.

    - -

    The format of the PixelGetYellowQuantum method is:

    - -
    -  Quantum PixelGetYellowQuantum(const PixelWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    -

    PixelSetAlpha

    -
    - -

    PixelSetAlpha() sets the normalized alpha color of the pixel wand.

    - -

    The format of the PixelSetAlpha method is:

    - -
    -  void PixelSetAlpha(PixelWand *wand,const double alpha)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    alpha
    -

    the level of transparency: 1.0 is fully opaque and 0.0 is fully transparent.

    - -
    -

    PixelSetAlphaQuantum

    -
    - -

    PixelSetAlphaQuantum() sets the alpha color of the pixel wand.

    - -

    The format of the PixelSetAlphaQuantum method is:

    - -
    -  void PixelSetAlphaQuantum(PixelWand *wand,
-    const Quantum opacity)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    opacity
    -

    the opacity color.

    - -
    -

    PixelSetBlack

    -
    - -

    PixelSetBlack() sets the normalized black color of the pixel wand.

    - -

    The format of the PixelSetBlack method is:

    - -
    -  void PixelSetBlack(PixelWand *wand,const double black)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    black
    -

    the black color.

    - -
    -

    PixelSetBlackQuantum

    -
    - -

    PixelSetBlackQuantum() sets the black color of the pixel wand.

    - -

    The format of the PixelSetBlackQuantum method is:

    - -
    -  void PixelSetBlackQuantum(PixelWand *wand,const Quantum black)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    black
    -

    the black color.

    - -
    -

    PixelSetBlue

    -
    - -

    PixelSetBlue() sets the normalized blue color of the pixel wand.

    - -

    The format of the PixelSetBlue method is:

    - -
    -  void PixelSetBlue(PixelWand *wand,const double blue)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    blue
    -

    the blue color.

    - -
    -

    PixelSetBlueQuantum

    -
    - -

    PixelSetBlueQuantum() sets the blue color of the pixel wand.

    - -

    The format of the PixelSetBlueQuantum method is:

    - -
    -  void PixelSetBlueQuantum(PixelWand *wand,const Quantum blue)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    blue
    -

    the blue color.

    - -
    -

    PixelSetColor

    -
    - -

    PixelSetColor() sets the color of the pixel wand with a string (e.g. "blue", "#0000ff", "rgb(0,0,255)", "cmyk(100,100,100,10)", etc.).

    - -

    The format of the PixelSetColor method is:

    - -
    -  MagickBooleanType PixelSetColor(PixelWand *wand,const char *color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    color
    -

    the pixel wand color.

    - -
    -

    PixelSetColorCount

    -
    - -

    PixelSetColorCount() sets the color count of the pixel wand.

    - -

    The format of the PixelSetColorCount method is:

    - -
    -  void PixelSetColorCount(PixelWand *wand,const size_t count)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    count
    -

    the number of this particular color.

    - -
    -

    PixelSetColorFromWand

    -
    - -

    PixelSetColorFromWand() sets the color of the pixel wand.

    - -

    The format of the PixelSetColorFromWand method is:

    - -
    -  PixelSetColorFromWand(PixelWand *wand,const PixelWand *color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    color
    -

    set the pixel wand color here.

    - -
    -

    PixelSetCyan

    -
    - -

    PixelSetCyan() sets the normalized cyan color of the pixel wand.

    - -

    The format of the PixelSetCyan method is:

    - -
    -  void PixelSetCyan(PixelWand *wand,const double cyan)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    cyan
    -

    the cyan color.

    - -
    -

    PixelSetCyanQuantum

    -
    - -

    PixelSetCyanQuantum() sets the cyan color of the pixel wand.

    - -

    The format of the PixelSetCyanQuantum method is:

    - -
    -  void PixelSetCyanQuantum(PixelWand *wand,const Quantum cyan)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    cyan
    -

    the cyan color.

    - -
    -

    PixelSetFuzz

    -
    - -

    PixelSetFuzz() sets the fuzz value of the pixel wand.

    - -

    The format of the PixelSetFuzz method is:

    - -
    -  void PixelSetFuzz(PixelWand *wand,const double fuzz)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    fuzz
    -

    the fuzz value.

    - -
    -

    PixelSetGreen

    -
    - -

    PixelSetGreen() sets the normalized green color of the pixel wand.

    - -

    The format of the PixelSetGreen method is:

    - -
    -  void PixelSetGreen(PixelWand *wand,const double green)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    green
    -

    the green color.

    - -
    -

    PixelSetGreenQuantum

    -
    - -

    PixelSetGreenQuantum() sets the green color of the pixel wand.

    - -

    The format of the PixelSetGreenQuantum method is:

    - -
    -  void PixelSetGreenQuantum(PixelWand *wand,const Quantum green)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    green
    -

    the green color.

    - -
    -

    PixelSetHSL

    -
    - -

    PixelSetHSL() sets the normalized HSL color of the pixel wand.

    - -

    The format of the PixelSetHSL method is:

    - -
    -  void PixelSetHSL(PixelWand *wand,const double hue,
-    const double saturation,const double lightness)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    hue,saturation,lightness
    -

    Return the pixel hue, saturation, and brightness.

    - -
    -

    PixelSetIndex

    -
    - -

    PixelSetIndex() sets the colormap index of the pixel wand.

    - -

    The format of the PixelSetIndex method is:

    - -
    -  void PixelSetIndex(PixelWand *wand,const IndexPacket index)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    index
    -

    the colormap index.

    - -
    -

    PixelSetMagenta

    -
    - -

    PixelSetMagenta() sets the normalized magenta color of the pixel wand.

    - -

    The format of the PixelSetMagenta method is:

    - -
    -  void PixelSetMagenta(PixelWand *wand,const double magenta)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    magenta
    -

    the magenta color.

    - -
    -

    PixelSetMagentaQuantum

    -
    - -

    PixelSetMagentaQuantum() sets the magenta color of the pixel wand.

    - -

    The format of the PixelSetMagentaQuantum method is:

    - -
    -  void PixelSetMagentaQuantum(PixelWand *wand,
-    const Quantum magenta)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    magenta
    -

    the green magenta.

    - -
    -

    PixelSetMagickColor

    -
    - -

    PixelSetMagickColor() sets the color of the pixel wand.

    - -

    The format of the PixelSetMagickColor method is:

    - -
    -  PixelSetMagickColor(PixelWand *wand,const MagickPixelPacket *color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    color
    -

    the pixel wand color.

    - -
    -

    PixelSetOpacity

    -
    - -

    PixelSetOpacity() sets the normalized opacity color of the pixel wand.

    - -

    The format of the PixelSetOpacity method is:

    - -
    -  void PixelSetOpacity(PixelWand *wand,const double opacity)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    opacity
    -

    the opacity color.

    - -
    -

    PixelSetOpacityQuantum

    -
    - -

    PixelSetOpacityQuantum() sets the opacity color of the pixel wand.

    - -

    The format of the PixelSetOpacityQuantum method is:

    - -
    -  void PixelSetOpacityQuantum(PixelWand *wand,
-    const Quantum opacity)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    opacity
    -

    the opacity color.

    - -
    -

    PixelSetQuantumColor

    -
    - -

    PixelSetQuantumColor() sets the color of the pixel wand.

    - -

    The format of the PixelSetQuantumColor method is:

    - -
    -  PixelSetQuantumColor(PixelWand *wand,const PixelPacket *color)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    color
    -

    the pixel wand color.

    - -
    -

    PixelSetRed

    -
    - -

    PixelSetRed() sets the normalized red color of the pixel wand.

    - -

    The format of the PixelSetRed method is:

    - -
    -  void PixelSetRed(PixelWand *wand,const double red)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    red
    -

    the red color.

    - -
    -

    PixelSetRedQuantum

    -
    - -

    PixelSetRedQuantum() sets the red color of the pixel wand.

    - -

    The format of the PixelSetRedQuantum method is:

    - -
    -  void PixelSetRedQuantum(PixelWand *wand,const Quantum red)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    red
    -

    the red color.

    - -
    -

    PixelSetYellow

    -
    - -

    PixelSetYellow() sets the normalized yellow color of the pixel wand.

    - -

    The format of the PixelSetYellow method is:

    - -
    -  void PixelSetYellow(PixelWand *wand,const double yellow)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    yellow
    -

    the yellow color.

    - -
    -

    PixelSetYellowQuantum

    -
    - -

    PixelSetYellowQuantum() sets the yellow color of the pixel wand.

    - -

    The format of the PixelSetYellowQuantum method is:

    - -
    -  void PixelSetYellowQuantum(PixelWand *wand,const Quantum yellow)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the pixel wand.

    - -
    yellow
    -

    the yellow color.

    - -
    diff --git a/www/api/profile.html b/www/api/profile.html index 60cf0f863..5f234fe9c 100644 --- a/www/api/profile.html +++ b/www/api/profile.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,225 +190,9 @@
    -

    Module profile - Methods

    -

    [CloneImageProfiles • DeleteImageProfile • DestroyImageProfiles • GetImageProfile • GetNextImageProfile • ProfileImage • RemoveImageProfile • ResetImageProfileIterator • SetImageProfile • SyncImageProfiles]

    +

    Module Methods

    +

    []

    -

    CloneImageProfiles

    -
    - -

    CloneImageProfiles() clones one or more image profiles.

    - -

    The format of the CloneImageProfiles method is:

    - -
    -  MagickBooleanType CloneImageProfiles(Image *image,
-    const Image *clone_image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    clone_image
    -

    the clone image.

    - -
    -

    DeleteImageProfile

    -
    - -

    DeleteImageProfile() deletes a profile from the image by its name.

    - -

    The format of the DeleteImageProfile method is:

    - -
    -  MagickBooleanTyupe DeleteImageProfile(Image *image,const char *name)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    name
    -

    the profile name.

    - -
    -

    DestroyImageProfiles

    -
    - -

    DestroyImageProfiles() releases memory associated with an image profile map.

    - -

    The format of the DestroyProfiles method is:

    - -
    -  void DestroyImageProfiles(Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    GetImageProfile

    -
    - -

    GetImageProfile() gets a profile associated with an image by name.

    - -

    The format of the GetImageProfile method is:

    - -
    -  const StringInfo *GetImageProfile(const Image *image,const char *name)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    name
    -

    the profile name.

    - -
    -

    GetNextImageProfile

    -
    - -

    GetNextImageProfile() gets the next profile name for an image.

    - -

    The format of the GetNextImageProfile method is:

    - -
    -  char *GetNextImageProfile(const Image *image)
-
    - -

    A description of each parameter follows:

    - -
    hash_info
    -

    the hash info.

    - -
    -

    ProfileImage

    -
    - -

    ProfileImage() associates, applies, or removes an ICM, IPTC, or generic profile with / to / from an image. If the profile is NULL, it is removed from the image otherwise added or applied. Use a name of '*' and a profile of NULL to remove all profiles from the image.

    - -

    ICC and ICM profiles are handled as follows: If the image does not have an associated color profile, the one you provide is associated with the image and the image pixels are not transformed. Otherwise, the colorspace transform defined by the existing and new profile are applied to the image pixels and the new profile is associated with the image.

    - -

    The format of the ProfileImage method is:

    - -
    -  MagickBooleanType ProfileImage(Image *image,const char *name,
-    const void *datum,const size_t length,const MagickBooleanType clone)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    name
    -

    Name of profile to add or remove: ICC, IPTC, or generic profile.

    - -
    datum
    -

    the profile data.

    - -
    length
    -

    the length of the profile.

    - -
    clone
    -

    should be MagickFalse.

    - -
    -

    RemoveImageProfile

    -
    - -

    RemoveImageProfile() removes a named profile from the image and returns its value.

    - -

    The format of the RemoveImageProfile method is:

    - -
    -  void *RemoveImageProfile(Image *image,const char *name)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    name
    -

    the profile name.

    - -
    -

    ResetImageProfileIterator

    -
    - -

    ResetImageProfileIterator() resets the image profile iterator. Use it in conjunction with GetNextImageProfile() to iterate over all the profiles associated with an image.

    - -

    The format of the ResetImageProfileIterator method is:

    - -
    -  ResetImageProfileIterator(Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    SetImageProfile

    -
    - -

    SetImageProfile() adds a named profile to the image. If a profile with the same name already exists, it is replaced. This method differs from the ProfileImage() method in that it does not apply CMS color profiles.

    - -

    The format of the SetImageProfile method is:

    - -
    -  MagickBooleanType SetImageProfile(Image *image,const char *name,
-    const StringInfo *profile)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    name
    -

    the profile name, for example icc, exif, and 8bim (8bim is the Photoshop wrapper for iptc profiles).

    - -
    profile
    -

    A StringInfo structure that contains the named profile.

    - -
    -

    SyncImageProfiles

    -
    - -

    SyncImageProfiles() synchronizes image properties with the image profiles. Currently we only support updating the EXIF resolution and orientation.

    - -

    The format of the SyncImageProfiles method is:

    - -
    -  MagickBooleanType SyncImageProfiles(Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    diff --git a/www/api/property.html b/www/api/property.html index 728767327..75f4956d6 100644 --- a/www/api/property.html +++ b/www/api/property.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,246 +190,9 @@
    -

    Module property - Methods

    -

    [CloneImageProperties • DefineImageProperty • DeleteImageProperty • DestroyImageProperties • FormatImageProperty • GetImageProperty • GetNextImageProperty • InterpretImageProperties • RemoveImageProperty • ResetImagePropertyIterator • SetImageProperty]

    +

    Module Methods

    +

    []

    -

    CloneImageProperties

    -
    - -

    CloneImageProperties() clones one or more image properties.

    - -

    The format of the CloneImageProperties method is:

    - -
    -  MagickBooleanType CloneImageProperties(Image *image,
-    const Image *clone_image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    clone_image
    -

    the clone image.

    - -
    -

    DefineImageProperty

    -
    - -

    DefineImageProperty() associates a key/value pair with an image property.

    - -

    The format of the DefineImageProperty method is:

    - -
    -  MagickBooleanType DefineImageProperty(Image *image,
-    const char *property)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    property
    -

    the image property.

    - -
    -

    DeleteImageProperty

    -
    - -

    DeleteImageProperty() deletes an image property.

    - -

    The format of the DeleteImageProperty method is:

    - -
    -  MagickBooleanType DeleteImageProperty(Image *image,const char *property)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    property
    -

    the image property.

    - -
    -

    DestroyImageProperties

    -
    - -

    DestroyImageProperties() releases memory associated with image property values.

    - -

    The format of the DestroyDefines method is:

    - -
    -  void DestroyImageProperties(Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    FormatImageProperty

    -
    - -

    FormatImageProperty() permits formatted property/value pairs to be saved as an image property.

    - -

    The format of the FormatImageProperty method is:

    - -
    -  MagickBooleanType FormatImageProperty(Image *image,const char *property,
-    const char *format,...)
-
    - -

    A description of each parameter follows.

    - -
    image
    -

    The image.

    - -
    property
    -

    The attribute property.

    - -
    format
    -

    A string describing the format to use to write the remaining arguments.

    - -
    -

    GetImageProperty

    -
    - -

    GetImageProperty() gets a value associated with an image property.

    - -

    The format of the GetImageProperty method is:

    - -
    -  const char *GetImageProperty(const Image *image,const char *key)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    key
    -

    the key.

    - -
    -

    GetNextImageProperty

    -
    - -

    GetNextImageProperty() gets the next image property value.

    - -

    The format of the GetNextImageProperty method is:

    - -
    -  char *GetNextImageProperty(const Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    InterpretImageProperties

    -
    - -

    InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpretted text.

    - -

    The format of the InterpretImageProperties method is:

    - -
    -  char *InterpretImageProperties(const ImageInfo *image_info,Image *image,
-    const char *embed_text)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    image
    -

    the image.

    - -
    embed_text
    -

    the address of a character string containing the embedded formatting characters.

    - -
    -

    RemoveImageProperty

    -
    - -

    RemoveImageProperty() removes a property from the image and returns its value.

    - -

    The format of the RemoveImageProperty method is:

    - -
    -  char *RemoveImageProperty(Image *image,const char *property)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    property
    -

    the image property.

    - -
    -

    ResetImagePropertyIterator

    -
    - -

    ResetImagePropertyIterator() resets the image properties iterator. Use it in conjunction with GetNextImageProperty() to iterate over all the values associated with an image property.

    - -

    The format of the ResetImagePropertyIterator method is:

    - -
    -  ResetImagePropertyIterator(Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    SetImageProperty

    -
    - -

    SetImageProperty() associates an value with an image property.

    - -

    The format of the SetImageProperty method is:

    - -
    -  MagickBooleanType SetImageProperty(Image *image,const char *property,
-    const char *value)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    property
    -

    the image property.

    - -
    values
    -

    the image property values.

    - -
    diff --git a/www/api/quantize.html b/www/api/quantize.html index 78ceeca92..b21de65ba 100644 --- a/www/api/quantize.html +++ b/www/api/quantize.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,334 +190,9 @@
    -

    Module quantize - Methods

    -

    [QuantizeImage • AcquireQuantizeInfo • CloneQuantizeInfo • CompressImageColormap • DestroyQuantizeInfo • GetImageQuantizeError • GetQuantizeInfo • PosterizeImage • QuantizeImage • QuantizeImages • RemapImage • RemapImages • SetGrayscaleImage]

    +

    Module Methods

    +

    []

    -

    QuantizeImage

    -
    - -

    QuantizeImage() takes a standard RGB or monochrome images and quantizes them down to some fixed number of colors.

    - -

    For purposes of color allocation, an image is a set of n pixels, where each pixel is a point in RGB space. RGB space is a 3-dimensional vector space, and each pixel, Pi, is defined by an ordered triple of red, green, and blue coordinates, (Ri, Gi, Bi).

    - -

    Each primary color component (red, green, or blue) represents an intensity which varies linearly from 0 to a maximum value, Cmax, which corresponds to full saturation of that color. Color allocation is defined over a domain consisting of the cube in RGB space with opposite vertices at (0,0,0) and (Cmax, Cmax, Cmax). QUANTIZE requires Cmax = 255.

    - -

    The algorithm maps this domain onto a tree in which each node represents a cube within that domain. In the following discussion these cubes are defined by the coordinate of two opposite vertices:

    - -
    -    the origin.
-
    - -

    The tree's root node represents the entire domain, (0,0,0) through (Cmax,Cmax,Cmax). Each lower level in the tree is generated by subdividing one node's cube into eight smaller cubes of equal size. This corresponds to bisecting the parent cube with planes passing through the midpoints of each edge.

    - -

    The basic algorithm operates in three phases: Classification, Reduction, and Assignment. Classification builds a color description tree for the image. Reduction collapses the tree until the number it represents, at most, the number of colors desired in the output image. Assignment defines the output image's color map and sets each pixel's color by restorage_class in the reduced tree. Our goal is to minimize the numerical discrepancies between the original colors and quantized colors (quantization error).

    - -

    Classification begins by initializing a color description tree of sufficient depth to represent each possible input color in a leaf. However, it is impractical to generate a fully-formed color description tree in the storage_class phase for realistic values of Cmax. If colors components in the input image are quantized to k-bit precision, so that Cmax= 2k-1, the tree would need k levels below the root node to allow representing each possible input color in a leaf. This becomes prohibitive because the tree's total number of nodes is 1 + sum(i=1, k, 8k).

    - -

    A complete tree would require 19,173,961 nodes for k = 8, Cmax = 255.

    -
    avoid building a fully populated tree, QUANTIZE
    -

    (1) Initializes data structures for nodes only as they are needed; (2) Chooses a maximum depth for the tree as a function of the desired number of colors in the output image (currently log2(colormap size)).

    - -

    For each pixel in the input image, storage_class scans downward from the root of the color description tree. At each level of the tree it identifies the single node which represents a cube in RGB space containing the pixel's color. It updates the following data for each such node:

    - -
    -      n1: Number of pixels whose color is contained in the RGB cube which
-      this node represents;
-
    - -

    n2: Number of pixels whose color is not represented in a node at lower depth in the tree; initially, n2 = 0 for all nodes except leaves of the tree.

    - -

    Sr, Sg, Sb: Sums of the red, green, and blue component values for all pixels not classified at a lower depth. The combination of these sums and n2 will ultimately characterize the mean color of a set of pixels represented by this node.

    - -

    E: the distance squared in RGB space between each pixel contained within a node and the nodes' center. This represents the quantization error for a node.

    - -

    Reduction repeatedly prunes the tree until the number of nodes with n2 > 0 is less than or equal to the maximum number of colors allowed in the output image. On any given iteration over the tree, it selects those nodes whose E count is minimal for pruning and merges their color statistics upward. It uses a pruning threshold, Ep, to govern node selection as follows:

    - -

    Ep = 0 while number of nodes with (n2 > 0) > required maximum number of colors prune all nodes such that E <= Ep Set Ep to minimum E in remaining nodes

    - -

    This has the effect of minimizing any quantization error when merging two nodes together.

    - -

    When a node to be pruned has offspring, the pruning procedure invokes itself recursively in order to prune the tree from the leaves upward. n2, Sr, Sg, and Sb in a node being pruned are always added to the corresponding data in that node's parent. This retains the pruned node's color characteristics for later averaging.

    - -

    For each node, n2 pixels exist for which that node represents the smallest volume in RGB space containing those pixel's colors. When n2 > 0 the node will uniquely define a color in the output image. At the beginning of reduction, n2 = 0 for all nodes except a the leaves of the tree which represent colors present in the input image.

    - -

    The other pixel count, n1, indicates the total number of colors within the cubic volume which the node represents. This includes n1 - n2 pixels whose colors should be defined by nodes at a lower level in the tree.

    - -

    Assignment generates the output image from the pruned tree. The output

    -
    parts
    -

    (1) A color map, which is an array of color descriptions (RGB triples) for each color present in the output image; (2) A pixel array, which represents each pixel as an index into the color map array.

    - -

    First, the assignment phase makes one pass over the pruned color description tree to establish the image's color map. For each node with n2 > 0, it divides Sr, Sg, and Sb by n2 . This produces the mean color of all pixels that classify no lower than this node. Each of these colors becomes an entry in the color map.

    - -

    Finally, the assignment phase reclassifies each pixel in the pruned tree to identify the deepest node containing the pixel's color. The pixel's value in the pixel array becomes the index of this node's mean color in the color map.

    - -

    This method is based on a similar algorithm written by Paul Raveling.

    - -
    -

    AcquireQuantizeInfo

    -
    - -

    AcquireQuantizeInfo() allocates the QuantizeInfo structure.

    - -

    The format of the AcquireQuantizeInfo method is:

    - -
    -  QuantizeInfo *AcquireQuantizeInfo(const ImageInfo *image_info)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    -

    CloneQuantizeInfo

    -
    - -

    CloneQuantizeInfo() makes a duplicate of the given quantize info structure, or if quantize info is NULL, a new one.

    - -

    The format of the CloneQuantizeInfo method is:

    - -
    -  QuantizeInfo *CloneQuantizeInfo(const QuantizeInfo *quantize_info)
-
    - -

    A description of each parameter follows:

    - -
    clone_info
    -

    Method CloneQuantizeInfo returns a duplicate of the given quantize info, or if image info is NULL a new one.

    - -
    quantize_info
    -

    a structure of type info.

    - -
    -

    CompressImageColormap

    -
    - -

    CompressImageColormap() compresses an image colormap by removing any duplicate or unused color entries.

    - -

    The format of the CompressImageColormap method is:

    - -
    -  MagickBooleanType CompressImageColormap(Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    -

    DestroyQuantizeInfo

    -
    - -

    DestroyQuantizeInfo() deallocates memory associated with an QuantizeInfo structure.

    - -

    The format of the DestroyQuantizeInfo method is:

    - -
    -  QuantizeInfo *DestroyQuantizeInfo(QuantizeInfo *quantize_info)
-
    - -

    A description of each parameter follows:

    - -
    quantize_info
    -

    Specifies a pointer to an QuantizeInfo structure.

    - -
    -

    GetImageQuantizeError

    -
    - -

    GetImageQuantizeError() measures the difference between the original and quantized images. This difference is the total quantization error. The error is computed by summing over all pixels in an image the distance squared in RGB space between each reference pixel value and its quantized value. These values are computed:

    - -
    -      o mean_error_per_pixel:  This value is the mean error for any single
-  pixel in the image.
-
    - -
    normalized_mean_square_error
    -

    This value is the normalized mean quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in the image.

    - -
    normalized_maximum_square_error
    -

    Thsi value is the normalized maximum quantization error for any single pixel in the image. This distance measure is normalized to a range between 0 and 1. It is independent of the range of red, green, and blue values in your image.

    - -

    The format of the GetImageQuantizeError method is:

    - -
    -  MagickBooleanType GetImageQuantizeError(Image *image)
-
    - -

    A description of each parameter follows.

    - -
    image
    -

    the image.

    - -
    -

    GetQuantizeInfo

    -
    - -

    GetQuantizeInfo() initializes the QuantizeInfo structure.

    - -

    The format of the GetQuantizeInfo method is:

    - -
    -  GetQuantizeInfo(QuantizeInfo *quantize_info)
-
    - -

    A description of each parameter follows:

    - -
    quantize_info
    -

    Specifies a pointer to a QuantizeInfo structure.

    - -
    -

    PosterizeImage

    -
    - -

    PosterizeImage() reduces the image to a limited number of colors for a "poster" effect.

    - -

    The format of the PosterizeImage method is:

    - -
    -  MagickBooleanType PosterizeImage(Image *image,const size_t levels,
-    const MagickBooleanType dither)
-  MagickBooleanType PosterizeImageChannel(Image *image,
-    const ChannelType channel,const size_t levels,
-    const MagickBooleanType dither)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    Specifies a pointer to an Image structure.

    - -
    levels
    -

    Number of color levels allowed in each channel. Very low values (2, 3, or 4) have the most visible effect.

    - -
    dither
    -

    Set this integer value to something other than zero to dither the mapped image.

    - -
    -

    QuantizeImage

    -
    - -

    QuantizeImage() analyzes the colors within a reference image and chooses a fixed number of colors to represent the image. The goal of the algorithm is to minimize the color difference between the input and output image while minimizing the processing time.

    - -

    The format of the QuantizeImage method is:

    - -
    -  MagickBooleanType QuantizeImage(const QuantizeInfo *quantize_info,
-    Image *image)
-
    - -

    A description of each parameter follows:

    - -
    quantize_info
    -

    Specifies a pointer to an QuantizeInfo structure.

    - -
    image
    -

    the image.

    - -
    -

    QuantizeImages

    -
    - -

    QuantizeImages() analyzes the colors within a set of reference images and chooses a fixed number of colors to represent the set. The goal of the algorithm is to minimize the color difference between the input and output images while minimizing the processing time.

    - -

    The format of the QuantizeImages method is:

    - -
    -  MagickBooleanType QuantizeImages(const QuantizeInfo *quantize_info,
-    Image *images)
-
    - -

    A description of each parameter follows:

    - -
    quantize_info
    -

    Specifies a pointer to an QuantizeInfo structure.

    - -
    images
    -

    Specifies a pointer to a list of Image structures.

    - -
    -

    RemapImage

    -
    - -

    RemapImage() replaces the colors of an image with the closest color from a reference image.

    - -

    The format of the RemapImage method is:

    - -
    -  MagickBooleanType RemapImage(const QuantizeInfo *quantize_info,
-    Image *image,const Image *remap_image)
-
    - -

    A description of each parameter follows:

    - -
    quantize_info
    -

    Specifies a pointer to an QuantizeInfo structure.

    - -
    image
    -

    the image.

    - -
    remap_image
    -

    the reference image.

    - -
    -

    RemapImages

    -
    - -

    RemapImages() replaces the colors of a sequence of images with the closest color from a reference image.

    - -

    The format of the RemapImage method is:

    - -
    -  MagickBooleanType RemapImages(const QuantizeInfo *quantize_info,
-    Image *images,Image *remap_image)
-
    - -

    A description of each parameter follows:

    - -
    quantize_info
    -

    Specifies a pointer to an QuantizeInfo structure.

    - -
    images
    -

    the image sequence.

    - -
    remap_image
    -

    the reference image.

    - -
    -

    SetGrayscaleImage

    -
    - -

    SetGrayscaleImage() converts an image to a PseudoClass grayscale image.

    - -

    The format of the SetGrayscaleImage method is:

    - -
    -  MagickBooleanType SetGrayscaleImage(Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    The image.

    - -
    diff --git a/www/api/registry.html b/www/api/registry.html index 2b77b1cde..d6a1cb0db 100644 --- a/www/api/registry.html +++ b/www/api/registry.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,270 +190,9 @@
    -

    Module resize - Methods

    -

    [AdaptiveResizeImage • MagnifyImage • MinifyImage • ResampleImage • LiquidRescaleImage • ResizeImage • SampleImage • ScaleImage • ThumbnailImage]

    +

    Module Methods

    +

    []

    -

    AdaptiveResizeImage

    -
    - -

    AdaptiveResizeImage() adaptively resize image with pixel resampling.

    - -

    The format of the AdaptiveResizeImage method is:

    - -
    -  Image *AdaptiveResizeImage(const Image *image,const size_t columns,
-    const size_t rows,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    columns
    -

    the number of columns in the resized image.

    - -
    rows
    -

    the number of rows in the resized image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    MagnifyImage

    -
    - -

    MagnifyImage() is a convenience method that scales an image proportionally to twice its size.

    - -

    The format of the MagnifyImage method is:

    - -
    -  Image *MagnifyImage(const Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    MinifyImage

    -
    - -

    MinifyImage() is a convenience method that scales an image proportionally to half its size.

    - -

    The format of the MinifyImage method is:

    - -
    -  Image *MinifyImage(const Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ResampleImage

    -
    - -

    ResampleImage() resize image in terms of its pixel size, so that when displayed at the given resolution it will be the same size in terms of real world units as the original image at the original resolution.

    - -

    The format of the ResampleImage method is:

    - -
    -  Image *ResampleImage(Image *image,const double x_resolution,
-    const double y_resolution,const FilterTypes filter,const double blur,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image to be resized to fit the given resolution.

    - -
    x_resolution
    -

    the new image x resolution.

    - -
    y_resolution
    -

    the new image y resolution.

    - -
    filter
    -

    Image filter to use.

    - -
    blur
    -

    the blur factor where > 1 is blurry, < 1 is sharp.

    - -
    -

    LiquidRescaleImage

    -
    - -

    LiquidRescaleImage() rescales image with seam carving.

    - -

    The format of the LiquidRescaleImage method is:

    - -
    -  Image *LiquidRescaleImage(const Image *image,
-    const size_t columns,const size_t rows,
-    const double delta_x,const double rigidity,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    columns
    -

    the number of columns in the rescaled image.

    - -
    rows
    -

    the number of rows in the rescaled image.

    - -
    delta_x
    -

    maximum seam transversal step (0 means straight seams).

    - -
    rigidity
    -

    introduce a bias for non-straight seams (typically 0).

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ResizeImage

    -
    - -

    ResizeImage() scales an image to the desired dimensions, using the given filter (see AcquireFilterInfo()).

    - -

    If an undefined filter is given the filter defaults to Mitchell for a colormapped image, a image with a matte channel, or if the image is enlarged. Otherwise the filter defaults to a Lanczos.

    - -

    ResizeImage() was inspired by Paul Heckbert's "zoom" program.

    - -

    The format of the ResizeImage method is:

    - -
    -  Image *ResizeImage(Image *image,const size_t columns,
-    const size_t rows,const FilterTypes filter,const double blur,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    columns
    -

    the number of columns in the scaled image.

    - -
    rows
    -

    the number of rows in the scaled image.

    - -
    filter
    -

    Image filter to use.

    - -
    blur
    -

    the blur factor where > 1 is blurry, < 1 is sharp. Typically set this to 1.0.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    SampleImage

    -
    - -

    SampleImage() scales an image to the desired dimensions with pixel sampling. Unlike other scaling methods, this method does not introduce any additional color into the scaled image.

    - -

    The format of the SampleImage method is:

    - -
    -  Image *SampleImage(const Image *image,const size_t columns,
-    const size_t rows,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    columns
    -

    the number of columns in the sampled image.

    - -
    rows
    -

    the number of rows in the sampled image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ScaleImage

    -
    - -

    ScaleImage() changes the size of an image to the given dimensions.

    - -

    The format of the ScaleImage method is:

    - -
    -  Image *ScaleImage(const Image *image,const size_t columns,
-    const size_t rows,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    columns
    -

    the number of columns in the scaled image.

    - -
    rows
    -

    the number of rows in the scaled image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ThumbnailImage

    -
    - -

    ThumbnailImage() changes the size of an image to the given dimensions and removes any associated profiles. The goal is to produce small low cost thumbnail images suited for display on the Web.

    - -

    The format of the ThumbnailImage method is:

    - -
    -  Image *ThumbnailImage(const Image *image,const size_t columns,
-    const size_t rows,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    columns
    -

    the number of columns in the scaled image.

    - -
    rows
    -

    the number of rows in the scaled image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/resource.html b/www/api/resource.html index de87fa5da..b5accc013 100644 --- a/www/api/resource.html +++ b/www/api/resource.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,170 +190,9 @@
    -

    Module resource - Methods

    -

    [AcquireMagickResource • AcquireUniqueFileResource • GetMagickResource • GetMagickResourceLimit • ListMagickResourceInfo • RelinquishMagickResource • RelinquishUniqueFileResource • SetMagickResourceLimit]

    +

    Module Methods

    +

    []

    -

    AcquireMagickResource

    -
    - -

    AcquireMagickResource() acquires resources of the specified type. MagickFalse is returned if the specified resource is exhausted otherwise MagickTrue.

    - -

    The format of the AcquireMagickResource() method is:

    - -
    -  MagickBooleanType AcquireMagickResource(const ResourceType type,
-    const MagickSizeType size)
-
    - -

    A description of each parameter follows:

    - -
    type
    -

    the type of resource.

    - -
    size
    -

    the number of bytes needed from for this resource.

    - -
    -

    AcquireUniqueFileResource

    -
    - -

    AcquireUniqueFileResource() returns a unique file name, and returns a file descriptor for the file open for reading and writing.

    - -

    The format of the AcquireUniqueFileResource() method is:

    - -
    -  int AcquireUniqueFileResource(char *path)
-
    - -

    A description of each parameter follows:

    - -
    path
    -

    Specifies a pointer to an array of characters. The unique path name is returned in this array.

    - -
    -

    GetMagickResource

    -
    - -

    GetMagickResource() returns the specified resource.

    - -

    The format of the GetMagickResource() method is:

    - -
    -  MagickSizeType GetMagickResource(const ResourceType type)
-
    - -

    A description of each parameter follows:

    - -
    type
    -

    the type of resource.

    - -
    -

    GetMagickResourceLimit

    -
    - -

    GetMagickResourceLimit() returns the specified resource limit.

    - -

    The format of the GetMagickResourceLimit() method is:

    - -
    -  MagickSizeType GetMagickResourceLimit(const ResourceType type)
-
    - -

    A description of each parameter follows:

    - -
    type
    -

    the type of resource.

    - -
    -

    ListMagickResourceInfo

    -
    - -

    ListMagickResourceInfo() lists the resource info to a file.

    - -

    The format of the ListMagickResourceInfo method is:

    - -
    -  MagickBooleanType ListMagickResourceInfo(FILE *file,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows.

    - -
    file
    -

    An pointer to a FILE.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    RelinquishMagickResource

    -
    - -

    RelinquishMagickResource() relinquishes resources of the specified type.

    - -

    The format of the RelinquishMagickResource() method is:

    - -
    -  void RelinquishMagickResource(const ResourceType type,
-    const MagickSizeType size)
-
    - -

    A description of each parameter follows:

    - -
    type
    -

    the type of resource.

    - -
    size
    -

    the size of the resource.

    - -
    -

    RelinquishUniqueFileResource

    -
    - -

    RelinquishUniqueFileResource() relinquishes a unique file resource.

    - -

    The format of the RelinquishUniqueFileResource() method is:

    - -
    -  MagickBooleanType RelinquishUniqueFileResource(const char *path)
-
    - -

    A description of each parameter follows:

    - -
    name
    -

    the name of the temporary resource.

    - -
    -

    SetMagickResourceLimit

    -
    - -

    SetMagickResourceLimit() sets the limit for a particular resource.

    - -

    The format of the SetMagickResourceLimit() method is:

    - -
    -  MagickBooleanType SetMagickResourceLimit(const ResourceType type,
-    const MagickSizeType limit)
-
    - -

    A description of each parameter follows:

    - -
    type
    -

    the type of resource.

    - -
    limit
    -

    the maximum limit for the resource.

    - -
    diff --git a/www/api/segment.html b/www/api/segment.html index 31a1212b6..8710f68fe 100644 --- a/www/api/segment.html +++ b/www/api/segment.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,114 +190,9 @@
    -

    Module shear - Methods

    -

    [AffineTransformImage • DeskewImage • RotateImage • ShearImage]

    +

    Module Methods

    +

    []

    -

    AffineTransformImage

    -
    - -

    AffineTransformImage() transforms an image as dictated by the affine matrix. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

    - -

    The format of the AffineTransformImage method is:

    - -
    -  Image *AffineTransformImage(const Image *image,
-    AffineMatrix *affine_matrix,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    affine_matrix
    -

    the affine matrix.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    DeskewImage

    -
    - -

    DeskewImage() removes skew from the image. Skew is an artifact that occurs in scanned images because of the camera being misaligned, imperfections in the scanning or surface, or simply because the paper was not placed completely flat when scanned.

    - -

    The format of the DeskewImage method is:

    - -
    -  Image *DeskewImage(const Image *image,const double threshold,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    threshold
    -

    separate background from foreground.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    RotateImage

    -
    - -

    RotateImage() creates a new image that is a rotated copy of an existing one. Positive angles rotate counter-clockwise (right-hand rule), while negative angles rotate clockwise. Rotated images are usually larger than the originals and have 'empty' triangular corners. X axis. Empty triangles left over from shearing the image are filled with the background color defined by member 'background_color' of the image. RotateImage allocates the memory necessary for the new Image structure and returns a pointer to the new image.

    - -

    RotateImage() is based on the paper "A Fast Algorithm for General Raster Rotatation" by Alan W. Paeth. RotateImage is adapted from a similar method based on the Paeth paper written by Michael Halle of the Spatial Imaging Group, MIT Media Lab.

    - -

    The format of the RotateImage method is:

    - -
    -  Image *RotateImage(const Image *image,const double degrees,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows.

    - -
    image
    -

    the image.

    - -
    degrees
    -

    Specifies the number of degrees to rotate the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ShearImage

    -
    - -

    ShearImage() creates a new image that is a shear_image copy of an existing one. Shearing slides one edge of an image along the X or Y axis, creating a parallelogram. An X direction shear slides an edge along the X axis, while a Y direction shear slides an edge along the Y axis. The amount of the shear is controlled by a shear angle. For X direction shears, x_shear is measured relative to the Y axis, and similarly, for Y direction shears y_shear is measured relative to the X axis. Empty triangles left over from shearing the image are filled with the background color defined by member 'background_color' of the image.. ShearImage() allocates the memory necessary for the new Image structure and returns a pointer to the new image.

    - -

    ShearImage() is based on the paper "A Fast Algorithm for General Raster Rotatation" by Alan W. Paeth.

    - -

    The format of the ShearImage method is:

    - -
    -  Image *ShearImage(const Image *image,const double x_shear,
-    const double y_shear,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows.

    - -
    image
    -

    the image.

    - -
    x_shear, y_shear
    -

    Specifies the number of degrees to shear the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/signature.html b/www/api/signature.html index 5864c5e46..01dd414c0 100644 --- a/www/api/signature.html +++ b/www/api/signature.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,28 +190,9 @@
    -

    Module signature - Methods

    -

    [SignatureImage]

    +

    Module Methods

    +

    []

    -

    SignatureImage

    -
    - -

    SignatureImage() computes a message digest from an image pixel stream with an implementation of the NIST SHA-256 Message Digest algorithm. This signature uniquely identifies the image and is convenient for determining if an image has been modified or whether two images are identical.

    - -

    The format of the SignatureImage method is:

    - -
    -  MagickBooleanType SignatureImage(Image *image)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    diff --git a/www/api/statistic.html b/www/api/statistic.html index 228a33d24..f792593a7 100644 --- a/www/api/statistic.html +++ b/www/api/statistic.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,57 +190,9 @@
    -

    Module stream - Methods

    -

    [ReadStream • WriteStream]

    +

    Module Methods

    +

    []

    -

    ReadStream

    -
    - -

    ReadStream() makes the image pixels available to a user supplied callback method immediately upon reading a scanline with the ReadImage() method.

    - -

    The format of the ReadStream() method is:

    - -
    -  Image *ReadStream(const ImageInfo *image_info,StreamHandler stream,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    stream
    -

    a callback method.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    WriteStream

    -
    - -

    WriteStream() makes the image pixels available to a user supplied callback method immediately upon writing pixel data with the WriteImage() method.

    - -

    The format of the WriteStream() method is:

    - -
    -  MagickBooleanType WriteStream(const ImageInfo *image_info,Image *,
-    StreamHandler stream)
-
    - -

    A description of each parameter follows:

    - -
    image_info
    -

    the image info.

    - -
    stream
    -

    A callback method.

    - -
    diff --git a/www/api/transform.html b/www/api/transform.html index 3c97d4d8b..f6d958a42 100644 --- a/www/api/transform.html +++ b/www/api/transform.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,346 +190,9 @@
    -

    Module transform - Methods

    -

    [ChopImage • CropImage • ExcerptImage • ExtentImage • FlipImage • FlopImage • RollImage • ShaveImage • SpliceImage • TransformImage • TransformImages • TransposeImage • TransverseImage • TrimImage]

    +

    Module Methods

    +

    []

    -

    ChopImage

    -
    - -

    ChopImage() removes a region of an image and collapses the image to occupy the removed portion.

    - -

    The format of the ChopImage method is:

    - -
    -  Image *ChopImage(const Image *image,const RectangleInfo *chop_info)
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    chop_info
    -

    Define the region of the image to chop.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    CropImage

    -
    - -

    CropImage() extracts a region of the image starting at the offset defined by geometry.

    - -

    The format of the CropImage method is:

    - -
    -  Image *CropImage(const Image *image,const RectangleInfo *geometry,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    geometry
    -

    Define the region of the image to crop with members x, y, width, and height.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ExcerptImage

    -
    - -

    ExcerptImage() returns a excerpt of the image as defined by the geometry.

    - -

    The format of the ExcerptImage method is:

    - -
    -  Image *ExcerptImage(const Image *image,const RectangleInfo *geometry,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    geometry
    -

    Define the region of the image to extend with members x, y, width, and height.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ExtentImage

    -
    - -

    ExtentImage() extends the image as defined by the geometry, gravity, and image background color. Set the (x,y) offset of the geometry to move the original image relative to the extended image.

    - -

    The format of the ExtentImage method is:

    - -
    -  Image *ExtentImage(const Image *image,const RectangleInfo *geometry,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    geometry
    -

    Define the region of the image to extend with members x, y, width, and height.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    FlipImage

    -
    - -

    FlipImage() creates a vertical mirror image by reflecting the pixels around the central x-axis.

    - -

    The format of the FlipImage method is:

    - -
    -  Image *FlipImage(const Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    FlopImage

    -
    - -

    FlopImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis.

    - -

    The format of the FlopImage method is:

    - -
    -  Image *FlopImage(const Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    RollImage

    -
    - -

    RollImage() offsets an image as defined by x_offset and y_offset.

    - -

    The format of the RollImage method is:

    - -
    -  Image *RollImage(const Image *image,const ssize_t x_offset,
-    const ssize_t y_offset,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    x_offset
    -

    the number of columns to roll in the horizontal direction.

    - -
    y_offset
    -

    the number of rows to roll in the vertical direction.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    ShaveImage

    -
    - -

    ShaveImage() shaves pixels from the image edges. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

    - -

    The format of the ShaveImage method is:

    - -
    -  Image *ShaveImage(const Image *image,const RectangleInfo *shave_info,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    shave_image
    -

    Method ShaveImage returns a pointer to the shaved image. A null image is returned if there is a memory shortage or if the image width or height is zero.

    - -
    image
    -

    the image.

    - -
    shave_info
    -

    Specifies a pointer to a RectangleInfo which defines the region of the image to crop.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    SpliceImage

    -
    - -

    SpliceImage() splices a solid color into the image as defined by the geometry.

    - -

    The format of the SpliceImage method is:

    - -
    -  Image *SpliceImage(const Image *image,const RectangleInfo *geometry,
-    ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    geometry
    -

    Define the region of the image to splice with members x, y, width, and height.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    TransformImage

    -
    - -

    TransformImage() is a convenience method that behaves like ResizeImage() or CropImage() but accepts scaling and/or cropping information as a region geometry specification. If the operation fails, the original image handle is returned.

    - -

    The format of the TransformImage method is:

    - -
    -  MagickBooleanType TransformImage(Image **image,const char *crop_geometry,
-    const char *image_geometry)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image The transformed image is returned as this parameter.

    - -
    crop_geometry
    -

    A crop geometry string. This geometry defines a subregion of the image to crop.

    - -
    image_geometry
    -

    An image geometry string. This geometry defines the final size of the image.

    - -
    -

    TransformImages

    -
    - -

    TransformImages() calls TransformImage() on each image of a sequence.

    - -

    The format of the TransformImage method is:

    - -
    -  MagickBooleanType TransformImages(Image **image,
-    const char *crop_geometry,const char *image_geometry)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image The transformed image is returned as this parameter.

    - -
    crop_geometry
    -

    A crop geometry string. This geometry defines a subregion of the image to crop.

    - -
    image_geometry
    -

    An image geometry string. This geometry defines the final size of the image.

    - -
    -

    TransposeImage

    -
    - -

    TransposeImage() creates a horizontal mirror image by reflecting the pixels around the central y-axis while rotating them by 90 degrees.

    - -

    The format of the TransposeImage method is:

    - -
    -  Image *TransposeImage(const Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    TransverseImage

    -
    - -

    TransverseImage() creates a vertical mirror image by reflecting the pixels around the central x-axis while rotating them by 270 degrees.

    - -

    The format of the TransverseImage method is:

    - -
    -  Image *TransverseImage(const Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    -

    TrimImage

    -
    - -

    TrimImage() trims pixels from the image edges. It allocates the memory necessary for the new Image structure and returns a pointer to the new image.

    - -

    The format of the TrimImage method is:

    - -
    -  Image *TrimImage(const Image *image,ExceptionInfo *exception)
-
    - -

    A description of each parameter follows:

    - -
    image
    -

    the image.

    - -
    exception
    -

    return any errors or warnings in this structure.

    - -
    diff --git a/www/api/version.html b/www/api/version.html index f28d81318..d1b8f4ff1 100644 --- a/www/api/version.html +++ b/www/api/version.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,135 +190,9 @@
    -

    Module version - Methods

    -

    [GetMagickCopyright • GetMagickFeatures • GetMagickHomeURL • GetMagickPackageName • GetMagickQuantumDepth • GetMagickQuantumRange • GetMagickReleaseDate • GetMagickVersion]

    +

    Module Methods

    +

    []

    -

    GetMagickCopyright

    -
    - -

    GetMagickCopyright() returns the ImageMagick API copyright as a string.

    - -

    The format of the GetMagickCopyright method is:

    - -
    -  const char *GetMagickCopyright(void)
-
    - -
    -

    GetMagickFeatures

    -
    - -

    GetMagickFeatures() returns the ImageMagick features.

    - -

    The format of the GetMagickFeatures method is:

    - -
    -  const char *GetMagickFeatures(void)
-
    - -

    No parameters are required.

    - -
    -

    GetMagickHomeURL

    -
    - -

    GetMagickHomeURL() returns the ImageMagick home URL.

    - -

    The format of the GetMagickHomeURL method is:

    - -
    -  char *GetMagickHomeURL(void)
-
    - -
    -

    GetMagickPackageName

    -
    - -

    GetMagickPackageName() returns the ImageMagick package name.

    - -

    The format of the GetMagickName method is:

    - -
    -  const char *GetMagickName(void)
-
    - -

    No parameters are required.

    - -
    -

    GetMagickQuantumDepth

    -
    - -

    GetMagickQuantumDepth() returns the ImageMagick quantum depth.

    - -

    The format of the GetMagickQuantumDepth method is:

    - -
    -  const char *GetMagickQuantumDepth(size_t *depth)
-
    - -

    A description of each parameter follows:

    - -
    depth
    -

    the quantum depth is returned as a number.

    - -
    -

    GetMagickQuantumRange

    -
    - -

    GetMagickQuantumRange() returns the ImageMagick quantum range.

    - -

    The format of the GetMagickQuantumRange method is:

    - -
    -  const char *GetMagickQuantumRange(size_t *range)
-
    - -

    A description of each parameter follows:

    - -
    range
    -

    the quantum range is returned as a number.

    - -
    -

    GetMagickReleaseDate

    -
    - -

    GetMagickReleaseDate() returns the ImageMagick release date.

    - -

    The format of the GetMagickReleaseDate method is:

    - -
    -  const char *GetMagickReleaseDate(void)
-
    - -

    No parameters are required.

    - -
    -

    GetMagickVersion

    -
    - -

    GetMagickVersion() returns the ImageMagick API version as a string and as a number.

    - -

    The format of the GetMagickVersion method is:

    - -
    -  const char *GetMagickVersion(size_t *version)
-
    - -

    A description of each parameter follows:

    - -
    version
    -

    the ImageMagick version is returned as a number.

    - -
    diff --git a/www/api/wand-view.html b/www/api/wand-view.html index 4d0a00c41..5fbc0f544 100644 --- a/www/api/wand-view.html +++ b/www/api/wand-view.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -186,435 +190,9 @@
    -

    Module wand-view - Methods

    -

    [CloneWandView • DestroyWandView • DuplexTransferWandViewIterator • GetWandViewException • GetWandViewExtent • GetWandViewIterator • GetWandViewPixels • GetWandViewWand • IsWandView • NewWandView • NewWandViewExtent • SetWandViewDescription • SetWandViewIterator • SetWandViewThreads • TransferWandViewIterator • UpdateWandViewIterator]

    +

    Module Methods

    +

    []

    -

    CloneWandView

    -
    - -

    CloneWandView() makes a copy of the specified wand view.

    - -

    The format of the CloneWandView method is:

    - -
    -  WandView *CloneWandView(const WandView *wand_view)
-
    - -

    A description of each parameter follows:

    - -
    wand_view
    -

    the wand view.

    - -
    -

    DestroyWandView

    -
    - -

    DestroyWandView() deallocates memory associated with a wand view.

    - -

    The format of the DestroyWandView method is:

    - -
    -  WandView *DestroyWandView(WandView *wand_view)
-
    - -

    A description of each parameter follows:

    - -
    wand_view
    -

    the wand view.

    - -
    -

    DuplexTransferWandViewIterator

    -
    - -

    DuplexTransferWandViewIterator() iterates over three wand views in parallel and calls your transfer method for each scanline of the view. The source and duplex pixel extent is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. However, the destination wand view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.

    - -

    The callback signature is:

    - -
    -  MagickBooleanType DuplexTransferImageViewMethod(const WandView *source,
-    const WandView *duplex,WandView *destination,const ssize_t y,
-    const int thread_id,void *context)
-
    - -

    Use this pragma if the view is not single threaded:

    - -
    -      #pragma omp critical
-
    - -

    to define a section of code in your callback transfer method that must be executed by a single thread at a time.

    - -

    The format of the DuplexTransferWandViewIterator method is:

    - -
    -  MagickBooleanType DuplexTransferWandViewIterator(WandView *source,
-    WandView *duplex,WandView *destination,
-    DuplexTransferWandViewMethod transfer,void *context)
-
    - -

    A description of each parameter follows:

    - -
    source
    -

    the source wand view.

    - -
    duplex
    -

    the duplex wand view.

    - -
    destination
    -

    the destination wand view.

    - -
    transfer
    -

    the transfer callback method.

    - -
    context
    -

    the user defined context.

    - -
    -

    GetWandViewException

    -
    - -

    GetWandViewException() returns the severity, reason, and description of any error that occurs when utilizing a wand view.

    - -

    The format of the GetWandViewException method is:

    - -
    -  char *GetWandViewException(const PixelWand *wand_view,
-    ExceptionType *severity)
-
    - -

    A description of each parameter follows:

    - -
    wand_view
    -

    the pixel wand_view.

    - -
    severity
    -

    the severity of the error is returned here.

    - -
    -

    GetWandViewExtent

    -
    - -

    GetWandViewExtent() returns the wand view extent.

    - -

    The format of the GetWandViewExtent method is:

    - -
    -  RectangleInfo GetWandViewExtent(const WandView *wand_view)
-
    - -

    A description of each parameter follows:

    - -
    wand_view
    -

    the wand view.

    - -
    -

    GetWandViewIterator

    -
    - -

    GetWandViewIterator() iterates over the wand view in parallel and calls your get method for each scanline of the view. The pixel extent is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. Any updates to the pixels in your callback are ignored.

    - -

    The callback signature is:

    - -
    -  MagickBooleanType GetImageViewMethod(const WandView *source,
-    const ssize_t y,const int thread_id,void *context)
-
    - -

    Use this pragma if the view is not single threaded:

    - -
    -      #pragma omp critical
-
    - -

    to define a section of code in your callback get method that must be executed by a single thread at a time.

    - -

    The format of the GetWandViewIterator method is:

    - -
    -  MagickBooleanType GetWandViewIterator(WandView *source,
-    GetWandViewMethod get,void *context)
-
    - -

    A description of each parameter follows:

    - -
    source
    -

    the source wand view.

    - -
    get
    -

    the get callback method.

    - -
    context
    -

    the user defined context.

    - -
    -

    GetWandViewPixels

    -
    - -

    GetWandViewPixels() returns the wand view pixel_wands.

    - -

    The format of the GetWandViewPixels method is:

    - -
    -  PixelWand *GetWandViewPixels(const WandView *wand_view)
-
    - -

    A description of each parameter follows:

    - -
    wand_view
    -

    the wand view.

    - -
    -

    GetWandViewWand

    -
    - -

    GetWandViewWand() returns the magick wand associated with the wand view.

    - -

    The format of the GetWandViewWand method is:

    - -
    -  MagickWand *GetWandViewWand(const WandView *wand_view)
-
    - -

    A description of each parameter follows:

    - -
    wand_view
    -

    the wand view.

    - -
    -

    IsWandView

    -
    - -

    IsWandView() returns MagickTrue if the the parameter is verified as a wand view object.

    - -

    The format of the IsWandView method is:

    - -
    -  MagickBooleanType IsWandView(const WandView *wand_view)
-
    - -

    A description of each parameter follows:

    - -
    wand_view
    -

    the wand view.

    - -
    -

    NewWandView

    -
    - -

    NewWandView() returns a wand view required for all other methods in the Wand View API.

    - -

    The format of the NewWandView method is:

    - -
    -  WandView *NewWandView(MagickWand *wand)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the wand.

    - -
    -

    NewWandViewExtent

    -
    - -

    NewWandViewExtent() returns a wand view required for all other methods in the Wand View API.

    - -

    The format of the NewWandViewExtent method is:

    - -
    -  WandView *NewWandViewExtent(MagickWand *wand,const ssize_t x,
-    const ssize_t y,const size_t width,const size_t height)
-
    - -

    A description of each parameter follows:

    - -
    wand
    -

    the magick wand.

    - -
    x,y,columns,rows
    -

    These values define the perimeter of a extent of pixel_wands view.

    - -
    -

    SetWandViewDescription

    -
    - -

    SetWandViewDescription() associates a description with an image view.

    - -

    The format of the SetWandViewDescription method is:

    - -
    -  void SetWandViewDescription(WandView *image_view,const char *description)
-
    - -

    A description of each parameter follows:

    - -
    wand_view
    -

    the wand view.

    - -
    description
    -

    the wand view description.

    - -
    -

    SetWandViewIterator

    -
    - -

    SetWandViewIterator() iterates over the wand view in parallel and calls your set method for each scanline of the view. The pixel extent is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension. The pixels are initiallly undefined and any settings you make in the callback method are automagically synced back to your image.

    - -

    The callback signature is:

    - -
    -  MagickBooleanType SetImageViewMethod(ImageView *destination,
-    const ssize_t y,const int thread_id,void *context)
-
    - -

    Use this pragma if the view is not single threaded:

    - -
    -      #pragma omp critical
-
    - -

    to define a section of code in your callback set method that must be executed by a single thread at a time.

    - -

    The format of the SetWandViewIterator method is:

    - -
    -  MagickBooleanType SetWandViewIterator(WandView *destination,
-    SetWandViewMethod set,void *context)
-
    - -

    A description of each parameter follows:

    - -
    destination
    -

    the wand view.

    - -
    set
    -

    the set callback method.

    - -
    context
    -

    the user defined context.

    - -
    -

    SetWandViewThreads

    -
    - -

    SetWandViewThreads() sets the number of threads in a thread team.

    - -

    The format of the SetWandViewDescription method is:

    - -
    -  void SetWandViewThreads(WandView *image_view,
-    const size_t number_threads)
-
    - -

    A description of each parameter follows:

    - -
    image_view
    -

    the image view.

    - -
    number_threads
    -

    the number of threads in a thread team.

    - -
    -

    TransferWandViewIterator

    -
    - -

    TransferWandViewIterator() iterates over two wand views in parallel and calls your transfer method for each scanline of the view. The source pixel extent is not confined to the image canvas-- that is you can include negative offsets or widths or heights that exceed the image dimension. However, the destination wand view is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted.

    - -

    The callback signature is:

    - -
    -  MagickBooleanType TransferImageViewMethod(const WandView *source,
-    WandView *destination,const ssize_t y,const int thread_id,
-    void *context)
-
    - -

    Use this pragma if the view is not single threaded:

    - -
    -      #pragma omp critical
-
    - -

    to define a section of code in your callback transfer method that must be executed by a single thread at a time.

    - -

    The format of the TransferWandViewIterator method is:

    - -
    -  MagickBooleanType TransferWandViewIterator(WandView *source,
-    WandView *destination,TransferWandViewMethod transfer,void *context)
-
    - -

    A description of each parameter follows:

    - -
    source
    -

    the source wand view.

    - -
    destination
    -

    the destination wand view.

    - -
    transfer
    -

    the transfer callback method.

    - -
    context
    -

    the user defined context.

    - -
    -

    UpdateWandViewIterator

    -
    - -

    UpdateWandViewIterator() iterates over the wand view in parallel and calls your update method for each scanline of the view. The pixel extent is confined to the image canvas-- that is no negative offsets or widths or heights that exceed the image dimension are permitted. Updates to pixels in your callback are automagically synced back to the image.

    - -

    The callback signature is:

    - -
    -  MagickBooleanType UpdateImageViewMethod(WandView *source,const ssize_t y,
-    const int thread_id,void *context)
-
    - -

    Use this pragma if the view is not single threaded:

    - -
    -      #pragma omp critical
-
    - -

    to define a section of code in your callback update method that must be executed by a single thread at a time.

    - -

    The format of the UpdateWandViewIterator method is:

    - -
    -  MagickBooleanType UpdateWandViewIterator(WandView *source,
-    UpdateWandViewMethod update,void *context)
-
    - -

    A description of each parameter follows:

    - -
    source
    -

    the source wand view.

    - -
    update
    -

    the update callback method.

    - -
    context
    -

    the user defined context.

    - -
    diff --git a/www/architecture.html b/www/architecture.html index 7c3c38be3..4c959748c 100644 --- a/www/architecture.html +++ b/www/architecture.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -286,12 +290,12 @@

    Once the pixel cache is associated with an image, you typically want to get, update, or put pixels into it. We refer to pixels inside the image region as authentic pixels and outside the region as virtual pixels. Use these methods to access the pixels in the cache:

    -
    +
    +

    Here is a typical MagickCore code snippet for manipulating pixels in the pixel cache. In our example, we copy pixels from the input image to the output image and decrease the intensity by 10%:

    @@ -500,19 +504,31 @@ File Area Memory Map Disk Thread Time

    Use ReadStream() or WriteStream() with an appropriate callback method in your MagickCore program to consume the pixels as they are streaming. Here's an abbreviated example of using ReadStream:

    -static size_t StreamHandler(const Image *image,const void *pixels,
+static size_t StreamPixels(const Image *image,const void *pixels,
   const size_t columns)
 {
-  /* process pixels here */
+  register const PixelPacket
+    *p;
+
+  MyData
+    *my_data;
+
+  my_data=(MyData *) image->client_data;
+  p=(PixelPacket *) pixels;
+  if (p != (const PixelPacket *) NULL)
+    {
+      /* process pixels here */
+    }
   return(columns);
 }
 
 ...
 /* invoke the pixel stream here */
-image=ReadStream(image_info,&StreamHandler,exception);
+image_info->client_data=(void *) MyData;
+image=ReadStream(image_info,&StreamPixels,exception);
    -

    We also provide a lightweight tool, stream, to stream one or more pixel components of the image or portion of the image to your choice of storage formats. It writes the pixel components as they are read from the input image a row at a time making stream desirable when working with large images or when you require raw pixel components.

    +

    We also provide a lightweight tool, stream, to stream one or more pixel components of the image or portion of the image to your choice of storage formats. It writes the pixel components as they are read from the input image a row at a time making stream desirable when working with large images or when you require raw pixel components. A majority of the image formats stream pixels (red, green, and blue) from left to right and top to bottom. However, a few formats do not support this common ordering (e.g. the PSD format).

    @@ -661,13 +677,13 @@ void ConvertBMPToImage(const BITMAPINFOHEADER *bmp_info, Copy all pixel data, row by row. */ #pragma omp parallel for - for (int y=0; y < int(image->rows()); y++) + for (int y=0; y < int(image->rows()); y++) { int row=(bmp_info->biHeight > 0) ? (image->rows()-y-1) : y; register const unsigned char *restrict p=pixels+row*bytes_per_row; register MagickCore::PixelPacket *restrict q= image->setPixels(0,y,image->columns(),1); - for (int x=0; x < int(image->columns()); x++) + for (int x=0; x < int(image->columns()); x++) { q->blue=p[0]; q->green=p[1]; diff --git a/www/binary-releases.html b/www/binary-releases.html index 7f4092a6c..c7790695c 100644 --- a/www/binary-releases.html +++ b/www/binary-releases.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/changelog.html b/www/changelog.html index 3b193be49..6a8930456 100644 --- a/www/changelog.html +++ b/www/changelog.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/cipher.html b/www/cipher.html index f33672ee2..4d4dd21e8 100644 --- a/www/cipher.html +++ b/www/cipher.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings @@ -194,7 +198,7 @@

    A number of ImageMagick options and methods take a color as an argument. The color can then be given as a color name (there is a limited but large set of these; see below) or it can be given as a set of numbers (in decimal or hexadecimal), each corresponding to a channel in an RGB or RGBA color model. HSL, HSLA, HSB, HSBA, CMYK, or CMYKA color models may also be specified. These topics are briefly described in the sections below.

    -

    Interactive Color Converter

    +

    Interactive Color Converter

    Use the @@ -260,7 +264,7 @@ color swatch of that color and to convert to all the other color models.

    The HSL color system is geometrically represented as a stacked double cone with one apex pointing downward and the other pointing upward. The widest ends of both cones are stacked together one on top of the other. Hue is measured around the perimeter. Saturation is measured from the axis outward. Lightness is measured from the bottom apex upward.

    -

    See http://en.wikipedia.org/wiki/HSL_and_HSV for more details on HSL and HSB color systems.

    +

    See http://en.wikipedia.org/wiki/HSL_and_HSV for more details on HSL and HSB color systems.

    Hue is represented as an angle of the color around the circular perimeter of the cone(s) (i.e. the rainbow represented in a circle). Hue values are either integer or floats in the range 0—360 or integer or float percentage values in the range 0—100%. By definition red=0=360 (or 0%=100%), and the other colors are spread around the circle, so green=120 (or 33.3333%), blue=240 (or (66.6667%), etc. As an angle, it implicitly wraps around such that -120=240 and 480=120, for instance. (Students of trigonometry would say that "coterminal angles are equivalent" here; an angle θ can be standardized by computing the equivalent angle, θ mod 360.)

    diff --git a/www/command-line-options.html b/www/command-line-options.html index c2b8ecc84..2568406d9 100644 --- a/www/command-line-options.html +++ b/www/command-line-options.html @@ -4,7 +4,11 @@ - + @@ -153,7 +157,7 @@ Web Hosting Ratings
    @@ -4782,19 +4786,19 @@ CMYK profiles are often very asymmetric since they involve 3−>4 and 4&m

    The -profile option can also be used to inject previously-formatted ancillary chunks into the output PNG file, using the commandline option as shown below or by setting the profile via a -programming interface: +programming interface:

    -

    $magick> -profile PNG-chunk-x:

    -where x is a location flag and +

    $magick> -profile PNG-chunk-x:<filename>

    +

    where x is a location flag and filename is a file containing the chunk name in the first 4 bytes, then a colon (":"), followed by the chunk data. This encoder will compute the chunk length and CRC, so those must not -be included in the file. +be included in the file.

    -"x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT), +

    "x" can be "b" (before PLTE), "m" (middle, i.e., between PLTE and IDAT), or "e" (end, i.e., after IDAT). If you want to write multiple chunks of the same type, then add a short unique string after the "x" to prevent -subsequent profiles from overwriting the preceding ones, e.g., +subsequent profiles from overwriting the preceding ones, e.g.,

    $magick> -profile PNG-chunk-b01:file01 -profile PNG-chunk-b02:file02

    diff --git a/www/command-line-processing.html b/www/command-line-processing.html index 18a6f5a3f..5b4b3863c 100644 --- a/www/command-line-processing.html +++ b/www/command-line-processing.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/command-line-tools.html b/www/command-line-tools.html index f1808a887..880b8f573 100644 --- a/www/command-line-tools.html +++ b/www/command-line-tools.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/compare.html b/www/compare.html index 8c5a001dc..3b22f44ad 100644 --- a/www/compare.html +++ b/www/compare.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings diff --git a/www/compose.html b/www/compose.html index 29809c5b2..d1218e0d5 100644 --- a/www/compose.html +++ b/www/compose.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings diff --git a/www/composite.html b/www/composite.html index 14bca2fc0..650a57a3e 100644 --- a/www/composite.html +++ b/www/composite.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings diff --git a/www/conjure.html b/www/conjure.html index fcd2c7817..c18cac5e0 100644 --- a/www/conjure.html +++ b/www/conjure.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings @@ -199,22 +203,22 @@
    - + - + - + - + - - + + diff --git a/www/convert.html b/www/convert.html index 8773f7856..6527b5f72 100644 --- a/www/convert.html +++ b/www/convert.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings diff --git a/www/display.html b/www/display.html index 424c894a7..2965d382b 100644 --- a/www/display.html +++ b/www/display.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings diff --git a/www/download.html b/www/download.html index de5180951..58d3e59c9 100644 --- a/www/download.html +++ b/www/download.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/escape.html b/www/escape.html index 25864a513..be2921d02 100644 --- a/www/escape.html +++ b/www/escape.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings diff --git a/www/examples.html b/www/examples.html index 78cb8cabc..4d9e30a53 100644 --- a/www/examples.html +++ b/www/examples.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -191,7 +195,7 @@

    Here are a few examples of what you can do with an image using ImageMagick from the command line, a program interface, or script. You can generate this image yourself with this PerlMagick script, examples.pl.


    - [ImageMagick] + [ImageMagick]
    diff --git a/www/exception.html b/www/exception.html index d8cebbef4..584369441 100644 --- a/www/exception.html +++ b/www/exception.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -189,6 +193,7 @@

    ImageMagick Exceptions

    +

    ImageMagick returns a status of 0 whenever a command or algorithm successfully complete without complaint. A warning code generally is typically just a notice that something unusual occurred but the command or algorithm still completed and most likely the results are still usable. An error means the command or algorithm could not complete as expected and any results are unreliable. A fatal error means the command or algorithm could not complete and the process exits prematurely and no results are returned.

    @@ -381,7 +386,6 @@
    - diff --git a/www/export.html b/www/export.html index 76077cb52..e27a7094f 100644 --- a/www/export.html +++ b/www/export.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/formats.html b/www/formats.html index 87b086d22..e2e3bf3b8 100644 --- a/www/formats.html +++ b/www/formats.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings @@ -985,7 +989,7 @@ convert \( -size 15x15 xc:black xc:white -append \) \ SID, MrSID R Multiresolution seamless image - Requires the mrsidgeodecode command line utility that decompresses MG2 or MG3 SID image files. + Requires the mrsidgeodecode command line utility that decompresses MG2 or MG3 SID image files. diff --git a/www/fx.html b/www/fx.html index 419421d17..cf7705e70 100644 --- a/www/fx.html +++ b/www/fx.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings diff --git a/www/identify.html b/www/identify.html index 6373fcf5a..758139910 100644 --- a/www/identify.html +++ b/www/identify.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/import.html b/www/import.html index 61c3a1d63..386fd44ea 100644 --- a/www/import.html +++ b/www/import.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings @@ -229,7 +233,7 @@
  • Morphology of shapes: extract features, describe shapes and recognize patterns in images.
  • Motion picture support: read and write the common image formats used in digital film work.
  • Image calculator: apply a mathematical expression to an image or image channels.
    • -
  • Discrete Fourier transform: implements the forward and inverse DFT.
    • +
  • Discrete Fourier transform: implements the forward and inverse DFT.
  • High dynamic-range images: accurately represent the wide range of intensity levels found in real scenes ranging from the brightest direct sunlight to the deepest darkest shadows.
  • Encipher or decipher an image: convert ordinary images into unintelligible gibberish and back again.
  • Virtual pixel support: convenient access to pixels outside the image region.
    • diff --git a/www/install-source.html b/www/install-source.html index 075ab61f2..52a4e48df 100644 --- a/www/install-source.html +++ b/www/install-source.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/jp2.html b/www/jp2.html index 5a9a1f8e8..d586b046a 100644 --- a/www/jp2.html +++ b/www/jp2.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings diff --git a/www/license.html b/www/license.html index 216f90344..df8a62a8e 100644 --- a/www/license.html +++ b/www/license.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/magick++.html b/www/magick++.html index f0092a9b6..bfe0c6fb6 100644 --- a/www/magick++.html +++ b/www/magick++.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings @@ -191,8 +195,8 @@

    [Introduction to Magick++ • Documentation • Obtaining Magick++ • Installation • Reporting Bugs]

    -

    Magick++ is the object-oriented C++ API to the ImageMagick image-processing library.

    -

    Magick++ supports an object model which is inspired by PerlMagick. +

    Magick++ is the object-oriented C++ API to the ImageMagick image-processing library.

    +

    Magick++ supports an object model which is inspired by PerlMagick. Images support implicit reference counting so that copy constructors and assignment incur almost no cost. The cost of actually copying an image (if necessary) is done just before modification and this copy @@ -201,11 +205,11 @@ automagically deleted. The image objects support value (rather than pointer) semantics so it is trivial to support multiple generations of an image in memory at one time.

    -

    Magick++ provides integrated support for the Standard -Template Library (STL) so that the powerful containers available -(e.g. deque, -vector, list, -and map)  can +

    Magick++ provides integrated support for the Standard +Template Library (STL) so that the powerful containers available +(e.g. deque, +vector, list, +and map)  can be used to write programs similar to those possible with PERL & PerlMagick. STL-compatible template versions of ImageMagick's list-style operations are provided so that operations may be @@ -215,31 +219,30 @@ performed on multiple images stored in STL containers.

    Documentation

    -

    Detailed documentation is +

    Detailed documentation is provided for all Magick++ classes, class methods, and template functions which comprise the API. See a Gentle Introduction to Magick++ for an introductory tutorial to Magick++. We include the source if you want to correct, enhance, or expand the tutorial.

    -

    Obtaining Magick++

    -

    Magick++ is included as part of ImageMagick -source releases and may be retrieved via ftp -or Subversion. +

    Magick++ is included as part of ImageMagick +source releases and may be retrieved via ftp +or Subversion.

    Installation

    Once you have the Magick++ sources available, follow these detailed -installation instructions for UNIX and +installation instructions for UNIX and Windows.

    -

    A helper script named Magick++-config is installed +

    A helper script named Magick++-config is installed under Unix which assists with recalling compilation options required to compile and link programs which use Magick++. For example, the -following command will compile and link the source file demo.cpp -to produce the executable demo (notice that quotes are +following command will compile and link the source file demo.cpp +to produce the executable demo (notice that quotes are backward quotes): 

    @@ -264,7 +267,7 @@ of installing ImageMagick in a known location.
 
    
 
 
    Questions regarding usage should be directed to or to report any bugs go to
-Magick++ bug tracking forum.
+Magick++ bug tracking forum.
 
    
 
    
 
diff --git a/www/magick-core.html b/www/magick-core.html
index f8399c40d..00419e1bd 100644
--- a/www/magick-core.html
+++ b/www/magick-core.html
@@ -1,7 +1,11 @@
 
 
-
+
 
   
   
@@ -150,7 +154,7 @@
   Web Hosting Ratings
    diff --git a/www/magick-vector-graphics.html b/www/magick-vector-graphics.html index f0113a76c..8d00e4c94 100644 --- a/www/magick-vector-graphics.html +++ b/www/magick-vector-graphics.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/miff.html b/www/miff.html index e2c124cd8..04291b33e 100644 --- a/www/miff.html +++ b/www/miff.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/montage.html b/www/montage.html index e674216bc..f3e377bfd 100644 --- a/www/montage.html +++ b/www/montage.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings diff --git a/www/motion-picture.html b/www/motion-picture.html index a6b7d24d3..d8d854854 100644 --- a/www/motion-picture.html +++ b/www/motion-picture.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings diff --git a/www/perl-magick.html b/www/perl-magick.html index b9c843571..171614872 100644 --- a/www/perl-magick.html +++ b/www/perl-magick.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/quantize.html b/www/quantize.html index 8ef488a5e..357c0bd23 100644 --- a/www/quantize.html +++ b/www/quantize.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/resources.html b/www/resources.html index 07faa98bf..750b6f77b 100644 --- a/www/resources.html +++ b/www/resources.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/search.html b/www/search.html index fc98155b4..add917841 100644 --- a/www/search.html +++ b/www/search.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings diff --git a/www/sitemap.html b/www/sitemap.html index f8e6efadc..74e10ed7e 100644 --- a/www/sitemap.html +++ b/www/sitemap.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -240,7 +244,7 @@
    Command-line tools: overview of the ImageMagick commands.
    -
      +
      animate: animates an image sequence on any X server.
      compare: mathematically and visually annotate the difference between an image and its reconstruction.
      composite: overlaps one image over another.
      @@ -252,7 +256,7 @@
      mogrify: resize an image, blur, crop, despeckle, dither, draw on, flip, join, re-sample, and more.
      montage: create a composite image by combining several separate images.
      stream: a lightweight tool to stream one or more pixel components of the image or portion of the image to your choice of storage formats.
      -
    +
    Command line processing: the anatomy of the command line.
    Command line options: annotated list of all options that can appear on the command-line.
    Fx: apply a mathematical expression to an image or image channels.
    @@ -265,7 +269,7 @@
    Program interfaces: application programming interfaces.
    -
      +
      ChMagick: is a Ch an embeddable MagickCore C/C++ interpreter for cross-platform scripting.
      CL-Magick: provides a Common Lisp interface to the ImageMagick library.
      G2F: implements an Ada 95 binding to a subset of the low-level MagickCore library.
      @@ -281,7 +285,7 @@
      PythonMagick: an object-oriented Python interface to ImageMagick.
      RMagick: is an interface between the Ruby programming language and ImageMagick.
      TclMagick: a native Tcl-extension to the ImageMagick MagickWand API.
      -
    +
    diff --git a/www/sponsors.html b/www/sponsors.html index 369a47564..6e4c0217d 100644 --- a/www/sponsors.html +++ b/www/sponsors.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings @@ -191,7 +195,7 @@ -

    Active ImageMagick Sponsors

    +

    Active ImageMagick Sponsors

    We want to thank the sponsors of the ImageMagick project, including:

    @@ -236,8 +240,8 @@
    - Support the ImageMagick Project +

    Sponsorships can be anonymous, or public. We are willing to provide recognition for significant sponsorships, and can provide links to the sponsor's web site. We reserve the right to refuse a sponsorship if we deem the site being sponsored as having inappropriate content. For direct monetary contributions, click on the donate button to contribute thru Paypal or with a credit card:

    diff --git a/www/stream.html b/www/stream.html index eade6158f..a3935208b 100644 --- a/www/stream.html +++ b/www/stream.html @@ -1,7 +1,11 @@ - + @@ -150,7 +154,7 @@ Web Hosting Ratings

    diff --git a/www/subversion.html b/www/subversion.html index 39a856006..9bc0f73fd 100644 --- a/www/subversion.html +++ b/www/subversion.html @@ -1,6 +1,10 @@ - + @@ -149,7 +153,7 @@ Web Hosting Ratings