Sign in Join
FPDoc Onlineexperiment

TRawImage object

In unit GraphType

An uncompressed graphics image (bitmap).

Declaration

pascal
TRawImage = class

Description

This object hold the pixels, mask and color palette of the image, as well as a detailed description of the storage format of these parts.

This object currently is subject to refactoring, don't use it in application code.

Methods

InitInit - initiator for the object. Don't use a constructor here, it will break compatibility with a record.
CreateDataCreateData - method to create the data for the record.
FreeDataDestroys the allocated Data, Mask and Palette arrays.
ReleaseDataReleaseData - frees the resources when finished with the data.
ExtractRectExtractRect - find the position of the bounding rectangle from the raw data.
GetLineStartGets a pointer to the byte position at the beginning of the specified scanline.
PerformEffectPerformEffect - applies a specified special effect to the data of the Raw Image.
ReadBitsReadBits - reads the bit values for the raw image data at a given position.
ReadChannelsReads the Red, Green, Blue and Alpha channel values at a given position in pixel data.
ReadMaskReads the Mask value at the given position in the image data.
WriteBitsWrites ABits into Data at the given position.
WriteChannelsWriteChannels - writes the specified channel values at the nominated position.
WriteMaskWrites the mask for the raw image when assigned and given a valid bit depth in the image description.
IsMaskedIsMasked - returns True if the specified pixels are masked.
IsTransparentIsTransparent - returns True if the specified pixels are transparent.
IsEqualIsEqual - returns True if the current and specified images are equal.

Fields

DescriptionDescription record for the Raw Image.
DataData - a pointer to the actual data of the image.
DataSizeDataSize - pointer to the size of the image.
MaskMask - pointer to the Mask for use with the image.
MaskSizeMaskSize - pointer to the size of the mask.
PalettePalette - pointer to the palette of colors for this image.
PaletteSizePaletteSize - pointer to the size of the palette.

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