MagickCore 6.9.12
Data Structures | Macros | Typedefs | Enumerations | Functions
image.h File Reference
#include "magick/color.h"
#include "magick/blob.h"
#include "magick/colorspace.h"
#include "magick/cache-view.h"
#include "magick/composite.h"
#include "magick/compress.h"
#include "magick/effect.h"
#include "magick/geometry.h"
#include "magick/layer.h"
#include "magick/locale_.h"
#include "magick/monitor.h"
#include "magick/pixel.h"
#include "magick/profile.h"
#include "magick/quantum.h"
#include "magick/resample.h"
#include "magick/resize.h"
#include "magick/semaphore.h"
#include "magick/stream.h"
#include "magick/timer.h"
Include dependency graph for image.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _PrimaryInfo
 
struct  _SegmentInfo
 
struct  _ChromaticityInfo
 
struct  _Image
 
struct  _ImageInfo
 

Macros

#define OpaqueOpacity   ((Quantum) 0UL)
 
#define TransparentOpacity   (QuantumRange)
 

Typedefs

typedef struct _PrimaryInfo PrimaryInfo
 
typedef struct _SegmentInfo SegmentInfo
 
typedef struct _ChromaticityInfo ChromaticityInfo
 

Enumerations

enum  AlphaChannelType {
  UndefinedAlphaChannel , ActivateAlphaChannel , BackgroundAlphaChannel , CopyAlphaChannel ,
  DeactivateAlphaChannel , ExtractAlphaChannel , OpaqueAlphaChannel , ResetAlphaChannel ,
  SetAlphaChannel , ShapeAlphaChannel , TransparentAlphaChannel , FlattenAlphaChannel ,
  RemoveAlphaChannel , AssociateAlphaChannel , DisassociateAlphaChannel
}
 
enum  ImageType {
  UndefinedType , BilevelType , GrayscaleType , GrayscaleMatteType ,
  PaletteType , PaletteMatteType , TrueColorType , TrueColorMatteType ,
  ColorSeparationType , ColorSeparationMatteType , OptimizeType , PaletteBilevelMatteType
}
 
enum  InterlaceType {
  UndefinedInterlace , NoInterlace , LineInterlace , PlaneInterlace ,
  PartitionInterlace , GIFInterlace , JPEGInterlace , PNGInterlace
}
 
enum  OrientationType {
  UndefinedOrientation , TopLeftOrientation , TopRightOrientation , BottomRightOrientation ,
  BottomLeftOrientation , LeftTopOrientation , RightTopOrientation , RightBottomOrientation ,
  LeftBottomOrientation
}
 
enum  ResolutionType { UndefinedResolution , PixelsPerInchResolution , PixelsPerCentimeterResolution }
 
enum  TransmitType {
  UndefinedTransmitType , FileTransmitType , BlobTransmitType , StreamTransmitType ,
  ImageTransmitType
}
 

Functions

MagickExport ExceptionType CatchImageException (Image *)
 
MagickExport FILE * GetImageInfoFile (const ImageInfo *)
 
MagickExport Image * AcquireImage (const ImageInfo *)
 
MagickExport Image * AppendImages (const Image *, const MagickBooleanType, ExceptionInfo *)
 
MagickExport Image * CloneImage (const Image *, const size_t, const size_t, const MagickBooleanType, ExceptionInfo *)
 
MagickExport Image * DestroyImage (Image *)
 
MagickExport Image * GetImageClipMask (const Image *, ExceptionInfo *) magick_attribute((__pure__))
 
MagickExport Image * GetImageMask (const Image *, ExceptionInfo *) magick_attribute((__pure__))
 
MagickExport Image * NewMagickImage (const ImageInfo *, const size_t, const size_t, const MagickPixelPacket *)
 
MagickExport Image * ReferenceImage (Image *)
 
MagickExport Image * SmushImages (const Image *, const MagickBooleanType, const ssize_t, ExceptionInfo *)
 
MagickExport ImageInfo * AcquireImageInfo (void)
 
MagickExport ImageInfo * CloneImageInfo (const ImageInfo *)
 
MagickExport ImageInfo * DestroyImageInfo (ImageInfo *)
 
