image.h File Reference

#include <MagickCore/color.h>
#include "MagickCore/blob.h"
#include "MagickCore/colorspace.h"
#include "MagickCore/cache-view.h"
#include "MagickCore/composite.h"
#include "MagickCore/compress.h"
#include "MagickCore/effect.h"
#include "MagickCore/geometry.h"
#include "MagickCore/layer.h"
#include "MagickCore/locale_.h"
#include "MagickCore/monitor.h"
#include "MagickCore/pixel.h"
#include "MagickCore/profile.h"
#include "MagickCore/quantum.h"
#include "MagickCore/resample.h"
#include "MagickCore/resize.h"
#include "MagickCore/semaphore.h"
#include "MagickCore/stream.h"
#include "MagickCore/timer.h"

Include dependency graph for image.h:

Go to the source code of this file.

Data Structures
struct	_PrimaryInfo
struct	_SegmentInfo
struct	_ChromaticityInfo
struct	_Image
struct	_ImageInfo
Defines
#define	OpaqueAlpha   ((Quantum) QuantumRange)
#define	TransparentAlpha   ((Quantum) 0UL)
Typedefs
typedef struct _PrimaryInfo	PrimaryInfo
typedef struct _SegmentInfo	SegmentInfo
typedef struct _ChromaticityInfo	ChromaticityInfo
Enumerations
enum	AlphaChannelType {   UndefinedAlphaChannel, ActivateAlphaChannel, BackgroundAlphaChannel, CopyAlphaChannel,   DeactivateAlphaChannel, ExtractAlphaChannel, OpaqueAlphaChannel, RemoveAlphaChannel,   SetAlphaChannel, ShapeAlphaChannel, TransparentAlphaChannel }
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 *, ExceptionInfo *)
MagickExport Image *	AppendImages (const Image *, const MagickBooleanType, ExceptionInfo *)
MagickExport Image *	CloneImage (const Image *, const size_t, const size_t, const MagickBooleanType, ExceptionInfo *)
MagickExport Image *	CombineImages (const Image *, ExceptionInfo *)
MagickExport Image *	DestroyImage (Image *)
MagickExport Image *	GetImageClipMask (const Image *, ExceptionInfo *)
MagickExport Image *	GetImageMask (const Image *, ExceptionInfo *)
MagickExport Image *	NewMagickImage (const ImageInfo *, const size_t, const size_t, const PixelInfo *, ExceptionInfo *)
MagickExport Image *	ReferenceImage (Image *)
MagickExport Image *	SeparateImage (const Image *, const ChannelType, ExceptionInfo *)
MagickExport Image *	SeparateImages (const Image *, ExceptionInfo *)
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 *, ExceptionInfo *)
MagickExport MagickBooleanType	ClipImagePath (Image *, const char *, const MagickBooleanType, ExceptionInfo *)
MagickExport MagickBooleanType	GetImageAlphaChannel (const Image *)
MagickExport MagickBooleanType	IsTaintImage (const Image *)
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	SetImageAlpha (Image *, const Quantum, ExceptionInfo *)
MagickExport MagickBooleanType	SetImageAlphaChannel (Image *, const AlphaChannelType, ExceptionInfo *)
MagickExport MagickBooleanType	SetImageBackgroundColor (Image *, ExceptionInfo *)
MagickExport MagickBooleanType	SetImageColor (Image *, const PixelInfo *, ExceptionInfo *)
MagickExport MagickBooleanType	SetImageExtent (Image *, const size_t, const size_t, ExceptionInfo *)
MagickExport MagickBooleanType	SetImageInfo (ImageInfo *, const unsigned int, ExceptionInfo *)
MagickExport MagickBooleanType	SetImageMask (Image *, const Image *, ExceptionInfo *)
MagickExport MagickBooleanType	SetImageStorageClass (Image *, const ClassType, ExceptionInfo *)
MagickExport MagickBooleanType	SetImageType (Image *, const ImageType, ExceptionInfo *)
MagickExport MagickBooleanType	StripImage (Image *, ExceptionInfo *)
MagickExport MagickBooleanType	SyncImage (Image *, ExceptionInfo *)
MagickExport MagickBooleanType	SyncImageSettings (const ImageInfo *, Image *, ExceptionInfo *)
MagickExport MagickBooleanType	SyncImagesSettings (ImageInfo *, Image *, ExceptionInfo *)
MagickExport size_t	InterpretImageFilename (const ImageInfo *, Image *, const char *, int, char *, ExceptionInfo *)
MagickExport ssize_t	GetImageReferenceCount (Image *)
MagickExport VirtualPixelMethod	GetImageVirtualPixelMethod (const Image *)
MagickExport VirtualPixelMethod	SetImageVirtualPixelMethod (const Image *, const VirtualPixelMethod)
MagickExport void	AcquireNextImage (const ImageInfo *, Image *, ExceptionInfo *)
MagickExport void	DestroyImagePixels (Image *)
MagickExport void	DisassociateImageStream (Image *)
MagickExport void	GetImageInfo (ImageInfo *)
MagickExport void	SetImageInfoBlob (ImageInfo *, const void *, const size_t)
MagickExport void	SetImageInfoFile (ImageInfo *, FILE *)
Variables
MagickExport const char	DefaultTileGeometry []
MagickExport const char	DefaultTileLabel []
MagickExport const char	LoadImageTag []
MagickExport const char	LoadImagesTag []
MagickExport const char	PSDensityGeometry []
MagickExport const char	PSPageGeometry []
MagickExport const char	SaveImageTag []
MagickExport const char	SaveImagesTag []
MagickExport const double	DefaultResolution

