ImGuiListClipper

imguicpp.ImGuiListClipper (extern class)

Static Members

begin(self: cpp.Star, itemsCount: Int, ?itemsHeight: cpp.Float32 = -1.0): Void
Name Type Default
self cpp.Star
itemsCount Int
itemsHeight cpp.Float32 -1.0

end(self: cpp.Star): Void

Automatically called on the last call of Step() that returns false.

Name Type
self cpp.Star

step(self: cpp.Star): Bool

Call until it returns false. The DisplayStart/DisplayEnd fields will be set and you can process/draw those items.

Name Type
self cpp.Star
Returns
Bool

includeItemByIndex(self: cpp.Star, itemIndex: Int): Void
Name Type
self cpp.Star
itemIndex Int

includeItemsByIndex(self: cpp.Star, itemBegin: Int, itemEnd: Int): Void

item_end is exclusive e.g. use (42, 42+1) to make item 42 never clipped.

Name Type
self cpp.Star
itemBegin Int
itemEnd Int

seekCursorForItem(self: cpp.Star, itemIndex: Int): Void
Name Type
self cpp.Star
itemIndex Int

Instance Members

displayStart: Int

First item to display, updated by each call to Step()


displayEnd: Int

End of items to display (exclusive)


userIndex: Int

Helper storage for user convenience/code. Optional, and otherwise unused if you don't use it.


itemsCount: Int

[Internal] Number of items


itemsHeight: cpp.Float32

[Internal] Height of item after a first step and item submission can calculate it


flags: Int

[Internal] Flags, currently not yet well exposed.


startPosY: Float

[Internal] Cursor position at the time of Begin() or after table frozen rows are all processed


startSeekOffsetY: Float

[Internal] Account for frozen rows in a table and initial loss of precision in very large windows.


[Internal] Parent UI context


[Internal] Internal data

Metadata

Name Parameters
:structAccess -
:include "linc_imgui.h"