Graphics unit

graphics.pp contains classes, types, and routines used to represent graphic images in a Lazarus Component Library ( LCL) application. The following classes are added to the registered class list used by the Run-time Library ( RTL):

• TBitmap
• TPixmap
• TPortableNetworkGraphic
• TPortableAnyMapGraphic (when not explicitly disabled)
• TJpegImage (when not explicitly disabled)
• TGIFImage (when not explicitly disabled)
• TPicture
• TFont
• TPen
• TBrush
• TRegion

graphics.pp is part of the Lazarus Component Library ( LCL).

Classes and records

EGraphicException	class	Base exception type for an error in a graphic operation.
EInvalidGraphic	class	EInvalidGraphic - exception handler for an invalid graphic.
EInvalidGraphicOperation	class	EInvalidGraphicOperation - exception handler for invalid graphic operation.
TBitmap	class	Implements a FCL-compatible reader/writer for a Bitmap image.
TBrush	class	The Brush to be used to Paint on the current Canvas.
TBrushHandleCache	class	TBrushHandleCache - resource cache for Brush Handles.
TCanvas	class	Implements a drawing surface for a visual control or bitmap image.
TCursorImage	class	TCursorImage - an Icon to be used to represent a cursor.
TCursorImageImage	class	Implements the image for a cursor, stored as an Icon.
TCustomBitmap	class	TCustomBitmap - the base class for TBitmap.
TCustomIcon	class	TCustomIcon - base class for TIcon.
TFont	class	Represents a font used to draw text in an application.
TFontData	record	Contains information about a font used in an application.
TFontHandleCache	class	TFontHandleCache - a resource cache for font handles.
TFontHandleCacheDescriptor	class	TFontHandleCacheDescriptor - descriptor for items in Font Handle Cache.
TFPImageBitmap	class	Implements a Bitmap using the FPImage reader and writer from the FCL.
TGIFImage	class	Implements an image using the GIF (Graphics Interchange Format) image format.
TGraphic	class	Abstract base class used for images in supported image formats.
TGraphicsObject	class	Primitive ancestor class, mainly for Delphi compatibility.
TIcnsIcon	class	Implements a macOS Icon Resource file.
TIcnsList	class	Implements a list used to maintain TIcnsIcon instances.
TIcnsRec	record	Record type with the icon type and raw image data for a TIcnsIcon instance.
TIcon	class	Implements an icon image type; small images typically associated with applications, controls, etc.
TIconImage	class	TIconImage - a primitive Icon class with handles for the Bitmap, Mask and Palette.
TJPEGImage	class	TJPEGImage - a class for handling images stored in JPEG (compressed) format.
TLCLTextMetric	record	A record representing the physical dimensions of the currently selected font in the canvas.
TPen	class	Represents a pen used to draw on a canvas.
TPenHandleCache	class	TPenHandleCache - Resource Cache for Pen Handles.
TPenHandleCacheDescriptor	class	Cache descriptor for Pen Handles.
TPicture	class	Implements a container for TGraphic and descendent classes.
TPixmap	class	Implements support for the XPM (Pixmap) image format.
TPortableAnyMapGraphic	class	Implements an image which supports for the Portable Any Map (PNM) graphic format.
TPortableNetworkGraphic	class	Implements support for the PNG image format.
TRasterImage	class	Base class for a number of graphic controls, including TCustomBitmap and TCustomIcon, which use a raster of dots to display graphic information.
TRegion	class	A defined area on a screen or canvas used to render a graphic image or text output.
TRegionOperation	record	Represents a region operation.
TSharedBitmap	class	Defines a reference-counted shared Bitmap graphic.
TSharedCursorImage	class	Implements a reference-counted shared image used for cursors.
TSharedCustomBitmap	class	Implements the base class for a reference-counted shared image.
TSharedGIFImage	class	Implements a reference-counted shared GIF image.
TSharedIcnsIcon	class	Declares the shared icon for the TIcnsIcon type.
TSharedIcon	class	Implements a reference-counted shared Icon image type.
TSharedImage	class	Specifies the base class for reference-counted shared images.
TSharedJpegImage	class	TSharedJpegImage - a reference counted shared image of type JPEG.
TSharedPixmap	class	Implements a reference-counted shared Pixmap image type.
TSharedPortableAnyMapGraphic	class	TSharedPortableAnyMapGraphic - a reference counted shared PNM.
TSharedPortableNetworkGraphic	class	TSharedPortableNetworkGraphic - a reference counted PNG Image.
TSharedRasterImage	class	Implements a reference counted raster image that may be shared between controls.
TSharedTiffImage	class	Declares the shared image for the TTiffImage type.
TTextStyle	record	The Style of the Text to be drawn in a rectangle.
TTiffImage	class	Implements support for the TIFF (Tag Image File Format) graphic format.

