Sign in Join
FPDoc Onlineexperiment

CreateBitmapFromLazarusResource function

In unit Graphics

Creates and loads a Bitmap from a Lazarus Resource (.lrs) file.

Declaration

pascal
function CreateBitmapFromLazarusResource(const AName: string)
: TCustomBitmap

Arguments

AName

Name for the graphic resource loaded in the routine.

Function result

TCustomBitmap with the graphic content created in the routine.

Description

CreateBitmapFromLazarusResource is an overloaded TCustomBitmap function used to create and populate a bitmap with the content specified by the arguments to the routine.

The overloaded variants allow either a resource name (AName) or TLResource handle (AHandle) to be used to select the content for the bitmap. The variants with the AMinimumClass argument allow the class type for the graphic to be specified. TCustomBitmapClass is the default class type used in the overloaded variants.

CreateBitmapFromLazarusResource uses a temporary TLazarusResourceStream instance to load the content from the Lazarus resource.

CreateBitmapFromLazarusResource is used in the implementation of routines like LoadBitmapFromLazarusResourceHandle and GetDefaultGlyph (in ImgList.pp).

See also

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