imgui

package module

v4.5.1-0...-3c2ec40 Latest Latest Go to latest Published: Jul 20, 2022 License: BSD-3-Clause Imports: 9 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Edgaru089/imgui-go

Links

Open Source Insights

README ¶

For information on the original imgui-go go here

ImPlot for Go

This library is a Go wrapper for ImPlot, merged into a fork of imgui-go which wraps Dear ImGui.

It currently targets ImPlot v0.13 with imgui-go v4.5.0 (which wraps Dear ImGui v1.85).

It has similar goals compared to inkyblackness's imgui-go wrapper:

hand-crafted
documented
feature-complete
versioned
with examples (living in another repo here)

Screenshot

ImPlot-go is merged with a fork of ImGui-go because of the way Go links C/C++ libraries. Basically, Go/GC links every package into a standalone .so library, before linking them staticly to somehow get the final executable. The symbols are somehow again deduplicated (?), and with system libraries this is perfectly fine.

But, because of that, for ImPlot to reach into ImGui, they must be built together.

I just rm -rfed what I've been working on for a whole day. Don't ever do that. - 2022/02/19

This is very much work in progress, here is a list from the Table of Contents of implot.h:

Contexts
Begin/End Plot
Begin/End Subplot
Setup
SetNext
Plot Items
Plot Tools
Plot Utils
Legend Utils
Drag and Drop
Styling (& SetNextXXXStyle)
Colormaps
Input Mapping
Miscellaneous

Documentation ¶

Overview ¶

Package imgui contains all the functions to create an immediate mode graphical user interface based on Dear ImGui.

Setup ¶

For integration, please refer to the dedicated repository https://github.com/inkyblackness/imgui-go-examples , which contains ported examples of the C++ version, available to Go.

Conventions ¶

The exported functions and constants are named closely to that of the wrapped library. If a function has optional parameters, it will be available in two versions: A verbose one, which has all optional parameters listed, and a terse one, with only the mandatory parameters in its signature. The verbose variant will have the suffix V in its name. For example, there are

func Button(id string) bool

and

func ButtonV(id string, size Vec2) bool

The terse variant will list the default parameters it uses to call the verbose variant.

There are several types which are based on uintptr. These are references to the wrapped instances in C++. You will always get to such a reference via some function - you never "instantiate" such an instance on your own.

Index ¶