Procedures and functions

AllocPatternBitmap	function	Ensures that a Pattern Bitmap with the specified colors exists in the Pattern cache.
Blue	function	Finds the Blue component of the supplied color.
CharsetToIdent	function	Converts the specified numeric character set identifier to its representation as a string.
ClearXLFDHeight	function	Replaces the PixelSize, PointSize, ResolutionX, ResolutionY and AverageWidth segments in an XLFD font name with the '*' wildcard.
ClearXLFDItem	function	Replaces the specified XLFD segment value with the '*' wildcard.
ClearXLFDPitch	function	Replaces the spacing for a XLFD font descriptor format with a '*' wildcard.
ClearXLFDStyle	function	Replaces the WeightName, Slant and SetwidthName segments in an XLFD font name with the '*' wildcard.
ColorIndex	function	Finds the position in the color identifier map for the specified value.
ColorToIdent	function	ColorToIdent - given a Color value, find its name ( Ident) in the look-up table of Colors.
ColorToRGB	function	Converts a TColor value to an RGB color constant.
ColorToString	function	Gets a string representation for the specified TColor value.
CreateBitmapFromFPImage	function	Creates a Bitmap with the content from the specified TFPCustomImage instance.
CreateBitmapFromLazarusResource	function	Creates and loads a Bitmap from a Lazarus Resource (.lrs) file.
CreateBitmapFromResourceName	function	Creates a TCustomBitmap instance with the content for the named Lazarus resource.
CreateCompatibleBitmaps	function	Creates a TLazIntfImage instance for the specified raw image data, and returns the handles to the image and optional mask information.
CreateGraphicFromResourceName	function	Creates and loads a TGraphic instance with the content from the specified resource instance handle and resource name.
DbgS	function	Creates a formatted debugger message with values from the TFontStyles set.
DecColor	function	Decreases the component RGB values in a color by the specified amount (results in a darker color overall).
ExtractFamilyFromXLFDName	function	Gets the family name for the typeface used in the XLFD font descriptor.
ExtractXLFDItem	function	Gets the value for the specified segment in an XLFD font descriptor.
FontNameToPangoFontDescStr	procedure	Parses the specified font name into X Logical Font Descriptor attributes.
FPColorToTColor	function	FPColorToTColor - converts a color specified as a FPColor to a color of type TColor.
FPColorToTColorRef	function	Converts a TFPColor value to a Cardinal color reference used in API system color constants.
GetCharsetValues	procedure	Calls the specified procedure for each of the character set names in FontCharsets.
GetColorValues	procedure	Executes the specified procedure for each of the non-deprecated Color names defined for the platform.
GetDefFontCharSet	function	Gets the default TFontCharSet value for the platform.
GetFontData	function	Gets font data for the specified font handle.
GetGraphicClassForFileExtension	function	Gets the TGraphicClass instance used for images with the specified file extension.
GraphicExtension	function	Gets a string with the file extension used for the specified graphic class type.
GraphicFileMask	function	Gets one or more file masks which can be used to select image files for the specified TGraphicClass instance.
GraphicFilter	function	Gets a filter string for files using the specified graphic class type.
Green	function	Finds the Green component of the supplied color.
IdentEntry	function	Checks whether a given Entry exists in a Map of color names.
IdentToCharset	function	Converts the specified character set identifier to the its numeric representation.
IdentToColor	function	IdentToColor - given a color identifier (name) returns the color value.
IncColor	function	Increases the component RGB values in a color by the specified amount (results in a lighter color overall).
InvertColor	function	InvertColor - returns the complementary color to the supplied value - helps to produce a 'negative' image.
IsFontNameXLogicalFontDesc	function	Determines if the specified font name is a valid X Logical Font Description.
IsSysColor	function	Indicates whether the specified color reference is one of the system colors.
LazResourceXPMToPPChar	function	Loads an XPM image resource into an array.
LoadCursorFromLazarusResource	function	LoadCursorFromLazarusResource - loads a named cursor handle from the Lazarus Resource (.LRS).
ReadXPMFromStream	function	Converts an XPM image stored in the specified stream into an array of PChar values.
ReadXPMSize	function	Reads the first line from an XPM PChar array which contains the width, height and number of colors for the XPM data.
Red	function	Finds the Red component of the supplied color.
RedGreenBlue	procedure	RedGreenBlue - decomposes a composite color into its component Red, Green and Blue values.
Register	procedure	Registers TPersistent classes for use in the RTL.
RGBToColor	function	Combines the values for Red, Green and Blue into a TColor value.
ScaleX	function	Resizes the specified horizontal size from a given display density to the current screen PPI.
ScaleY	function	Resizes the specified vertical size from a given display density to the current screen PPI.
StringToColor	function	Converts the specified string representation for a color to a TColor value.
StringToColorDef	function	Converts the specified string representation for a color to a TColor value using a specified default value.
SysColorToSysColorIndex	function	SysColorToSysColorIndex - if Color is one of the system colors, returns the Index of the system color.
TColorToFPColor	function	TColorToFPColor - converts a color of type TColor to one specified as a FPColor.
TestStreamIsBMP	function	Examines values in the specified stream to determine if it contains a .BMP image.
TestStreamIsCursor	function	Examines values in the specified stream to determine if it contains a .CUR cursor image.
TestStreamIsIcon	function	Examines values in the specified stream to determine if it contains a .ICO image.
TestStreamIsXPM	function	Examines values in the specified stream to determine if it contains a .XPM image.
UpdateHandleObjects	procedure	Renews handles for Fonts, Pens, and Brushes.
XLFDHeightIsSet	function	Checks whether an explicit value is assigned to XLFD segments controlling font height.
XLFDNameToLogFont	function	Gets a logical font record with values representing the specified XLFD font descriptor.
XPMToPPChar	function	Converts an XPM image file into an array of PChar values.