---

Define Documentation

#define OpaqueAlpha   ((Quantum) QuantumRange)

Definition at line 27 of file image.h.

Referenced by IsImageOpaque(), GetVirtualPixelsFromNexus(), GetColorTuple(), QueryColorCompliance(), QueryColorname(), AcquireImageColormap(), CompositePixelInfoOver(), CompositeImage(), FrameImage(), DistortImage(), DrawPrimitive(), GetDrawInfo(), ImplodeImage(), SwirlImage(), TintImage(), WaveImage(), SetImageAlphaChannel(), ComparePixels(), GetMontageInfo(), GradientImage(), GetPixelAlpha(), GetPixelOpacity(), GetPixelInfoPixel(), IsPixelInfoEquivalent(), SetPixelInfoPixel(), GetPixelInfo(), IsFuzzyEquivalencePixelInfo(), AssociateAlphaPixel(), AssociateAlphaPixelInfo(), DefineImageColormap(), ExportGrayAlphaQuantum(), ImportBGRQuantum(), ImportGrayQuantum(), ImportGrayAlphaQuantum(), ImportIndexAlphaQuantum(), ImportRGBQuantum(), and ExtentImage().

#define TransparentAlpha   ((Quantum) 0UL)

Definition at line 28 of file image.h.

Referenced by AnnotateImage(), RenderPostscript(), GetVirtualPixelsFromNexus(), CompositeImage(), DrawClipPath(), DrawPrimitive(), DrawStrokePolygon(), GetDrawInfo(), IdentifyImage(), SetImageAlphaChannel(), SmushXGap(), SmushYGap(), ClearBounds(), DisposeImages(), CompareImagesLayers(), OptimizeLayerFrames(), OptimizeImageTransparency(), GetMontageInfo(), IsPixelInfoEquivalent(), ExportIndexAlphaQuantum(), ImportGrayAlphaQuantum(), ImportIndexAlphaQuantum(), CropImage(), and TrimImage().

---

Typedef Documentation

typedef struct _ChromaticityInfo ChromaticityInfo

typedef struct _PrimaryInfo PrimaryInfo

typedef struct _SegmentInfo SegmentInfo

---

Enumeration Type Documentation

enum AlphaChannelType

Enumerator:

UndefinedAlphaChannel
ActivateAlphaChannel
BackgroundAlphaChannel
CopyAlphaChannel
DeactivateAlphaChannel
ExtractAlphaChannel
OpaqueAlphaChannel
RemoveAlphaChannel
SetAlphaChannel
ShapeAlphaChannel
TransparentAlphaChannel

