image.h File Reference

#include "MagickCore/blob.h"
#include "MagickCore/colorspace.h"
#include "MagickCore/cache-view.h"
#include "MagickCore/color.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:

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	OpaqueAlpha   ((Quantum) QuantumRange)
#define	TransparentAlpha   ((Quantum) 0)

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

Enumerations
enum	AlphaChannelOption {   UndefinedAlphaChannel, ActivateAlphaChannel, AssociateAlphaChannel, BackgroundAlphaChannel,   CopyAlphaChannel, DeactivateAlphaChannel, DiscreteAlphaChannel, DisassociateAlphaChannel,   ExtractAlphaChannel, OffAlphaChannel, OnAlphaChannel, OpaqueAlphaChannel,   RemoveAlphaChannel, SetAlphaChannel, ShapeAlphaChannel, TransparentAlphaChannel }
enum	ImageType {   UndefinedType, BilevelType, GrayscaleType, GrayscaleAlphaType,   PaletteType, PaletteAlphaType, TrueColorType, TrueColorAlphaType,   ColorSeparationType, ColorSeparationAlphaType, OptimizeType, PaletteBilevelAlphaType }
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 ChannelType	SetImageChannelMask (Image *, const ChannelType)
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 *	DestroyImage (Image *)
MagickExport Image *	GetImageMask (const Image *, const PixelMask, ExceptionInfo *)
MagickExport Image *	NewMagickImage (const ImageInfo *, const size_t, const size_t, const PixelInfo *, ExceptionInfo *)
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 *, ExceptionInfo *)
MagickExport MagickBooleanType	ClipImagePath (Image *, const char *, const MagickBooleanType, ExceptionInfo *)
MagickExport MagickBooleanType	CopyImagePixels (Image *, const Image *, const RectangleInfo *, const OffsetInfo *, ExceptionInfo *)
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	ResetImagePixels (Image *, ExceptionInfo *)
MagickExport MagickBooleanType	SetImageAlpha (Image *, const Quantum, 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 PixelMask type, const Image *, ExceptionInfo *)
MagickExport MagickBooleanType	SetImageRegionMask (Image *, const PixelMask type, const RectangleInfo *, ExceptionInfo *)
MagickExport MagickBooleanType	SetImageStorageClass (Image *, const ClassType, 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 (Image *, const VirtualPixelMethod, ExceptionInfo *)
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 *)
MagickExport void	SetImageInfoCustomStream (ImageInfo *, CustomStreamInfo *)

Macro Definition Documentation

OpaqueAlpha

#define OpaqueAlpha   ((Quantum) QuantumRange)

Definition at line 25 of file image.h.

Referenced by AcquireImageColormap(), ApplyPixelCompositeMask(), AssociateAlphaPixel(), AssociateAlphaPixelInfo(), ClassifyImageColors(), ColorizeImage(), ComparePixels(), ConformPixelInfo(), DefineImageColormap(), DrawClippingMask(), DrawCompositeMask(), DrawPrimitive(), ExportGrayAlphaQuantum(), FloodfillPaintImage(), FrameImage(), GetDrawInfo(), GetMontageInfo(), GetPixelAlpha(), GetPixelInfo(), GetPixelInfoChannel(), GetPixelInfoPixel(), GetPixelOpacity(), GetVirtualPixelCacheNexus(), ImplodeImage(), ImportBGRQuantum(), ImportGrayAlphaQuantum(), ImportGrayQuantum(), ImportIndexAlphaQuantum(), ImportRGBQuantum(), IsFuzzyEquivalencePixelInfo(), IsImageOpaque(), IsPixelEquivalent(), IsPixelInfoColorMatch(), IsPixelInfoEquivalent(), KmeansMetric(), QueryColorCompliance(), QueryColorname(), RenderMVGContent(), SetImageAlphaChannel(), SetPixelBackgoundColor(), SetPixelCacheVirtualMethod(), SetPixelViaPixelInfo(), SpliceImage(), TintImage(), and WaveImage().

