imgui::ImDrawList Class Reference

Public Member Functions
function	addBezierCurve (local pos0, local cp0, local cp1, local pos1, local col, local thickness, local num_segments)
function	addCCNode (local node, local pos)
function	addCircle (local centre, local radius, local col, local num_segments, local thickness)
function	addCircleFilled (local centre, local radius, local col, local num_segments)
function	addConvexPolyFilled (local points, local col)
function	addDrawCmd ()
function	addImage (local texture, local a, local b, local uv_a, local uv_b, local col)
function	addImageQuad (local texture, local a, local b, local c, local d, local uv_a, local uv_b, local uv_c, local uv_d, local col)
function	addImageRounded (local texture, local a, local b, local uv_a, local uv_b, local col, local rounding, local rounding_corners)
function	addLine (local a, local b, local col, local thickness)
function	addNgon (local center, local radius, local col, local num_segments, local thickness)
function	addNgonFilled (local center, local radius, local col, local num_segments)
function	addPolyline (local points, local col, local closed, local thickness)
function	addQuad (local a, local b, local c, local d, local col, local thickness)
function	addQuadFilled (local a, local b, local c, local d, local col)
function	addRect (local a, local b, local col, local rounding, local rounding_corners_flags, local thickness)
function	addRectFilled (local a, local b, local col, local rounding, local rounding_corners_flags)
function	addRectFilledMultiColor (local a, local b, local col_upr_left, local col_upr_right, local col_bot_right, local col_bot_left)
function	addText (local font, local font_size, local pos, local col, local text, local wrap_width, local cpu_fine_clip_rect)
	imgui.ImDrawList More...
function	addTriangle (local a, local b, local c, local col, local thickness)
function	addTriangleFilled (local a, local b, local c, local col)
function	channelsMerge ()
function	channelsSetCurrent (local n)
function	channelsSplit (local count)
function	cloneOutput ()
function	getClipRectMax ()
function	getClipRectMin ()
function	pathArcTo (local centre, local radius, local a_min, local a_max, local num_segments)
function	pathArcToFast (local centre, local radius, local a_min_of_12, local a_max_of_12)
function	pathBezierCurveTo (local p1, local p2, local p3, local num_segments)
function	pathClear ()
function	pathFillConvex (local col)
function	pathLineTo (local pos)
function	pathLineToMergeDuplicate (local pos)
function	pathRect (local rect_min, local rect_max, local rounding, local rounding_corners_flags)
function	pathStroke (local col, local closed, local thickness)
function	popClipRect ()
function	popTextureID ()
function	primQuadUV (local a, local b, local c, local d, local uv_a, local uv_b, local uv_c, local uv_d, local col)
function	primRect (local a, local b, local col)
function	primRectUV (local a, local b, local uv_a, local uv_b, local col)
function	primReserve (local idx_count, local vtx_count)
function	primUnreserve (local idx_count, local vtx_count)
function	primVtx (local pos, local uv, local col)
function	primWriteIdx (local idx)
function	primWriteVtx (local pos, local uv, local col)
function	pushClipRect (local clip_rect_min, local clip_rect_max, local intersect_with_current_clip_rect)
function	pushClipRectFullScreen ()

Member Function Documentation

addBezierCurve()

function addBezierCurve	(	local	pos0,
		local	cp0,
		local	cp1,
		local	pos1,
		local	col,
		local	thickness,
		local	num_segments
	)

Parameters

pos0	ImVec2
cp0	ImVec2
cp1	ImVec2
pos1	ImVec2
col	number
thickness	number
num_segments	number

Returns

imgui.ImDrawList

addCCNode()

function addCCNode	(	local	node,
		local	pos
	)

Parameters

node	cc.Node
pos	ImVec2

addCircle()

function addCircle	(	local	centre,
		local	radius,
		local	col,
		local	num_segments,
		local	thickness
	)

Parameters

centre	ImVec2
radius	number
col	number
num_segments	number
thickness	number

Returns

imgui.ImDrawList

addCircleFilled()

function addCircleFilled	(	local	centre,
		local	radius,
		local	col,
		local	num_segments
	)

Parameters

centre	ImVec2
radius	number
col	number
num_segments	number

Returns

imgui.ImDrawList

addConvexPolyFilled()

function addConvexPolyFilled	(	local	points,
		local	col
	)

Note: Anti-aliased filling requires points to be in clockwise order.

Parameters

points	ImVec2[]
col	number

addDrawCmd()

function addDrawCmd

(

)

This is useful if you need to forcefully create a new draw call (to allow for dependent rendering / blending). Otherwise primitives are merged into the same draw-call as much as possible

Returns

imgui.ImDrawList

addImage()

function addImage	(	local	texture,
		local	a,
		local	b,
		local	uv_a,
		local	uv_b,
		local	col
	)

Parameters

texture	cc.Texture2D
a	ImVec2
b	ImVec2
uv_a	ImVec2 optional
uv_b	ImVec2 optional
col	number optional

重载

fun(self:imgui.ImDrawList,sp:cc.Sprite,a:ImVec2,b:ImVec2,col:number)

