Skip to content

Documentation / imgui / ImGui / ImFont

Class: ImFont ​

Defined in: libs/imgui/src/imgui.ts:2958

Constructors ​

Constructor ​

new ImFont(native): ImFont

Defined in: libs/imgui/src/imgui.ts:2959

Parameters ​

native ​

reference_ImFont

Returns ​

ImFont

Properties ​

native ​

readonly native: reference_ImFont

Defined in: libs/imgui/src/imgui.ts:2959

Accessors ​

FontStyle ​

Get Signature ​

get FontStyle(): string

Defined in: libs/imgui/src/imgui.ts:2970

Returns ​

string

Set Signature ​

set FontStyle(v): void

Defined in: libs/imgui/src/imgui.ts:2973

Parameters ​
v ​

string

Returns ​

void


FontName ​

Get Signature ​

get FontName(): string

Defined in: libs/imgui/src/imgui.ts:2977

Returns ​

string

Set Signature ​

set FontName(v): void

Defined in: libs/imgui/src/imgui.ts:2980

Parameters ​
v ​

string

Returns ​

void


FontSize ​

Get Signature ​

get FontSize(): number

Defined in: libs/imgui/src/imgui.ts:2984

Returns ​

number

Set Signature ​

set FontSize(v): void

Defined in: libs/imgui/src/imgui.ts:2987

Parameters ​
v ​

number

Returns ​

void


SpaceX ​

Get Signature ​

get SpaceX(): number[]

Defined in: libs/imgui/src/imgui.ts:2991

Returns ​

number[]

Set Signature ​

set SpaceX(v): void

Defined in: libs/imgui/src/imgui.ts:2994

Parameters ​
v ​

number[]

Returns ​

void


Scale ​

Get Signature ​

get Scale(): number

Defined in: libs/imgui/src/imgui.ts:3000

Returns ​

number

Set Signature ​

set Scale(value): void

Defined in: libs/imgui/src/imgui.ts:3003

Parameters ​
value ​

number

Returns ​

void


Glyphs ​

Get Signature ​

get Glyphs(): ImVector<ImFontGlyph>

Defined in: libs/imgui/src/imgui.ts:3007

Returns ​

ImVector<ImFontGlyph>


FallbackGlyph ​

Get Signature ​

get FallbackGlyph(): ImFontGlyph

Defined in: libs/imgui/src/imgui.ts:3019

Returns ​

ImFontGlyph

Set Signature ​

set FallbackGlyph(value): void

Defined in: libs/imgui/src/imgui.ts:3023

Parameters ​
value ​

ImFontGlyph

Returns ​

void


FallbackAdvanceX ​

Get Signature ​

get FallbackAdvanceX(): number

Defined in: libs/imgui/src/imgui.ts:3027

Returns ​

number


FallbackChar ​

Get Signature ​

get FallbackChar(): number

Defined in: libs/imgui/src/imgui.ts:3031

Returns ​

number


EllipsisChar ​

Get Signature ​

get EllipsisChar(): number

Defined in: libs/imgui/src/imgui.ts:3035

Returns ​

number


ConfigDataCount ​

Get Signature ​

get ConfigDataCount(): number

Defined in: libs/imgui/src/imgui.ts:3041

Returns ​

number


ConfigData ​

Get Signature ​

get ConfigData(): ImFontConfig

Defined in: libs/imgui/src/imgui.ts:3045

Returns ​

ImFontConfig


ContainerAtlas ​

Get Signature ​

get ContainerAtlas(): ImFontAtlas

Defined in: libs/imgui/src/imgui.ts:3049

Returns ​

ImFontAtlas


Ascent ​

Get Signature ​

get Ascent(): number

Defined in: libs/imgui/src/imgui.ts:3053

Returns ​

number

Set Signature ​

set Ascent(v): void

Defined in: libs/imgui/src/imgui.ts:3056

Parameters ​
v ​

number

Returns ​

void


Descent ​

Get Signature ​

get Descent(): number

Defined in: libs/imgui/src/imgui.ts:3059

Returns ​

number

Set Signature ​

set Descent(v): void

Defined in: libs/imgui/src/imgui.ts:3062

Parameters ​
v ​

number

Returns ​

void


MetricsTotalSurface ​

Get Signature ​

get MetricsTotalSurface(): number

Defined in: libs/imgui/src/imgui.ts:3066

Returns ​

number


GlyphToCreate ​

Get Signature ​

