TBLFontVariationSettings

Font variation settings.

Definition

Unit: Blend2D

type TBLFontVariationSettings = record ... end;

Properties

Name	Description
Capacity	The container capacity.
IsEmpty	Whether the container is empty, which means that no tag/value pairs are stored in it.
Size	The number of variation tag/value pairs stored in the container.
Values	The value associated with the given AVariationTag.

Constructors

Name	Description
Assign	Copy constructor makes a weak copy of the underlying representation of the ASrc font variation settings.
Finalize	Destroys the font variation settings.
Initialize	Creates default initialized font variation settings.

Operators

Name	Description
Equal(TBLFontVariationSettings, TBLFontVariationSettings)	Returns True if two font variation settings instances are equal.
Equal(TBLFontVariationSettings, Pointer)	Used to compare against nil (empty font variation settings).
NotEqual(TBLFontVariationSettings, TBLFontVariationSettings)	Returns True if two font variation settings instances are not equal.
NotEqual(TBLFontVariationSettings, Pointer)	Used to compare against nil (empty font variation settings).

Methods

Name	Description
Clear
Equals	Tests whether this and AOther font variation settings are equal.
GetValue	Returns the value associated with the given AVariationTag.
HasValue	Tests whether the settings contains the given AVariationTag.
RemoveValue	Removes the given AVariationTag and its associated value from the settings.
Reset	Resets the font variation settings to a default constructed state.
SetValue	Sets or inserts the given AVariationTag to the settings, associating the AVariationTag with AValue.
Swap	Swaps the underlying representation with AOther.
View	Returns a normalized view of tag/value pairs.

Property Descriptions

Capacity

The container capacity.

property Capacity: NativeInt read GetCapacity

Type: NativeInt

---

IsEmpty

Whether the container is empty, which means that no tag/value pairs are stored in it.

property IsEmpty: Boolean read GetIsEmpty

Type: Boolean

---

Size

The number of variation tag/value pairs stored in the container.

property Size: NativeInt read GetSize

Type: NativeInt

---

Values

The value associated with the given AVariationTag.

See GetValue and SetValue for more information.

property Values[const AVariationTag: TBLTag]: Single read GetValue write SetValue

Type: Single

Exceptions

EBlend2DError: Raised on failure.

See Also

• GetValue
• SetValue

---

Constructor Descriptions

Assign

Copy constructor makes a weak copy of the underlying representation of the ASrc font variation settings.

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

Parameters

ADest: TBLFontVariationSettings

ASrc: TBLFontVariationSettings

Exceptions

EBlend2DError: Raised on failure.

---

Finalize

Destroys the font variation settings.

destructor Finalize(var ADest: TBLFontVariationSettings)

Parameters

ADest: TBLFontVariationSettings

Exceptions

EBlend2DError: Raised on failure.

---

Initialize

Creates default initialized font variation settings.

constructor Initialize(out ADest: TBLFontVariationSettings)

Parameters

ADest: TBLFontVariationSettings

Exceptions

EBlend2DError: Raised on failure.

---

Operator Descriptions

Equal(TBLFontVariationSettings, TBLFontVariationSettings)

Returns True if two font variation settings instances are equal.

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

Parameters

ALeft: TBLFontVariationSettings

ARight: TBLFontVariationSettings

Returns

Boolean

---

Equal(TBLFontVariationSettings, Pointer)

Used to compare against nil (empty font variation settings).

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

Parameters

ALeft: TBLFontVariationSettings

ARight: Pointer

Returns

Boolean

---

NotEqual(TBLFontVariationSettings, TBLFontVariationSettings)

Returns True if two font variation settings instances are not equal.

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

Parameters

ALeft: TBLFontVariationSettings

ARight: TBLFontVariationSettings

Returns

Boolean

---

NotEqual(TBLFontVariationSettings, Pointer)

Used to compare against nil (empty font variation settings).

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

Parameters

ALeft: TBLFontVariationSettings

ARight: Pointer

Returns

Boolean

---

Method Descriptions

Clear

procedure Clear; inline

---

Equals(TBLFontVariationSettings)

Tests whether this and AOther font variation settings are equal.

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

Parameters

AOther: TBLFontVariationSettings

Returns

Boolean

---

GetValue(TBLTag)

Returns the value associated with the given AVariationTag.

If the AVariationTag doesn't exist or is invalid NaN is returned.

function GetValue(const AVariationTag: TBLTag): Single; inline

Parameters

AVariationTag: TBLTag

Returns

Single

---

HasValue(TBLTag)

Tests whether the settings contains the given AVariationTag.

function HasValue(const AVariationTag: TBLTag): Boolean; inline

Parameters

AVariationTag: TBLTag

Returns

Boolean

---

RemoveValue(TBLTag)

Removes the given AVariationTag and its associated value from the settings.

Nothing happens if the AVariationTag is not in the settings.

procedure RemoveValue(const AVariationTag: TBLTag); inline

Exceptions

EBlend2DError: Raised on failure.

Parameters

AVariationTag: TBLTag

---

Reset

Resets the font variation settings to a default constructed state.

procedure Reset; inline

---

SetValue(TBLTag, Single)

Sets or inserts the given AVariationTag to the settings, associating the AVariationTag with AValue.

procedure SetValue(const ATag: TBLTag; const AValue: Single); inline

Exceptions

EBlend2DError: Raised on failure.

Parameters

ATag: TBLTag

AValue: Single

---

Swap(TBLFontVariationSettings)

Swaps the underlying representation with AOther.

procedure Swap(var AOther: TBLFontVariationSettings); inline

Parameters

AOther: TBLFontVariationSettings

---

View

Returns a normalized view of tag/value pairs.

function View: TBLFontVariationSettingsView; inline

Exceptions

EBlend2DError: Raised on failure.

Returns

TBLFontVariationSettingsView

---