Types

PColor	type	Pointer to the TColor type.
PIcnsRec	type	Pointer to a TIcnsRec instance.
TAntialiasingMode	enumeration	Represents anti-aliasing modes used in TCanvas.
TBitmapHandleType	enumeration	Represents handle types used for Bitmaps.
TBrushStyle	type	Represents the pattern for a Brush.
TCanvasOrientation	enumeration	Represents orientations for a canvas.
TCanvasState	set	Set type used to store TCanvasStates values.
TCanvasStates	enumeration	Represents states values for TCanvas.
TColor	type	Color type used by most LCL drawing functions.
TCopymode	type	Type used to represent canvas copy modes.
TCustomBitmapClass	type	Class reference used to create new instances of TCustomBitmap.
TDefaultColorType	enumeration	Indicates whether a default color applies to a font or a brush.
TFillMode	enumeration	Represents Fill Mode values.
TFillStyle	type	Alias for the TGraphicsFillStyle enumeration type in LazUtils.
TFontCharSet	type	Represents a font character set as a numeric value.
TFontDataName	type	Short String type used for typeface names.
TFontName	type	Alias to the String type used to represent font names.
TFontPitch	enumeration	Represents pitches (or spacings) used in typefaces.
TFontQuality	enumeration	Font output quality, like anti-aliasing.
TFontStyle	enumeration	Represents styles or variants for a font.
TFontStyles	set	Set type used to store TFontStyle value(s).
TFontStylesbase	set	Set type used to store TFontStyle value(s).
TFPImageBitmapClass	type	Class reference used to create new instances of TFPImageBitmap.
TGetColorStringProc	procedure type	Specifies an object procedure used to process color value to color identifier map entries.
TGradientDirection	enumeration	Represents the fill directions used for gradient fills.
TGraphicClass	type	TGraphicClass - class of TGraphic.
TIconImageClass	type	Class reference used to create new instances of TIconImage.
TJPEGPerformance	type	Represents JPEG read performance setting values.
TJPEGQualityRange	type	Represents JPEG compression quality values.
TOnGetSystemFont	procedure type	Specifies a function type which returns a HFONT handle for a system font.
TOnLoadGraphicFromClipboardFormat	procedure type	Specifies a procedure type used to load a graphic image from a clipboard format.
TOnSaveGraphicToClipboardFormat	procedure type	Specifies a procedure type used to save a graphic image to a clipboard format.
TPenEndCap	type	Represents end cap styles used for a pen.
TPenJoinStyle	type	Represents join styles used between line segments.
TPenMode	type	Represents pen modes used when rendering to a canvas.
TPenPattern	type	Represents a pattern brush for a pen.
TPenStyle	type	Represents line drawing styles used when rendering to a canvas.
TPixelFormat	enumeration	Represents storage formats for pixels in image data.
TProgressEvent	type	Specifies an event handler for monitoring the progress of a drawing process.
TProgressStage	type	Alias for the TFPImgProgressStage type in the FCL.
TRasterImageClass	type	Class reference used to create new instances of TRasterImage.
TRegionCombineMode	enumeration	Represents combination methods used for regions.
TRegionOperations	type	Array type used to store TRegionOpertation elements.
TRegionOperationType	enumeration	Represents Region operators used in TRegionOperation.
TSharedRasterImageClass	type	TSharedRasterImageClass - class of TSharedRasterImage.
TTextLayout	enumeration	Represents the text layout used to render text in its rectangle.
TTiffUnit	enumeration	Represents units of measure used in TIFF image data.
TTransparentMode	enumeration	Represents transparency modes used in raster images.