Constants
Variables
func AcceptDragDropPayload(dataType string, flags DragDropFlags) []byte
func AlignTextToFramePadding()
func Begin(id string) bool
func BeginChild(id string) bool
func BeginChildV(id string, size Vec2, border bool, flags WindowFlags) bool
func BeginCombo(label, previewValue string) bool
func BeginComboV(label, previewValue string, flags ComboFlags) bool
func BeginDragDropSource(flags DragDropFlags) bool
func BeginDragDropTarget() bool
func BeginGroup()
func BeginListBox(label string) bool
func BeginListBoxV(label string, size Vec2) bool
func BeginMainMenuBar() bool
func BeginMenu(label string) bool
func BeginMenuBar() bool
func BeginMenuV(label string, enabled bool) bool
func BeginPlot(title string) bool
func BeginPlotV(title string, size Vec2, flags PlotFlags) bool
func BeginPopup(name string) bool
func BeginPopupContextItem() bool
func BeginPopupContextItemV(id string, flags PopupFlags) bool
func BeginPopupContextVoid() bool
func BeginPopupContextVoidV(id string, flags PopupFlags) bool
func BeginPopupContextWindow() bool
func BeginPopupContextWindowV(id string, flags PopupFlags) bool
func BeginPopupModal(name string) bool
func BeginPopupModalV(name string, open *bool, flags WindowFlags) bool
func BeginPopupV(name string, flags WindowFlags) bool
func BeginSubplots(title string, rows, cols int) bool
func BeginSubplotsV(title string, rows, cols int, size Vec2, flags SubplotFlags, ...) bool
func BeginTabBar(strID string) bool
func BeginTabBarV(strID string, flags TabBarFlags) bool
func BeginTabItem(label string) bool
func BeginTabItemV(label string, open *bool, flags TabItemFlags) bool
func BeginTable(id string, columnsCount int) bool
func BeginTableV(id string, columnsCount int, flags TableFlags, outerSize Vec2, ...) bool
func BeginTooltip()
func BeginV(id string, open *bool, flags WindowFlags) bool
func Bullet()
func Button(id string) bool
func ButtonV(id string, size Vec2) bool
func CalcItemWidth() float32
func Checkbox(id string, selected *bool) bool
func ClearActiveID()
func CloseCurrentPopup()
func CollapsingHeader(label string) bool
func CollapsingHeaderV(label string, flags TreeNodeFlags) bool
func ColorButton(id string, col Vec4, flags ColorEditFlags, size Vec2) bool
func ColorEdit3(label string, col *[3]float32) bool
func ColorEdit3V(label string, col *[3]float32, flags ColorEditFlags) bool
func ColorEdit4(label string, col *[4]float32) bool
func ColorEdit4V(label string, col *[4]float32, flags ColorEditFlags) bool
func ColorPicker3(label string, col *[3]float32) bool
func ColorPicker3V(label string, col *[3]float32, flags ColorPickerFlags) bool
func ColorPicker4(label string, col *[4]float32) bool
func ColorPicker4V(label string, col *[4]float32, flags ColorPickerFlags) bool
func ColumnIndex() int
func ColumnOffset() float32
func ColumnOffsetV(index int) float32
func ColumnWidth() int
func ColumnWidthV(index int) int
func Columns()
func ColumnsCount() int
func ColumnsV(count int, label string, border bool)
func Combo(id string, value *int32, list []string) bool
func ComboV(id string, value *int32, list []string, heightInItems int) bool
func CursorPosX() float32
func CursorPosY() float32
func DragFloat(label string, value *float32) bool
func DragFloat2(label string, value *[2]float32) bool
func DragFloat2V(label string, values *[2]float32, speed, min, max float32, format string, ...) bool
func DragFloat3(label string, value *[3]float32) bool
func DragFloat3V(label string, values *[3]float32, speed, min, max float32, format string, ...) bool
func DragFloat4(label string, value *[4]float32) bool
func DragFloat4V(label string, values *[4]float32, speed, min, max float32, format string, ...) bool
func DragFloatRange2(label string, currentMin *float32, currentMax *float32) bool
func DragFloatRange2V(label string, currentMin *float32, currentMax *float32, speed float32, ...) bool
func DragFloatV(label string, value *float32, speed, min, max float32, format string, ...) bool
func DragInt(label string, value *int32) bool
func DragInt2(label string, value *[2]int32) bool
func DragInt2V(label string, values *[2]int32, speed float32, min, max int32, format string, ...) bool
func DragInt3(label string, value *[3]int32) bool
func DragInt3V(label string, values *[3]int32, speed float32, min, max int32, format string, ...) bool
func DragInt4(label string, value *[4]int32) bool
func DragInt4V(label string, values *[4]int32, speed float32, min, max int32, format string, ...) bool
func DragIntRange2(label string, currentMin *int32, currentMax *int32) bool
func DragIntRange2V(label string, currentMin *int32, currentMax *int32, speed float32, min int, ...) bool
func DragIntV(label string, value *int32, speed float32, min, max int32, format string, ...) bool
func Dummy(size Vec2)
func End()
func EndChild()
func EndCombo()
func EndDragDropSource()
func EndDragDropTarget()
func EndFrame()
func EndGroup()
func EndListBox()
func EndMainMenuBar()
func EndMenu()
func EndMenuBar()
func EndPlot()
func EndPopup()
func EndSubplots()
func EndTabBar()
func EndTabItem()
func EndTable()
func EndTooltip()
func FontSize() float32
func FrameHeight() float32
func FrameHeightWithSpacing() float32
func GetMarkerName(id Marker) string
func GetPlotStyleColorName(id PlotStyleCol) string
func Image(id TextureID, size Vec2)
func ImageButton(id TextureID, size Vec2) bool
func ImageButtonV(id TextureID, size Vec2, uv0, uv1 Vec2, framePadding int, bgCol Vec4, ...) bool
func ImageV(id TextureID, size Vec2, uv0, uv1 Vec2, tintCol, borderCol Vec4)
func Indent()
func IndentV(indentW float32)
func IndexBufferLayout() (entrySize int)
func InputInt(label string, value *int32) bool
func InputIntV(label string, value *int32, step int, stepFast int, flags InputTextFlags) bool
func InputText(label string, text *string) bool
func InputTextMultiline(label string, text *string) bool
func InputTextMultilineV(label string, text *string, size Vec2, flags InputTextFlags, ...) bool
func InputTextV(label string, text *string, flags InputTextFlags, cb InputTextCallback) bool
func InputTextWithHint(label string, hint string, text *string) bool
func InputTextWithHintV(label string, hint string, text *string, flags InputTextFlags, ...) bool
func InvisibleButton(id string, size Vec2) bool
func InvisibleButtonV(id string, size Vec2, flags ButtonFlags) bool
func IsAnyItemActive() bool
func IsAnyItemFocused() bool
func IsAnyMouseDown() bool
func IsItemActivated() bool
func IsItemActive() bool
func IsItemClicked() bool
func IsItemDeactivated() bool
func IsItemDeactivatedAfterEdit() bool
func IsItemEdited() bool
func IsItemFocused() bool
func IsItemHovered() bool
func IsItemHoveredV(flags HoveredFlags) bool
func IsItemToggledOpen() bool
func IsItemVisible() bool
func IsKeyDown(key int) bool
func IsKeyPressed(key int) bool
func IsKeyPressedV(key int, repeat bool) bool
func IsKeyReleased(key int) bool
func IsMouseClicked(button int) bool
func IsMouseClickedV(button int, repeat bool) bool
func IsMouseDoubleClicked(button int) bool
func IsMouseDown(button int) bool
func IsMouseDragging(button int, threshold float64) bool
func IsMouseReleased(button int) bool
func IsPopupOpen(id string) bool
func IsPopupOpenV(id string, flags PopupFlags) bool
func IsWindowAppearing() bool
func IsWindowCollapsed() bool
func IsWindowFocused() bool
func IsWindowFocusedV(flags FocusedFlags) bool
func IsWindowHovered() bool
func IsWindowHoveredV(flags HoveredFlags) bool
func LabelText(label, text string)
func LabelTextf(label, format string, v ...interface{})
func ListBox(label string, currentItem *int32, items []string) bool
func ListBoxV(label string, currentItem *int32, items []string, heightItems int) bool
func LoadIniSettingsFromDisk(fileName string)
func LoadIniSettingsFromMemory(data string)
func MenuItem(label string) bool
func MenuItemV(label string, shortcut string, selected bool, enabled bool) bool
func NewFrame()
func NextColumn()
func OpenPopup(id string)
func OpenPopupOnItemClick()
func OpenPopupOnItemClickV(id string, flags PopupFlags)
func OpenPopupV(id string, flags PopupFlags)
func PlotBarGroups(itemLabels []string, values [][]float64, groupWidth, x0 float64, ...)
func PlotBarGroupsH(itemLabels []string, values [][]float64, groupWidth, y0 float64, ...)
func PlotBars(label string, vs interface{})
func PlotBarsG(label string, getter DataGetter, userData interface{}, count int, ...)
func PlotBarsH(label string, vs interface{})
func PlotBarsHG(label string, getter DataGetter, userData interface{}, count int, ...)
func PlotBarsHP(label string, ps []Point, barHeight float64)
func PlotBarsHV(label string, vs interface{}, barHeight, y0 float64)
func PlotBarsHXY(label string, vx, vy interface{}, barHeight float64)
func PlotBarsP(label string, ps []Point, barWidth float64)
func PlotBarsV(label string, vs interface{}, barWidth, x0 float64)
func PlotBarsXY(label string, vx, vy interface{}, barWidth float64)
func PlotHistogram(label string, values []float32)
func PlotHistogramV(label string, values []float32, valuesOffset int, overlayText string, ...)
func PlotLine(label string, values interface{})
func PlotLineG(label string, getter DataGetter, userData interface{}, count int)
func PlotLineP(label string, points []Point)
func PlotLineV(label string, values interface{}, xscale, x0 float64)
func PlotLineXY(label string, xs, ys interface{})
func PlotLines(label string, values []float32)
func PlotLinesV(label string, values []float32, valuesOffset int, overlayText string, ...)
func PlotScatter(label string, values interface{})
func PlotScatterG(label string, getter DataGetter, userData interface{}, count int)
func PlotScatterP(label string, points []Point)
func PlotScatterV(label string, values interface{}, xscale, x0 float64)
func PlotScatterXY(label string, xs, ys interface{})
func PlotShadedLines(label string, vs0, vs1 interface{})
func PlotShadedLinesG(label string, get1 DataGetter, data1 interface{}, get2 DataGetter, ...)
func PlotShadedLinesV(label string, vs0, vs1 interface{}, xscale, x0 float64)
func PlotShadedLinesXY(label string, xs, ys1, ys2 interface{})
func PlotShadedRef(label string, values interface{})
func PlotShadedRefG(label string, getter DataGetter, userData interface{}, count int, yref float64)
func PlotShadedRefP(label string, points []Point, yref float64)
func PlotShadedRefV(label string, values interface{}, yref, xscale, x0 float64)
func PlotShadedRefXY(label string, xs, ys interface{}, yref float64)
func PlotStairs(label string, values interface{})
func PlotStairsG(label string, getter DataGetter, userData interface{}, count int)
func PlotStairsP(label string, points []Point)
func PlotStairsV(label string, values interface{}, xscale, x0 float64)
func PlotStairsXY(label string, xs, ys interface{})
func PlotStyleColorsAuto()
func PlotStyleColorsClassic()
func PlotStyleColorsDark()
func PlotStyleColorsLight()
func PlotVersion() string
func PopAllowKeyboardFocus()
func PopButtonRepeat()
func PopFont()
func PopID()
func PopItemFlag()
func PopItemWidth()
func PopPlotStyleColor()
func PopPlotStyleColorV(count int)
func PopPlotStyleVar()
func PopPlotStyleVarV(count int)
func PopStyleColor()
func PopStyleColorV(count int)
func PopStyleVar()
func PopStyleVarV(count int)
func PopTextWrapPos()
func ProgressBar(fraction float32)
func ProgressBarV(fraction float32, size Vec2, overlay string)
func PushAllowKeyboardFocus(allow bool)
func PushButtonRepeat(repeat bool)
func PushFont(font Font)
func PushID(id string)
func PushIDInt(id int)
func PushItemFlag(options ItemFlags, enabled bool)
func PushItemWidth(width float32)
func PushPlotStyleColor(id PlotStyleCol, color Vec4)
func PushPlotStyleVar(v PlotStyleVar, val interface{})
func PushPlotStyleVarFloat(v PlotStyleVar, val float32)
func PushPlotStyleVarInt(v PlotStyleVar, val int)
func PushPlotStyleVarVec2(v PlotStyleVar, val Vec2)
func PushStyleColor(id StyleColorID, color Vec4)
func PushStyleVarFloat(id StyleVarID, value float32)
func PushStyleVarVec2(id StyleVarID, value Vec2)
func PushTextWrapPos()
func PushTextWrapPosV(wrapPosX float32)
func RadioButton(id string, active bool) bool
func RadioButtonInt(id string, v *int, button int) bool
func Render()
func ResetMouseDragDelta(button int)
func SameLine()
func SameLineV(posX float32, spacingW float32)
func SaveIniSettingsToDisk(fileName string)
func SaveIniSettingsToMemory() string
func ScrollMaxX() float32
func ScrollMaxY() float32
func ScrollX() float32
func ScrollY() float32
func Selectable(label string) bool
func SelectableV(label string, selected bool, flags SelectableFlags, size Vec2) bool
func Separator()
func SetAssertHandler(handler AssertHandler)
func SetColumnOffset(index int, offsetX float32)
func SetColumnWidth(index int, width float32)
func SetCursorPos(localPos Vec2)
func SetCursorScreenPos(absPos Vec2)
func SetDragDropPayload(dataType string, data []byte, cond Condition) bool
func SetItemAllowOverlap()
func SetItemDefaultFocus()
func SetKeyboardFocusHere()
func SetKeyboardFocusHereV(offset int)
func SetMouseCursor(cursor MouseCursorID)
func SetNextErrorBarStyle(color Vec4, size, weight float32)
func SetNextFillStyle(color Vec4, alpha float32)
func SetNextItemOpen(open bool, cond Condition)
func SetNextItemWidth(width float32)
func SetNextLineStyle(color Vec4, weight float32)
func SetNextMarkerStyle(marker Marker, size float32, fillColor Vec4, outlineWeight float32, ...)
func SetNextWindowBgAlpha(value float32)
func SetNextWindowCollapsed(collapsed bool, cond Condition)
func SetNextWindowContentSize(size Vec2)
func SetNextWindowFocus()
func SetNextWindowPos(pos Vec2)
func SetNextWindowPosV(pos Vec2, cond Condition, pivot Vec2)
func SetNextWindowSize(size Vec2)
func SetNextWindowSizeConstraints(sizeMin Vec2, sizeMax Vec2)
func SetNextWindowSizeV(size Vec2, cond Condition)
func SetScrollHereX(ratio float32)
func SetScrollHereY(ratio float32)
func SetScrollX(scrollX float32)
func SetScrollY(scrollY float32)
func SetTabItemClosed(tabOrDockedWindowLabel string)
func SetTooltip(text string)
func SetTooltipf(format string, v ...interface{})
func SetupAxes(xlabel, ylabel string, xflags, yflags AxisFlags)
func SetupAxesLimits(xmin, xmax, ymin, ymax float64, cond Cond)
func SetupAxis(axis Axis, label string, flags AxisFlags)
func SetupAxisFormat(axis Axis, fmt string)
func SetupAxisFormatCallback(axis Axis, formatter Formatter, userData interface{})
func SetupAxisLimits(axis Axis, vmin, vmax float64, cond Cond)
func SetupAxisTickRange(axis Axis, vmin, vmax float64, n int, labels []string, keepDefaults bool)
func SetupAxisTickValues(axis Axis, values []float64, labels []string, keepDefaults bool)
func SetupFinish()
func SetupLegend(location Location, flags LegendFlags)
func SetupMouseText(location Location, flags MouseTextFlags)
func ShowDemoWindow(open *bool)
func ShowPlotDemoWindow(open *bool)
func ShowUserGuide()
func SliderFloat(label string, value *float32, min, max float32) bool
func SliderFloat2(label string, values *[2]float32, min, max float32) bool
func SliderFloat2V(label string, values *[2]float32, min, max float32, format string, ...) bool
func SliderFloat3(label string, values *[3]float32, min, max float32) bool
func SliderFloat3V(label string, values *[3]float32, min, max float32, format string, ...) bool
func SliderFloat4(label string, values *[4]float32, min, max float32) bool
func SliderFloat4V(label string, values *[4]float32, min, max float32, format string, ...) bool
func SliderFloatV(label string, value *float32, min, max float32, format string, ...) bool
func SliderInt(label string, value *int32, min, max int32) bool
func SliderInt2(label string, values *[2]int32, min, max int) bool
func SliderInt2V(label string, values *[2]int32, min, max int, format string, flags SliderFlags) bool
func SliderInt3(label string, values *[3]int32, min, max int) bool
func SliderInt3V(label string, values *[3]int32, min, max int, format string, flags SliderFlags) bool
func SliderInt4(label string, values *[4]int32, min, max int) bool
func SliderInt4V(label string, values *[4]int32, min, max int, format string, flags SliderFlags) bool
func SliderIntV(label string, value *int32, min, max int32, format string, flags SliderFlags) bool
func Spacing()
func StyleColorsClassic()
func StyleColorsDark()
func StyleColorsLight()
func TabItemButton(label string) bool
func TabItemButtonV(label string, flags TabItemFlags) bool
func TableGetColumnCount() int
func TableGetColumnIndex() int
func TableGetColumnName() string
func TableGetColumnNameV(columnN int) string
func TableGetRowIndex() int
func TableHeader(label string)
func TableHeadersRow()
func TableNextColumn() bool
func TableNextRow()
func TableNextRowV(flags TableRowFlags, minRowHeight float32)
func TableSetBgColor(target TableBgTarget, color Vec4)
func TableSetBgColorV(target TableBgTarget, color Vec4, columnN int)
func TableSetColumnIndex(columnN int) bool
func TableSetupColumn(label string)
func TableSetupColumnV(label string, flags TableColumnFlags, initWidthOrHeight float32, userID uint)
func TableSetupScrollFreeze(cols int, rows int)
func Text(text string)
func TextLineHeight() float32
func TextLineHeightWithSpacing() float32
func Textf(format string, v ...interface{})
func Time() float64
func TreeNode(label string) bool
func TreeNodeToLabelSpacing() float32
func TreeNodeV(label string, flags TreeNodeFlags) bool
func TreeNodef(format string, v ...interface{}) bool
func TreePop()
func Unindent()
func UnindentV(indentW float32)
func VSliderFloat(label string, size Vec2, value *float32, min, max float32) bool
func VSliderFloatV(label string, size Vec2, value *float32, min, max float32, format string, ...) bool
func VSliderInt(label string, size Vec2, value *int32, min, max int32) bool
func VSliderIntV(label string, size Vec2, value *int32, min, max int32, format string, ...) bool
func Version() string
func VertexBufferLayout() (entrySize int, posOffset int, uvOffset int, colOffset int)
func WindowContentRegionWidth() float32
func WindowHeight() float32
func WindowWidth() float32
type AllocatedGlyphRanges
- func (ranges *AllocatedGlyphRanges) Free()
type Alpha8Image
type AssertHandler
type AssertionError
- func (err AssertionError) Error() string
type Axis
type AxisFlags
type BackendFlags
type BarGroupsFlags
type Bin
type ButtonFlags
type Clipboard
type ColorEditFlags
type ColorPickerFlags
type Colormap
type ComboFlags
type Cond
type Condition
type ConfigFlags
type Context
- func CreateContext(fontAtlas *FontAtlas) *Context
- func CurrentContext() (*Context, error)
- func (context *Context) Destroy()
- func (context Context) SetCurrent() error
type DataGetter
type Dir
type DragDropFlags
type DragToolFlags
type DrawCommand
- func (cmd DrawCommand) CallUserCallback(list DrawList)
- func (cmd DrawCommand) ClipRect() (rect Vec4)
- func (cmd DrawCommand) ElementCount() int
- func (cmd DrawCommand) HasUserCallback() bool
- func (cmd DrawCommand) IndexOffset() int
- func (cmd DrawCommand) TextureID() TextureID
- func (cmd DrawCommand) VertexOffset() int
type DrawCornerFlags
type DrawData
- func RenderedDrawData() DrawData
- func (data DrawData) CommandLists() []DrawList
- func (data DrawData) DisplayPos() Vec2
- func (data DrawData) DisplaySize() Vec2
- func (data DrawData) FrameBufferScale() Vec2
- func (data DrawData) ScaleClipRects(scale Vec2)
- func (data DrawData) Valid() bool
type DrawFlags
type DrawList
- func BackgroundDrawList() DrawList
- func ForegroundDrawList() DrawList
- func WindowDrawList() DrawList
- func (list DrawList) AddCircle(center Vec2, radius float32, col PackedColor)
- func (list DrawList) AddCircleFilled(center Vec2, radius float32, col PackedColor)
- func (list DrawList) AddCircleFilledV(center Vec2, radius float32, col PackedColor, numSegments int)
- func (list DrawList) AddCircleV(center Vec2, radius float32, col PackedColor, numSegments int, ...)
- func (list DrawList) AddImage(textureID TextureID, posMin Vec2, posMax Vec2)
- func (list DrawList) AddImageV(textureID TextureID, posMin Vec2, posMax Vec2, uvMin Vec2, uvMax Vec2, ...)
- func (list DrawList) AddLine(p1 Vec2, p2 Vec2, col PackedColor)
- func (list DrawList) AddLineV(p1 Vec2, p2 Vec2, col PackedColor, thickness float32)
- func (list DrawList) AddRect(min Vec2, max Vec2, col PackedColor)
- func (list DrawList) AddRectFilled(min Vec2, max Vec2, col PackedColor)
- func (list DrawList) AddRectFilledMultiColor(min Vec2, max Vec2, ...)
- func (list DrawList) AddRectFilledV(min Vec2, max Vec2, col PackedColor, rounding float32, flags DrawFlags)
- func (list DrawList) AddRectV(min Vec2, max Vec2, col PackedColor, rounding float32, flags DrawFlags, ...)
- func (list DrawList) AddText(pos Vec2, col PackedColor, text string)
- func (list DrawList) AddTriangle(p1 Vec2, p2 Vec2, p3 Vec2, col PackedColor)
- func (list DrawList) AddTriangleFilled(p1 Vec2, p2 Vec2, p3 Vec2, col PackedColor)
- func (list DrawList) AddTriangleV(p1 Vec2, p2 Vec2, p3 Vec2, col PackedColor, thickness float32)
- func (list DrawList) Commands() []DrawCommand
- func (list DrawList) IndexBuffer() (unsafe.Pointer, int)
- func (list DrawList) PopClipRect()
- func (list DrawList) PushClipRect(min, max Vec2)
- func (list DrawList) PushClipRectV(min, max Vec2, intersectWithCurrentClipRect bool)
- func (list DrawList) VertexBuffer() (unsafe.Pointer, int)
type FocusedFlags
type Font
type FontAtlas
- func (atlas FontAtlas) AddFontDefault() Font
- func (atlas FontAtlas) AddFontDefaultV(cfg FontConfig) Font
- func (atlas FontAtlas) AddFontFromFileTTF(filename string, sizePixels float32) Font
- func (atlas FontAtlas) AddFontFromFileTTFV(filename string, sizePixels float32, config FontConfig, glyphRange GlyphRanges) Font
- func (atlas FontAtlas) AddFontFromMemoryTTF(fontData []byte, sizePixels float32) Font
- func (atlas FontAtlas) AddFontFromMemoryTTFV(fontData []byte, sizePixels float32, config FontConfig, glyphRange GlyphRanges) Font
- func (atlas FontAtlas) Build() bool
- func (atlas FontAtlas) FontBuilderFlags() uint
- func (atlas FontAtlas) GlyphRangesChineseFull() GlyphRanges
- func (atlas FontAtlas) GlyphRangesChineseSimplifiedCommon() GlyphRanges
- func (atlas FontAtlas) GlyphRangesCyrillic() GlyphRanges
- func (atlas FontAtlas) GlyphRangesDefault() GlyphRanges
- func (atlas FontAtlas) GlyphRangesJapanese() GlyphRanges
- func (atlas FontAtlas) GlyphRangesKorean() GlyphRanges
- func (atlas FontAtlas) GlyphRangesThai() GlyphRanges
- func (atlas FontAtlas) SetFontBuilderFlags(flags uint)
- func (atlas FontAtlas) SetTexDesiredWidth(value int)
- func (atlas FontAtlas) SetTextureID(id TextureID)
- func (atlas FontAtlas) TextureDataAlpha8() *Alpha8Image
- func (atlas FontAtlas) TextureDataRGBA32() *RGBA32Image
type FontConfig
- func NewFontConfig() FontConfig
- func (config *FontConfig) Delete()
- func (config FontConfig) FontBuilderFlags() uint
- func (config FontConfig) SetFontBuilderFlags(flags uint)
- func (config FontConfig) SetGlyphMaxAdvanceX(value float32)
- func (config FontConfig) SetGlyphMinAdvanceX(value float32)
- func (config FontConfig) SetGlyphOffsetX(value float32)
- func (config FontConfig) SetGlyphOffsetY(value float32)
- func (config FontConfig) SetMergeMode(value bool)
- func (config FontConfig) SetName(name string)
- func (config FontConfig) SetOversampleH(value int)
- func (config FontConfig) SetOversampleV(value int)
- func (config FontConfig) SetPixelSnapH(value bool)
- func (config FontConfig) SetSize(sizePixels float32)
type Formatter
type GlyphRanges
type GlyphRangesBuilder
- func (builder *GlyphRangesBuilder) Add(from, to rune)
- func (builder *GlyphRangesBuilder) AddExisting(ranges ...GlyphRanges)
- func (builder *GlyphRangesBuilder) Build() AllocatedGlyphRanges
type HoveredFlags
type IO
- func CurrentIO() IO
- func (io IO) AddInputCharacters(chars string)
- func (io IO) AddMouseWheelDelta(horizontal, vertical float32)
- func (io IO) DisplayFrameBufferScale() Vec2
- func (io IO) Fonts() FontAtlas
- func (io IO) Framerate() float32
- func (io IO) GetBackendFlags() BackendFlags
- func (io IO) KeyAlt(leftAlt int, rightAlt int)
- func (io IO) KeyAltPressed() bool
- func (io IO) KeyCtrl(leftCtrl int, rightCtrl int)
- func (io IO) KeyCtrlPressed() bool
- func (io IO) KeyMap(imguiKey int, nativeKey int)
- func (io IO) KeyPress(key int)
- func (io IO) KeyRelease(key int)
- func (io IO) KeyShift(leftShift int, rightShift int)
- func (io IO) KeyShiftPressed() bool
- func (io IO) KeySuper(leftSuper int, rightSuper int)
- func (io IO) KeySuperPressed() bool
- func (io IO) MetricsActiveAllocations() int
- func (io IO) MetricsActiveWindows() int
- func (io IO) MetricsRenderIndices() int
- func (io IO) MetricsRenderVertices() int
- func (io IO) MetricsRenderWindows() int
- func (io IO) MouseDelta() Vec2
- func (io IO) MousePosition() Vec2
- func (io IO) MouseWheel() (float32, float32)
- func (io IO) SetBackendFlags(flags BackendFlags)
- func (io IO) SetClipboard(board Clipboard)
- func (io IO) SetConfigFlags(flags ConfigFlags)
- func (io IO) SetDeltaTime(value float32)
- func (io IO) SetDisplayFrameBufferScale(value Vec2)
- func (io IO) SetDisplaySize(value Vec2)
- func (io IO) SetFontGlobalScale(value float32)
- func (io IO) SetIniFilename(value string)
- func (io IO) SetMouseButtonDown(index int, down bool)
- func (io IO) SetMouseDrawCursor(show bool)
- func (io IO) SetMousePosition(value Vec2)
- func (io IO) WantCaptureKeyboard() bool
- func (io IO) WantCaptureMouse() bool
- func (io IO) WantCaptureMouseUnlessPopupClose() bool
- func (io IO) WantTextInput() bool
type InputTextCallback
type InputTextCallbackData
- func (data InputTextCallbackData) Buffer() []byte
- func (data InputTextCallbackData) CursorPos() int
- func (data InputTextCallbackData) DeleteBytes(offset, count int)
- func (data InputTextCallbackData) EventChar() rune
- func (data InputTextCallbackData) EventFlag() InputTextFlags
- func (data InputTextCallbackData) EventKey() int
- func (data InputTextCallbackData) Flags() InputTextFlags
- func (data InputTextCallbackData) InsertBytes(offset int, bytes []byte)
- func (data InputTextCallbackData) MarkBufferModified()
- func (data InputTextCallbackData) SelectionEnd() int
- func (data InputTextCallbackData) SelectionStart() int
- func (data InputTextCallbackData) SetCursorPos(value int)
- func (data InputTextCallbackData) SetEventChar(value rune)
- func (data InputTextCallbackData) SetSelectionEnd(value int)
- func (data InputTextCallbackData) SetSelectionStart(value int)
type InputTextFlags
type ItemFlags
type LegendFlags
type ListClipper
- func (clipper *ListClipper) Begin(itemsCount int)
- func (clipper *ListClipper) BeginV(itemsCount int, itemsHeight float32)
- func (clipper *ListClipper) End()
- func (clipper *ListClipper) Step() bool
type Location
type Marker
type MouseCursorID
- func MouseCursor() MouseCursorID
type MouseTextFlags
type PackedColor
- func Packed(c color.Color) PackedColor
- func PackedColorFromVec4(vec Vec4) PackedColor
- func (clr PackedColor) RGBA() (r, g, b, a uint32)
type PlotFlags
type PlotStyle
- func CurrentPlotStyle() PlotStyle
- func (s PlotStyle) PlotColor(color PlotStyleCol) Vec4
- func (s PlotStyle) SetColor(color PlotStyleCol, to Vec4)
- func (s PlotStyle) SetVar(v PlotStyleVar, to interface{})
- func (s PlotStyle) SetVarFloat(v PlotStyleVar, to float32)
- func (s PlotStyle) SetVarInt(v PlotStyleVar, to int)
- func (s PlotStyle) SetVarVec2(v PlotStyleVar, to Vec2)
- func (s PlotStyle) Var(v PlotStyleVar) interface{}
- func (s PlotStyle) VarFloat(v PlotStyleVar) float32
- func (s PlotStyle) VarInt(v PlotStyleVar) int
- func (s PlotStyle) VarVec2(v PlotStyleVar) Vec2
type PlotStyleCol
type PlotStyleVar
type Point
- func DataGet(getter DataGetter, userData interface{}, count int) (ps []Point)
type PopupFlags
type RGBA32Image
type Range
- func (r Range) Clamp(value float64) float64
- func (r Range) Contains(value float64) bool
- func (r Range) Size() float64
type Rect
- func RectFromAABB(xMin, xMax, yMin, yMax float64) Rect
- func (r Rect) Clamp(p Point) Point
- func (r Rect) Contains(p Point) bool
- func (r Rect) Max() Point
- func (r Rect) Min() Point
- func (r Rect) Size() Point
type SelectableFlags
type SliderFlags
type SortDirection
type Style
- func CurrentStyle() Style
- func (style Style) Alpha() float32
- func (style Style) AntiAliasedFill() bool
- func (style Style) AntiAliasedLines() bool
- func (style Style) AntiAliasedLinesUseTex() bool
- func (style Style) ButtonTextAlign() Vec2
- func (style Style) CellPadding() Vec2
- func (style Style) ChildBorderSize() float32
- func (style Style) ChildRounding() float32
- func (style Style) CircleTessellationMaxError() float32
- func (style Style) Color(id StyleColorID) Vec4
- func (style Style) ColorButtonPosition() Dir
- func (style Style) ColumnsMinSpacing() float32
- func (style Style) CurveTessellationTol() float32
- func (style Style) DisabledAlpha() float32
- func (style Style) DisplaySafeAreaPadding() Vec2
- func (style Style) DisplayWindowPadding() Vec2
- func (style Style) FrameBorderSize() float32
- func (style Style) FramePadding() Vec2
- func (style Style) FrameRounding() float32
- func (style Style) GrabMinSize() float32
- func (style Style) GrabRounding() float32
- func (style Style) IndentSpacing() float32
- func (style Style) ItemInnerSpacing() Vec2
- func (style Style) ItemSpacing() Vec2
- func (style Style) LogSliderDeadzone() float32
- func (style Style) MouseCursorScale() float32
- func (style Style) PopupBorderSize() float32
- func (style Style) PopupRounding() float32
- func (style Style) ScaleAllSizes(scale float32)
- func (style Style) ScrollbarRounding() float32
- func (style Style) ScrollbarSize() float32
- func (style Style) SelectableTextAlign() Vec2
- func (style Style) SetAlpha(v float32)
- func (style Style) SetAntiAliasedFill(value bool)
- func (style Style) SetAntiAliasedLines(value bool)
- func (style Style) SetAntiAliasedLinesUseTex(value bool)
- func (style Style) SetButtonTextAlign(value Vec2)
- func (style Style) SetCellPadding(value Vec2)
- func (style Style) SetChildBorderSize(v float32)
- func (style Style) SetChildRounding(v float32)
- func (style Style) SetCircleTessellationMaxError(v float32)
- func (style Style) SetColor(id StyleColorID, value Vec4)
- func (style Style) SetColorButtonPosition(value Dir)
- func (style Style) SetColumnsMinSpacing(v float32)
- func (style Style) SetCurveTessellationTol(v float32)
- func (style Style) SetDisabledAlpha(v float32)
- func (style Style) SetDisplaySafeAreaPadding(value Vec2)
- func (style Style) SetDisplayWindowPadding(value Vec2)
- func (style Style) SetFrameBorderSize(v float32)
- func (style Style) SetFramePadding(value Vec2)
- func (style Style) SetFrameRounding(v float32)
- func (style Style) SetGrabMinSize(v float32)
- func (style Style) SetGrabRounding(v float32)
- func (style Style) SetIndentSpacing(v float32)
- func (style Style) SetItemInnerSpacing(value Vec2)
- func (style Style) SetItemSpacing(value Vec2)
- func (style Style) SetLogSliderDeadzone(v float32)
- func (style Style) SetMouseCursorScale(v float32)
- func (style Style) SetPopupBorderSize(v float32)
- func (style Style) SetPopupRounding(v float32)
- func (style Style) SetScrollbarRounding(v float32)
- func (style Style) SetScrollbarSize(v float32)
- func (style Style) SetSelectableTextAlign(value Vec2)
- func (style Style) SetTabBorderSize(v float32)
- func (style Style) SetTabMinWidthForCloseButton(v float32)
- func (style Style) SetTabRounding(v float32)
- func (style Style) SetTouchExtraPadding(value Vec2)
- func (style Style) SetWindowBorderSize(v float32)
- func (style Style) SetWindowMenuButtonPosition(value Dir)
- func (style Style) SetWindowMinSize(value Vec2)
- func (style Style) SetWindowPadding(value Vec2)
- func (style Style) SetWindowRounding(v float32)
- func (style Style) SetWindowTitleAlign(value Vec2)
- func (style Style) TabBorderSize() float32
- func (style Style) TabMinWidthForCloseButton() float32
- func (style Style) TabRounding() float32
- func (style Style) TouchExtraPadding() Vec2
- func (style Style) WindowBorderSize() float32
- func (style Style) WindowMenuButtonPosition() Dir
- func (style Style) WindowMinSize() Vec2
- func (style Style) WindowPadding() Vec2
- func (style Style) WindowRounding() float32
- func (style Style) WindowTitleAlign() Vec2
type StyleColorID
type StyleVarID
type SubplotFlags
type TabBarFlags
type TabItemFlags
type TableBgTarget
type TableColumnFlags
- func TableGetColumnFlags() TableColumnFlags
- func TableGetColumnFlagsV(columnN int) TableColumnFlags
type TableColumnSortSpecs
type TableFlags
type TableRowFlags
type TableSortSpecs
- func TableGetSortSpecs() TableSortSpecs
- func (specs TableSortSpecs) ClearSpecsDirty()
- func (specs TableSortSpecs) SetSpecsDirty(value bool)
- func (specs TableSortSpecs) Specs() []TableColumnSortSpecs
- func (specs TableSortSpecs) SpecsCount() int
- func (specs TableSortSpecs) SpecsDirty() bool
type TextureID
type TreeNodeFlags
type Vec2
- func CalcTextSize(text string, hideTextAfterDoubleHash bool, wrapWidth float32) Vec2
- func ContentRegionAvail() Vec2
- func ContentRegionMax() Vec2
- func CursorPos() Vec2
- func CursorScreenPos() Vec2
- func CursorStartPos() Vec2
- func ItemRectMax() Vec2
- func ItemRectMin() Vec2
- func MouseDragDelta(button int, lockThreshold float32) Vec2
- func MousePos() Vec2
- func WindowContentRegionMax() Vec2
- func WindowContentRegionMin() Vec2
- func WindowPos() Vec2
- func WindowSize() Vec2
- func (vec Vec2) Minus(other Vec2) Vec2
- func (vec Vec2) Plus(other Vec2) Vec2
- func (vec Vec2) Times(value float32) Vec2
type Vec4
- func GetLastItemColor() Vec4
- func (vec Vec4) Minus(other Vec4) Vec4
- func (vec Vec4) Plus(other Vec4) Vec4
- func (vec Vec4) Times(value float32) Vec4
type Viewport
- func MainViewport() Viewport
- func (viewport Viewport) Center() Vec2
- func (viewport Viewport) Flags() ViewportFlags
- func (viewport Viewport) Pos() Vec2
- func (viewport Viewport) Size() Vec2
- func (viewport Viewport) WorkCenter() Vec2
- func (viewport Viewport) WorkPos() Vec2
- func (viewport Viewport) WorkSize() Vec2
type ViewportFlags
type WindowFlags

