Sign in Join
FPDoc Onlineexperiment

TCustomImageList.GetFullBitmap procedure

Member of TCustomImageListpublicIn unit ImgList

Gets a bitmap with all of the images in the default resolution.

Declaration

pascal
procedure GetFullBitmap(Image: TCustomBitmap; 
 AEffect: TGraphicsDrawEffect=gdeNormal)

Arguments

Image

Bitmap where image data is stored.

AEffect

Drawing effect applied to the rendered images.

Description

GetFullBitmap is a procedure used to get a bitmap with all of the images stored in the default resolution. GetFullBitmap mimics the image list storage format used in previous versions of TCustomImageList. This means that the combined image data for the resolution uses the value in the Height property as its vertical size, and the horizontal size is determined by the value from Width * Count.

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

AEffect is a value from the TGraphicsDrawEffect enumeration that indicates the drawing effect applied to the rendered images and stored in Image. The default value for the parameter is gdeNormal and causes the normal enabled drawing effect for the widgetset to be used.

GetFullBitmap calls the GetResolution method to retrieve the image resolution which uses the value in the Width property. The TCustomImageListResolution class instance is used to call its GetFullBitmap method passing Image and AEffect as arguments.

Use GetBitmap to retrieve a single image in the default resolution. Use GetRawImage or GetFullRawImage to retrieve raw image data for the default resolution.

See also

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