TransparentAlpha

#define TransparentAlpha   ((Quantum) 0)

Definition at line 26 of file image.h.

Referenced by AnnotateImage(), ClearBounds(), CoalesceImages(), ColorizeImage(), CompareImagesLayers(), CompositeImage(), CompositeOverImage(), CropImage(), DisposeImages(), DrawClippingMask(), DrawCompositeMask(), DrawPrimitive(), DrawStrokePolygon(), ExportIndexAlphaQuantum(), GetDrawInfo(), GetFillColor(), GetMontageInfo(), GetStrokeColor(), GetVirtualPixelCacheNexus(), IdentifyImage(), ImportGrayAlphaQuantum(), ImportIndexAlphaQuantum(), IsPixelEquivalent(), IsPixelInfoEquivalent(), OptimizeImageTransparency(), OptimizeLayerFrames(), RenderMVGContent(), RenderPostscript(), SetImageAlphaChannel(), SketchImage(), SmushXGap(), SmushYGap(), and TrimImage().

Typedef Documentation

ChromaticityInfo

typedef struct _ChromaticityInfo ChromaticityInfo

PrimaryInfo

typedef struct _PrimaryInfo PrimaryInfo

SegmentInfo

typedef struct _SegmentInfo SegmentInfo

Enumeration Type Documentation

AlphaChannelOption

enum AlphaChannelOption

Enumerator
UndefinedAlphaChannel
ActivateAlphaChannel
AssociateAlphaChannel
BackgroundAlphaChannel
CopyAlphaChannel
DeactivateAlphaChannel
DiscreteAlphaChannel
DisassociateAlphaChannel
ExtractAlphaChannel
OffAlphaChannel
OnAlphaChannel
OpaqueAlphaChannel
RemoveAlphaChannel
SetAlphaChannel
ShapeAlphaChannel
TransparentAlphaChannel

Definition at line 28 of file image.h.

ImageType

enum ImageType

Enumerator
UndefinedType
BilevelType
GrayscaleType
GrayscaleAlphaType
PaletteType
PaletteAlphaType
TrueColorType
TrueColorAlphaType
ColorSeparationType
ColorSeparationAlphaType
OptimizeType
PaletteBilevelAlphaType

Definition at line 48 of file image.h.

InterlaceType

enum InterlaceType

Enumerator
UndefinedInterlace
NoInterlace
LineInterlace
PlaneInterlace
PartitionInterlace
GIFInterlace
JPEGInterlace
PNGInterlace

Definition at line 64 of file image.h.

OrientationType

enum OrientationType

Enumerator
UndefinedOrientation
TopLeftOrientation
TopRightOrientation
BottomRightOrientation
BottomLeftOrientation
LeftTopOrientation
RightTopOrientation
RightBottomOrientation
LeftBottomOrientation

Definition at line 76 of file image.h.

ResolutionType

enum ResolutionType

Enumerator
UndefinedResolution
PixelsPerInchResolution
PixelsPerCentimeterResolution

Definition at line 89 of file image.h.

TransmitType

enum TransmitType

Enumerator
UndefinedTransmitType
FileTransmitType
BlobTransmitType
StreamTransmitType
ImageTransmitType

Definition at line 113 of file image.h.

Function Documentation

AcquireImage()

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

AcquireImageInfo()

MagickExport ImageInfo* AcquireImageInfo

(

void

)

AcquireNextImage()

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

AppendImages()

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

CatchImageException()

MagickExport ExceptionType CatchImageException

(

Image *

)

Definition at line 625 of file image.c.

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

ClipImage()

MagickExport MagickBooleanType ClipImage	(	Image *	,
		ExceptionInfo *
	)

ClipImagePath()

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

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 *

)

Definition at line 1239 of file image.c.

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

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

DestroyImagePixels()

MagickExport void DestroyImagePixels

(

Image *

)

DisassociateImageStream()

MagickExport void DisassociateImageStream

