David Alm: Automated Syncronization with Documentation

2012-10-18T17:18:37Z

Automated Syncronization with Documentation

New page

<b><span style="color:red">
This is a Beta Read Only version of this page.
Please review and send recommendations to [mailto:mitov@mitov.com mitov@mitov.com].
We will enable the editing as soon as we are happy with the overall Wiki site.
</span></b>

'''Package:''' [[Package SignalLabBasicPkg|SignalLabBasicPkg]]

'''Unit:''' [[Unit IGDIPlus|IGDIPlus]]

== Syntax ==
=== Delphi: ===
<code>
'''type''' IGPImage = '''interface'''
</code>
== Summary ==
Interface to [[Class IGDIPlus.TGPImage|TGPImage]] object.

== Description ==
Use this interface to access the [[Class IGDIPlus.TGPImage|TGPImage]] object.

The [[Class IGDIPlus.TGPImage|TGPImage]] class provides methods for loading and saving
raster images (bitmaps) and vector images (metafiles). An
Image object encapsulates a bitmap or a metafile and stores
attributes that you can retrieve by calling various Get
methods. You can construct Image objects from a variety of
file types including BMP, ICON, GIF, JPEG, Exif, PNG, TIFF,
WMF, and EMF.

== Properties ==
*[[Property IGDIPlus.IGPImage.Width|Width]] - Returns the Width of the image.
*[[Property IGDIPlus.IGPImage.Height|Height]] - Returns the Height of the image.
*[[Property IGDIPlus.IGPImage.PixelFormat|PixelFormat]] - Returns the pixel format of this Image object.
*[[Property IGDIPlus.IGPImage.ImageType|ImageType]] - Returns the type (bitmap or metafile) of this Image object.
*[[Property IGDIPlus.IGPImage.FormatName|FormatName]] - Returns the name of the image format.
*[[Property IGDIPlus.IGPImage.FrameDimensionsCount|FrameDimensionsCount]] - Returns the number of frame dimensions in this Image object.
*[[Property IGDIPlus.IGPImage.FrameDimensionsList|FrameDimensionsList]] - Returns the identifiers for the frame dimensions of this Image object.
*[[Property IGDIPlus.IGPImage.HorizontalResolution|HorizontalResolution]] - Returns the horizontal resolution, in dots per inch, of this image.
*[[Property IGDIPlus.IGPImage.VerticalResolution|VerticalResolution]] - Returns the vertical resolution, in dots per inch, of this image.
*[[Property IGDIPlus.IGPImage.RawFormat|RawFormat]] - Returns a globally unique identifier ( GUID) that identifies the format of this Image object.
*[[Property IGDIPlus.IGPImage.PhysicalDimension|PhysicalDimension]] - Returns the width and height of this image.
*[[Property IGDIPlus.IGPImage.PropertyCount|PropertyCount]] - Returns the number of properties (pieces of metadata) stored in this Image object.
*[[Property IGDIPlus.IGPImage.PropertyIdList|PropertyIdList]] - Returns a list of the property identifiers used in the metadata of this Image object.

