Interface IGDIPlus.IGPImage

This is a Beta Read Only version of this page. Please review and send recommendations to mitov@mitov.com. We will enable the editing as soon as we are happy with the overall Wiki site.

Package: SignalLabBasicPkg

Unit: IGDIPlus

Contents 1 Syntax 1.1 Delphi: 2 Summary 3 Description 4 Properties 5 Methods

Syntax

Delphi:

type IGPImage = interface

Summary

Interface to TGPImage object.

Description

Use this interface to access the TGPImage object.

The 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

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

Methods

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