Constants ¶

View Source

const (
	// DragDropPayloadTypeColor3F is payload type for 3 floats component color.
	DragDropPayloadTypeColor3F = "_COL3F"
	// DragDropPayloadTypeColor4F is payload type for 4 floats component color.
	DragDropPayloadTypeColor4F = "_COL4F"
)

View Source

const (
	KeyTab         = 0
	KeyLeftArrow   = 1
	KeyRightArrow  = 2
	KeyUpArrow     = 3
	KeyDownArrow   = 4
	KeyPageUp      = 5
	KeyPageDown    = 6
	KeyHome        = 7
	KeyEnd         = 8
	KeyInsert      = 9
	KeyDelete      = 10
	KeyBackspace   = 11
	KeySpace       = 12
	KeyEnter       = 13
	KeyEscape      = 14
	KeyKeyPadEnter = 15
	KeyA           = 16 // for text edit CTRL+A: select all
	KeyC           = 17 // for text edit CTRL+C: copy
	KeyV           = 18 // for text edit CTRL+V: paste
	KeyX           = 19 // for text edit CTRL+X: cut
	KeyY           = 20 // for text edit CTRL+Y: redo
	KeyZ           = 21 // for text edit CTRL+Z: undo
)

Constants to fill IO.KeyMap() lookup with indices into the IO.KeysDown[512] array. The mapped indices are then the ones reported to IO.KeyPress() and IO.KeyRelease().

