Skip to content

Documentation / imgui / ImGui / ImGuiIO

Class: ImGuiIO ​

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

Constructors ​

Constructor ​

new ImGuiIO(native): ImGuiIO

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

Parameters ​

native ​

reference_ImGuiIO

Returns ​

ImGuiIO

Properties ​

native ​

readonly native: reference_ImGuiIO

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


KeyMap ​

KeyMap: number[]

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


MouseDown ​

MouseDown: boolean[]

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


KeysDown ​

KeysDown: boolean[]

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


NavInputs: number[]

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


MouseClickedPos ​

MouseClickedPos: Readonly<reference_ImVec2>[]

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


MouseDownDuration ​

MouseDownDuration: number[]

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


KeysDownDuration ​

KeysDownDuration: number[]

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


NavInputsDownDuration: number[]

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

Accessors ​

ConfigFlags ​

Get Signature ​

get ConfigFlags(): ImGuiConfigFlags

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

Returns ​

ImGuiConfigFlags

Set Signature ​

set ConfigFlags(value): void

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

Parameters ​
value ​

ImGuiConfigFlags

Returns ​

void


BackendFlags ​

Get Signature ​

get BackendFlags(): ImGuiBackendFlags

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

Returns ​

ImGuiBackendFlags

Set Signature ​

set BackendFlags(value): void

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

Parameters ​
value ​

ImGuiBackendFlags

Returns ​

void


DisplaySize ​

Get Signature ​

get DisplaySize(): reference_ImVec2

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

Returns ​

reference_ImVec2


DeltaTime ​

Get Signature ​

get DeltaTime(): number

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

Returns ​

number

Set Signature ​

set DeltaTime(value): void

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

Parameters ​
value ​

number

Returns ​

void


IniSavingRate ​

Get Signature ​

get IniSavingRate(): number

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

Returns ​

number

Set Signature ​

set IniSavingRate(value): void

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

Parameters ​
value ​

number

Returns ​

void


IniFilename ​

Get Signature ​

get IniFilename(): string

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

Returns ​

string

Set Signature ​

set IniFilename(value): void

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

Parameters ​
value ​

string

Returns ​

void


LogFilename ​

Get Signature ​

get LogFilename(): string

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

Returns ​

string

Set Signature ​

set LogFilename(value): void

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

Parameters ​
value ​

string

Returns ​

void


MouseDoubleClickTime ​

Get Signature ​

get MouseDoubleClickTime(): number

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

Returns ​

number

Set Signature ​

set MouseDoubleClickTime(value): void

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

Parameters ​
value ​

number

Returns ​

void


MouseDoubleClickMaxDist ​

Get Signature ​

get MouseDoubleClickMaxDist(): number

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

Returns ​

number

Set Signature ​

set MouseDoubleClickMaxDist(value): void

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

Parameters ​
value ​

number

Returns ​

void


MouseDragThreshold ​

Get Signature ​

get MouseDragThreshold(): number

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

Returns ​

number

Set Signature ​

set MouseDragThreshold(value): void

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

Parameters ​
value ​

number

Returns ​

void


KeyRepeatDelay ​

Get Signature ​

get KeyRepeatDelay(): number

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

Returns ​

number

Set Signature ​

set KeyRepeatDelay(value): void

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

Parameters ​
value ​

number

Returns ​

void


KeyRepeatRate ​

Get Signature ​

get KeyRepeatRate(): number

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

Returns ​

number

Set Signature ​

set KeyRepeatRate(value): void

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

Parameters ​
value ​

number

Returns ​

void


UserData ​

Get Signature ​

get UserData(): any

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

Returns ​

any

Set Signature ​

set UserData(value): void

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

Parameters ​
value ​

any

Returns ​

void


Fonts ​

Get Signature ​

get Fonts(): ImFontAtlas

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

Returns ​

ImFontAtlas


FontGlobalScale ​

Get Signature ​

get FontGlobalScale(): number

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

