Documentation / imgui / ImGui / ImDrawList

Class: ImDrawList

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

Constructors

Constructor

new ImDrawList(native): ImDrawList

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

Parameters

native

reference_ImDrawList

Returns

ImDrawList

Properties

native

readonly native: reference_ImDrawList

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

Accessors

IdxBuffer

Get Signature

get IdxBuffer(): Uint8Array<ArrayBuffer>

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

Returns

Uint8Array<ArrayBuffer>

---

VtxBuffer

Get Signature

get VtxBuffer(): Uint8Array<ArrayBuffer>

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

Returns

Uint8Array<ArrayBuffer>

---

Flags

Get Signature

get Flags(): ImDrawListFlags

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

Returns

ImDrawListFlags

Set Signature

set Flags(value): void

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

Parameters

value

ImDrawListFlags

Returns

void

Methods

IterateDrawCmds()

IterateDrawCmds(callback): void

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

Parameters

callback

(draw_cmd, ElemStart) => void

Returns

void

---

PushClipRect()

PushClipRect(clip_rect_min, clip_rect_max, intersect_with_current_clip_rect?): void

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

Parameters

clip_rect_min

Readonly<Bind.interface_ImVec2>

clip_rect_max

Readonly<Bind.interface_ImVec2>

intersect_with_current_clip_rect?

boolean = false

Returns

void

---

PushClipRectFullScreen()

PushClipRectFullScreen(): void

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

Returns

void

---

PopClipRect()

PopClipRect(): void

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

Returns

void

---

PushTextureID()

PushTextureID(texture_id): void

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

Parameters

texture_id

ImTextureID

Returns

void

---

PopTextureID()

PopTextureID(): void

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

Returns

void

---

GetClipRectMin()

GetClipRectMin(out?): interface_ImVec2

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

Parameters

out?

interface_ImVec2 = ...

Returns

interface_ImVec2

---

GetClipRectMax()

GetClipRectMax(out?): interface_ImVec2

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

Parameters

out?

interface_ImVec2 = ...

Returns

interface_ImVec2

---

AddLine()

AddLine(a, b, col, thickness?): void

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

Parameters

a

Readonly<Bind.interface_ImVec2>

b

Readonly<Bind.interface_ImVec2>

col

number

thickness?

number = 1.0

Returns

void

---

AddRect()

AddRect(a, b, col, rounding?, rounding_corners_flags?, thickness?): void

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

Parameters

a

Readonly<Bind.interface_ImVec2>

b

Readonly<Bind.interface_ImVec2>

col

number

rounding?

number = 0.0

rounding_corners_flags?

ImDrawCornerFlags = ImDrawCornerFlags.All

thickness?

number = 1.0

Returns

void

---

AddRectFilled()

AddRectFilled(a, b, col, rounding?, rounding_corners_flags?): void

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

Parameters

a

Readonly<Bind.interface_ImVec2>

b

Readonly<Bind.interface_ImVec2>

col

number

rounding?

number = 0.0

rounding_corners_flags?

ImDrawCornerFlags = ImDrawCornerFlags.All

Returns

void

---

AddRectFilledMultiColor()

AddRectFilledMultiColor(a, b, col_upr_left, col_upr_right, col_bot_right, col_bot_left): void

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

Parameters

a

Readonly<Bind.interface_ImVec2>

b

Readonly<Bind.interface_ImVec2>

col_upr_left

number

col_upr_right

number

col_bot_right

number

col_bot_left

number

Returns

void

---

AddQuad()

AddQuad(a, b, c, d, col, thickness?): void

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

Parameters

a

Readonly<Bind.interface_ImVec2>

b

Readonly<Bind.interface_ImVec2>

c

Readonly<Bind.interface_ImVec2>

d

Readonly<Bind.interface_ImVec2>

col

number

thickness?

number = 1.0

Returns

void

---

AddQuadFilled()

AddQuadFilled(a, b, c, d, col): void

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

Parameters

a

Readonly<Bind.interface_ImVec2>

b

Readonly<Bind.interface_ImVec2>

c

Readonly<Bind.interface_ImVec2>

d

Readonly<Bind.interface_ImVec2>

col

number

Returns

void

---

AddTriangle()

AddTriangle(a, b, c, col, thickness?): void

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

Parameters

a

Readonly<Bind.interface_ImVec2>

b

Readonly<Bind.interface_ImVec2>

c

Readonly<Bind.interface_ImVec2>

col

number

thickness?

number = 1.0

Returns

void

---

AddTriangleFilled()

AddTriangleFilled(a, b, c, col): void

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

Parameters

a

Readonly<Bind.interface_ImVec2>

b

Readonly<Bind.interface_ImVec2>

c

Readonly<Bind.interface_ImVec2>

col

number

Returns