addImageQuad()

function addImageQuad	(	local	texture,
		local	a,
		local	b,
		local	c,
		local	d,
		local	uv_a,
		local	uv_b,
		local	uv_c,
		local	uv_d,
		local	col
	)

Parameters

texture	cc.Texture2D
a	ImVec2
b	ImVec2
c	ImVec2
d	ImVec2
uv_a	ImVec2 optional
uv_b	ImVec2 optional
uv_c	ImVec2 optional
uv_d	ImVec2 optional
col	number optional

重载

fun(self:imgui.ImDrawList,sp:cc.Sprite,a:ImVec2,b:ImVec2,c:ImVec2,d:ImVec2,col:number)

addImageRounded()

function addImageRounded	(	local	texture,
		local	a,
		local	b,
		local	uv_a,
		local	uv_b,
		local	col,
		local	rounding,
		local	rounding_corners
	)

Parameters

texture	cc.Texture2D
a	ImVec2
b	ImVec2
uv_a	ImVec2
uv_b	ImVec2
col	number
rounding	number
rounding_corners	number optional

重载

fun(self:imgui.ImDrawList,sp:cc.Sprite,a:ImVec2,b:ImVec2,col:number,rounding:number,rounding_corners:number)

addLine()

function addLine	(	local	a,
		local	b,
		local	col,
		local	thickness
	)

Parameters

a	ImVec2
b	ImVec2
col	number
thickness	number

Returns

imgui.ImDrawList

addNgon()

function addNgon	(	local	center,
		local	radius,
		local	col,
		local	num_segments,
		local	thickness
	)

Parameters

center	ImVec2
radius	number
col	number
num_segments	number
thickness	number

Returns

imgui.ImDrawList

addNgonFilled()

function addNgonFilled	(	local	center,
		local	radius,
		local	col,
		local	num_segments
	)

Parameters

center	ImVec2
radius	number
col	number
num_segments	number

Returns

imgui.ImDrawList

addPolyline()

function addPolyline	(	local	points,
		local	col,
		local	closed,
		local	thickness
	)

Parameters

points	ImVec2[]
col	number
closed	boolean
thickness	number

addQuad()

function addQuad	(	local	a,
		local	b,
		local	c,
		local	d,
		local	col,
		local	thickness
	)

Parameters

a	ImVec2
b	ImVec2
c	ImVec2
d	ImVec2
col	number
thickness	number

Returns

imgui.ImDrawList

addQuadFilled()

function addQuadFilled	(	local	a,
		local	b,
		local	c,
		local	d,
		local	col
	)

Parameters

a	ImVec2
b	ImVec2
c	ImVec2
d	ImVec2
col	number

Returns

imgui.ImDrawList

addRect()

function addRect	(	local	a,
		local	b,
		local	col,
		local	rounding,
		local	rounding_corners_flags,
		local	thickness
	)

a: upper-left, b: lower-right (== upper-left + size), rounding_corners_flags: 4-bits corresponding to which corner to round

Parameters

a	ImVec2
b	ImVec2
col	number
rounding	number
rounding_corners_flags	number
thickness	number

Returns

imgui.ImDrawList

addRectFilled()

function addRectFilled	(	local	a,
		local	b,
		local	col,
		local	rounding,
		local	rounding_corners_flags
	)

a: upper-left, b: lower-right (== upper-left + size)

Parameters

a	ImVec2
b	ImVec2
col	number
rounding	number
rounding_corners_flags	number

Returns

imgui.ImDrawList

addRectFilledMultiColor()

function addRectFilledMultiColor	(	local	a,
		local	b,
		local	col_upr_left,
		local	col_upr_right,
		local	col_bot_right,
		local	col_bot_left
	)

Parameters

a	ImVec2
b	ImVec2
col_upr_left	number
col_upr_right	number
col_bot_right	number
col_bot_left	number

Returns

imgui.ImDrawList

addText()

function addText	(	local	font,
		local	font_size,
		local	pos,
		local	col,
		local	text,
		local	wrap_width,
		local	cpu_fine_clip_rect
	)

imgui.ImDrawList

Parameters

font	imgui.ImFont
font_size	number
pos	ImVec2
col	number
text	string
wrap_width	number optional
cpu_fine_clip_rect	ImVec4 optional

重载

fun(self:imgui.ImDrawList,pos:ImVec2,col:number,text:string)

addTriangle()

function addTriangle	(	local	a,
		local	b,
		local	c,
		local	col,
		local	thickness
	)

Parameters

a	ImVec2
b	ImVec2
c	ImVec2
col	number
thickness	number

Returns

imgui.ImDrawList

addTriangleFilled()

function addTriangleFilled	(	local	a,
		local	b,
		local	c,
		local	col
	)

Parameters

a	ImVec2
b	ImVec2
c	ImVec2
col	number

Returns

imgui.ImDrawList

channelsMerge()

function channelsMerge

(

)

Returns

imgui.ImDrawList

channelsSetCurrent()

function channelsSetCurrent

(

local

n

)

Parameters

n

number

Returns

imgui.ImDrawList

channelsSplit()

function channelsSplit