MagickExport MagickBooleanType ClipImage (Image *)
 
MagickExport MagickBooleanType ClipImagePath (Image *, const char *, const MagickBooleanType)
 
MagickExport MagickBooleanType CopyImagePixels (Image *, const Image *, const RectangleInfo *, const OffsetInfo *, ExceptionInfo *)
 
MagickExport MagickBooleanType IsTaintImage (const Image *)
 
MagickExport MagickBooleanType IsMagickConflict (const char *) magick_attribute((__pure__))
 
MagickExport MagickBooleanType IsHighDynamicRangeImage (const Image *, ExceptionInfo *)
 
MagickExport MagickBooleanType IsImageObject (const Image *)
 
MagickExport MagickBooleanType ListMagickInfo (FILE *, ExceptionInfo *)
 
MagickExport MagickBooleanType ModifyImage (Image **, ExceptionInfo *)
 
MagickExport MagickBooleanType ResetImagePage (Image *, const char *)
 
MagickExport MagickBooleanType ResetImagePixels (Image *, ExceptionInfo *)
 
MagickExport MagickBooleanType SetImageBackgroundColor (Image *)
 
MagickExport MagickBooleanType SetImageClipMask (Image *, const Image *)
 
MagickExport MagickBooleanType SetImageColor (Image *, const MagickPixelPacket *)
 
MagickExport MagickBooleanType SetImageExtent (Image *, const size_t, const size_t)
 
MagickExport MagickBooleanType SetImageInfo (ImageInfo *, const unsigned int, ExceptionInfo *)
 
MagickExport MagickBooleanType SetImageMask (Image *, const Image *)
 
MagickExport MagickBooleanType SetImageOpacity (Image *, const Quantum)
 
MagickExport MagickBooleanType SetImageChannels (Image *, const size_t)
 
MagickExport MagickBooleanType SetImageStorageClass (Image *, const ClassType)
 
MagickExport MagickBooleanType StripImage (Image *)
 
MagickExport MagickBooleanType SyncImage (Image *)
 
MagickExport MagickBooleanType SyncImageSettings (const ImageInfo *, Image *)
 
MagickExport MagickBooleanType SyncImagesSettings (ImageInfo *, Image *)
 
MagickExport size_t InterpretImageFilename (const ImageInfo *, Image *, const char *, int, char *)
 
MagickExport ssize_t GetImageReferenceCount (Image *)
 
MagickExport size_t GetImageChannels (Image *)
 
MagickExport VirtualPixelMethod GetImageVirtualPixelMethod (const Image *)
 
MagickExport VirtualPixelMethod SetImageVirtualPixelMethod (const Image *, const VirtualPixelMethod)
 
MagickExport void AcquireNextImage (const ImageInfo *, Image *)
 
MagickExport void DestroyImagePixels (Image *)
 
MagickExport void DisassociateImageStream (Image *)
 
MagickExport void GetImageException (Image *, ExceptionInfo *)
 
MagickExport void GetImageInfo (ImageInfo *)
 
MagickExport void SetImageInfoBlob (ImageInfo *, const void *, const size_t)
 
MagickExport void SetImageInfoFile (ImageInfo *, FILE *)
 

Macro Definition Documentation

◆ OpaqueOpacity

#define OpaqueOpacity   ((Quantum) 0UL)

Definition at line 27 of file image.h.

◆ TransparentOpacity

#define TransparentOpacity   (QuantumRange)

Definition at line 28 of file image.h.

Typedef Documentation

◆ ChromaticityInfo

typedef struct _ChromaticityInfo ChromaticityInfo

◆ PrimaryInfo

typedef struct _PrimaryInfo PrimaryInfo

◆ SegmentInfo

typedef struct _SegmentInfo SegmentInfo

Enumeration Type Documentation

◆ AlphaChannelType

enum AlphaChannelType
Enumerator
UndefinedAlphaChannel 
ActivateAlphaChannel 
BackgroundAlphaChannel 
CopyAlphaChannel 
DeactivateAlphaChannel 
ExtractAlphaChannel 
OpaqueAlphaChannel 
ResetAlphaChannel 
SetAlphaChannel 
ShapeAlphaChannel 
TransparentAlphaChannel 
FlattenAlphaChannel 
RemoveAlphaChannel 
AssociateAlphaChannel 
DisassociateAlphaChannel 

