TBLImageDecoder

Image decoder.

Definition

Unit: Blend2D

type TBLImageDecoder = record ... end;

Properties

Name	Description
BufferIndex	The position in source buffer.
Codec
FrameIndex	The current frame index (to be decoded).
IsValid	Tests whether the image decoder is not a built-in null instance.
LastResult	The last decoding result.

Constructors

Name	Description
Assign	Creates a copy of the AOther image decoder.
Finalize	Destroys the image decoder and releases all resources allocated by it.
Initialize	Creates a new default-initialized image decoder.

Operators

Name	Description
Equal(TBLImageDecoder, TBLImageDecoder)	Returns True if two image decoders are equal.
Equal(TBLImageDecoder, Pointer)	Used to compare against nil.
NotEqual(TBLImageDecoder, TBLImageDecoder)	Returns True if two image decoders are not equal.
NotEqual(TBLImageDecoder, Pointer)	Used to compare against nil.

Methods

Name	Description
Equals
ReadFrame(TBLImage, TBLArray<Byte>)
ReadFrame(TBLImage, TBytes)
ReadFrame(TBLImage, TBLArrayView<Byte>)
ReadFrame(TBLImage, Pointer, NativeInt)
ReadInfo(TBLImageInfo, Pointer, NativeInt)
ReadInfo(TBLImageInfo, TBLArrayView<Byte>)
ReadInfo(TBLImageInfo, TBytes)
ReadInfo(TBLImageInfo, TBLArray<Byte>)
Reset
Restart
Swap

Property Descriptions

BufferIndex

The position in source buffer.

property BufferIndex: NativeInt read GetBufferIndex

Type: NativeInt

---

Codec

property Codec: TBLImageCodec read GetCodec

Type: TBLImageCodec

---

FrameIndex

The current frame index (to be decoded).

property FrameIndex: Int64 read GetFrameIndex

Type: Int64

---

IsValid

Tests whether the image decoder is not a built-in null instance.

property IsValid: Boolean read GetIsValid

Type: Boolean

---

LastResult

The last decoding result.

property LastResult: TBLResult read GetLastResult

Type: TBLResult

---

Constructor Descriptions

Assign

Creates a copy of the AOther image decoder.

constructor Assign(var ADest: TBLImageDecoder; const ASrc: TBLImageDecoder); inline

Parameters

ADest: TBLImageDecoder

ASrc: TBLImageDecoder

Exceptions

EBlend2DError: Raised on failure.

---

Finalize

Destroys the image decoder and releases all resources allocated by it.

destructor Finalize(var ADest: TBLImageDecoder)

Parameters

ADest: TBLImageDecoder

Exceptions

EBlend2DError: Raised on failure.

---

Initialize

Creates a new default-initialized image decoder.

constructor Initialize(out ADest: TBLImageDecoder)

Parameters

ADest: TBLImageDecoder

Exceptions

EBlend2DError: Raised on failure.

---

Operator Descriptions

Equal(TBLImageDecoder, TBLImageDecoder)

Returns True if two image decoders are equal.

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

Parameters

ALeft: TBLImageDecoder

ARight: TBLImageDecoder

Returns

Boolean

---

Equal(TBLImageDecoder, Pointer)

Used to compare against nil.

class operator Equal(const ALeft: TBLImageDecoder; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TBLImageDecoder

ARight: Pointer

Returns

Boolean

---

NotEqual(TBLImageDecoder, TBLImageDecoder)

Returns True if two image decoders are not equal.

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

Parameters

ALeft: TBLImageDecoder

ARight: TBLImageDecoder

Returns

Boolean

---

NotEqual(TBLImageDecoder, Pointer)

Used to compare against nil.

class operator NotEqual(const ALeft: TBLImageDecoder; const ARight: Pointer): Boolean; inline; static

Parameters

ALeft: TBLImageDecoder

ARight: Pointer

Returns

Boolean

---

Method Descriptions

Equals(TBLImageDecoder)

function Equals(const AOther: TBLImageDecoder): Boolean; inline

Parameters

AOther: TBLImageDecoder

Returns

Boolean

---

ReadFrame(TBLImage, TBLArray<Byte>)

procedure ReadFrame(out ADst: TBLImage; const ABuffer: TBLArray<Byte>); overload; inline

Parameters

ADst: TBLImage

ABuffer: TBLArray<Byte>

---

ReadFrame(TBLImage, TBytes)

procedure ReadFrame(out ADst: TBLImage; const ABuffer: TBytes); overload; inline

Parameters

ADst: TBLImage

ABuffer: TBytes

---

ReadFrame(TBLImage, TBLArrayView<Byte>)

procedure ReadFrame(out ADst: TBLImage; const AView: TBLArrayView<Byte>); overload; inline

Parameters

ADst: TBLImage

AView: TBLArrayView<Byte>

---

ReadFrame(TBLImage, Pointer, NativeInt)

procedure ReadFrame(out ADst: TBLImage; const AData: Pointer; const ASize: NativeInt); overload; inline

Parameters

ADst: TBLImage

AData: Pointer

ASize: NativeInt

---

ReadInfo(TBLImageInfo, Pointer, NativeInt)

procedure ReadInfo(out ADst: TBLImageInfo; const AData: Pointer; const ASize: NativeInt); overload; inline

Parameters

ADst: TBLImageInfo

AData: Pointer

ASize: NativeInt

---

ReadInfo(TBLImageInfo, TBLArrayView<Byte>)

procedure ReadInfo(out ADst: TBLImageInfo; const AView: TBLArrayView<Byte>); overload; inline

Parameters

ADst: TBLImageInfo

AView: TBLArrayView<Byte>

---

ReadInfo(TBLImageInfo, TBytes)

procedure ReadInfo(out ADst: TBLImageInfo; const ABuffer: TBytes); overload; inline

Parameters

ADst: TBLImageInfo

ABuffer: TBytes

---

ReadInfo(TBLImageInfo, TBLArray<Byte>)

procedure ReadInfo(out ADst: TBLImageInfo; const ABuffer: TBLArray<Byte>); overload; inline

Parameters

ADst: TBLImageInfo

ABuffer: TBLArray<Byte>

---

Reset

procedure Reset; inline

---

Restart

procedure Restart; inline

---

Swap(TBLImageDecoder)

procedure Swap(var AOther: TBLImageDecoder); inline

Parameters

AOther: TBLImageDecoder

---