Sign in Join
FPDoc Onlineexperiment

TCustomImageListResolution.GetRawImage procedure

Member of TCustomImageListResolutionpublicIn unit ImgList

Gets the 32-bit RGBA raw image data for the specified image.

Declaration

pascal
procedure GetRawImage(Index: Integer; out Image: TRawImage)

Arguments

Index

Ordinal position for the image in the list.

Image

TRawImage instance where image data is stored in the method.

Description

GetRawImage is a procedure used to get the 32-bit RGBA raw image data for the specified image in the resolution.

Index is the ordinal position for the image in the list.

Image is a TRawImage class instance used to store the raw image data for the specified image.

GetRawImage calls CheckIndex to ensure that Index contains a valid position in the image resolution. An exception is raised in CheckIndex if the requested position is invalid. No actions are performed in the method when Count contains 0 (zero).

GetRawImage stores image metadata in Image by calling the FillDescription method. The 32-bit RGBA raw image data at the specified Index in the resolution is stored in Image. Its DataSize property is updated to reflect the number of pixels (Width * Height * 32b) stored in the class instance.

GetRawImage is used in the implementation of the GetBitmap, GetFullBitmap, GetIcon, and ReadData methods. It is also used in the AddImages and GetRawImage methods in TCustomImageList.

See also

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