void

---

AddCircle()

AddCircle(centre, radius, col, num_segments?, thickness?): void

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

Parameters

centre

Readonly<Bind.interface_ImVec2>

radius

number

col

number

num_segments?

number = 12

thickness?

number = 1.0

Returns

void

---

AddCircleFilled()

AddCircleFilled(centre, radius, col, num_segments?): void

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

Parameters

centre

Readonly<Bind.interface_ImVec2>

radius

number

col

number

num_segments?

number = 12

Returns

void

---

AddNgon()

AddNgon(centre, radius, col, num_segments, thickness?): void

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

Parameters

centre

Readonly<Bind.interface_ImVec2>

radius

number

col

number

num_segments

number

thickness?

number = 1.0

Returns

void

---

AddNgonFilled()

AddNgonFilled(centre, radius, col, num_segments): void

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

Parameters

centre

Readonly<Bind.interface_ImVec2>

radius

number

col

number

num_segments

number

Returns

void

---

AddText()

Call Signature

AddText(pos, col, text_begin, text_end?): void

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

Parameters

pos

Readonly<Bind.interface_ImVec2>

col

number

text_begin

string

text_end?

number

Returns

void

Call Signature

AddText(font, font_size, pos, col, text_begin, text_end?, wrap_width?, cpu_fine_clip_rect?): void

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

Parameters

font

ImFont

font_size

number

pos

Readonly<Bind.interface_ImVec2>

col

number

text_begin

string

text_end?

number

wrap_width?

number

cpu_fine_clip_rect?

Readonly<interface_ImVec4>

Returns

void

---

AddPolyline()

AddPolyline(points, num_points, col, closed, thickness): void

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

Parameters

points

Readonly<interface_ImVec2>[]

num_points

number

col

number

closed

boolean

thickness

number

Returns

void

---

AddConvexPolyFilled()

AddConvexPolyFilled(points, num_points, col): void

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

Parameters

points

Readonly<interface_ImVec2>[]

num_points

number

col

number

Returns

void

---

AddBezierCubic()

AddBezierCubic(p1, p2, p3, p4, col, thickness?, num_segments?): void

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

Parameters

p1

Readonly<Bind.interface_ImVec2>

p2

Readonly<Bind.interface_ImVec2>

p3

Readonly<Bind.interface_ImVec2>

p4

Readonly<Bind.interface_ImVec2>

col

number

thickness?

number = 1.0

num_segments?

number = 0

Returns

void

---

AddBezierQuadratic()

AddBezierQuadratic(p1, p2, p3, col, thickness?, num_segments?): void

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

Parameters

p1

Readonly<Bind.interface_ImVec2>

p2

Readonly<Bind.interface_ImVec2>

p3

Readonly<Bind.interface_ImVec2>

col

number

thickness?

number = 1.0

num_segments?

number = 0

Returns

void

---

AddImage()

AddImage(user_texture_id, a, b, uv_a?, uv_b?, col?): void

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

Parameters

user_texture_id

ImTextureID

a

Readonly<Bind.interface_ImVec2>

b

Readonly<Bind.interface_ImVec2>

uv_a?

Readonly<Bind.interface_ImVec2> = ImVec2.ZERO

uv_b?

Readonly<Bind.interface_ImVec2> = ImVec2.UNIT

col?

number = 0xffffffff

Returns

void

---

AddImageQuad()

AddImageQuad(user_texture_id, a, b, c, d, uv_a?, uv_b?, uv_c?, uv_d?, col?): void

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

Parameters

user_texture_id

ImTextureID

a

Readonly<Bind.interface_ImVec2>

b

Readonly<Bind.interface_ImVec2>

c

Readonly<Bind.interface_ImVec2>

d

Readonly<Bind.interface_ImVec2>

uv_a?

Readonly<Bind.interface_ImVec2> = ImVec2.ZERO

uv_b?

Readonly<Bind.interface_ImVec2> = ImVec2.UNIT_X

uv_c?

Readonly<Bind.interface_ImVec2> = ImVec2.UNIT

uv_d?

Readonly<Bind.interface_ImVec2> = ImVec2.UNIT_Y

col?

number = 0xffffffff

Returns

void

---

AddImageRounded()

AddImageRounded(user_texture_id, a, b, uv_a, uv_b, col, rounding, rounding_corners?): void

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

Parameters

user_texture_id

ImTextureID

a

Readonly<Bind.interface_ImVec2>

b

Readonly<Bind.interface_ImVec2>

uv_a

Readonly<Bind.interface_ImVec2>

uv_b

Readonly<Bind.interface_ImVec2>

col

number

rounding

number

rounding_corners?

ImDrawCornerFlags = ImDrawCornerFlags.All

Returns

void

---

PathClear()

PathClear(): void

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

