Sign in Join
FPDoc Onlineexperiment

AllocPatternBitmap function

In unit Graphics

Ensures that a Pattern Bitmap with the specified colors exists in the Pattern cache.

Declaration

pascal
function AllocPatternBitmap(colorBG: TColor; colorFG: TColor): TBitmap

Description

AllocPatternBitmap is a TBitmap function used to ensure that a bitmap with the specified colors exists in the internal pattern cache.

AllocPatternBitmap tries to locate a TPatternBitmap instance with the colors specified in colorBG and colorFG. If the requested Pattern Bitmap does not already exist, it is created and added to the pattern cache.

The return value is the TBitmap instance stored in the Bitmap property for the cached TPatternBitmap instance. No actions are performed if the Pattern cache has not been assigned; the return value is Nil in this situation.

See also

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