View Source

const (
	Location_North  Location = 1 << iota // top-center
	Location_South                       // bottom-center
	Location_West                        // center-left
	Location_East                        // center-right
	Location_Center = 0                  // center-center

	Location_NorthWest = Location_North | Location_West // top-left
	Location_NorthEast = Location_North | Location_East // top-right
	Location_SouthWest = Location_South | Location_West // bottom-left
	Location_SouthEast = Location_South | Location_East // bottom-right
)

Locations used to position items on a plot

View Source

const (
	Bin_Sqrt    Bin = -1 // k = sqrt(n)
	Bin_Sturges     = -2 // k = 1 + log2(n)
	Bin_Rice        = -3 // k = 2 * cbrt(n)
	Bin_Scott       = -4 // w = 3.49 * sigma / cbrt(n)
)

Different automatic histogram binning methods (k = bin count or w = bin width)

Variables ¶

View Source

var Auto float32 = -1

Special auto value. Used in sizes, width, etc.

View Source

var AutoColor = Vec4{X: 0, Y: 0, Z: 0, W: -1}

Special color used to indicate that a color should be deduced automatically.

View Source

var ErrContextDestroyed = errors.New("context is destroyed")

ErrContextDestroyed is returned when trying to use an already destroyed context.

View Source

var ErrNoContext = errors.New("no current context")

ErrNoContext is used when no context is current.

View Source

var PackedColorModel = color.ModelFunc(func(in color.Color) color.Color { return Packed(in) })

PackedColorModel converts colors to PackedColor instances.

Functions ¶

func AcceptDragDropPayload ¶

func AcceptDragDropPayload(dataType string, flags DragDropFlags) []byte

AcceptDragDropPayload accepts contents of a given type. If ImGuiDragDropFlags_AcceptBeforeDelivery is set you can peek into the payload before the mouse button is released.

func AlignTextToFramePadding ¶

func AlignTextToFramePadding()

AlignTextToFramePadding vertically aligns upcoming text baseline to FramePadding.y so that it will align properly to regularly framed items. Call if you have text on a line before a framed item.

func Begin ¶

func Begin(id string) bool

Begin calls BeginV(id, nil, 0).

func BeginChild ¶

func BeginChild(id string) bool

BeginChild calls BeginChildV(id, Vec2{0,0}, false, 0).

func BeginChildV ¶

func BeginChildV(id string, size Vec2, border bool, flags WindowFlags) bool

BeginChildV pushes a new child to the stack and starts appending to it. flags are the WindowFlags to apply.

func BeginCombo ¶

func BeginCombo(label, previewValue string) bool

BeginCombo calls BeginComboV(label, previewValue, 0).

func BeginComboV ¶

func BeginComboV(label, previewValue string, flags ComboFlags) bool

BeginComboV creates a combo box with complete control over the content to the user. Call EndCombo() if this function returns true. flags are the ComboFlags to apply.

func BeginDragDropSource ¶

func BeginDragDropSource(flags DragDropFlags) bool

BeginDragDropSource registers the currently active item as drag'n'drop source. When this returns true you need to: a) call SetDragDropPayload() exactly once, b) you may render the payload visual/description, c) call EndDragDropSource().

func BeginDragDropTarget ¶

func BeginDragDropTarget() bool

BeginDragDropTarget must be called after submitting an item that may receive an item. If this returns true, you can call AcceptDragDropPayload() and EndDragDropTarget().

func BeginGroup ¶

func BeginGroup()

BeginGroup locks horizontal starting position + capture group bounding box into one "item"; So you can use IsItemHovered() or layout primitives such as SameLine() on whole group, etc.

func BeginListBox ¶

func BeginListBox(label string) bool

BeginListBox calls BeginListBoxV(label, Vec2{}).

func BeginListBoxV ¶

func BeginListBoxV(label string, size Vec2) bool