== Methods ==
*[[Method function IGDIPlus.IGPImage.GetNativeImage() : GpImage|function GetNativeImage() : GpImage]]
*[[Method function IGDIPlus.IGPImage.Clone() : TGPImage|function Clone() : TGPImage]] - Creates a new Image object and initializes it with the contents of this [[Class IGDIPlus.TGPImage|TGPImage]] object.
*[[Method function IGDIPlus.IGPImage.Save(WideString;TGUID;PGPEncoderParameters) : TGPImage|function Save(filename : WideString; clsidEncoder : TGUID; encoderParams : PGPEncoderParameters) : TGPImage]] - Saves this image to a file.
*[[Method function IGDIPlus.IGPImage.Save(IStream;TGUID;PGPEncoderParameters) : TGPImage|function Save(stream : IStream; clsidEncoder : TGUID; encoderParams : PGPEncoderParameters) : TGPImage]] - Saves this image to a stream.
*[[Method function IGDIPlus.IGPImage.SaveAdd(PGPEncoderParameters) : TGPImage|function SaveAdd(encoderParams : PGPEncoderParameters) : TGPImage]] - Adds a frame to a file or stream specified in a previous call to the [[Method function IGDIPlus.IGPImage.Save(WideString;TGUID;PGPEncoderParameters) : TGPImage|Save]] method.
*[[Method function IGDIPlus.IGPImage.SaveAdd(IGPImage;PGPEncoderParameters) : TGPImage|function SaveAdd(newImage : IGPImage; encoderParams : PGPEncoderParameters) : TGPImage]] - Adds a frame to a file or stream specified in a previous call to the [[Method function IGDIPlus.IGPImage.Save(WideString;TGUID;PGPEncoderParameters) : TGPImage|Save]] method.
*[[Method function IGDIPlus.IGPImage.GetType() : TGPImageType|function GetType() : TGPImageType]] - Returns the type (bitmap or metafile) of this Image object.
*[[Method function IGDIPlus.IGPImage.GetPhysicalDimension() : TGPSizeF|function GetPhysicalDimension() : TGPSizeF]] - Returns the width and height of this image.
*[[Method function IGDIPlus.IGPImage.GetBounds(TGPRectF;TGPUnit) : TGPImage|function GetBounds(srcRect : TGPRectF; srcUnit : TGPUnit) : TGPImage]] - Returns the bounding rectangle for this image.
*[[Method function IGDIPlus.IGPImage.GetWidth() : Cardinal|function GetWidth() : Cardinal]] - Returns the [[Property IGDIPlus.IGPImage.Width|Width]] of the image.
*[[Method function IGDIPlus.IGPImage.GetHeight() : Cardinal|function GetHeight() : Cardinal]] - Returns the [[Property IGDIPlus.IGPImage.Height|Height]] of the image.
*[[Method function IGDIPlus.IGPImage.GetHorizontalResolution() : Single|function GetHorizontalResolution() : Single]] - Returns the horizontal resolution, in dots per inch, of this image.
*[[Method function IGDIPlus.IGPImage.GetVerticalResolution() : Single|function GetVerticalResolution() : Single]] - Returns the vertical resolution, in dots per inch, of this image.
*[[Method function IGDIPlus.IGPImage.GetFlags() : Cardinal|function GetFlags() : Cardinal]] - Returns a set of flags that indicate certain attributes of this Image object.
*[[Method function IGDIPlus.IGPImage.GetRawFormat() : TGUID|function GetRawFormat() : TGUID]] - Returns a globally unique identifier ( GUID) that identifies the format of this Image object.
*[[Method function IGDIPlus.IGPImage.GetFormatName() : String|function GetFormatName() : String]] - Returns the name of the image format.
*[[Method function IGDIPlus.IGPImage.GetPixelFormat() : TGPPixelFormat|function GetPixelFormat() : TGPPixelFormat]] - Returns the pixel format of this Image object.
*[[Method function IGDIPlus.IGPImage.GetPaletteSize() : Integer|function GetPaletteSize() : Integer]] - Returns the size, in bytes, of the color palette of this Image object.
*[[Method function IGDIPlus.IGPImage.GetPalette(PGPColorPalette;Integer) : TGPImage|function GetPalette(palette : PGPColorPalette; size : Integer) : TGPImage]] - Returns the color palette of this Image object.
*[[Method function IGDIPlus.IGPImage.SetPalette(PGPColorPalette) : TGPImage|function SetPalette(palette : PGPColorPalette) : TGPImage]] - Sets the color palette of this Image object.
*[[Method function IGDIPlus.IGPImage.GetThumbnailImage(Cardinal;Cardinal;TGPGetThumbnailImageAbortProc) : TGPImage|function GetThumbnailImage(thumbWidth : Cardinal; thumbHeight : Cardinal; callback : TGPGetThumbnailImageAbortProc) : TGPImage]] - Returns a thumbnail image from this Image object.
*[[Method function IGDIPlus.IGPImage.GetFrameDimensionsCount() : Cardinal|function GetFrameDimensionsCount() : Cardinal]] - Returns the number of frame dimensions in this Image object.
*[[Method function IGDIPlus.IGPImage.GetFrameDimensionsList() : TGUIDArray|function GetFrameDimensionsList() : TGUIDArray]] - Returns the identifiers for the frame dimensions of this Image object.
*[[Method function IGDIPlus.IGPImage.GetFrameCount(TGUID) : Cardinal|function GetFrameCount(dimensionID : TGUID) : Cardinal]] - Returns the number of frames in a specified dimension of this [[Class IGDIPlus.TGPImage|TGPImage]] object.
*[[Method function IGDIPlus.IGPImage.SelectActiveFrame(TGUID;Cardinal) : TGPImage|function SelectActiveFrame(dimensionID : TGUID; frameIndex : Cardinal) : TGPImage]] - Selects the frame in this Image object specified by a dimension and an index.
*[[Method function IGDIPlus.IGPImage.RotateFlip(TGPRotateFlipType) : TGPImage|function RotateFlip(rotateFlipType : TGPRotateFlipType) : TGPImage]] - Rotates and/or flips this image.
*[[Method function IGDIPlus.IGPImage.GetPropertyCount() : Cardinal|function GetPropertyCount() : Cardinal]] - Returns the number of properties (pieces of metadata) stored in this Image object.
*[[Method function IGDIPlus.IGPImage.GetPropertyIdList() : TGPPropIDArray|function GetPropertyIdList() : TGPPropIDArray]] - Returns a list of the property identifiers used in the metadata of this Image object.
*[[Method function IGDIPlus.IGPImage.GetPropertyItemSize(PROPID) : Cardinal|function GetPropertyItemSize(propId : PROPID) : Cardinal]] - Returns the size, in bytes, of a specified property item of this Image object.
*[[Method function IGDIPlus.IGPImage.GetPropertyItem(PROPID;Cardinal;PGPPropertyItem) : TGPImage|function GetPropertyItem(propId : PROPID; propSize : Cardinal; buffer : PGPPropertyItem) : TGPImage]] - Returns a specified property item (piece of metadata) from this Image object.
*[[Method function IGDIPlus.IGPImage.GetPropertySize(Cardinal;Cardinal) : TGPImage|function GetPropertySize(totalBufferSize : Cardinal; numProperties : Cardinal) : TGPImage]] - Returns the total size, in bytes, of all the property items stored in this Image object.
*[[Method function IGDIPlus.IGPImage.GetAllPropertyItems(Cardinal;Cardinal;PGPPropertyItem) : TGPImage|function GetAllPropertyItems(totalBufferSize : Cardinal; numProperties : Cardinal; allItems : PGPPropertyItem) : TGPImage]] - Returns all the property items (metadata) stored in this Image object.
*[[Method function IGDIPlus.IGPImage.RemovePropertyItem(TPROPID) : TGPImage|function RemovePropertyItem(propId : TPROPID) : TGPImage]] - Removes a property item (piece of metadata) from this Image object.
*[[Method function IGDIPlus.IGPImage.SetPropertyItem(TGPPropertyItem) : TGPImage|function SetPropertyItem(item : TGPPropertyItem) : TGPImage]] - Sets a property item (piece of metadata) for this Image object.
*[[Method function IGDIPlus.IGPImage.GetEncoderParameterListSize(TGUID) : Cardinal|function GetEncoderParameterListSize(clsidEncoder : TGUID) : Cardinal]] - Returns the size, in bytes, of the parameter list for a specified image encoder.
*[[Method function IGDIPlus.IGPImage.GetEncoderParameterList(TGUID;Cardinal;PGPEncoderParameters) : TGPImage|function GetEncoderParameterList(clsidEncoder : TGUID; size : Cardinal; buffer : PGPEncoderParameters) : TGPImage]] - Returns a list of the parameters supported by a specified image encoder.

[[Category:Interfaces]]

Interface IGDIPlus.IGPImage - Revision history

David Alm: Automated Syncronization with Documentation