Definition at line 30 of file image.h.

enum ImageType

Enumerator:

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

Definition at line 45 of file image.h.

enum InterlaceType

Enumerator:

UndefinedInterlace
NoInterlace
LineInterlace
PlaneInterlace
PartitionInterlace
GIFInterlace
JPEGInterlace
PNGInterlace

Definition at line 61 of file image.h.

enum OrientationType

Enumerator:

UndefinedOrientation
TopLeftOrientation
TopRightOrientation
BottomRightOrientation
BottomLeftOrientation
LeftTopOrientation
RightTopOrientation
RightBottomOrientation
LeftBottomOrientation

Definition at line 73 of file image.h.

enum ResolutionType

Enumerator:

UndefinedResolution
PixelsPerInchResolution
PixelsPerCentimeterResolution

Definition at line 86 of file image.h.

enum TransmitType

Enumerator:

UndefinedTransmitType
FileTransmitType
BlobTransmitType
StreamTransmitType
ImageTransmitType

Definition at line 110 of file image.h.

---

Function Documentation

MagickExport Image* AcquireImage	(	const ImageInfo *	,
		ExceptionInfo *
	)

MagickExport ImageInfo* AcquireImageInfo

(

void

)

MagickExport void AcquireNextImage	(	const ImageInfo *	,
		Image *	,
		ExceptionInfo *
	)

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

MagickExport ExceptionType CatchImageException

(

Image *

)

Definition at line 624 of file image.c.

References _ImageView::exception, _Image::signature, MagickSignature, _Image::debug, MagickFalse, LogMagickEvent(), TraceEvent, GetMagickModule, _Image::filename, AcquireExceptionInfo(), CatchException(), _ExceptionInfo::severity, and DestroyExceptionInfo().

MagickExport MagickBooleanType ClipImage	(	Image *	,
		ExceptionInfo *
	)

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

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

MagickExport ImageInfo * CloneImageInfo

(

const ImageInfo *

)

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

MagickExport Image * DestroyImage

(

Image *

)

MagickExport ImageInfo * DestroyImageInfo

(

ImageInfo *

)

Definition at line 1228 of file image.c.

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

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

MagickExport void DestroyImagePixels

(

Image *

)

MagickExport void DisassociateImageStream

(

Image *

)

MagickExport MagickBooleanType GetImageAlphaChannel

(

const Image *

)

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

MagickExport void GetImageInfo

(

ImageInfo *

)

MagickExport FILE* GetImageInfoFile

(

const ImageInfo *

)

Definition at line 1413 of file image.c.

References _ImageInfo::file.

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

MagickExport ssize_t GetImageReferenceCount

(

Image *

)

Definition at line 1527 of file image.c.

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

Referenced by ModifyImage().

MagickExport VirtualPixelMethod GetImageVirtualPixelMethod

(

const Image *

)

MagickExport size_t InterpretImageFilename	(	const ImageInfo *	,
		Image *	,
		const char *	,
		int	,
		char *	,
		ExceptionInfo *
	)

Definition at line 1611 of file image.c.

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

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

MagickExport MagickBooleanType IsHighDynamicRangeImage	(	const Image *	,
		ExceptionInfo *
	)

MagickExport MagickBooleanType IsImageObject

(

const Image *

)

MagickExport MagickBooleanType IsTaintImage

(

const Image *

)

MagickExport MagickBooleanType ListMagickInfo	(	FILE *	,
		ExceptionInfo *
	)

MagickExport MagickBooleanType ModifyImage	(	Image **	,
		ExceptionInfo *
	)

MagickExport Image * NewMagickImage	(	const ImageInfo *	,
		const size_t	,
		const size_t	,
		const PixelInfo *	,
		ExceptionInfo *
	)

MagickExport Image * ReferenceImage

(

Image *

)

MagickExport MagickBooleanType ResetImagePage	(	Image *	,
		const char *
	)

MagickExport Image * SeparateImage	(	const Image *	,
		const ChannelType	,
		ExceptionInfo *
	)

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

MagickExport MagickBooleanType SetImageAlpha	(	Image *	,
		const Quantum	,
		ExceptionInfo *
	)