Returns ​

number

Set Signature ​

set FontGlobalScale(value): void

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

Parameters ​
value ​

number

Returns ​

void


FontAllowUserScaling ​

Get Signature ​

get FontAllowUserScaling(): boolean

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

Returns ​

boolean

Set Signature ​

set FontAllowUserScaling(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


FontDefault ​

Get Signature ​

get FontDefault(): ImFont

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

Returns ​

ImFont

Set Signature ​

set FontDefault(value): void

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

Parameters ​
value ​

ImFont

Returns ​

void


DisplayFramebufferScale ​

Get Signature ​

get DisplayFramebufferScale(): reference_ImVec2

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

Returns ​

reference_ImVec2


ConfigMacOSXBehaviors ​

Get Signature ​

get ConfigMacOSXBehaviors(): boolean

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

Returns ​

boolean

Set Signature ​

set ConfigMacOSXBehaviors(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


Get Signature ​

get ConfigInputTextCursorBlink(): boolean

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

Returns ​

boolean

Set Signature ​

set ConfigInputTextCursorBlink(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


ConfigDragClickToInputText ​

Get Signature ​

get ConfigDragClickToInputText(): boolean

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

Returns ​

boolean

Set Signature ​

set ConfigDragClickToInputText(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


ConfigWindowsResizeFromEdges ​

Get Signature ​

get ConfigWindowsResizeFromEdges(): boolean

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

Returns ​

boolean

Set Signature ​

set ConfigWindowsResizeFromEdges(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


ConfigWindowsMoveFromTitleBarOnly ​

Get Signature ​

get ConfigWindowsMoveFromTitleBarOnly(): boolean

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

Returns ​

boolean

Set Signature ​

set ConfigWindowsMoveFromTitleBarOnly(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


ConfigMemoryCompactTimer ​

Get Signature ​

get ConfigMemoryCompactTimer(): number

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

Returns ​

number

Set Signature ​

set ConfigMemoryCompactTimer(value): void

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

Parameters ​
value ​

number

Returns ​

void


BackendPlatformName ​

Get Signature ​

get BackendPlatformName(): string

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

Returns ​

string

Set Signature ​

set BackendPlatformName(value): void

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

Parameters ​
value ​

string

Returns ​

void


BackendRendererName ​

Get Signature ​

get BackendRendererName(): string

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

Returns ​

string

Set Signature ​

set BackendRendererName(value): void

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

Parameters ​
value ​

string

Returns ​

void


BackendPlatformUserData ​

Get Signature ​

get BackendPlatformUserData(): string

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

Returns ​

string

Set Signature ​

set BackendPlatformUserData(value): void

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

Parameters ​
value ​

string

Returns ​

void


BackendRendererUserData ​

Get Signature ​

get BackendRendererUserData(): string

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

Returns ​

string

Set Signature ​

set BackendRendererUserData(value): void

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

Parameters ​
value ​

string

Returns ​

void


BackendLanguageUserData ​

Get Signature ​

get BackendLanguageUserData(): string

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

Returns ​

string

Set Signature ​

set BackendLanguageUserData(value): void

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

Parameters ​
value ​

string

Returns ​

void


GetClipboardTextFn ​

Get Signature ​

get GetClipboardTextFn(): (user_data) => string

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

Returns ​

(user_data) => string

Set Signature ​

set GetClipboardTextFn(value): void

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

Parameters ​
value ​

(user_data) => string

Returns ​

void


SetClipboardTextFn ​

Get Signature ​

get SetClipboardTextFn(): (user_data, text) => void

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

Returns ​

(user_data, text) => void

Set Signature ​

set SetClipboardTextFn(value): void

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

Parameters ​
value ​

(user_data, text) => void

Returns ​

void


ClipboardUserData ​

Get Signature ​

get ClipboardUserData(): any

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

Returns ​

any

Set Signature ​

set ClipboardUserData(value): void

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

Parameters ​
value ​

any

Returns ​

void


MousePos ​

Get Signature ​

get MousePos(): reference_ImVec2

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

Returns ​

reference_ImVec2


MouseWheel ​

Get Signature ​

get MouseWheel(): number

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

Returns ​

number

Set Signature ​

set MouseWheel(value): void

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

Parameters ​
value ​

number

Returns ​

void


MouseWheelH ​

Get Signature ​

get MouseWheelH(): number

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

Returns ​

number

Set Signature ​

set MouseWheelH(value): void

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

Parameters ​
value ​

number

Returns ​

void


MouseDrawCursor ​

Get Signature ​

get MouseDrawCursor(): boolean

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

Returns ​

boolean

Set Signature ​

set MouseDrawCursor(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


KeyCtrl ​

Get Signature ​

get KeyCtrl(): boolean

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

Returns ​

boolean

Set Signature ​

set KeyCtrl(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


KeyShift ​

Get Signature ​

get KeyShift(): boolean

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

Returns ​

boolean

Set Signature ​

set KeyShift(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


KeyAlt ​

Get Signature ​

get KeyAlt(): boolean

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

Returns ​

boolean

Set Signature ​

set KeyAlt(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


KeySuper ​

Get Signature ​

get KeySuper(): boolean

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

Returns ​

boolean

Set Signature ​

set KeySuper(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


WantCaptureMouse ​

Get Signature ​

get WantCaptureMouse(): boolean

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

Returns ​

boolean

Set Signature ​

set WantCaptureMouse(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


WantCaptureKeyboard ​

Get Signature ​

get WantCaptureKeyboard(): boolean

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

Returns ​

boolean

Set Signature ​

set WantCaptureKeyboard(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


WantTextInput ​

Get Signature ​

get WantTextInput(): boolean

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

Returns ​

boolean

Set Signature ​

set WantTextInput(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


WantSetMousePos ​

Get Signature ​

get WantSetMousePos(): boolean

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

Returns ​

boolean

Set Signature ​

set WantSetMousePos(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


WantSaveIniSettings ​

Get Signature ​

get WantSaveIniSettings(): boolean

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

Returns ​

boolean

Set Signature ​

set WantSaveIniSettings(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


Get Signature ​

get NavActive(): boolean

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

Returns ​

boolean

Set Signature ​

set NavActive(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


Get Signature ​

get NavVisible(): boolean

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

Returns ​

boolean

Set Signature ​

set NavVisible(value): void

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

Parameters ​
value ​

boolean

Returns ​

void


Framerate ​

Get Signature ​

get Framerate(): number

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

Returns ​

number


MetricsRenderVertices ​

Get Signature ​

get MetricsRenderVertices(): number

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

Returns ​

number


MetricsRenderIndices ​

Get Signature ​

get MetricsRenderIndices(): number

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

Returns ​

number


MetricsRenderWindows ​

Get Signature ​

get MetricsRenderWindows(): number

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

Returns ​

number


MetricsActiveWindows ​

Get Signature ​

get MetricsActiveWindows(): number

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

Returns ​

number


MetricsActiveAllocations ​

Get Signature ​

get MetricsActiveAllocations(): number

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

Returns ​

number


MouseDelta ​

Get Signature ​

get MouseDelta(): Readonly<Bind.reference_ImVec2>

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

Returns ​

Readonly<Bind.reference_ImVec2>

Methods ​

AddInputCharacter() ​

AddInputCharacter(c): void

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

Parameters ​

c ​

number

Returns ​

void


AddInputCharacterUTF16() ​

AddInputCharacterUTF16(c): void

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

Parameters ​

c ​

number

Returns ​

void


AddInputCharactersUTF8() ​

AddInputCharactersUTF8(utf8_chars): void

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

Parameters ​

utf8_chars ​

string

Returns ​

void


ClearInputCharacters() ​

ClearInputCharacters(): void

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

Returns ​

void

Released under the MIT License.