Definition at line 30 of file image.h.

◆ ImageType

enum ImageType
Enumerator
UndefinedType 
BilevelType 
GrayscaleType 
GrayscaleMatteType 
PaletteType 
PaletteMatteType 
TrueColorType 
TrueColorMatteType 
ColorSeparationType 
ColorSeparationMatteType 
OptimizeType 
PaletteBilevelMatteType 

Definition at line 49 of file image.h.

◆ InterlaceType

enum InterlaceType
Enumerator
UndefinedInterlace 
NoInterlace 
LineInterlace 
PlaneInterlace 
PartitionInterlace 
GIFInterlace 
JPEGInterlace 
PNGInterlace 

Definition at line 65 of file image.h.

◆ OrientationType

enum OrientationType
Enumerator
UndefinedOrientation 
TopLeftOrientation 
TopRightOrientation 
BottomRightOrientation 
BottomLeftOrientation 
LeftTopOrientation 
RightTopOrientation 
RightBottomOrientation 
LeftBottomOrientation 

Definition at line 77 of file image.h.

◆ ResolutionType

enum ResolutionType
Enumerator
UndefinedResolution 
PixelsPerInchResolution 
PixelsPerCentimeterResolution 

Definition at line 90 of file image.h.

◆ TransmitType

enum TransmitType
Enumerator
UndefinedTransmitType 
FileTransmitType 
BlobTransmitType 
StreamTransmitType 
ImageTransmitType 

Definition at line 114 of file image.h.

Function Documentation

◆ AcquireImage()

MagickExport Image * AcquireImage ( const ImageInfo *  )

◆ AcquireImageInfo()

MagickExport ImageInfo * AcquireImageInfo ( void  )

◆ AcquireNextImage()

MagickExport void AcquireNextImage ( const ImageInfo *  ,
Image *   
)

◆ AppendImages()

MagickExport Image * AppendImages ( const Image *  ,
const  MagickBooleanType,
ExceptionInfo *   
)

◆ CatchImageException()

MagickExport ExceptionType CatchImageException ( Image *  image)

Definition at line 623 of file image.c.

References AcquireExceptionInfo(), CatchException(), DestroyExceptionInfo(), _Image::filename, GetImageException(), GetMagickModule, IsEventLogging(), LogMagickEvent(), MagickCoreSignature, MagickFalse, _ExceptionInfo::severity, _Image::signature, and TraceEvent.

◆ ClipImage()

MagickExport MagickBooleanType ClipImage ( Image *  )

◆ ClipImagePath()

MagickExport MagickBooleanType ClipImagePath ( Image *  ,
const char *  ,
const  MagickBooleanType 
)

◆ CloneImage()

MagickExport Image * CloneImage ( const Image *  ,
const  size_t,
const  size_t,
const  MagickBooleanType,
ExceptionInfo *   
)

◆ CloneImageInfo()

MagickExport ImageInfo * CloneImageInfo ( const ImageInfo *  )

◆ CopyImagePixels()

MagickExport MagickBooleanType CopyImagePixels ( Image *  ,
const Image *  ,
const RectangleInfo *  ,
const OffsetInfo *  ,
ExceptionInfo *   
)

◆ DestroyImage()

MagickExport Image * DestroyImage ( Image *  )

◆ DestroyImageInfo()

MagickExport ImageInfo * DestroyImageInfo ( ImageInfo *  image_info)

Definition at line 1252 of file image.c.

References _ImageInfo::authenticate, _ImageInfo::cache, _ImageInfo::density, DestroyImageOptions(), DestroyPixelCache(), DestroyString(), DestroyStringInfo(), _ImageInfo::extract, _ImageInfo::filename, _ImageInfo::font, GetMagickModule, IsEventLogging(), LogMagickEvent(), MagickCoreSignature, MagickFalse, _ImageInfo::page, _ImageInfo::profile, RelinquishMagickMemory(), _ImageInfo::sampling_factor, _ImageInfo::scenes, _ImageInfo::server_name, _ImageInfo::signature, _ImageInfo::size, _ImageInfo::texture, TraceEvent, and _ImageInfo::view.

