Sign in Join
FPDoc Onlineexperiment

TCustomBitmap.RawimageNeeded procedure

Member of TCustomBitmapprotectedIn unit Graphics

Ensures that the RawImage data is allocated prior to use.

Declaration

pascal
procedure RawimageNeeded(ADescOnly: Boolean)

Arguments

ADescOnlyTrue when only the image descriptor in the raw image data is needed.

Description

Ensures that the RawImage property is allocated prior to accessing values in the raw image data.

ADescOnly indicates whether the image descriptor or the complete raw image data is required. When ADescOnly is True, only the TRawImageDescription in the raw image is needed. When set to False, all values in the TRawImage instance are required.

RawImageNeeded is called from methods access the raw image data, and occurs before the value in RawImage is accessed. For example:

  • SetSize
  • UpdatePixelFormat
  • GetMonochrome
  • UnshareImage
  • GetRawImagePtr
  • GetRawImageDescriptionPtr

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