granicus.if.org Git - imagemagick/blob - Magick++/README

   1 This is Magick++, the object-oriented C++ API to the ImageMagick
   2 image-processing library, the most comprehensive open-source image processing
   3 solution available. Read the release notes for Magick++.
   4
   5 Magick++ supports an object model which is inspired by PerlMagick.  Magick++
   6 executes faster than PerlMagick since it is accessed from a compiled language
   7 rather than from a scripting language. This makes it more suitable for Web CGI
   8 programs which must start-up and execute quickly.  Images support implicit
   9 reference counting so that copy constructors and assignment incur almost no
  10 cost. The cost of actually copying an image (if necessary) is done just before
  11 modification and this copy is managed automatically by Magick++. De-referenced
  12 copies are automatically deleted.  The image objects support value (rather than
  13 pointer)  semantics so it is trivial to support multiple generations of an
  14 image in memory at one time.
  15
  16 Magick++ provides integrated support for the Standard Template Library (STL) so
  17 that the powerful containers available (e.g. deque, vector, list, and map) can
  18 be used to write programs similar to those possible with PERL & PerlMagick.
  19 STL-compatable template versions of ImageMagick's list-style operations are
  20 provided so that operations may be performed on multiple images stored in STL
  21 containers.
  22
  23 Documentation
  24
  25 Detailed documentation are provided for all Magick++ classes, class methods,
  26 and template functions which comprise the API.
  27
  28 Obtaining Magick++
  29
  30 Magick++ is included as part of ImageMagick source releases and may be
  31 retrieved via ftp or Subversion.
  32
  33 Installation
  34
  35 Once you have the sources available, follow these detailed installation
  36 instructions for UNIX and Windows.
  37
  38 Usage
  39
  40 A helper script named Magick++-config is installed under Unix which assists
  41 with recalling compilation options required to compile and link programs which
  42 use Magick++.  For example, the following command will compile and link the
  43 source file example.cpp to produce the executable example (notice that quotes
  44 are backward quotes):
  45
  46      c++ `Magick++-config --cxxflags --cppflags --ldflags --libs` \
  47        -o example example.cpp
  48
  49 Windows users may get started by manually editing a project file for one of the
  50 Magick++ demo programs.
  51
  52 Reporting Bugs
  53
  54 Please report any bugs via the Magick++ Bug Tracking System at
  55 https://imagemagick.org/discourse-server/.