Referenced by BlobToImage(), ClipImagePath(), DestroyRegistryNode(), DrawPatternPath(), DrawPrimitive(), GetDrawInfo(), GlobExpression(), HoughLineImage(), IdentifyImage(), ImagesToBlob(), ImageToBlob(), InjectImageBlob(), InterpretImageProperties(), InvokeDelegate(), MontageImageList(), MontageImages(), PingBlob(), PingImage(), PingImages(), PreviewImage(), ReadImage(), ReadImages(), ReadInlineImage(), ReadStream(), RenderPostscript(), SetImageProperty(), SetImageType(), StreamImage(), WriteImage(), WriteImages(), WriteStream(), and WriteStreamImage().

◆ DestroyImagePixels()

MagickExport void DestroyImagePixels ( Image *  )

◆ DisassociateImageStream()

MagickExport void DisassociateImageStream ( Image *  )

◆ GetImageChannels()

MagickExport size_t GetImageChannels ( Image *  image)

Definition at line 1553 of file image.c.

References _Image::channels, _Image::filename, GetMagickModule, IsEventLogging(), LogMagickEvent(), MagickCoreSignature, MagickFalse, _Image::signature, and TraceEvent.

◆ GetImageClipMask()

MagickExport Image * GetImageClipMask ( const Image *  ,
ExceptionInfo *   
)

◆ GetImageException()

MagickExport void GetImageException ( Image *  ,
ExceptionInfo *   
)

◆ GetImageInfo()

MagickExport void GetImageInfo ( ImageInfo *  )

◆ GetImageInfoFile()

MagickExport FILE * GetImageInfoFile ( const ImageInfo *  image_info)

Definition at line 1492 of file image.c.

References _ImageInfo::file.

◆ GetImageMask()

MagickExport Image * GetImageMask ( const Image *  ,
ExceptionInfo *   
)

◆ GetImageReferenceCount()

MagickExport ssize_t GetImageReferenceCount ( Image *  image)

Definition at line 1584 of file image.c.

References _Image::filename, GetMagickModule, IsEventLogging(), LockSemaphoreInfo(), LogMagickEvent(), MagickCoreSignature, MagickFalse, _Image::reference_count, _Image::semaphore, _Image::signature, TraceEvent, and UnlockSemaphoreInfo().

Referenced by ModifyImage().

◆ GetImageVirtualPixelMethod()

MagickExport VirtualPixelMethod GetImageVirtualPixelMethod ( const Image *  )

◆ InterpretImageFilename()

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

Definition at line 1665 of file image.c.

References ConcatenateMagickString(), CopyMagickString(), FormatLocaleString(), GetImageArtifact(), GetImageOption(), GetImageProperty(), IsStringTrue(), LocaleNCompare(), MagickFalse, MagickTrue, and MaxTextExtent.

Referenced by OpenBlob(), PingImages(), ReadImages(), and SetImageInfo().

◆ IsHighDynamicRangeImage()

MagickExport MagickBooleanType IsHighDynamicRangeImage ( const Image *  ,
ExceptionInfo *   
)

◆ IsImageObject()

MagickExport MagickBooleanType IsImageObject ( const Image *  )

◆ IsMagickConflict()

MagickExport MagickBooleanType IsMagickConflict ( const char *  )

Referenced by GetPathComponent(), and SetImageInfo().

◆ IsTaintImage()

MagickExport MagickBooleanType IsTaintImage ( const Image *  )

◆ ListMagickInfo()

MagickExport MagickBooleanType ListMagickInfo ( FILE *  ,
ExceptionInfo *   
)

◆ ModifyImage()

MagickExport MagickBooleanType ModifyImage ( Image **  ,
ExceptionInfo *   
)

◆ NewMagickImage()

MagickExport Image * NewMagickImage ( const ImageInfo *  ,
const  size_t,
const  size_t,
const MagickPixelPacket *   
)

◆ ReferenceImage()

MagickExport Image * ReferenceImage ( Image *  )

◆ ResetImagePage()

MagickExport MagickBooleanType ResetImagePage ( Image *  ,
const char *   
)

◆ ResetImagePixels()