BeginListBoxV opens a framed scrolling region. - This is essentially a thin wrapper to using BeginChild/EndChild with some stylistic changes. - The BeginListBox()/EndListBox() api allows you to manage your contents and selection state however you want it, by creating e.g. Selectable() or any items. - The simplified/old ListBox() api are helpers over BeginListBox()/EndListBox() which are kept available for convenience purpose. This is analoguous to how Combos are created. - Choose frame width: size.x > 0.0f: custom / size.x < 0.0f or -FLT_MIN: right-align / size.x = 0.0f (default): use current ItemWidth - Choose frame height: size.y > 0.0f: custom / size.y < 0.0f or -FLT_MIN: bottom-align / size.y = 0.0f (default): arbitrary default height which can fit ~7 items.

func BeginMainMenuBar ¶

func BeginMainMenuBar() bool

BeginMainMenuBar creates and appends to a full screen menu-bar. If the return value is true, then EndMainMenuBar() must be called!

func BeginMenu ¶

func BeginMenu(label string) bool

BeginMenu calls BeginMenuV(label, true).

func BeginMenuBar ¶

func BeginMenuBar() bool

BeginMenuBar appends to menu-bar of current window. This requires WindowFlagsMenuBar flag set on parent window. If the return value is true, then EndMenuBar() must be called!

func BeginMenuV ¶

func BeginMenuV(label string, enabled bool) bool

BeginMenuV creates a sub-menu entry. If the return value is true, then EndMenu() must be called!

func BeginPlot ¶

func BeginPlot(title string) bool

BeginPlot starts a 2D plotting context with only the title specified. It calls BeginPlotV(title, Vec2{-1, 0}, Flags_None).

If this function returns true, then EndPlot() MUST be called! You can do:

if igwrap.BeginPlot(...) {
    igwrap.PlotXXX(...)
    ...
    igwrap.EndPlot()
}

Note that:

title must be unique to the current ImGui ID scope. If you need to avoid ID collisions or don't want to display a title in the plot, use double hashes (e.g. "MyPlot##HiddenIdText" or "##NoTitle").
size is the **frame** size of the plot widget, not the plot area. The default size of plots (i.e. when ImVec2(0,0)) can be modified in your ImPlotStyle.

func BeginPlotV ¶

func BeginPlotV(title string, size Vec2, flags PlotFlags) bool

BeginPlotV starts a 2D plotting context with all the parameters specified.

If this function returns true, then EndPlot() MUST be called! You can do:

if igwrap.BeginPlot(...) {
    igwrap.PlotXXX(...)
    ...
    igwrap.EndPlot()
}

Note that:

title must be unique to the current ImGui ID scope. If you need to avoid ID collisions or don't want to display a title in the plot, use double hashes (e.g. "MyPlot##HiddenIdText" or "##NoTitle").
size is the **frame** size of the plot widget, not the plot area. The default size of plots (i.e. when ImVec2(0,0)) can be modified in your ImPlotStyle.

func BeginPopup ¶

func BeginPopup(name string) bool

BeginPopup calls BeginPopupV(name, nil, 0).

func BeginPopupContextItem ¶

func BeginPopupContextItem() bool

BeginPopupContextItem calls BeginPopupContextItemV("", PopupFlagsMouseButtonRight).

func BeginPopupContextItemV ¶

func BeginPopupContextItemV(id string, flags PopupFlags) bool

BeginPopupContextItemV returns true if the identified mouse button was pressed while hovering over the last item.

func BeginPopupContextVoid ¶

func BeginPopupContextVoid() bool

BeginPopupContextVoid calls BeginPopupContextVoidV("", PopupFlagsMouseButtonRight).

func BeginPopupContextVoidV ¶

func BeginPopupContextVoidV(id string, flags PopupFlags) bool

BeginPopupContextVoidV open+begin popup when clicked in void (where there are no windows).

func BeginPopupContextWindow ¶

func BeginPopupContextWindow() bool

BeginPopupContextWindow calls BeginPopupContextWindowV("", PopupFlagsMouseButtonRight).

func BeginPopupContextWindowV ¶

func BeginPopupContextWindowV(id string, flags PopupFlags) bool

BeginPopupContextWindowV open+begin popup when clicked on current window.

func BeginPopupModal ¶

func BeginPopupModal(name string) bool

BeginPopupModal calls BeginPopupModalV(name, nil, 0).

func BeginPopupModalV ¶

func BeginPopupModalV(name string, open *bool, flags WindowFlags) bool

