Sign in Join
FPDoc Onlineexperiment

TCustomImageList.GetBitmap procedure

Member of TCustomImageListpublicIn unit ImgList

Gets image data at the specified position as a bitmap.

Declaration

pascal
procedure GetBitmap(Index: Integer; Image: TCustomBitmap); overload
procedure GetBitmap(Index: Integer; Image: TCustomBitmap; 
 AEffect: TGraphicsDrawEffect); overload

Arguments

Index

Ordinal position of the requested image.

Image

Bitmap used to store the image data.

AEffect

Drawing effect applied to the image.

Description

GetBitmap is an overloaded procedure used to get the image stored at the specified position in the image list as a bitmap image.

Index contains the ordinal position in the image list where the image is stored.

Image is the TCustomBitmap class instance where the requested image data is stored in the method.

An overloaded variant of the method includes the AEffect parameter which specifies the drawing effect applied to the image data and stored in Image. The default value for AEffect is gdeNormal and cause the image to be rendered using the normal enabled style for the widgetset.

GetBitmap calls GetResolution to locate the default image resolution which uses the width specified in the Width property. The TCustomImageListResolution class instance is used to call its GetBitmap method using the parameters supplied to the method.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.