MagickExport MagickBooleanType ResetImagePixels ( Image *  ,
ExceptionInfo *   
)

◆ SetImageBackgroundColor()

MagickExport MagickBooleanType SetImageBackgroundColor ( Image *  )

◆ SetImageChannels()

MagickExport MagickBooleanType SetImageChannels ( Image *  ,
const  size_t 
)

◆ SetImageClipMask()

MagickExport MagickBooleanType SetImageClipMask ( Image *  ,
const Image *   
)

◆ SetImageColor()

MagickExport MagickBooleanType SetImageColor ( Image *  ,
const MagickPixelPacket *   
)

◆ SetImageExtent()

MagickExport MagickBooleanType SetImageExtent ( Image *  ,
const  size_t,
const  size_t 
)

◆ SetImageInfo()

MagickExport MagickBooleanType SetImageInfo ( ImageInfo *  ,
const unsigned int  ,
ExceptionInfo *   
)

◆ SetImageInfoBlob()

MagickExport void SetImageInfoBlob ( ImageInfo *  ,
const void *  ,
const  size_t 
)

◆ SetImageInfoFile()

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

Definition at line 3117 of file image.c.

References _ImageInfo::file, _ImageInfo::filename, GetMagickModule, IsEventLogging(), LogMagickEvent(), MagickCoreSignature, MagickFalse, _ImageInfo::signature, and TraceEvent.

Referenced by CloneImageInfo(), InjectImageBlob(), and SetImageInfo().

◆ SetImageMask()

MagickExport MagickBooleanType SetImageMask ( Image *  ,
const Image *   
)

◆ SetImageOpacity()

MagickExport MagickBooleanType SetImageOpacity ( Image *  ,
const  Quantum 
)

◆ SetImageStorageClass()

MagickExport MagickBooleanType SetImageStorageClass ( Image *  ,
const  ClassType 
)

◆ SetImageVirtualPixelMethod()

MagickExport VirtualPixelMethod SetImageVirtualPixelMethod ( const Image *  image,
const  VirtualPixelMethod 
)

Definition at line 3281 of file image.c.

References _Image::filename, GetMagickModule, IsEventLogging(), LogMagickEvent(), MagickCoreSignature, MagickFalse, SetPixelCacheVirtualMethod(), _Image::signature, and TraceEvent.

Referenced by DeskewImage(), DistortResizeImage(), RotateImage(), ShadowImage(), and TextureImage().

◆ SmushImages()

MagickExport Image * SmushImages ( const Image *  images,
const  MagickBooleanType,
const  ssize_t,
ExceptionInfo *  exception 
)

Definition at line 3468 of file image.c.

References AcquireVirtualCacheView(), CloneImage(), _Image::columns, CompositeImage(), DestroyCacheView(), DestroyImage(), DirectClass, _Image::exception, _Image::filename, GetMagickModule, GetNextImageInList(), _Image::gravity, GravityAdjustGeometry(), InheritException(), IsEventLogging(), LogMagickEvent(), MagickCoreSignature, MagickFalse, MagickTrue, _Image::matte, OverCompositeOp, _Image::previous, _Image::rows, SetGeometry(), SetImageBackgroundColor(), SetImageProgress(), SetImageStorageClass(), _ExceptionInfo::signature, _Image::signature, SmushImageTag, SmushXGap(), SmushYGap(), TraceEvent, _RectangleInfo::x, and _RectangleInfo::y.

◆ StripImage()

MagickExport MagickBooleanType StripImage ( Image *  )

◆ SyncImage()

MagickExport MagickBooleanType SyncImage ( Image *  )

◆ SyncImageSettings()

MagickExport MagickBooleanType SyncImageSettings ( const ImageInfo *  ,
Image *   
)

◆ SyncImagesSettings()

MagickExport MagickBooleanType SyncImagesSettings ( ImageInfo *  image_info,
Image *  images 
)

Definition at line 3776 of file image.c.

References DeleteImageOption(), _Image::filename, GetMagickModule, GetNextImageInList(), IsEventLogging(), LogMagickEvent(), MagickCoreSignature, MagickFalse, MagickTrue, _Image::signature, _ImageInfo::signature, SyncImageSettings(), and TraceEvent.