Class FontImportOptions

Import options that allow you to control how is a font imported.

Hierarchy (View Summary)

ImportOptions
- FontImportOptions

Index

Constructors

Accessors

characterIndexRanges dpiScale fontSizes isBold isDynamic isItalic renderMode

Methods

Constructors

constructor

new FontImportOptions(isInternalConstructor?: boolean): FontImportOptions
Creates a new import options object that allows you to customize how are fonts imported.
Parameters
- OptionalisInternalConstructor: boolean
Returns FontImportOptions

Overrides ImportOptions.constructor

Accessors

characterIndexRanges

get characterIndexRanges(): Iterable<CharRange>

Determines character index ranges to import. Ranges are defined as unicode numbers.

Returns Iterable<CharRange>
set characterIndexRanges(
value: Iterable<CharRange> | readonly Immutable<CharRange>[],
): void
Parameters
- value: Iterable<CharRange> | readonly Immutable<CharRange>[]
Returns void

dpiScale

get dpiScale(): number

Determines dots per inch scale that will be used when rendering the characters.

Returns number
set dpiScale(value: number): void
Parameters
- value: number
Returns void

fontSizes

get fontSizes(): Iterable<number>

Determines font sizes that are to be imported. Sizes are in points.

Returns Iterable<number>
set fontSizes(value: readonly number[] | Iterable<number>): void
Parameters
- value: readonly number[] | Iterable<number>
Returns void

isBold

get isBold(): boolean

Determines whether the bold font style should be used when rendering.

Returns boolean
set isBold(value: boolean): void
Parameters
- value: boolean
Returns void

isDynamic

get isDynamic(): boolean

Determines if the font is dynamic. Dynamic fonts can generate glyphs at runtime and can be used to represent a much larger character set.

Returns boolean
set isDynamic(value: boolean): void
Parameters
- value: boolean
Returns void

isItalic

get isItalic(): boolean

Determines whether the italic font style should be used when rendering.

Returns boolean
set isItalic(value: boolean): void
Parameters
- value: boolean
Returns void

renderMode

get renderMode(): EnumValue<FontRenderMode>

Determines the render mode used for rendering the characters into a bitmap.

Returns EnumValue<FontRenderMode>
set renderMode(value: EnumValue<FontRenderMode>): void
Parameters
- value: EnumValue<FontRenderMode>
Returns void

Methods

equals

equals(other: ImportOptions): boolean
Virtual
Checks if this object has the same contents as the provided one.
Parameters
- other: ImportOptions
Returns boolean

Inherited from ImportOptions.equals