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/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
Defines
#define	OpaqueOpacity   ((Quantum) 0UL)
#define	TransparentOpacity   ((Quantum) QuantumRange)
Typedefs
typedef struct _PrimaryInfo	PrimaryInfo
typedef struct _SegmentInfo	SegmentInfo
typedef struct _ChromaticityInfo	ChromaticityInfo
Enumerations
enum	AlphaChannelType {   UndefinedAlphaChannel, ActivateAlphaChannel, CopyAlphaChannel, DeactivateAlphaChannel,   ExtractAlphaChannel, OpaqueAlphaChannel, ResetAlphaChannel, 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 Image *	AcquireImage (const ImageInfo *)
MagickExport Image **	AppendImages (const Image *, const MagickBooleanType, ExceptionInfo *)
MagickExport Image ***	AverageImages (const Image *, ExceptionInfo *)
MagickExport Image ****	CloneImage (const Image *, const unsigned long, const unsigned long, const MagickBooleanType, ExceptionInfo *)
MagickExport Image *****	CombineImages (const Image *, const ChannelType, ExceptionInfo *)
MagickExport Image ******	DestroyImage (Image *)
MagickExport Image *******	GetImageClipMask (const Image *, ExceptionInfo *)
MagickExport Image ********	GetImageMask (const Image *, ExceptionInfo *)
MagickExport Image *********	NewMagickImage (const ImageInfo *, const unsigned long, const unsigned long, const MagickPixelPacket *)
MagickExport Image **********	ReferenceImage (Image *)
MagickExport Image ***********	SeparateImages (const Image *, const ChannelType, ExceptionInfo *)
MagickExport ImageInfo *	AcquireImageInfo (void)
MagickExport ImageInfo **	CloneImageInfo (const ImageInfo *)
MagickExport ImageInfo ***	DestroyImageInfo (ImageInfo *)
MagickExport ImageType	GetImageType (Image *, ExceptionInfo *)
MagickExport long	InterpretImageFilename (char *, const size_t, const char *, int)
MagickExport MagickBooleanType	AcquireImageColormap (Image *, const unsigned long)
MagickExport MagickBooleanType	ClipImage (Image *)
MagickExport MagickBooleanType	ClipImagePath (Image *, const char *, const MagickBooleanType)
MagickExport MagickBooleanType	CycleColormapImage (Image *, const long)
MagickExport MagickBooleanType	GetImageAlphaChannel (const Image *)
MagickExport MagickBooleanType	IsTaintImage (const Image *)
MagickExport MagickBooleanType	IsMagickConflict (const char *)
MagickExport MagickBooleanType	IsHighDynamicRangeImage (const Image *, ExceptionInfo *)
MagickExport MagickBooleanType	IsImageObject (const Image *)
MagickExport MagickBooleanType	ListMagickInfo (FILE *, ExceptionInfo *)
MagickExport MagickBooleanType	ModifyImage (Image **, ExceptionInfo *)
MagickExport MagickBooleanType	PlasmaImage (Image *, const SegmentInfo *, unsigned long, unsigned long)
MagickExport MagickBooleanType	ResetImagePage (Image *, const char *)
MagickExport MagickBooleanType	SeparateImageChannel (Image *, const ChannelType)
MagickExport MagickBooleanType	SetImageAlphaChannel (Image *, const AlphaChannelType)
MagickExport MagickBooleanType	SetImageBackgroundColor (Image *)
MagickExport MagickBooleanType	SetImageClipMask (Image *, const Image *)
MagickExport MagickBooleanType	SetImageExtent (Image *, const unsigned long, const unsigned long)
MagickExport MagickBooleanType	SetImageInfo (ImageInfo *, const MagickBooleanType, ExceptionInfo *)
MagickExport MagickBooleanType	SetImageMask (Image *, const Image *)
MagickExport MagickBooleanType	SetImageOpacity (Image *, const Quantum)
MagickExport MagickBooleanType	SetImageStorageClass (Image *, const ClassType)
MagickExport MagickBooleanType	SetImageType (Image *, const ImageType)
MagickExport MagickBooleanType	SortColormapByIntensity (Image *)
MagickExport MagickBooleanType	StripImage (Image *)
MagickExport MagickBooleanType	SyncImage (Image *)
MagickExport MagickBooleanType	TextureImage (Image *, const 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 *)

---

Define Documentation

#define OpaqueOpacity   ((Quantum) 0UL)

Definition at line 27 of file image.h.

Referenced by AcquireCacheNexus(), AcquireImageColormap(), AssociateAlphaPixel(), BilevelImageChannel(), ColorFloodfillImage(), ColorizeImage(), ComparePixels(), CompositeImageChannel(), DefineImageColormap(), DistortImage(), DrawPrimitive(), ExportQuantumPixels(), ExtentImage(), FloodfillPaintImage(), FrameImage(), GetColorTuple(), GetDrawInfo(), GetFillColor(), GetMagickPixelPacket(), GetMontageInfo(), GetStrokeColor(), GradientImage(), ImplodeImage(), ImportQuantumPixels(), IsMagickColorEqual(), IsOpaqueImage(), MatteFloodfillImage(), OpaqueImage(), PosterizeImage(), QueryMagickColor(), QueryMagickColorname(), SetImage(), SetImageAlphaChannel(), SetImageBackgroundColor(), SetImageOpacity(), SpliceImage(), SwirlImage(), TextureImage(), ThresholdImageChannel(), TintImage(), and WaveImage().

#define TransparentOpacity   ((Quantum) QuantumRange)

Definition at line 28 of file image.h.

Referenced by AcquireCacheNexus(), AnnotateImage(), BilevelImageChannel(), ClearBounds(), CoalesceImages(), ColorFloodfillImage(), CompareImageLayers(), CompositeClear(), CompositeImageChannel(), CropImage(), DisposeImages(), DrawClipPath(), DrawImage(), DrawPrimitive(), DrawStrokePolygon(), ExportQuantumPixels(), FloodfillPaintImage(), GetDrawInfo(), GetMontageInfo(), IdentifyImage(), ImportQuantumPixels(), IsMagickColorEqual(), MagickCompositeBlend(), MagickCompositeOver(), MagickPixelCompositeMask(), MagickPixelCompositeOver(), MatteFloodfillImage(), OptimizeImageTransparency(), OptimizeLayerFrames(), RenderPostscript(), SetImageAlphaChannel(), and TrimImage().

---

Typedef Documentation

typedef struct _ChromaticityInfo ChromaticityInfo

typedef struct _PrimaryInfo PrimaryInfo

typedef struct _SegmentInfo SegmentInfo

---

Enumeration Type Documentation

enum AlphaChannelType

Enumerator:

UndefinedAlphaChannel
ActivateAlphaChannel
CopyAlphaChannel
DeactivateAlphaChannel
ExtractAlphaChannel
OpaqueAlphaChannel
ResetAlphaChannel
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 44 of file image.h.

enum InterlaceType

Enumerator:

UndefinedInterlace
NoInterlace
LineInterlace
PlaneInterlace
PartitionInterlace
GIFInterlace
JPEGInterlace
PNGInterlace

Definition at line 60 of file image.h.

enum OrientationType

Enumerator:

UndefinedOrientation
TopLeftOrientation
TopRightOrientation
BottomRightOrientation
BottomLeftOrientation
LeftTopOrientation
RightTopOrientation
RightBottomOrientation
LeftBottomOrientation

Definition at line 72 of file image.h.

enum ResolutionType

Enumerator:

UndefinedResolution
PixelsPerInchResolution
PixelsPerCentimeterResolution

Definition at line 85 of file image.h.

enum TransmitType

Enumerator:

UndefinedTransmitType
FileTransmitType
BlobTransmitType
StreamTransmitType
ImageTransmitType

Definition at line 109 of file image.h.

---

Function Documentation

MagickExport Image* AcquireImage

(

const ImageInfo *

)

MagickExport MagickBooleanType AcquireImageColormap	(	Image *	,
		const unsigned long
	)

MagickExport ImageInfo* AcquireImageInfo

(

void

)

MagickExport void AcquireNextImage	(	const ImageInfo *	,
		Image *
	)

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

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

MagickExport ExceptionType CatchImageException

(

Image *

)

Definition at line 963 of file image.c.

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

MagickExport MagickBooleanType ClipImage

(

Image *

)

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

MagickExport Image* * * * CloneImage	(	const Image *	,
		const unsigned long	,
		const unsigned long	,
		const	MagickBooleanType,
		ExceptionInfo *
	)

MagickExport ImageInfo* * CloneImageInfo

(

const ImageInfo *

)

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

MagickExport MagickBooleanType CycleColormapImage	(	Image *	,
		const	long
	)

MagickExport Image* * * * * * DestroyImage

(

Image *

)

MagickExport ImageInfo* * * DestroyImageInfo

(

ImageInfo *

)

Definition at line 1748 of file image.c.

References _ImageInfo::authenticate, _ImageInfo::cache, _ImageInfo::debug, _ImageInfo::density, DestroyCacheInfo(), DestroyImageOptions(), DestroyString(), DestroyStringInfo(), _ImageInfo::extract, _ImageInfo::filename, _ImageInfo::font, GetMagickModule, LogMagickEvent(), MagickFalse, MagickSignature, _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(), DrawImage(), DrawPatternPath(), DrawPrimitive(), GetDrawInfo(), GlobExpression(), IdentifyImage(), ImagesToBlob(), ImageToBlob(), InjectImageBlob(), InterpretImageProperties(), InvokeDelegate(), MontageImageList(), MontageImages(), PingBlob(), PingImage(), PingImages(), PreviewImage(), ReadImage(), ReadImages(), ReadInlineImage(), ReadStream(), RenderPostscript(), SetImageType(), StreamImage(), WriteImage(), WriteImages(), WriteStream(), and WriteStreamImage().

MagickExport void DestroyImagePixels

(

Image *

)

MagickExport void DisassociateImageStream

(

Image *

)

MagickExport MagickBooleanType GetImageAlphaChannel

(

const Image *

)

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

MagickExport void GetImageException	(	Image *	,
		ExceptionInfo *
	)

MagickExport void GetImageInfo

(

ImageInfo *

)

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

MagickExport ImageType GetImageType	(	Image *	,
		ExceptionInfo *
	)

Definition at line 2051 of file image.c.

References BilevelType, CMYKColorspace, ColorSeparationMatteType, ColorSeparationType, _Image::colorspace, _Image::debug, _Image::filename, GetMagickModule, GrayscaleMatteType, GrayscaleType, IsGrayImage(), IsMonochromeImage(), IsPaletteImage(), LogMagickEvent(), MagickFalse, MagickSignature, _Image::matte, PaletteMatteType, PaletteType, _Image::signature, TraceEvent, TrueColorMatteType, and TrueColorType.

Referenced by IdentifyImage().

MagickExport VirtualPixelMethod GetImageVirtualPixelMethod

(

const Image *

)

MagickExport long InterpretImageFilename	(	char *	,
		const	size_t,
		const char *	,
		int
	)

Definition at line 2148 of file image.c.

References ConcatenateMagickString(), CopyMagickString(), FormatMagickString(), MagickFalse, and MagickTrue.

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

MagickExport MagickBooleanType IsHighDynamicRangeImage	(	const Image *	,
		ExceptionInfo *
	)

MagickExport MagickBooleanType IsImageObject

(

const Image *

)

MagickExport MagickBooleanType IsMagickConflict

(

const char *

)

Referenced by GetPathComponent(), and SetImageInfo().

MagickExport MagickBooleanType IsTaintImage

(

const Image *

)

MagickExport MagickBooleanType ListMagickInfo	(	FILE *	,
		ExceptionInfo *
	)

MagickExport MagickBooleanType ModifyImage	(	Image **	,
		ExceptionInfo *
	)

MagickExport Image* * * * * * * * * NewMagickImage	(	const ImageInfo *	,
		const unsigned long	,
		const unsigned long	,
		const MagickPixelPacket *
	)

MagickExport MagickBooleanType PlasmaImage	(	Image *	,
		const SegmentInfo *	,
		unsigned long	,
		unsigned long
	)

MagickExport Image* * * * * * * * * * ReferenceImage

(

Image *

)

MagickExport MagickBooleanType ResetImagePage	(	Image *	,
		const char *
	)

MagickExport MagickBooleanType SeparateImageChannel	(	Image *	,
		const	ChannelType
	)

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

Definition at line 3070 of file image.c.

References AppendImageToList(), BlackChannel, BlueChannel, CloneImage(), CMYKColorspace, _Image::colorspace, _Image::debug, _Image::filename, GetMagickModule, GreenChannel, LogMagickEvent(), MagickFalse, MagickSignature, MagickTrue, NewImageList(), OpacityChannel, RedChannel, SeparateImageChannel(), _Image::signature, and TraceEvent.

MagickExport MagickBooleanType SetImageAlphaChannel	(	Image *	,
		const	AlphaChannelType
	)

MagickExport MagickBooleanType SetImageBackgroundColor

(

Image *

)

MagickExport MagickBooleanType SetImageClipMask	(	Image *	,
		const Image *
	)

MagickExport MagickBooleanType SetImageExtent	(	Image *	,
		const unsigned long	,
		const unsigned long
	)

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

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

MagickExport void SetImageInfoFile	(	ImageInfo *	,
		FILE *
	)

Definition at line 3851 of file image.c.

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

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

MagickExport MagickBooleanType SetImageMask	(	Image *	,
		const Image *
	)

MagickExport MagickBooleanType SetImageOpacity	(	Image *	,
		const	Quantum
	)

MagickExport MagickBooleanType SetImageStorageClass	(	Image *	,
		const	ClassType
	)

MagickExport MagickBooleanType SetImageType	(	Image *	,
		const	ImageType
	)

MagickExport VirtualPixelMethod SetImageVirtualPixelMethod	(	const Image *	,
		const	VirtualPixelMethod
	)

Definition at line 4196 of file image.c.

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

Referenced by AcquireImage(), and ShadowImage().

MagickExport MagickBooleanType SortColormapByIntensity

(

Image *

)

MagickExport MagickBooleanType StripImage

(

Image *

)

MagickExport MagickBooleanType SyncImage

(

Image *

)

MagickExport MagickBooleanType TextureImage	(	Image *	,
		const Image *
	)

Definition at line 4510 of file image.c.

References