BeginPopupModalV creates modal dialog (regular window with title bar, block interactions behind the modal window, can't close the modal window by clicking outside). WindowFlags are forwarded to the window.

func BeginPopupV ¶

func BeginPopupV(name string, flags WindowFlags) bool

BeginPopupV returns true if the popup is open, and you can start outputting to it. Only call EndPopup() if BeginPopup() returns true. WindowFlags are forwarded to the window.

func BeginSubplots ¶

func BeginSubplots(title string, rows, cols int) bool

BeginSubplots starts a subdivided plotting context with onle the required parameters. It calls BeginSubplotsV(title, rows, cols, Vec2{-1, 0}, SubplotFlags_None, nil, nil).

If the function returns true, EndSubplots() MUST be called! Call BeginPlot/EndPlot AT MOST [rows*cols] times in between the begining and end of the subplot context. Plots are added in row major order. Example:

if BeginSubplots("My Subplot",2,3) {
    for i := 0; i < 6; i++ {
        if BeginPlot(...) {
            PlotLine(...);
            ...
            EndPlot();
        }
    }
    EndSubplots();
}

Produces:

[0] | [1] | [2]
----|-----|----
[3] | [4] | [5]

Important notes:

#title must be unique to the current ImGui ID scope. If you need to avoid ID collisions or don't want to display a title in the plot, use double hashes (e.g. "MySubplot##HiddenIdText" or "##NoTitle").
#rows and #cols must be greater than 0.
#size is the size of the entire grid of subplots, not the individual plots
#row_ratios and #col_ratios must have AT LEAST #rows and #cols elements, respectively. These are the sizes of the rows and columns expressed in ratios. If the user adjusts the dimensions, the arrays are updated with new ratios.

Important notes regarding BeginPlot from inside of BeginSubplots:

The #title parameter of _BeginPlot_ (see above) does NOT have to be unique when called inside of a subplot context. Subplot IDs are hashed for your convenience so you don't have call PushID or generate unique title strings. Simply pass an empty string to BeginPlot unless you want to title each subplot.
The #size parameter of _BeginPlot_ (see above) is ignored when inside of a subplot context. The actual size of the subplot will be based on the #size value you pass to _BeginSubplots_ and #row/#col_ratios if provided.

func BeginSubplotsV ¶

func BeginSubplotsV(title string, rows, cols int, size Vec2, flags SubplotFlags, rowRatios, colRatios []float32) bool

BeginSubplotsV starts a subdivided plotting context with all parameters.

If the function returns true, EndSubplots() MUST be called! Call BeginPlot/EndPlot AT MOST [rows*cols] times in between the begining and end of the subplot context. Plots are added in row major order. Example:

if BeginSubplots("My Subplot",2,3) {
    for i := 0; i < 6; i++ {
        if BeginPlot(...) {
            PlotLine(...);
            ...
            EndPlot();
        }
    }
    EndSubplots();
}

Produces:

[0] | [1] | [2]
----|-----|----
[3] | [4] | [5]

Important notes:

#title must be unique to the current ImGui ID scope. If you need to avoid ID collisions or don't want to display a title in the plot, use double hashes (e.g. "MySubplot##HiddenIdText" or "##NoTitle").
#rows and #cols must be greater than 0.
#size is the size of the entire grid of subplots, not the individual plots
#row_ratios and #col_ratios must have AT LEAST #rows and #cols elements, respectively. These are the sizes of the rows and columns expressed in ratios. If the user adjusts the dimensions, the arrays are updated with new ratios.

Important notes regarding BeginPlot from inside of BeginSubplots:

The #title parameter of _BeginPlot_ (see above) does NOT have to be unique when called inside of a subplot context. Subplot IDs are hashed for your convenience so you don't have call PushID or generate unique title strings. Simply pass an empty string to BeginPlot unless you want to title each subplot.
The #size parameter of _BeginPlot_ (see above) is ignored when inside of a subplot context. The actual size of the subplot will be based on the #size value you pass to _BeginSubplots_ and #row/#col_ratios if provided.

func BeginTabBar ¶

func BeginTabBar(strID string) bool

BeginTabBar calls BeginTabBarV(strId, 0).

func BeginTabBarV ¶

func BeginTabBarV(strID string, flags TabBarFlags) bool

BeginTabBarV create and append into a TabBar.

func BeginTabItem ¶

func BeginTabItem(label string) bool

BeginTabItem calls BeginTabItemV(label, nil, 0).

func BeginTabItemV ¶

func BeginTabItemV(label string, open *bool, flags TabItemFlags) bool

BeginTabItemV create a Tab. Returns true if the Tab is selected.

func BeginTable ¶

func BeginTable(id string, columnsCount int) bool

BeginTable calls BeginTableV(id, columnsCount, 0, imgui.Vec2{}, 0.0).

func BeginTableV ¶

func BeginTableV(id string, columnsCount int, flags TableFlags, outerSize Vec2, innerWidth float32) bool

BeginTableV creates a table (Read carefully because this is subtle but it does make sense!) About 'outerSize', its meaning needs to differ slightly depending of if we are using ScrollX/ScrollY flags:

X:
- outerSize.x < 0.0f  ->  right align from window/work-rect maximum x edge.
- outerSize.x = 0.0f  ->  auto enlarge, use all available space.
- outerSize.x > 0.0f  ->  fixed width
Y with ScrollX/ScrollY: using a child window for scrolling:
- outerSize.y < 0.0f  ->  bottom align
- outerSize.y = 0.0f  ->  bottom align, consistent with BeginChild(). not recommended unless table is last item in parent window.
- outerSize.y > 0.0f  ->  fixed child height. recommended when using Scrolling on any axis.
Y without scrolling, we output table directly in parent window:
- outerSize.y < 0.0f  ->  bottom align (will auto extend, unless NoHostExtendV is set)
- outerSize.y = 0.0f  ->  zero minimum height (will auto extend, unless NoHostExtendV is set)
- outerSize.y > 0.0f  ->  minimum height (will auto extend, unless NoHostExtendV is set)

About 'innerWidth':

With ScrollX:
- innerWidth  < 0.0f  ->  *illegal* fit in known width (right align from outerSize.x) <-- weird
- innerWidth  = 0.0f  ->  fit in outer_width: Fixed size columns will take space they need (if avail, otherwise shrink down), Stretch columns becomes Fixed columns.
- innerWidth  > 0.0f  ->  override scrolling width, generally to be larger than outerSize.x. Fixed column take space they need (if avail, otherwise shrink down), Stretch columns share remaining space!
Without ScrollX:
- innerWidth          ->  *ignored*

Details:

If you want to use Stretch columns with ScrollX, you generally need to specify 'innerWidth' otherwise the concept of "available space" doesn't make sense.
Even if not really useful, we allow 'innerWidth < outerSize.x' for consistency and to facilitate understanding of what the value does.

func BeginTooltip ¶

func BeginTooltip()

BeginTooltip begins/appends to a tooltip window. Used to create full-featured tooltip (with any kind of contents). Requires a call to EndTooltip().

func BeginV ¶

func BeginV(id string, open *bool, flags WindowFlags) bool

BeginV pushes a new window to the stack and start appending to it. You may append multiple times to the same window during the same frame. If the open argument is provided, the window can be closed, in which case the value will be false after the call.

Returns false if the window is currently not visible. Regardless of the return value, End() must be called for each call to Begin().

func Bullet ¶

func Bullet()

Bullet draws a small circle and keeps the cursor on the same line. Advance cursor x position by TreeNodeToLabelSpacing(), same distance that TreeNode() uses.

func Button ¶

func Button(id string) bool

Button calls ButtonV(id, Vec2{0,0}).

func ButtonV ¶

func ButtonV(id string, size Vec2) bool

ButtonV returns true if it is clicked.

func CalcItemWidth ¶

func CalcItemWidth() float32

CalcItemWidth returns the width of items given pushed settings and current cursor position.

func Checkbox ¶

func Checkbox(id string, selected *bool) bool

Checkbox creates a checkbox in the selected state. The return value indicates if the selected state has changed.

func ClearActiveID ¶

func ClearActiveID()

ClearActiveID removes focus from a currently item in edit mode. An application that handles its own undo/redo stack needs to call this function before changing the data a widget might currently own, such as a TextEdit().

func CloseCurrentPopup ¶

func CloseCurrentPopup()

CloseCurrentPopup closes the popup we have begin-ed into. Clicking on a MenuItem or Selectable automatically close the current popup.

func CollapsingHeader ¶

func CollapsingHeader(label string) bool

CollapsingHeader calls CollapsingHeaderV(label, 0).

func CollapsingHeaderV ¶

func CollapsingHeaderV(label string, flags TreeNodeFlags) bool

CollapsingHeaderV adds a collapsing header with TreeNode flags.

func ColorButton ¶

func ColorButton(id string, col Vec4, flags ColorEditFlags, size Vec2) bool

ColorButton displays a color square/button, hover for details, returns true when pressed.

func ColorEdit3 ¶

func ColorEdit3(label string, col *[3]float32) bool

ColorEdit3 calls ColorEdit3V(label, col, 0).

func ColorEdit3V ¶

func ColorEdit3V(label string, col *[3]float32, flags ColorEditFlags) bool

ColorEdit3V will show a clickable little square which will open a color picker window for 3D vector (rgb format).

func ColorEdit4 ¶

func ColorEdit4(label string, col *[4]float32) bool

ColorEdit4 calls ColorEdit4V(label, col, 0).

func ColorEdit4V ¶

func ColorEdit4V(label string, col *[4]float32, flags ColorEditFlags) bool

ColorEdit4V will show a clickable little square which will open a color picker window for 4D vector (rgba format).

func ColorPicker3 ¶

func ColorPicker3(label string, col *[3]float32) bool

ColorPicker3 calls ColorPicker3V(label, col, 0).

func ColorPicker3V ¶

func ColorPicker3V(label string, col *[3]float32, flags ColorPickerFlags) bool

ColorPicker3V will show directly a color picker control for editing a color in 3D vector (rgb format).

func ColorPicker4 ¶

func ColorPicker4(label string, col *[4]float32) bool

ColorPicker4 calls ColorPicker4V(label, col, 0).

func ColorPicker4V ¶

func ColorPicker4V(label string, col *[4]float32, flags ColorPickerFlags) bool

ColorPicker4V will show directly a color picker control for editing a color in 4D vector (rgba format).

func ColumnIndex ¶

func ColumnIndex() int

ColumnIndex get current column index.

func ColumnOffset ¶

func ColumnOffset() float32

ColumnOffset calls ColumnOffsetV(-1).

func ColumnOffsetV ¶

func ColumnOffsetV(index int) float32

ColumnOffsetV get position of column line (in pixels, from the left side of the contents region). pass -1 to use current column, otherwise 0..GetColumnsCount() inclusive. column 0 is typically 0.0.

func ColumnWidth ¶

func ColumnWidth() int

ColumnWidth calls ColumnWidthV(-1).

func ColumnWidthV ¶

func ColumnWidthV(index int) int

ColumnWidthV get column width (in pixels). pass -1 to use current column.

func Columns ¶

func Columns()

Columns API is Legacy (2021: prefer using Tables!). - You can also use SameLineV(pos_x, 0) to mimic simplified columns.

Columns calls ColumnsV(1, "", false).

func ColumnsCount ¶

func ColumnsCount() int

ColumnsCount returns number of current columns.

func ColumnsV ¶

func ColumnsV(count int, label string, border bool)

ColumnsV creates a column layout of the specified number of columns.

func Combo ¶

func Combo(id string, value *int32, list []string) bool

Combo calls ComboV(id, value, list, -1).

func ComboV ¶

func ComboV(id string, value *int32, list []string, heightInItems int) bool

ComboV is a helper over BeginCombo()/EndCombo() which are kept available for convenience purpose. This is analogous to how ListBox are created.

func CursorPosX ¶

func CursorPosX() float32

CursorPosX returns the x-coordinate of the cursor position in window coordinates.

func CursorPosY ¶

func CursorPosY() float32

CursorPosY returns the y-coordinate of the cursor position in window coordinates.

func DragFloat ¶

func DragFloat(label string, value *float32) bool

DragFloat calls DragFloatV(label, value, 1.0, 0.0, 0.0, "%.3f", SliderFlagsNone).

func DragFloat2 ¶

func DragFloat2(label string, value *[2]float32) bool

DragFloat2 calls DragFloat2V(label, value, 1.0, 0.0, 0.0, "%.3f", SliderFlagsNone).

func DragFloat2V ¶

func DragFloat2V(label string, values *[2]float32, speed, min, max float32, format string, flags SliderFlags) bool

DragFloat2V creates a draggable slider for a 2D vector.

func DragFloat3 ¶

func DragFloat3(label string, value *[3]float32) bool

DragFloat3 calls DragFloat3V(label, value, 1.0, 0.0, 0.0, "%.3f", SliderFlagsNone).

func DragFloat3V ¶

func DragFloat3V(label string, values *[3]float32, speed, min, max float32, format string, flags SliderFlags) bool

DragFloat3V creates a draggable slider for a 3D vector.

func DragFloat4 ¶

func DragFloat4(label string, value *[4]float32) bool

DragFloat4 calls DragFloat4V(label, value, 1.0, 0.0, 0.0, "%.3f", SliderFlagsNone).

func DragFloat4V ¶

func DragFloat4V(label string, values *[4]float32, speed, min, max float32, format string, flags SliderFlags) bool

DragFloat4V creates a draggable slider for a 4D vector.

func DragFloatRange2 ¶

func DragFloatRange2(label string, currentMin *float32, currentMax *float32) bool

DragFloatRange2 calls DragFloatRange2V(label, currentMin, currentMax, 1, 0, 0, "%.3f", "%.3f", SliderFlagsNone).

func DragFloatRange2V ¶

func DragFloatRange2V(label string, currentMin *float32, currentMax *float32, speed float32, min float32, max float32, format string, formatMax string, flags SliderFlags) bool

DragFloatRange2V creates a draggable slider in floats range.

func DragFloatV ¶

func DragFloatV(label string, value *float32, speed, min, max float32, format string, flags SliderFlags) bool

DragFloatV creates a draggable slider for floats.

func DragInt ¶

func DragInt(label string, value *int32) bool

DragInt calls DragIntV(label, value, 1.0, 0, 0, "%d", SliderFlagsNone).

func DragInt2 ¶

func DragInt2(label string, value *[2]int32) bool

DragInt2 calls DragInt2V(label, value, 1.0, 0.0, 0.0, "%d", SliderFlagsNone).

func DragInt2V ¶

func DragInt2V(label string, values *[2]int32, speed float32, min, max int32, format string, flags SliderFlags) bool

DragInt2V creates a draggable slider for a 2D vector.

func DragInt3 ¶

func DragInt3(label string, value *[3]int32) bool

DragInt3 calls DragInt3V(label, value, 1.0, 0.0, 0.0, "%d", SliderFlagsNone).

func DragInt3V ¶

func DragInt3V(label string, values *[3]int32, speed float32, min, max int32, format string, flags SliderFlags) bool

DragInt3V creates a draggable slider for a 3D vector.

func DragInt4 ¶

func DragInt4(label string, value *[4]int32) bool

DragInt4 calls DragInt4V(label, value, 1.0, 0.0, 0.0, "%d", SliderFlagsNone).

func DragInt4V ¶

func DragInt4V(label string, values *[4]int32, speed float32, min, max int32, format string, flags SliderFlags) bool

DragInt4V creates a draggable slider for a 4D vector.

func DragIntRange2 ¶

func DragIntRange2(label string, currentMin *int32, currentMax *int32) bool

DragIntRange2 calls DragIntRange2V(label, currentMin, currentMax, 1, 0, 0, "%d", "%d", SliderFlagsNone).

func DragIntRange2V ¶

func DragIntRange2V(label string, currentMin *int32, currentMax *int32, speed float32, min int, max int, format string, formatMax string, flags SliderFlags) bool

DragIntRange2V creates a draggable slider in ints range.

func DragIntV ¶

func DragIntV(label string, value *int32, speed float32, min, max int32, format string, flags SliderFlags) bool

DragIntV creates a draggable slider for integers.

func Dummy ¶

func Dummy(size Vec2)

Dummy adds a dummy item of given size.

func End ¶

func End()

End closes the scope for the previously opened window. Every call to Begin() must be matched with a call to End().

func EndChild ¶

func EndChild()

EndChild closes the scope for the previously opened child. Every call to BeginChild() must be matched with a call to EndChild().

func EndCombo ¶

func EndCombo()

EndCombo must be called if BeginComboV() returned true.

func EndDragDropSource ¶

func EndDragDropSource()

EndDragDropSource closes the scope for current draw and drop source. Only call EndDragDropSource() if BeginDragDropSource() returns true.

func EndDragDropTarget ¶

func EndDragDropTarget()

EndDragDropTarget closed the scope for current drag and drop target. Only call EndDragDropTarget() if BeginDragDropTarget() returns true.

func EndFrame ¶

func EndFrame()

EndFrame ends the ImGui frame. Automatically called by Render(), so most likely don't need to ever call that yourself directly. If you don't need to render you may call EndFrame() but you'll have wasted CPU already. If you don't need to render, better to not create any imgui windows instead!

func EndGroup ¶

func EndGroup()

EndGroup must be called for each call to BeginGroup().

func EndListBox ¶

func EndListBox()

EndListBox closes the scope for the previously opened ListBox. only call EndListBox() if BeginListBox() returned true!

func EndMainMenuBar ¶

func EndMainMenuBar()

EndMainMenuBar finishes a main menu bar. Only call EndMainMenuBar() if BeginMainMenuBar() returns true!

func EndMenu ¶

func EndMenu()

EndMenu finishes a sub-menu entry. Only call EndMenu() if BeginMenu() returns true!

func EndMenuBar ¶

func EndMenuBar()

EndMenuBar finishes a menu bar. Only call EndMenuBar() if BeginMenuBar() returns true!

func EndPlot ¶

func EndPlot()

EndPlot marks the end of an active plot.

Only call EndPlot() if BeginPlot() returns true! Typically called at the end of an if statement conditioned on BeginPlot(). See example above.

func EndPopup ¶

func EndPopup()

EndPopup finishes a popup. Only call EndPopup() if BeginPopupXXX() returns true!

func EndSubplots ¶

func EndSubplots()

EndSubplots marks the end of a subdivided plotting area.

Only call EndSubplots() if BeginSubplots() returns true! Typically called at the end of an if statement conditioned on BeginSublots(). See example above.

func EndTabBar ¶

func EndTabBar()

EndTabBar only call EndTabBar() if BeginTabBar() returns true!

func EndTabItem ¶

func EndTabItem()

EndTabItem finishes a tab item. Don't call PushID(tab->ID)/PopID() on BeginTabItem()/EndTabItem().

func EndTable ¶

func EndTable()

EndTable closes the scope for the previously opened table. only call EndTable() if BeginTable() returns true!

func EndTooltip ¶

func EndTooltip()

EndTooltip closes the previously started tooltip window.

func FontSize ¶

func FontSize() float32

FontSize returns the current font size (= height in pixels) of the current font with the current scale applied.

func FrameHeight ¶

func FrameHeight() float32

FrameHeight returns the height of the current frame. This is equal to the font size plus the padding at the top and bottom.

func FrameHeightWithSpacing ¶

func FrameHeightWithSpacing() float32

FrameHeightWithSpacing returns the height of the current frame with the item spacing added. This is equal to the font size plus the padding at the top and bottom, plus the value of style.ItemSpacing.y.

func GetMarkerName ¶

func GetMarkerName(id Marker) string

GetMarkerName returns the name of a marker.

func GetPlotStyleColorName ¶

func GetPlotStyleColorName(id PlotStyleCol) string

GetStyleColorName returns the name of a style color.

func Image ¶

func Image(id TextureID, size Vec2)

Image calls ImageV(id, size, Vec2{0,0}, Vec2{1,1}, Vec4{1,1,1,1}, Vec4{0,0,0,0}).

func ImageButton ¶

func ImageButton(id TextureID, size Vec2) bool

ImageButton calls ImageButtonV(id, size, Vec2{0,0}, Vec2{1,1}, -1, Vec4{0,0,0,0}, Vec4{1,1,1,1}).

func ImageButtonV ¶

func ImageButtonV(id TextureID, size Vec2, uv0, uv1 Vec2, framePadding int, bgCol Vec4, tintCol Vec4) bool

ImageButtonV adds a button with an image, based on given texture ID. Refer to TextureID what this represents and how it is drawn. <0 framePadding uses default frame padding settings. 0 for no padding.

func ImageV ¶

func ImageV(id TextureID, size Vec2, uv0, uv1 Vec2, tintCol, borderCol Vec4)

ImageV adds an image based on given texture ID. Refer to TextureID what this represents and how it is drawn.

func Indent ¶

func Indent()

Indent moves content position toward the right by style.IndentSpacing.

func IndentV ¶

func IndentV(indentW float32)

IndentV moves content position toward the right, by style.IndentSpacing or indentW if not zero.

func IndexBufferLayout ¶

func IndexBufferLayout() (entrySize int)

IndexBufferLayout returns the byte size necessary to select fields in an index buffer of DrawList.

func InputInt ¶

func InputInt(label string, value *int32) bool

InputInt calls InputIntV(label, value, 1, 100, 0).

func InputIntV ¶

func InputIntV(label string, value *int32, step int, stepFast int, flags InputTextFlags) bool

InputIntV creates a input field for integer type.

func InputText ¶

func InputText(label string, text *string) bool

InputText calls InputTextV(label, text, 0, nil).

func InputTextMultiline ¶

func InputTextMultiline(label string, text *string) bool

InputTextMultiline calls InputTextMultilineV(label, text, Vec2{0,0}, 0, nil).

func InputTextMultilineV ¶

func InputTextMultilineV(label string, text *string, size Vec2, flags InputTextFlags, cb InputTextCallback) bool

InputTextMultilineV provides a field for dynamic text input of multiple lines.

Contrary to the original library, this wrapper does not limit the maximum number of possible characters. Dynamic resizing of the internal buffer is handled within the wrapper and the user will never be called for such requests.

The provided callback is called for any of the requested InputTextFlagsCallback* flags.

To implement a character limit, provide a callback that drops input characters when the requested length has been reached.

func InputTextV ¶

func InputTextV(label string, text *string, flags InputTextFlags, cb InputTextCallback) bool

InputTextV creates a text field for dynamic text input.

Contrary to the original library, this wrapper does not limit the maximum number of possible characters. Dynamic resizing of the internal buffer is handled within the wrapper and the user will never be called for such requests.

The provided callback is called for any of the requested InputTextFlagsCallback* flags.

To implement a character limit, provide a callback that drops input characters when the requested length has been reached.

func InputTextWithHint ¶

func InputTextWithHint(label string, hint string, text *string) bool

InputTextWithHint calls InputTextWithHintV(label, hint, text, 0, nil).

func InputTextWithHintV ¶

func InputTextWithHintV(label string, hint string, text *string, flags InputTextFlags, cb InputTextCallback) bool

InputTextWithHintV creates a text field for dynamic text input with a hint.

Contrary to the original library, this wrapper does not limit the maximum number of possible characters. Dynamic resizing of the internal buffer is handled within the wrapper and the user will never be called for such requests.

The provided callback is called for any of the requested InputTextFlagsCallback* flags.

To implement a character limit, provide a callback that drops input characters when the requested length has been reached.

func InvisibleButton ¶

func InvisibleButton(id string, size Vec2) bool

InvisibleButton calls InvisibleButtonV(id, size, ButtonFlagsNone).

func InvisibleButtonV ¶

func InvisibleButtonV(id string, size Vec2, flags ButtonFlags) bool

InvisibleButtonV returns true if it is clicked.

func IsAnyItemActive ¶

func IsAnyItemActive() bool

IsAnyItemActive returns true if the any item is active.

func IsAnyItemFocused ¶

func IsAnyItemFocused() bool

IsAnyItemFocused returns true if any item is focused.

func IsAnyMouseDown ¶

func IsAnyMouseDown() bool

IsAnyMouseDown returns true if any mouse button is currently being held down.

func IsItemActivated ¶

func IsItemActivated() bool

IsItemActivated returns true if the last item was made active (item was previously inactive).

func IsItemActive ¶

func IsItemActive() bool

IsItemActive returns if the last item is active. e.g. button being held, text field being edited.

This will continuously return true while holding mouse button on an item. Items that don't interact will always return false.

func IsItemClicked ¶

func IsItemClicked() bool

IsItemClicked returns true if the current item is clicked with the left mouse button.

func IsItemDeactivated ¶

func IsItemDeactivated() bool

IsItemDeactivated returns true if the last item was made inactive (item was previously active).

func IsItemDeactivatedAfterEdit ¶

func IsItemDeactivatedAfterEdit() bool

IsItemDeactivatedAfterEdit returns true if the last item was made inactive and made a value change when it was active (e.g. Slider/Drag moved).

func IsItemEdited ¶

func IsItemEdited() bool

IsItemEdited return true if the last item was modified or was pressed. This is generally the same as the "bool" return value of many widgets.

func IsItemFocused ¶

func IsItemFocused() bool

IsItemFocused returns true if the last item is focused.

func IsItemHovered ¶

func IsItemHovered() bool

IsItemHovered calls IsItemHoveredV(HoveredFlagsNone).

func IsItemHoveredV ¶

func IsItemHoveredV(flags HoveredFlags) bool

IsItemHoveredV returns true if the last item is hovered. (and usable, aka not blocked by a popup, etc.). See HoveredFlags for more options.

func IsItemToggledOpen ¶

func IsItemToggledOpen() bool

IsItemToggledOpen returns true if the last item's open was toggled open.

func IsItemVisible ¶

func IsItemVisible() bool

IsItemVisible returns true if the last item is visible.

func IsKeyDown ¶

func IsKeyDown(key int) bool

IsKeyDown returns true if the corresponding key is currently being held down.

func IsKeyPressed ¶

func IsKeyPressed(key int) bool

IsKeyPressed calls IsKeyPressedV(key, true).

func IsKeyPressedV ¶

func IsKeyPressedV(key int, repeat bool) bool

IsKeyPressedV returns true if the corresponding key was pressed (went from !Down to Down). If repeat=true and the key is being held down then the press is repeated using io.KeyRepeatDelay and KeyRepeatRate.

func IsKeyReleased ¶

func IsKeyReleased(key int) bool

IsKeyReleased returns true if the corresponding key was released (went from Down to !Down).

func IsMouseClicked ¶

func IsMouseClicked(button int) bool

IsMouseClicked calls IsMouseClickedV(key, false).

func IsMouseClickedV ¶

func IsMouseClickedV(button int, repeat bool) bool

IsMouseClickedV returns true if the mouse button was clicked (0=left, 1=right, 2=middle) If repeat=true and the mouse button is being held down then the click is repeated using io.KeyRepeatDelay and KeyRepeatRate.

func IsMouseDoubleClicked ¶

func IsMouseDoubleClicked(button int) bool

IsMouseDoubleClicked returns true if the mouse button was double-clicked (0=left, 1=right, 2=middle).

func IsMouseDown ¶

func IsMouseDown(button int) bool

IsMouseDown returns true if the corresponding mouse button is currently being held down.

func IsMouseDragging ¶

func IsMouseDragging(button int, threshold float64) bool

IsMouseDragging returns true if the mouse button is being dragged.

func IsMouseReleased ¶

func IsMouseReleased(button int) bool

IsMouseReleased returns true if the mouse button was released (went from Down to !Down).

func IsPopupOpen ¶

func IsPopupOpen(id string) bool

IsPopupOpen calls IsPopupOpenV(id, PopupFlagsNone).

func IsPopupOpenV ¶

func IsPopupOpenV(id string, flags PopupFlags) bool

IsPopupOpenV return true if the popup is open. IsPopupOpenV(id, PopupFlagsNone): return true if the popup is open at the current BeginPopup() level of the popup stack. IsPopupOpenV(id, PopupFlagsAnyPopupID: return true if any popup is open at the current BeginPopup() level of the popup stack. IsPopupOpenV(id, PopupFlagsAnyPopup): return true if any popup is open.

func IsWindowAppearing ¶

func IsWindowAppearing() bool

IsWindowAppearing returns whether the current window is appearing.

func IsWindowCollapsed ¶

func IsWindowCollapsed() bool

IsWindowCollapsed returns whether the current window is collapsed.

func IsWindowFocused ¶

func IsWindowFocused() bool

IsWindowFocused calls IsWindowFocusedV(FocusedFlagsNone).

func IsWindowFocusedV ¶

func IsWindowFocusedV(flags FocusedFlags) bool

IsWindowFocusedV returns if current window is focused or its root/child, depending on flags. See flags for options.

func IsWindowHovered ¶

func IsWindowHovered() bool

IsWindowHovered calls IsWindowHoveredV(HoveredFlagsNone).

func IsWindowHoveredV ¶

func IsWindowHoveredV(flags HoveredFlags) bool

IsWindowHoveredV returns if current window is hovered (and typically: not blocked by a popup/modal). See flags for options. NB: If you are trying to check whether your mouse should be dispatched to imgui or to your app, you should use the 'io.WantCaptureMouse' boolean for that!

func LabelText ¶

func LabelText(label, text string)

LabelText adds text+label aligned the same way as value+label widgets.

func LabelTextf ¶

func LabelTextf(label, format string, v ...interface{})

LabelTextf calls LabelText(label, fmt.Sprintf(format, v...)) .

func ListBox ¶

func ListBox(label string, currentItem *int32, items []string) bool

ListBox calls ListBoxV(label, currentItem, items, -1) The function returns true if the selection was changed. The value of currentItem will indicate the new selected item.

func ListBoxV ¶

func ListBoxV(label string, currentItem *int32, items []string, heightItems int) bool

ListBoxV creates a list of selectables of given items with equal height, enclosed with header and footer. This version accepts a custom item height. The function returns true if the selection was changed. The value of currentItem will indicate the new selected item.

func LoadIniSettingsFromDisk ¶

func LoadIniSettingsFromDisk(fileName string)

LoadIniSettingsFromDisk loads ini settings from disk.

func LoadIniSettingsFromMemory ¶

func LoadIniSettingsFromMemory(data string)

LoadIniSettingsFromMemory loads ini settings from memory.

func MenuItem ¶

func MenuItem(label string) bool

MenuItem calls MenuItemV(label, "", false, true).

func MenuItemV ¶

func MenuItemV(label string, shortcut string, selected bool, enabled bool) bool

MenuItemV adds a menu item with given label. Returns true if the item is selected. If selected is not nil, it will be toggled when true is returned. Shortcuts are displayed for convenience but not processed by ImGui at the moment.

func NewFrame ¶

func NewFrame()

NewFrame starts a new ImGui frame, you can submit any command from this point until Render()/EndFrame().

func NextColumn ¶

func NextColumn()

NextColumn next column, defaults to current row or next row if the current row is finished.

func OpenPopup ¶

func OpenPopup(id string)

OpenPopup calls OpenPopupV(id, 0).

func OpenPopupOnItemClick ¶

func OpenPopupOnItemClick()

OpenPopupOnItemClick calls OpenPopupOnItemClickV("", PopupFlagsMouseButtonRight).

func OpenPopupOnItemClickV ¶

func OpenPopupOnItemClickV(id string, flags PopupFlags)

OpenPopupOnItemClickV helper to open popup when clicked on last item. return true when just opened. (note: actually triggers on the mouse _released_ event to be consistent with popup behaviors).

func OpenPopupV ¶

func OpenPopupV(id string, flags PopupFlags)

OpenPopupV marks popup as open (don't call every frame!). Popups are closed when user click outside, or if CloseCurrentPopup() is called within a BeginPopup()/EndPopup() block. By default, Selectable()/MenuItem() are calling CloseCurrentPopup(). Popup identifiers are relative to the current ID-stack (so OpenPopup and BeginPopup needs to be at the same level).

func PlotBarGroups ¶

func PlotBarGroups(itemLabels []string, values [][]float64, groupWidth, x0 float64, flags BarGroupsFlags)

PlotBarGroups plots a group of vertical bars.

The I-th item in the J-th group is in #values[I][J]. The I-th item has a legend label of #itemLabels[I].

Item count N = Min(len(itemLabels), len(values)). Group count M = Min(len(values[0]), len(values[1]), ... len(values[N-1])).

The bar groups are centered at at x0, x0+1, x0+2, x0+M-1. If you want to put labels on the groups, use SetupAxisTickValues.

func PlotBarGroupsH ¶

func PlotBarGroupsH(itemLabels []string, values [][]float64, groupWidth, y0 float64, flags BarGroupsFlags)

PlotBarGroupsH plots a group of horizontal bars.

The I-th item in the J-th group is in #values[I][J]. The I-th item has a legend label of #itemLabels[I].

Item count N = Min(len(itemLabels), len(values)). Group count M = Min(len(values[0]), len(values[1]), ... len(values[N-1])).

The bar groups are centered at at y0, y0+1, y0+2, y0+M-1. If you want to put labels on the groups, use SetupAxisTickValues.

func PlotBars ¶

func PlotBars(label string, vs interface{})

PlotBars plots a vertical bar graph, with every bar centering at X coords 0, 1, ..., N-1.

func PlotBarsG ¶

func PlotBarsG(label string, getter DataGetter, userData interface{}, count int, barWidth float64)

PlotBarsG plots a vertical bar graph, with bars each taking up a fraction of the available width. #barWidth should be in (0, 1].

func PlotBarsH ¶

func PlotBarsH(label string, vs interface{})

PlotBarsH plots a horizontal bar graph, with every bar centering at Y coords 0, 1, ..., N-1.

func PlotBarsHG ¶

func PlotBarsHG(label string, getter DataGetter, userData interface{}, count int, barHeight float64)

PlotBarsHG plots a horizontal bar graph, with bars each taking up a fraction of the available height. #barHeight should be in (0, 1].

func PlotBarsHP ¶

func PlotBarsHP(label string, ps []Point, barHeight float64)

PlotBarsHP plots a horizontal bar graph, with bars each taking up a fraction of the available height. #barHeight should be in (0, 1].

func PlotBarsHV ¶

func PlotBarsHV(label string, vs interface{}, barHeight, y0 float64)

PlotBarsHV plots a horizontal bar graph, with bars centering at y0, y0+1, y0+2, ... y0+N-1, Each taking up a fraction of the available height. #barHeight should be in (0, 1].

func PlotBarsHXY ¶

func PlotBarsHXY(label string, vx, vy interface{}, barHeight float64)

PlotBarsHXY plots a horizontal bar graph, with bars each taking up a fraction of the available height. #barHeight should be in (0, 1].

func PlotBarsP ¶

func PlotBarsP(label string, ps []Point, barWidth float64)

PlotBarsP plots a vertical bar graph, with bars each taking up a fraction of the available width. #barWidthFraction should be in (0, 1].

func PlotBarsV ¶

func PlotBarsV(label string, vs interface{}, barWidth, x0 float64)

PlotBarsV plots a vertical bar graph, with bars centering at x0, x0+1, x0+2, ... x0+N-1, Each taking up a fraction of the available width. #barWidth should be in (0, 1].

func PlotBarsXY ¶

func PlotBarsXY(label string, vx, vy interface{}, barWidth float64)

PlotBarsXY plots a vertical bar graph, with bars each taking up a fraction of the available width. #barWidth should be in (0, 1].

func PlotHistogram ¶

func PlotHistogram(label string, values []float32)

PlotHistogram draws an array of floats as a bar graph. It calls PlotHistogramV using no overlay text and automatically calculated scale and graph size.

func PlotHistogramV ¶

func PlotHistogramV(label string, values []float32, valuesOffset int, overlayText string, scaleMin float32, scaleMax float32, graphSize Vec2)

PlotHistogramV draws an array of floats as a bar graph with additional options. valuesOffset specifies an offset into the values array at which to start drawing, wrapping around when the end of the values array is reached. overlayText specifies a string to print on top of the graph. scaleMin and scaleMax define the scale of the y axis, if either is math.MaxFloat32 that value is calculated from the input data. graphSize defines the size of the graph, if either coordinate is zero the default size for that direction is used.

func PlotLine ¶

func PlotLine(label string, values interface{})

PlotLine plots a standard 2D line plot with minimal parameters. It calls PlotLineV(label, values, 1, 0).

func PlotLineG ¶

func PlotLineG(label string, getter DataGetter, userData interface{}, count int)

PlotLineG plots a standard 2D line plot from a series of points obtained from a callback.

func PlotLineP ¶

func PlotLineP(label string, points []Point)

PlotLineP plots a standard 2D line plot from a slice of points.

func PlotLineV ¶

func PlotLineV(label string, values interface{}, xscale, x0 float64)

PlotLineV plots a standard 2D line plot with all parameters.

func PlotLineXY ¶

func PlotLineXY(label string, xs, ys interface{})

PlotLineXY plots a standard 2D line plot from slices of X/Y coords.

func PlotLines ¶

func PlotLines(label string, values []float32)

PlotLines draws an array of floats as a line graph. It calls PlotLinesV using no overlay text and automatically calculated scale and graph size.

func PlotLinesV ¶

func PlotLinesV(label string, values []float32, valuesOffset int, overlayText string, scaleMin float32, scaleMax float32, graphSize Vec2)

PlotLinesV draws an array of floats as a line graph with additional options. valuesOffset specifies an offset into the values array at which to start drawing, wrapping around when the end of the values array is reached. overlayText specifies a string to print on top of the graph. scaleMin and scaleMax define the scale of the y axis, if either is math.MaxFloat32 that value is calculated from the input data. graphSize defines the size of the graph, if either coordinate is zero the default size for that direction is used.

func PlotScatter ¶

func PlotScatter(label string, values interface{})

PlotScatter plots a standard 2D scatter plot with minimal parameters. It calls PlotScatterV(label, values, 1, 0).

Default marker is ImPlotMarker_Circle.

func PlotScatterG ¶

func PlotScatterG(label string, getter DataGetter, userData interface{}, count int)

PlotScatterG plots a standard 2D scatter plot from a series of points obtained from a callback.

Default marker is ImPlotMarker_Circle.

func PlotScatterP ¶

func PlotScatterP(label string, points []Point)

PlotScatterP plots a standard 2D scatter plot from a slice of points.

Default marker is ImPlotMarker_Circle.

func PlotScatterV ¶

func PlotScatterV(label string, values interface{}, xscale, x0 float64)

PlotScatterV plots a standard 2D scatter plot with all parameters.

Default marker is ImPlotMarker_Circle.

func PlotScatterXY ¶

func PlotScatterXY(label string, xs, ys interface{})

PlotScatterXY plots a standard 2D scatter plot from slices of X/Y coords.

Default marker is ImPlotMarker_Circle.

func PlotShadedLines ¶

func PlotShadedLines(label string, vs0, vs1 interface{})

PlotShadedLines plots a shaded (filled) region between two lines, without the lines themselves. It calls PlotShadedLinesV(label, vs0, vs1, 1, 0).

func PlotShadedLinesG ¶

func PlotShadedLinesG(label string, get1 DataGetter, data1 interface{}, get2 DataGetter, data2 interface{}, count int)

PlotShadedLinesG plots a shaded (filled) region between two lines, without the lines themselves.

The X component of the second getter is discarded.

func PlotShadedLinesV ¶

func PlotShadedLinesV(label string, vs0, vs1 interface{}, xscale, x0 float64)

PlotShadedLinesV plots a shaded (filled) region between two lines, without the lines themselves.

func PlotShadedLinesXY ¶

func PlotShadedLinesXY(label string, xs, ys1, ys2 interface{})

PlotShadedLinesXY plots a shaded (filled) region between two lines, without the lines themselves.

func PlotShadedRef ¶

func PlotShadedRef(label string, values interface{})

PlotShadedRef plots a shaded (filled) region between a line and a horizontal reference. It calls PlotShadedV(label, values, 0, 1, 0).

func PlotShadedRefG ¶

func PlotShadedRefG(label string, getter DataGetter, userData interface{}, count int, yref float64)

PlotShadedRefG plots a shaded (filled) region between a line and a horizontal reference.

Set yref to +/-INFINITY for infinite fill extents.

func PlotShadedRefP ¶

func PlotShadedRefP(label string, points []Point, yref float64)

PlotShadedRefP plots a shaded (filled) region between a line and a horizontal reference.

Set yref to +/-INFINITY for infinite fill extents.

func PlotShadedRefV ¶

func PlotShadedRefV(label string, values interface{}, yref, xscale, x0 float64)

PlotShadedRefV plots a shaded (filled) region between a line and a horizontal reference.

Set yref to +/-INFINITY for infinite fill extents.

func PlotShadedRefXY ¶

func PlotShadedRefXY(label string, xs, ys interface{}, yref float64)

PlotShadedRefXY plots a shaded (filled) region between a line and a horizontal reference.

Set yref to +/-INFINITY for infinite fill extents.

func PlotStairs ¶

func PlotStairs(label string, values interface{})

PlotStairs plots a stairstep graph with minimal parameters. It calls PlotStairsV(label, values, 1, 0).