TBLImageEncoder

Image encoder.

Definition

Unit: Blend2D

type TBLImageEncoder = record ... end;

Properties

Name	Description
BufferIndex	The position in destination buffer.
Codec
FrameIndex	The current frame index (yet to be written).
IsValid	Tests whether the image encoder is not a built-in null instance.
LastResult	The last encoding result.

Constructors

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

Operators

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

Methods

Name	Description
Equals
Reset
Restart
Swap
WriteFrame(TBLArray<Byte>, TBLImage)	Encodes the given AImage and writes the encoded data to the destination buffer ADst.
WriteFrame(TBLImage)	Encodes the given AImage and returns the encoded data.

Property Descriptions

BufferIndex

The position in destination buffer.

property BufferIndex: NativeInt read GetBufferIndex

Type: NativeInt

---

Codec

property Codec: TBLImageCodec read GetCodec

Type: TBLImageCodec

---

FrameIndex

The current frame index (yet to be written).

property FrameIndex: Int64 read GetFrameIndex

Type: Int64

---

IsValid

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

property IsValid: Boolean read GetIsValid

Type: Boolean

---

LastResult

The last encoding result.

property LastResult: TBLResult read GetLastResult

Type: TBLResult

---

Constructor Descriptions

Assign

Creates a copy of the AOther image encoder.

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

Parameters

ADest: TBLImageEncoder

ASrc: TBLImageEncoder

Exceptions

EBlend2DError: Raised on failure.

---

Finalize

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

destructor Finalize(var ADest: TBLImageEncoder)

Parameters

ADest: TBLImageEncoder

Exceptions

EBlend2DError: Raised on failure.

---

Initialize

Creates a new default-initialized image encoder.

constructor Initialize(out ADest: TBLImageEncoder)

Parameters

ADest: TBLImageEncoder

Exceptions

EBlend2DError: Raised on failure.

---

Operator Descriptions

Equal(TBLImageEncoder, TBLImageEncoder)

Returns True if two image encoders are equal.

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

Parameters

ALeft: TBLImageEncoder

ARight: TBLImageEncoder

Returns

Boolean

---

Equal(TBLImageEncoder, Pointer)

Used to compare against nil.

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

Parameters

ALeft: TBLImageEncoder

ARight: Pointer

Returns

Boolean

---

NotEqual(TBLImageEncoder, TBLImageEncoder)

Returns True if two image encoders are not equal.

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

Parameters

ALeft: TBLImageEncoder

ARight: TBLImageEncoder

Returns

Boolean

---

NotEqual(TBLImageEncoder, Pointer)

Used to compare against nil.

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

Parameters

ALeft: TBLImageEncoder

ARight: Pointer

Returns

Boolean

---

Method Descriptions

Equals(TBLImageEncoder)

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

Parameters

AOther: TBLImageEncoder

Returns

Boolean

---

Reset

procedure Reset; inline

---

Restart

procedure Restart; inline

---

Swap(TBLImageEncoder)

procedure Swap(var AOther: TBLImageEncoder); inline

Parameters

AOther: TBLImageEncoder

---

WriteFrame(TBLArray<Byte>, TBLImage)

Encodes the given AImage and writes the encoded data to the destination buffer ADst.

procedure WriteFrame(const ADst: TBLArray<Byte>; const AImage: TBLImage); overload; inline

Exceptions

EBlend2DError: Raised on failure.

Parameters

ADst: TBLArray<Byte>

AImage: TBLImage

---

WriteFrame(TBLImage)

Encodes the given AImage and returns the encoded data.

function WriteFrame(const AImage: TBLImage): TBytes; overload; inline

Exceptions

EBlend2DError: Raised on failure.

Parameters

AImage: TBLImage

Returns

TBytes

---