Constants

bsBDiagonal	constant	Represents the BDiagonal brush style.
bsClear	constant	Represents the Clear brush style.
bsCross	constant	Represents the Cross brush style.
bsDiagCross	constant	Represents the DiagCross brush style.
bsFDiagonal	constant	Represents the FDiagonal brush style.
bsHorizontal	constant	Represents the Horizontal brush style.
bsImage	constant	Represents the user-specified Image (bitmap) brush style.
bsPattern	constant	Represents the user-specified Pattern (bitmap) brush style.
bsSolid	constant	Represents the Solid brush style.
bsVertical	constant	Represents the Vertical brush style.
cl3DDkShadow	constant	One of the System colors.
cl3DFace	constant	A synonym not displayed in color lists.
cl3DHiLight	constant	A synonym not displayed in color lists.
cl3DLight	constant	One of the System colors.
cl3DShadow	constant	A synonym not displayed in color lists.
clActiveBorder	constant	One of the System colors.
clActiveCaption	constant	One of the System colors.
clAppWorkspace	constant	One of the System colors.
clAqua	constant	One of the standard colors. Delphi compatible.
clBackground	constant	One of the System colors.
clBlack	constant	One of the standard colors. Delphi compatible.
clBlue	constant	One of the standard colors. Delphi compatible.
clBtnFace	constant	Color for a button face.
clBtnHighlight	constant	One of the System colors.
clBtnHiLight	constant	A synonym not displayed in color lists.
clBtnShadow	constant	One of the System colors.
clBtnText	constant	The color for the text or other raised area on a button.
clCaptionText	constant	One of the System colors.
clColorDesktop	constant	A synonym not displayed in color lists.
clCream	constant	One of the extended colors.
clDefault	constant	The default color of a given control.
clDkGray	constant	One of the standard colors. Delphi compatible.
clDontMask	constant	Alias for the clBlack constant.
clFirstSpecialColor	constant	Alias for the clBtnHiLight constant.
clForm	constant	Represents the color of the background for a form.
clFuchsia	constant	One of the standard colors. Delphi compatible.
clGradientActiveCaption	constant	One of the System colors.
clGradientInactiveCaption	constant	One of the System colors.
clGray	constant	One of the standard colors. Delphi compatible.
clGrayText	constant	One of the System colors.
clGreen	constant	One of the standard colors. Delphi compatible.
clHighlight	constant	One of the System colors.
clHighlightText	constant	One of the System colors.
clHotLight	constant	One of the System colors.
clInactiveBorder	constant	One of the System colors.
clInactiveCaption	constant	One of the System colors.
clInactiveCaptionText	constant	One of the System colors.
clInfoBk	constant	One of the System colors.
clInfoText	constant	One of the System colors.
clLime	constant	One of the standard colors. Delphi compatible.
clLtGray	constant	One of the standard colors. Delphi compatible.
clMaroon	constant	One of the standard colors. Delphi compatible.
clMask	constant	Alias for the clWhite constant.
clMedGray	constant	One of the extended colors.
clMenu	constant	One of the System colors.
clMenuBar	constant	One of the System colors used for the menu bar.
clMenuHighlight	constant	One of the System colors used for highlights on a menu.
clMenuText	constant	The color of the text in menus.
clMoneyGreen	constant	One of the extended colors.
clNavy	constant	One of the standard colors. Delphi compatible.
clNone	constant	One of the special colors.
clOlive	constant	One of the standard colors. Delphi compatible.
clPurple	constant	One of the standard colors. Delphi compatible.
clRed	constant	One of the standard colors. Delphi compatible.
clScrollBar	constant	One of the System colors.
clSilver	constant	One of the standard colors. Delphi compatible.
clSkyBlue	constant	One of the extended colors.
clTeal	constant	One of the standard colors. Delphi compatible.
clWhite	constant	One of the standard colors. Delphi compatible.
clWindow	constant	Background color for an edit control.
clWindowFrame	constant	One of the System colors.
clWindowText	constant	The color for the text in an edit control.
clYellow	constant	One of the standard colors. Delphi compatible.
cmBlackness	constant	Ternary raster operation (Dst op Src op Pattern): Fills the destination area with all black.
cmDstInvert	constant	Ternary raster operation (Dst op Src op Pattern): Fills the destination area with (not Dst).
cmMergeCopy	constant	Ternary raster operation (Dst op Src op Pattern): Fills the destination area with (Src and Pattern).
cmMergePaint	constant	Ternary raster operation (Dst op Src op Pattern): Fills the destination area with (Dst or not Src).
cmNotSrcCopy	constant	Ternary raster operation (Dst op Src op Pattern): Fills the destination area with (not Src).
cmNotSrcErase	constant	Ternary raster operation (Dst op Src op Pattern): Fills the destination area with (not (Dst or Src)).
cmPatCopy	constant	Ternary raster operation (Dst op Src op Pattern): Fills the destination area with (Pattern).
cmPatInvert	constant	Ternary raster operation (Dst op Src op Pattern): Fills the destination area with (Dst xor Pattern).
cmPatPaint	constant	Ternary raster operation (Dst op Src op Pattern): Fills the destination area with (Dst or (not Src) or Pattern).
cmSrcAnd	constant	Ternary raster operation (Dst op Src op Pattern): Fills the destination area with (Dst and Src).
cmSrcCopy	constant	Ternary raster operation (Dst op Src op Pattern): Fills the destination area with Src.
cmSrcErase	constant	Ternary raster operation (Dst op Src op Pattern): Fills the destination area with ((not Dst) and Src).
cmSrcInvert	constant	Ternary raster operation (Dst op Src op Pattern): Fills the destination area with (Dst xor Src).
cmSrcPaint	constant	Ternary raster operation (Dst op Src op Pattern): Fills the destination area with (Dst or Src).
cmWhiteness	constant	Ternary raster operation (Dst op Src op Pattern): Fills the destination area with all white.
DefFontData	constant	Default font data used for new TFont instances.
ExtendedColorCount	constant	The number of defined extended color constants.
FontCharsets	constant	Array constant with TIdentMapEntry values for character sets in TFont instances.
pecFlat	constant	Represents the Flat pen end cap.
pecRound	constant	Represents the Round pen end cap.
pecSquare	constant	Represents the Square pen end cap.
PIXELFORMAT_BPP	constant	Constant with the number of bits per pixel for TPixelFormat enumeration values.
pjsBevel	constant	Represents the Bevel pen join style.
pjsMiter	constant	Represents the Miter pen join style.
pjsRound	constant	Represents the Round pen join style.
pmBlack	constant	Represents the Black pen mode.
pmCopy	constant	Represents the Copy pen mode.
pmMask	constant	Represents the Mask pen mode.
pmMaskNotPen	constant	Represents the Mask Not Pen pen mode.
pmMaskPenNot	constant	Represents the Mask Pen Not pen mode.
pmMerge	constant	Represents the Merge pen mode.
pmMergeNotPen	constant	Represents the Merge Not Pen pen mode.
pmMergePenNot	constant	Represents the Merge Pen Not pen mode.
pmNop	constant	Represents the No OP pen mode.
pmNot	constant	Represents the NOT pen mode.
pmNotCopy	constant	Represents the Not Copy pen mode.
pmNotMask	constant	Represents the Not Mask pen mode.
pmNotMerge	constant	Represents the Not Merge pen mode.
pmNotXor	constant	Represents the Not XOR pen mode.
pmWhite	constant	Represents the White pen mode.
pmXor	constant	Represents the XOR pen mode.
psClear	constant	Represents the clear pen style.
psDash	constant	Represents the dashed pen style.
psDashDot	constant	Represents the dash-dot pattern pen style.
psDashDotDot	constant	Represents the dash-dot-dot pattern pen style.
psDot	constant	Represents the dotted pen style.
psInsideframe	constant	Represents the pen style used for an inside frame.
psPattern	constant	Represents a pattern pen style.
psSolid	constant	Represents the solid pen style.
StandardColorsCount	constant	Number of defined standard color constants.

