Skip to content

TBLFormatInfo

Provides a detailed information about a pixel format. Use Query for information of Blend2D native pixel formats.

Definition

Unit: Blend2D

type TBLFormatInfo = record ... end;

Properties

Name Description
AShift
ASize
BShift
BSize
Depth
Flags
GShift
GSize
Palette
RShift
RSize
Shifts
Sizes

Operators

Name Description
Equal
NotEqual

Methods

Name Description
AddFlags
ClearFlags
HasFlag
Init
Query Query Blend2D AFormat and copy it to this format info.
Reset
Sanitize Sanitize this TBLFormatInfo.
SetShifts
SetSizes

Property Descriptions

AShift

property AShift: Byte read FShifts[3] write FShifts[3]

Type: Byte


ASize

property ASize: Byte read FSizes[3] write FSizes[3]

Type: Byte


BShift

property BShift: Byte read FShifts[2] write FShifts[2]

Type: Byte


BSize

property BSize: Byte read FSizes[2] write FSizes[2]

Type: Byte


Depth

property Depth: Integer read FDepth write FDepth

Type: Integer


Flags

property Flags: TBLFormatFlags read FFlags write FFlags

Type: TBLFormatFlags


GShift

property GShift: Byte read FShifts[1] write FShifts[1]

Type: Byte


GSize

property GSize: Byte read FSizes[1] write FSizes[1]

Type: Byte


Palette

property Palette: PBLRgba32 read GetPalette

Type: PBLRgba32


RShift

property RShift: Byte read FShifts[0] write FShifts[0]

Type: Byte


RSize

property RSize: Byte read FSizes[0] write FSizes[0]

Type: Byte


Shifts

property Shifts[const AIndex: Integer]: Byte read GetShift write SetShift

Type: Byte


Sizes

property Sizes[const AIndex: Integer]: Byte read GetSize write SetSize

Type: Byte


Operator Descriptions

Equal(TBLFormatInfo, TBLFormatInfo)

class operator Equal(const ALeft, ARight: TBLFormatInfo): Boolean; inline; static

Parameters

ALeft: TBLFormatInfo

ARight: TBLFormatInfo

Returns

Boolean


NotEqual(TBLFormatInfo, TBLFormatInfo)

class operator NotEqual(const ALeft, ARight: TBLFormatInfo): Boolean; inline; static

Parameters

ALeft: TBLFormatInfo

ARight: TBLFormatInfo

Returns

Boolean


Method Descriptions

AddFlags(TBLFormatFlags)

procedure AddFlags(const AFlags: TBLFormatFlags); inline

Parameters

AFlags: TBLFormatFlags


ClearFlags(TBLFormatFlags)

procedure ClearFlags(const AFlags: TBLFormatFlags); inline

Parameters

AFlags: TBLFormatFlags


HasFlag(TBLFormatFlag)

function HasFlag(const AFlag: TBLFormatFlag): Boolean; inline

Parameters

AFlag: TBLFormatFlag

Returns

Boolean


Init(Integer, TBLFormatFlags, TBLFourBytes, TBLFourBytes)

procedure Init(const ADepth: Integer; const AFlags: TBLFormatFlags; const ASizes, AShifts: TBLFourBytes); inline

Parameters

ADepth: Integer

AFlags: TBLFormatFlags

ASizes: TBLFourBytes

AShifts: TBLFourBytes


Query(TBLFormat)

Query Blend2D AFormat and copy it to this format info.

procedure Query(const AFormat: TBLFormat); inline

Parameters

AFormat: TBLFormat

Remarks

TBLFormat.None is considered invalid format, thus if it's passed to Query it will raise an error. <.remarks>Raised on failure.</.remarks>


Reset

procedure Reset; inline


Sanitize

Sanitize this TBLFormatInfo.

Sanitizer verifies whether the format is valid and updates the format information about flags to values that Blend2D expects. For example format flags are properly examined and simplified if possible, byte-swap is implicitly performed for formats where a single component matches one byte, etc...

procedure Sanitize; inline

Exceptions

EBlend2DError: Raised on failure.


SetShifts(Byte, Byte, Byte, Byte)

procedure SetShifts(const AR, AG, AB, AA: Byte); inline

Parameters

AR: Byte

AG: Byte

AB: Byte

AA: Byte


SetSizes(Byte, Byte, Byte, Byte)

procedure SetSizes(const AR, AG, AB, AA: Byte); inline

Parameters

AR: Byte

AG: Byte

AB: Byte

AA: Byte