MagickExport MagickBooleanType SetImageAlphaChannel	(	Image *	,
		const AlphaChannelType	,
		ExceptionInfo *
	)

MagickExport MagickBooleanType SetImageBackgroundColor	(	Image *	,
		ExceptionInfo *
	)

MagickExport MagickBooleanType SetImageColor	(	Image *	,
		const PixelInfo *	,
		ExceptionInfo *
	)

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

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

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

MagickExport void SetImageInfoFile	(	ImageInfo *	,
		FILE *
	)

Definition at line 3300 of file image.c.

References _ImageInfo::signature, MagickSignature, _ImageInfo::debug, MagickFalse, LogMagickEvent(), TraceEvent, GetMagickModule, _ImageInfo::filename, and _ImageInfo::file.

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

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

MagickExport MagickBooleanType SetImageStorageClass	(	Image *	,
		const ClassType	,
		ExceptionInfo *
	)

MagickExport MagickBooleanType SetImageType	(	Image *	,
		const ImageType	,
		ExceptionInfo *
	)

MagickExport VirtualPixelMethod SetImageVirtualPixelMethod	(	const Image *	,
		const VirtualPixelMethod
	)

Definition at line 3691 of file image.c.

References _Image::signature, MagickSignature, _Image::debug, MagickFalse, LogMagickEvent(), TraceEvent, GetMagickModule, _Image::filename, and SetPixelCacheVirtualMethod().

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

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

Definition at line 3878 of file image.c.

References _ImageView::image, _Image::signature, MagickSignature, _Image::debug, MagickFalse, LogMagickEvent(), TraceEvent, GetMagickModule, _Image::filename, _ExceptionInfo::signature, _Image::matte, _Image::columns, _Image::rows, GetNextImageInList(), MagickTrue, _Image::previous, CloneImage(), SetImageStorageClass(), DirectClass, DestroyImage(), SetImageBackgroundColor(), AcquireCacheView(), SetGeometry(), GravityAdjustGeometry(), _Image::gravity, _RectangleInfo::x, SmushYGap(), SmushXGap(), _RectangleInfo::y, CompositeImage(), OverCompositeOp, SetImageProgress(), SmushImageTag, and DestroyCacheView().

MagickExport MagickBooleanType StripImage	(	Image *	,
		ExceptionInfo *
	)

MagickExport MagickBooleanType SyncImage	(	Image *	,
		ExceptionInfo *
	)

MagickExport MagickBooleanType SyncImageSettings	(	const ImageInfo *	,
		Image *	,
		ExceptionInfo *
	)

MagickExport MagickBooleanType SyncImagesSettings	(	ImageInfo *	,
		Image *	,
		ExceptionInfo *
	)

Definition at line 4173 of file image.c.

References _ImageView::image, _ImageInfo::signature, MagickSignature, _Image::signature, _Image::debug, MagickFalse, LogMagickEvent(), TraceEvent, GetMagickModule, _Image::filename, GetNextImageInList(), SyncImageSettings(), DeleteImageOption(), and MagickTrue.

---

Variable Documentation

MagickExport const double DefaultResolution

Definition at line 120 of file image.c.

Referenced by RenderPostscript(), DrawBoundingRectangles(), and AcquireImage().

MagickExport const char DefaultTileGeometry[]

Definition at line 107 of file image.c.

Referenced by GetMontageInfo().

MagickExport const char DefaultTileLabel[]

Definition at line 108 of file image.c.

Referenced by PreviewImage().

MagickExport const char LoadImagesTag[]

Definition at line 111 of file image.c.

MagickExport const char LoadImageTag[]

Definition at line 110 of file image.c.

Referenced by HuffmanDecodeImage(), and HuffmanEncodeImage().

MagickExport const char PSDensityGeometry[]

Definition at line 113 of file image.c.

MagickExport const char PSPageGeometry[]

Definition at line 114 of file image.c.

MagickExport const char SaveImagesTag[]

Definition at line 116 of file image.c.

MagickExport const char SaveImageTag[]

Definition at line 115 of file image.c.