Variables

BrushResourceCache	variable	Variable used as the cache for Brush resources.
FontResourceCache	variable	Variable used as the cache for Font resources.
OnGetSystemFont	variable	Address of the routine used to get the handle for the system font.
OnLoadGraphicFromClipboardFormat	variable	Address of the routine used to load a graphic from a clipboard format.
OnLoadSaveClipBrdGraphicValid	variable	Indicates whether clipboard formats for graphic types have been registered for the application.
OnSaveGraphicToClipboardFormat	variable	Address of the routine used to save a graphic to a clipboard format.
PenResourceCache	variable	Variable used as the cache for Pen resources.
ScreenInfo	variable	Contains display attributes for the current screen in an application.

Uses

• SysUtils
• Math
• Types
• Classes
• Contnrs
• AVL_Tree
• FPImage
• FPCanvas
• FPWriteBMP
• FPWritePNG
• PNGComn
• FPReadPNM
• FPWritePNM
• FPReadJpeg
• FPWriteJpeg
• FPReadTiff
• FPTiffCmn
• FPReadGif
• System.UITypes
• LCLVersion
• LCLStrConsts
• LCLType
• LCLProc
• LMessages
• LResources
• LCLResCache
• IntfGraphics
• IcnsTypes
• WSReferences
• GraphType
• GraphMath
• FPCAdds
• LazLoggerBase
• LazTracer
• LazUtilities