Sign in Join
FPDoc Onlineexperiment

TCustomIcon.GetRawImagePtr function

Member of TCustomIconprotectedIn unit Graphics

Gets a pointer to the raw image data for the icon.

Declaration

pascal
function GetRawImagePtr: PRawImage; override

Description

GetRawImagePtr is an overridden method used to get a pointer to the raw image data for the icon image. The return value is a PRawImage type which points to the data in a TIconImage instance in the shared image list for the icon.

GetRawImagePtr uses the value in Current to determine which image is retrieved from the internal image list. When Current is -1, the return value is Nil. Otherwise, the shared icon image at the position in Current is accessed to get the return value for the method.

GetRawImagePtr is called from AssignImage a raw image is assigned to the icon. It is also used to get mask image data in the MaskHandleNeeded method.

See also

An experiment, built from Lazarus main 2dfa93c66e of 10-22-2026. Not the official Lazarus documentation.