[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] Reference for unit 'GraphType' (#lcl)

TRawImageDescription

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

TRawImageDescription - a descriptor record for Raw Images

Declaration

Source position: graphtype.pp line 113

type TRawImageDescription = object

  Format: TRawImageColorFormat;

  

Format - whether RGB+/- Alpha or greyscale, or uninitialised

  Width: cardinal;

  

Width of the image

  Height: cardinal;

  

Height of the image

  Depth: Byte;

  

Depth - used bits per pixel

  BitOrder: TRawImageBitOrder;

  

BitOrder - whether bit 0 or bit 7 is stored first

  ByteOrder: TRawImageByteOrder;

  

ByteOrder - whether Most Significant Byte (MSB) or Least SB is stored first

  LineOrder: TRawImageLineOrder;

  

LineOrder - whether line 0 represents the top or the bottom line

  LineEnd: TRawImageLineEnd;

  

LineEnd - whether lines end at Byte, Word, Double or Quad Word (etc) boundary, or there is no gap at the end of a line

  BitsPerPixel: Byte;

  

BitsPerPixel - can be greater than Depth

  RedPrec: Byte;

  

RedPrec - number of bits of precision for red

  RedShift: Byte;

  

RedShift number of bits to shift red (least to most significant)

  GreenPrec: Byte;

  

GreenPrec - number of bits of precision for green

  GreenShift: Byte;

  

GreenShift number of bits to shift green (least to most significant)

  BluePrec: Byte;

  

BluePrec - number of bits of precision for blue

  BlueShift: Byte;

  

BlueShift number of bits to shift blue (least to most significant)

  AlphaPrec: Byte;

  

AlphaPrec - number of bits of precision for alpha

  AlphaShift: Byte;

  

AlphaShift number of bits to shift alpha (least to most significant)

  MaskBitsPerPixel: Byte;

  

MaskBitsPerPixel - bits per mask pixel, usually 1, 0 when no mask

  MaskShift: Byte;

  

MaskShift - the shift (=position) of the mask bit

  MaskLineEnd: TRawImageLineEnd;

  

MaskLineEnd - how the line is to be ended

  MaskBitOrder: TRawImageBitOrder;

  

MaskBitOrder - bit order to use for the mask

  PaletteColorCount: Word;

  

PaletteColorCount - entries in color palette. 0 when no palette.

  PaletteBitsPerIndex: Byte;

  

PaletteBitsPerIndex - bits per palette index, this can be larger than the colors used

  PaletteShift: Byte;

  

PaletteShift - bitshift. Direction: from least to most significant

  PaletteLineEnd: TRawImageLineEnd;

  

PaletteLineEnd - how lines are ended in the palette

  PaletteBitOrder: TRawImageBitOrder;

  

PaletteBitOrder - bit order for the palette

  PaletteByteOrder: TRawImageByteOrder;

  

PaletteByteOrder - byte order for the palette

  procedure Init;

  

Init - initialise the image descriptor. Don't use a contructor here, it will break compatibility with a record

  procedure Init_BPP24_B8G8R8_BIO_TTB();

  

Init_BPP24_B8G8R8_BIO_TTB - initiator for specified format

  procedure Init_BPP24_B8G8R8_M1_BIO_TTB();

  

Init_BPP24_B8G8R8_M1_BIO_TTB - initiator for specfied format

  procedure Init_BPP32_B8G8R8_BIO_TTB();

  

Init_BPP32_B8G8R8_BIO_TTB - initiator for specified format

  procedure Init_BPP32_B8G8R8_M1_BIO_TTB();

  

Init_BPP32_B8G8R8_M1_BIO_TTB - initiator for specified format

  procedure Init_BPP32_B8G8R8A8_BIO_TTB();

  

Init_BPP32_B8G8R8A8_BIO_TTB - initiator for specified format

  procedure Init_BPP32_B8G8R8A8_M1_BIO_TTB();

  

Init_BPP32_B8G8R8A8_M1_BIO_TTB - initiator for specified format

  function GetDescriptionFromMask;

  

GetDescriptionFromMask - returns an image descriptor obtained from the mask

  function GetDescriptionFromAlpha;

  

GetDescriptionFromAlpha - returns an image descriptor obtained from the Alpha

  function BytesPerLine;

  

The number of BytesPerLine. Returns a pointer

  function BitsPerLine;

  

The number of BitsPerLine. Returns a pointer

  function MaskBytesPerLine;

  

The number of MaskBytesPerLine. Returns a pointer

  function MaskBitsPerLine;

  

The number of MaskBitsPerLine. Returns a pointer

  function AsString;

  

AsString - returns the image as a string

  function IsEqual();

  

IsEqual - compares th ecurrent descriptor with another, and returns True if they are equal

end;

Inheritance

TRawImageDescription

  

TRawImageDescription - a descriptor record for Raw Images

Description

Note: not all devices/images have all parts at any time. But if a part can be applied to the device/image, the 'Description' describes its structure.

The latest version of this document can be found at lazarus-ccr.sourceforge.net.