get GlyphToCreate(): ImFontGlyph

Defined in: libs/imgui/src/imgui.ts:3180

Returns ​

ImFontGlyph


IterateGlyphToCreate ​

Get Signature ​

get IterateGlyphToCreate(): ImFontGlyph[]

Defined in: libs/imgui/src/imgui.ts:3185

Returns ​

ImFontGlyph[]

Methods ​

setFont() ​

setFont(config): void

Defined in: libs/imgui/src/imgui.ts:2961

Parameters ​

config ​

DOMFontConfig

Returns ​

void


ClearOutputData() ​

ClearOutputData(): void

Defined in: libs/imgui/src/imgui.ts:3074

Returns ​

void


BuildLookupTable() ​

BuildLookupTable(): void

Defined in: libs/imgui/src/imgui.ts:3078

Returns ​

void


FindGlyph() ​

FindGlyph(c): Readonly<ImFontGlyph>

Defined in: libs/imgui/src/imgui.ts:3082

Parameters ​

c ​

number

Returns ​

Readonly<ImFontGlyph>


FindGlyphNoFallback() ​

FindGlyphNoFallback(c): ImFontGlyph

Defined in: libs/imgui/src/imgui.ts:3087

Parameters ​

c ​

number

Returns ​

ImFontGlyph


SetFallbackChar() ​

SetFallbackChar(c): void

Defined in: libs/imgui/src/imgui.ts:3092

Parameters ​

c ​

number

Returns ​

void


GetCharAdvance() ​

GetCharAdvance(c): number

Defined in: libs/imgui/src/imgui.ts:3096

Parameters ​

c ​

number

Returns ​

number


IsLoaded() ​

IsLoaded(): boolean

Defined in: libs/imgui/src/imgui.ts:3100

Returns ​

boolean


GetDebugName() ​

GetDebugName(): string

Defined in: libs/imgui/src/imgui.ts:3104

Returns ​

string


CalcTextSizeA() ​

CalcTextSizeA(size, max_width, wrap_width, text_begin, text_end?, remaining?, isready?): interface_ImVec2

Defined in: libs/imgui/src/imgui.ts:3111

Parameters ​

size ​

number

max_width ​

number

wrap_width ​

number

text_begin ​

string

text_end? ​

number = null

remaining? ​

ImScalar<number> = null

isready? ​

ImScalar<boolean> = null

Returns ​

interface_ImVec2


CalcWordWrapPositionA() ​

CalcWordWrapPositionA(scale, text, text_end?, wrap_width): number

Defined in: libs/imgui/src/imgui.ts:3131

Parameters ​

scale ​

number

text ​

string

text_end? ​

number = null

wrap_width ​

number

Returns ​

number


RenderChar() ​

RenderChar(draw_list, size, pos, col, c): void

Defined in: libs/imgui/src/imgui.ts:3144

Parameters ​

draw_list ​

ImDrawList

size ​

number

pos ​

Readonly<Bind.interface_ImVec2>

col ​

number

c ​

number

Returns ​

void


RenderText() ​

RenderText(_draw_list, _size, _pos, _col, _clip_rect, _text_begin, _text_end?, _wrap_width?, _cpu_fine_clip?): void

Defined in: libs/imgui/src/imgui.ts:3154

Parameters ​

_draw_list ​

ImDrawList

_size ​

number

_pos ​

Readonly<Bind.interface_ImVec2>

_col ​

number

_clip_rect ​

Readonly<Bind.interface_ImVec4>

_text_begin ​

string

_text_end? ​

number = null

_wrap_width? ​

number = 0.0

_cpu_fine_clip? ​

boolean = false

Returns ​

void


IsGlyphRangeUnused() ​

IsGlyphRangeUnused(_c_begin, _c_last): boolean

Defined in: libs/imgui/src/imgui.ts:3176

Parameters ​

_c_begin ​

number

_c_last ​

number

Returns ​

boolean


GlyphCreated() ​

GlyphCreated(glyph): void

Defined in: libs/imgui/src/imgui.ts:3192

Parameters ​

glyph ​

ImFontGlyph

Returns ​

void


ClearGlyphCreated() ​

ClearGlyphCreated(): void

Defined in: libs/imgui/src/imgui.ts:3195

Returns ​

void


CreateGlyph() ​

CreateGlyph(text): void

Defined in: libs/imgui/src/imgui.ts:3199

Parameters ​

text ​

string

Returns ​

void

Released under the MIT License.