Returns

void

---

PathLineTo()

PathLineTo(pos): void

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

Parameters

pos

Readonly<Bind.interface_ImVec2>

Returns

void

---

PathLineToMergeDuplicate()

PathLineToMergeDuplicate(pos): void

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

Parameters

pos

Readonly<Bind.interface_ImVec2>

Returns

void

---

PathFillConvex()

PathFillConvex(col): void

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

Parameters

col

number

Returns

void

---

PathStroke()

PathStroke(col, closed, thickness?): void

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

Parameters

col

number

closed

boolean

thickness?

number = 1.0

Returns

void

---

PathArcTo()

PathArcTo(centre, radius, a_min, a_max, num_segments?): void

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

Parameters

centre

Readonly<Bind.interface_ImVec2>

radius

number

a_min

number

a_max

number

num_segments?

number = 10

Returns

void

---

PathArcToFast()

PathArcToFast(centre, radius, a_min_of_12, a_max_of_12): void

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

Parameters

centre

Readonly<Bind.interface_ImVec2>

radius

number

a_min_of_12

number

a_max_of_12

number

Returns

void

---

PathBezierCubicCurveTo()

PathBezierCubicCurveTo(p2, p3, p4, num_segments?): void

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

Parameters

p2

Readonly<Bind.interface_ImVec2>

p3

Readonly<Bind.interface_ImVec2>

p4

Readonly<Bind.interface_ImVec2>

num_segments?

number = 0

Returns

void

---

PathBezierQuadraticCurveTo()

PathBezierQuadraticCurveTo(p2, p3, num_segments?): void

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

Parameters

p2

Readonly<Bind.interface_ImVec2>

p3

Readonly<Bind.interface_ImVec2>

num_segments?

number = 0

Returns

void

---

PathRect()

PathRect(rect_min, rect_max, rounding?, rounding_corners_flags?): void

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

Parameters

rect_min

Readonly<Bind.interface_ImVec2>

rect_max

Readonly<Bind.interface_ImVec2>

rounding?

number = 0.0

rounding_corners_flags?

ImDrawCornerFlags = ImDrawCornerFlags.All

Returns

void

---

ChannelsSplit()

ChannelsSplit(channels_count): void

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

Parameters

channels_count

number

Returns

void

---

ChannelsMerge()

ChannelsMerge(): void

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

Returns

void

---

ChannelsSetCurrent()

ChannelsSetCurrent(channel_index): void

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

Parameters

channel_index

number

Returns

void

---

AddCallback()

AddCallback(callback, callback_data): void

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

Parameters

callback

ImDrawCallback

callback_data

any

Returns

void

---

AddDrawCmd()

AddDrawCmd(): void

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

Returns

void

---

PrimReserve()

PrimReserve(idx_count, vtx_count): void

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

Parameters

idx_count

number

vtx_count

number

Returns

void

---

PrimUnreserve()

PrimUnreserve(idx_count, vtx_count): void

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

Parameters

idx_count

number

vtx_count

number

Returns

void

---

PrimRect()

PrimRect(a, b, col): void

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

Parameters

a

Readonly<Bind.interface_ImVec2>

b

Readonly<Bind.interface_ImVec2>

col

number

Returns

void

---

PrimRectUV()

PrimRectUV(a, b, uv_a, uv_b, col): void

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

Parameters

a

Readonly<Bind.interface_ImVec2>

b

Readonly<Bind.interface_ImVec2>

uv_a

Readonly<Bind.interface_ImVec2>

uv_b

Readonly<Bind.interface_ImVec2>

col

number

Returns

void

---

PrimQuadUV()

PrimQuadUV(a, b, c, d, uv_a, uv_b, uv_c, uv_d, col): void

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

Parameters

a

Readonly<Bind.interface_ImVec2>

b

Readonly<Bind.interface_ImVec2>

c

Readonly<Bind.interface_ImVec2>

d

Readonly<Bind.interface_ImVec2>

uv_a

Readonly<Bind.interface_ImVec2>

uv_b

Readonly<Bind.interface_ImVec2>

uv_c

Readonly<Bind.interface_ImVec2>

uv_d

Readonly<Bind.interface_ImVec2>

col

number

Returns

void

---

PrimWriteVtx()

PrimWriteVtx(pos, uv, col): void

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

Parameters

pos

Readonly<Bind.interface_ImVec2>

uv

Readonly<Bind.interface_ImVec2>

col

number

Returns

void

---

PrimWriteIdx()

PrimWriteIdx(idx): void

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

Parameters

idx

number

Returns

void

---

PrimVtx()

PrimVtx(pos, uv, col): void

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

Parameters

pos

Readonly<Bind.interface_ImVec2>

uv

Readonly<Bind.interface_ImVec2>

col

number

Returns

void