Skip to main content

TcxCustomImageList.DrawOverlay(TCanvas,Integer,Integer,Integer,TOverlay,Boolean) Method

Draws a specific image in the list and an overlay mask on the specified canvas.

Declaration

procedure DrawOverlay(Canvas: TCanvas; X: Integer; Y: Integer; ImageIndex: Integer; Overlay: TOverlay; Enabled: Boolean = True); overload;

Parameters

Name Type Description
Canvas TCanvas

The target canvas.

X Integer

The horizontal offset from the canvas’ top-left corner, in pixels.

Y Integer

The vertical offset from the canvas’ top-left corner, in pixels.

ImageIndex Integer

The index of the drawn image.

Overlay TOverlay

The index of an overlay mask.

Enabled Boolean

If True, the procedure draws image colors as is. If False, the procedure displays the image in grayscale colors.

Remarks

Call the Overlay function to associate an overlay with the target image, then pass the image index and the overlay as the ImageIndex and Overlay parameters, respectively.

Note

Refer to the TDrawingStyle and TImageType type descriptions for detailed information on available options.

See Also