cohtml.Net.UserFontDescription

Struct representing user font data. Baseline is 0.

Inherits from SystemIDisposable

Public Classes

	Name
class	CharInfo Struct representing data for individual char.
class	KerningPairInfo Struct representing kerning info between chars.

Public Functions

	Name
virtual void	Dispose()
	UserFontDescription()

Public Properties

	Name
UserFontType	FontType The font type that’s going to be used for loading and rendering.
string	FontFamily The font family.
float	Size The font size in which the glyph are generated. In pixels.
float	Spread The font spread size with which the glyphs are generated. It shows us how many pixels does it take to cover the [0-0.5] distance field range. In pixels. Spread specifies how many pixels does the distance field spread from the border(between inside and outside of a letter) to the outside. Therefore it maps to the [0-0.5] range. Some tools consider spread to be double the above distance - from end to end and is mapped to the [0-1] range. If that’s the case then that spread should be halved when used here.
FontWeight	Weight The font weight.
bool	IsBold Whether this is a bold font. Ignored when Weight is specified (not Auto)
bool	IsItalic Whether this is an italic font.
float	LineHeight The line height of the font according to the Size of the font. In pixels.
float	Ascent The ascent of the font (the distance from the baseline to the tops of the tallest glyphs). Positive number. In pixels.
float	Descent The descent of the font (the distance from the baseline to the bottoms of the lowest glyphs). Negative number. In pixels.
UserFontDescription.CharInfo	Chars Pointer to the char info data.
uint	NumChars Number of chars in this font.
UserFontDescription.KerningPairInfo	KerningPairs Pointer to kerning info. Kerning info is optional. If no info is present for given pair an implicit 0 amount of kerning is used. Kerning info is needed only for pairs with amount different from 0.
uint	NumKerningPairs Number of kerning pairs.

Protected Attributes

	Name
bool	swigCMemOwn

Public Functions Documentation

function Dispose

virtual void Dispose()

function UserFontDescription

UserFontDescription()

Public Property Documentation

property FontType

UserFontType FontType;

The font type that’s going to be used for loading and rendering.

property FontFamily

string FontFamily;

The font family.

property Size

float Size;

The font size in which the glyph are generated. In pixels.

property Spread

float Spread;

The font spread size with which the glyphs are generated. It shows us how many pixels does it take to cover the [0-0.5] distance field range. In pixels. Spread specifies how many pixels does the distance field spread from the border(between inside and outside of a letter) to the outside. Therefore it maps to the [0-0.5] range. Some tools consider spread to be double the above distance - from end to end and is mapped to the [0-1] range. If that’s the case then that spread should be halved when used here.

property Weight

FontWeight Weight;

The font weight.

property IsBold

bool IsBold;

Whether this is a bold font. Ignored when Weight is specified (not Auto)

property IsItalic

bool IsItalic;

Whether this is an italic font.

property LineHeight

float LineHeight;

The line height of the font according to the Size of the font. In pixels.

property Ascent

float Ascent;

The ascent of the font (the distance from the baseline to the tops of the tallest glyphs). Positive number. In pixels.

property Descent

float Descent;

The descent of the font (the distance from the baseline to the bottoms of the lowest glyphs). Negative number. In pixels.

property Chars

UserFontDescription.CharInfo Chars;

Pointer to the char info data.

property NumChars

uint NumChars;

Number of chars in this font.

property KerningPairs

UserFontDescription.KerningPairInfo KerningPairs;

Pointer to kerning info. Kerning info is optional. If no info is present for given pair an implicit 0 amount of kerning is used. Kerning info is needed only for pairs with amount different from 0.

property NumKerningPairs

uint NumKerningPairs;

Number of kerning pairs.

Protected Attributes Documentation

variable swigCMemOwn

bool swigCMemOwn;

---