(

Image *

)

GetImageInfo()

MagickExport void GetImageInfo

(

ImageInfo *

)

GetImageInfoFile()

MagickExport FILE* GetImageInfoFile

(

const ImageInfo *

)

Definition at line 1394 of file image.c.

References _ImageInfo::file.

GetImageMask()

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

GetImageReferenceCount()

MagickExport ssize_t GetImageReferenceCount

(

Image *

)

Definition at line 1553 of file image.c.

References _Image::debug, _Image::filename, GetMagickModule, _ImageView::image, 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 *	,
		const char *	,
		int	,
		char *	,
		ExceptionInfo *
	)

Definition at line 1636 of file image.c.

References ConcatenateMagickString(), CopyMagickString(), _ImageView::exception, FormatLocaleString(), GetImageArtifact(), GetImageOption(), GetImageProperty(), _ImageView::image, IsStringTrue(), LocaleNCompare(), MagickFalse, MagickPathExtent, and MagickTrue.

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

IsHighDynamicRangeImage()

MagickExport MagickBooleanType IsHighDynamicRangeImage	(	const Image *	,
		ExceptionInfo *
	)

IsImageObject()

MagickExport MagickBooleanType IsImageObject

(

const Image *

)

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 PixelInfo *	,
		ExceptionInfo *
	)

ReferenceImage()

MagickExport Image * ReferenceImage

(

Image *

)

ResetImagePage()

MagickExport MagickBooleanType ResetImagePage	(	Image *	,
		const char *
	)

ResetImagePixels()

MagickExport MagickBooleanType ResetImagePixels	(	Image *	,
		ExceptionInfo *
	)

SetImageAlpha()

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

SetImageBackgroundColor()

MagickExport MagickBooleanType SetImageBackgroundColor	(	Image *	,
		ExceptionInfo *
	)

SetImageChannelMask()

MagickExport ChannelType SetImageChannelMask	(	Image *	,
		const ChannelType
	)

Definition at line 2489 of file image.c.

References _ImageView::image, and SetPixelChannelMask().

Referenced by AutoGammaImage(), DrawPrimitive(), LevelImageColors(), MinMaxStretchImage(), SeparateImage(), SetImageType(), ShadowImage(), and WhiteBalanceImage().

SetImageColor()

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

SetImageExtent()

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

SetImageInfo()

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

SetImageInfoBlob()

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

SetImageInfoCustomStream()

MagickExport void SetImageInfoCustomStream	(	ImageInfo *	,
		CustomStreamInfo *
	)

Definition at line 3115 of file image.c.

References _ImageInfo::custom_stream, _ImageInfo::debug, _ImageInfo::filename, GetMagickModule, LogMagickEvent(), MagickCoreSignature, MagickFalse, _ImageInfo::signature, and TraceEvent.

SetImageInfoFile()

MagickExport void SetImageInfoFile	(	ImageInfo *	,
		FILE *
	)

SetImageMask()

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

SetImageRegionMask()

MagickExport MagickBooleanType SetImageRegionMask	(	Image *	,
		const PixelMask	type,
		const RectangleInfo *	,
		ExceptionInfo *
	)

SetImageStorageClass()

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

SetImageVirtualPixelMethod()

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

Definition at line 3497 of file image.c.

References _Image::debug, _ImageView::exception, _Image::filename, GetMagickModule, _ImageView::image, LogMagickEvent(), MagickCoreSignature, MagickFalse, SetPixelCacheVirtualMethod(), _Image::signature, and TraceEvent.

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

SmushImages()

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

Definition at line 3684 of file image.c.

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

StripImage()

MagickExport MagickBooleanType StripImage	(	Image *	,
		ExceptionInfo *
	)

SyncImage()

MagickExport MagickBooleanType SyncImage	(	Image *	,
		ExceptionInfo *
	)

SyncImageSettings()

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

SyncImagesSettings()

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

Definition at line 3991 of file image.c.

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