Vcl.ImgList.TCustomImageList.DrawOverlay

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure DrawOverlay(Canvas: TCanvas; X, Y: Integer;  ImageIndex: Integer; Overlay: TOverlay; Enabled: Boolean = True); overload;
procedure DrawOverlay(Canvas: TCanvas; X, Y: Integer;  ImageIndex: Integer; Overlay: TOverlay; ADrawingStyle: TDrawingStyle; AImageType: TImageType; Enabled: Boolean = True); overload;

C++

void __fastcall DrawOverlay(Vcl::Graphics::TCanvas* Canvas, int X, int Y, int ImageIndex, TOverlay Overlay, bool Enabled = true)/* overload */;
void __fastcall DrawOverlay(Vcl::Graphics::TCanvas* Canvas, int X, int Y, int ImageIndex, TOverlay Overlay, TDrawingStyle ADrawingStyle, TImageType AImageType, bool Enabled = true)/* overload */;

Properties

Type Visibility Source Unit Parent
procedure
function
public
Vcl.ImgList.pas
Vcl.ImgList.hpp
Vcl.ImgList TCustomImageList

Description

Draws an image and an overlay onto the provided Canvas.

An overlay mask is an image drawn transparently over another image. Any image can be used as an overlay mask. To draw an overlay mask over an image use the DrawOverlay method with the index of the overlay mask.

Canvas is the drawing surface on which to draw the overlay.

X and Y specify the location where the top-left corner should appear on Canvas.

ImageIndex indicates which image to draw, where 0 specifies the first image, 1 specifies the second image, and so on.

Overlay specifies the index of the overlay mask to use. This index is assigned to the image that is used as an overlay mask by calling the Overlay method.

ADrawingStyle indicates how the color of the image may be altered. If this parameter is not specified, Draw uses the value of the DrawingStyle property.

AImageType indicates whether to draw the image or its associated mask. If this parameter is not specified, Draw uses the value of the ImageType property.

Enabled indicates whether the image appears as a gray-mapped image. If Enabled is false, DoDraw renders a gray-mapped version of the image. Because Enabled has a default value of true, this parameter can be omitted if the image should not be grayed.

See Also