(

local

count

)

Parameters

count

number

Returns

imgui.ImDrawList

cloneOutput()

function cloneOutput

(

)

Create a clone of the CmdBuffer/IdxBuffer/VtxBuffer.

Returns

imgui.ImDrawList

getClipRectMax()

function getClipRectMax

(

)

Returns

ImVec2

getClipRectMin()

function getClipRectMin

(

)

Returns

ImVec2

pathArcTo()

function pathArcTo	(	local	centre,
		local	radius,
		local	a_min,
		local	a_max,
		local	num_segments
	)

Parameters

centre	ImVec2
radius	number
a_min	number
a_max	number
num_segments	number

Returns

imgui.ImDrawList

pathArcToFast()

function pathArcToFast	(	local	centre,
		local	radius,
		local	a_min_of_12,
		local	a_max_of_12
	)

Use precomputed angles for a 12 steps circle

Parameters

centre	ImVec2
radius	number
a_min_of_12	number
a_max_of_12	number

Returns

imgui.ImDrawList

pathBezierCurveTo()

function pathBezierCurveTo	(	local	p1,
		local	p2,
		local	p3,
		local	num_segments
	)

Parameters

p1	ImVec2
p2	ImVec2
p3	ImVec2
num_segments	number

Returns

imgui.ImDrawList

pathClear()

function pathClear

(

)

Returns

imgui.ImDrawList

pathFillConvex()

function pathFillConvex

(

local

col

)

Note: Anti-aliased filling requires points to be in clockwise order.

Parameters

col

number

Returns

imgui.ImDrawList

pathLineTo()

function pathLineTo

(

local

pos

)

Parameters

pos

ImVec2

Returns

imgui.ImDrawList

pathLineToMergeDuplicate()

function pathLineToMergeDuplicate

(

local

pos

)

Parameters

pos

ImVec2

Returns

imgui.ImDrawList

pathRect()

function pathRect	(	local	rect_min,
		local	rect_max,
		local	rounding,
		local	rounding_corners_flags
	)

Parameters

rect_min	ImVec2
rect_max	ImVec2
rounding	number
rounding_corners_flags	number

Returns

imgui.ImDrawList

pathStroke()

function pathStroke	(	local	col,
		local	closed,
		local	thickness
	)

Parameters

col	number
closed	boolean
thickness	number

Returns

imgui.ImDrawList

popClipRect()

function popClipRect

(

)

Returns

imgui.ImDrawList

popTextureID()

function popTextureID

(

)

Returns

imgui.ImDrawList

primQuadUV()

function primQuadUV	(	local	a,
		local	b,
		local	c,
		local	d,
		local	uv_a,
		local	uv_b,
		local	uv_c,
		local	uv_d,
		local	col
	)

Parameters

a	ImVec2
b	ImVec2
c	ImVec2
d	ImVec2
uv_a	ImVec2
uv_b	ImVec2
uv_c	ImVec2
uv_d	ImVec2
col	number

Returns

imgui.ImDrawList

primRect()

function primRect	(	local	a,
		local	b,
		local	col
	)

Parameters

a	ImVec2
b	ImVec2
col	number

Returns

imgui.ImDrawList

primRectUV()

function primRectUV	(	local	a,
		local	b,
		local	uv_a,
		local	uv_b,
		local	col
	)

Parameters

a	ImVec2
b	ImVec2
uv_a	ImVec2
uv_b	ImVec2
col	number

Returns

imgui.ImDrawList

primReserve()

function primReserve	(	local	idx_count,
		local	vtx_count
	)

Parameters

idx_count	number
vtx_count	number

Returns

imgui.ImDrawList

primUnreserve()

function primUnreserve	(	local	idx_count,
		local	vtx_count
	)

Parameters

idx_count	number
vtx_count	number

Returns

imgui.ImDrawList

primVtx()

function primVtx	(	local	pos,
		local	uv,
		local	col
	)

Parameters

pos	ImVec2
uv	ImVec2
col	number

Returns

imgui.ImDrawList

primWriteIdx()

function primWriteIdx

(

local

idx

)

Parameters

idx

number

Returns

imgui.ImDrawList

primWriteVtx()

function primWriteVtx	(	local	pos,
		local	uv,
		local	col
	)

Parameters

pos	ImVec2
uv	ImVec2
col	number

Returns

imgui.ImDrawList

pushClipRect()

function pushClipRect	(	local	clip_rect_min,
		local	clip_rect_max,
		local	intersect_with_current_clip_rect
	)

Render-level scissoring. This is passed down to your render function but not used for CPU-side coarse clipping. Prefer using higher-level ImGui::PushClipRect() to affect logic (hit-testing and widget culling)

Parameters

clip_rect_min	ImVec2
clip_rect_max	ImVec2
intersect_with_current_clip_rect	boolean

Returns

imgui.ImDrawList

pushClipRectFullScreen()

function pushClipRectFullScreen

(

)

Returns

imgui.ImDrawList

---

The documentation for this class was generated from the following files:

• imgui/ImDrawList.lua.hpp
• imgui/ImDrawList_manual.lua.hpp