giu

package module
v0.0.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 9, 2021 License: MIT Imports: 20 Imported by: 0

README

giu

Go Report Card Build Status Godoc Card

Cross platform rapid GUI framework for golang based on Dear ImGui and the great golang binding imgui-go.

Any contribution (features, widgets, tutorials, documents and etc...) is appreciated!

Supported Platforms

giu is built upon GLFW v3.3, so idealy giu could support all platforms that GLFW v3.3 supports.

  • Windows (only tested on Windows 10 x64)
  • MacOS (only tested on MacOS v10.15)
  • Linux (thanks remeh to test it)
  • Raspberry pi 3b (thanks sndvaps to test it)

Features

Compare to other Dear ImGui golang bindings, giu has following features:

  • Small executable file size (<3mb after upx compression for the example/helloworld demo).
  • Live-update during the resizing of OS window (implemented on GLFW 3.3 and OpenGL 3.2).
  • Support to display various languages without any font setting. Giu will rebuild font atlas incrementally according to texts in UI between frames. Below is the list of languages currently support.
    • MacOS
      1. English
      2. Simplified Chinese
      3. Japanese
      4. Korean
    • Windows
      1. English
      2. Simplified Chinese
      3. Japanese
    • Kali Linux
      1. English
    • Need your help to add more language support by creating PR or tell me the OS default font name for your language.
  • Redraw only when user event occurred. Costs only 0.5% CPU usage with 60FPS.
  • Declarative UI (see examples for more detail).
  • DPI awareness (auto scale font and UI to adapte high DPI monitor).
  • Drop in usage, no need to implement render and platform.
  • OS clipboard support.

Screenshot Screenshot1 Screenshot2

Hello world

package main

import (
	"fmt"

	g "github.com/AllenDang/giu"
)

func onClickMe() {
	fmt.Println("Hello world!")
}

func onImSoCute() {
	fmt.Println("Im sooooooo cute!!")
}

func loop() {
	g.SingleWindow("hello world").Layout(
		g.Label("Hello world from giu"),
		g.Row(
			g.Button("Click Me").OnClick(onClickMe),
			g.Button("I'm so cute").OnClick(onImSoCute),
		),
	)
}

func main() {
	wnd := g.NewMasterWindow("Hello world", 400, 200, g.MasterWindowFlagsNotResizable, nil)
	wnd.Run(loop)
}

Here is result.

Helloworld

Quick intruduction

What is immediate mode GUI?

Immediate mode GUI system means the UI control doesn't retain it's state and value. For example, call giu.InputText("ID", &str) will display a input text box on screen, and the user entered value will be stored in &str, input text box doesn't know anything about it.

And the loop method in the Hello world example is in charge of drawing all widgets based on the parameters passed into them. This method will be invoked 30 times per second to reflect interactive states (like clicked, hovered, value-changed etc...). It will be the place you define the UI structure.

The layout and sizing system

By default, any widget is placed inside a container's Layout will be place vertically.

To create a row of widgets (aka place widgets one by one horizontally), use Row() method. For example giu.Row(Label(...), Button(...)) will create a Label next to a Button.

To creata a column of widgets (aka place widgets one by one vertically) inside a row, use Column() method.

Any widget which has a Size() method, could set it's size explicitly. Note you could pass negative value to Size(), it means avaiable remain width/height - value. For example, InputText(...).Size(-1) will create a input text box with longest width it's container has lefted.

Containers
MasterWindow

A MasterWindow means the platform native window implemented by OS. All sub window and widgets will be placed inside it.

Window

A Window is a container with a title bar, and could be collapsed. SingleWindow is a special kind of window who will occupy all avaialbe space of MasterWindow.

Child

A Child is like a panel in other GUI framework, it could have a background color and border.

Widgets

Check examples/widgets for all kinds of widgets.

Install

The backend of giu depends on OpenGL 3.3, make sure your environment supports it (so far as I known some Virual Machine like VirualBox doesn`t support it).

MacOS
xcode-select --install
go get github.com/AllenDang/giu@master
Windows
  1. Install mingw download here. Thanks @alchem1ster!
  2. Add the binaries folder of mingw to the path (usually is \mingw64\bin).
  3. go get github.com/AllenDang/giu@master.
Linux

First you need to install libraries

# apt install libx11-dev libxcursor-dev libxrandr-dev libxinerama-dev libxi-dev libglx-dev libgl1-mesa-dev libxxf86vm-dev

Then simple go build will work.

Cross-compiling is a bit more complicated. Let's say that you want to build for arm64. That's what you would need to do:

# dpkg --add-architecture arm64
# apt update
# apt install gcc-aarch64-linux-gnu g++-aarch64-linux-gnu \
    libx11-dev:arm64 libxcursor-dev:arm64 libxrandr-dev:arm64 libxinerama-dev:arm64 libxi-dev:arm64 libglx-dev:arm64 libgl1-mesa-dev:arm64 libxxf86vm-dev:arm64
$ GOOS=linux GOARCH=arm64 CGO_ENABLED=1 CC=aarch64-linux-gnu-gcc CXX=aarch64-linux-gnu-g++ HOST=aarch64-linux-gnu go build -v

Deploy

Build MacOS version on MacOS.
go build -ldflags "-s -w" .
Build Windows version on Windows.
go build -ldflags "-s -w -H=windowsgui -extldflags=-static" .
Build Windows version on MacOS.
  1. Install mingw-64.
brew install mingw-w64
  1. Prepare and embed application icon to executable and build.
cat > YourExeName.rc << EOL
id ICON "./res/app_win.ico"
GLFW_ICON ICON "./res/app_win.ico"
EOL

x86_64-w64-mingw32-windres YourExeName.rc -O coff -o YourExeName.syso
GOOS=windows GOARCH=amd64 CGO_ENABLED=1 CC=x86_64-w64-mingw32-gcc CXX=x86_64-w64-mingw32-g++ HOST=x86_64-w64-mingw32 go build -ldflags "-s -w -H=windowsgui -extldflags=-static" -p 4 -v -o YourExeName.exe

rm YourExeName.syso
rm YourExeName.rc

Document

Check Wiki

Contribution

All kinds of pull request (document, demo, screenshots, code, etc...) are more then welcome!

Projects using giu

PipeIt

PipeIt is a text transformation, conversion, cleansing and extraction tool.

PipeIt Demo

NVTool

NVTool is a video encoding tool based on NVEncC.

NVTool Screenshots

Documentation

Index

Constants

View Source
const (
	DirectionLeft  = iota
	DirectionRight = iota
	DirectionUp    = iota
	DirectionDown  = iota
)
View Source
const (
	TextureFilterNearest = iota
	TextureFilterLinear
	TextureFilterNearestMipmapNearest
	TextureFilterLinearMipmapNearest
	TextureFilterNearestMipmapLinear
	TextureFilterLinearMipmapLinear
)

Texture filtering types.

Variables

View Source
var (
	Context context
)

Functions

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 CalcTextSize

func CalcTextSize(text string) (width, height float32)

func CloseCurrentPopup

func CloseCurrentPopup()

func GetAvaiableRegion

func GetAvaiableRegion() (width, height float32)

func GetCursorPos

func GetCursorPos() image.Point

func GetCursorScreenPos

func GetCursorScreenPos() image.Point

func GetFramePadding

func GetFramePadding() (float32, float32)

func GetItemInnerSpacing

func GetItemInnerSpacing() (float32, float32)

func GetItemSpacing

func GetItemSpacing() (float32, float32)

func GetMousePos

func GetMousePos() image.Point

func GetWindowPadding

func GetWindowPadding() (float32, float32)

func IsItemActive

func IsItemActive() bool

func IsItemClicked

func IsItemClicked(mouseButton MouseButton) bool

func IsItemHovered

func IsItemHovered() bool

func IsKeyDown

func IsKeyDown(key Key) bool

func IsKeyPressed

func IsKeyPressed(key Key) bool

func IsKeyReleased

func IsKeyReleased(key Key) bool

func IsMouseClicked

func IsMouseClicked(button MouseButton) bool

func IsMouseDoubleClicked

func IsMouseDoubleClicked(button MouseButton) bool

func IsMouseDown

func IsMouseDown(button MouseButton) bool

func IsMouseReleased

func IsMouseReleased(button MouseButton) bool

func IsWindowAppearing

func IsWindowAppearing() bool

func IsWindowCollapsed

func IsWindowCollapsed() bool

func IsWindowFocused

func IsWindowFocused(flags FocusedFlags) bool

func IsWindowHovered

func IsWindowHovered(flags HoveredFlags) bool

func LoadImage

func LoadImage(imgPath string) (*image.RGBA, error)

func Msgbox

func Msgbox(title, content string)

func MsgboxV

func MsgboxV(title, content string, buttons MsgboxButtons, resultCallback func(DialogResult))

func OpenPopup

func OpenPopup(name string)

func PopClipRect

func PopClipRect()

func PopFont

func PopFont()

func PopItemWidth

func PopItemWidth()

func PopStyle

func PopStyle()

func PopStyleColor

func PopStyleColor()

func PopStyleColorV

func PopStyleColorV(count int)

func PopStyleV

func PopStyleV(count int)

func PopTextWrapPos

func PopTextWrapPos()

func PushButtonTextAlign

func PushButtonTextAlign(width, height float32)

Alignment for button text. Defaults to (0.0f,0.5f) for left-aligned,vertically centered.

func PushClipRect

func PushClipRect(clipRectMin, clipRectMax image.Point, intersectWithClipRect bool)

func PushColorButton

func PushColorButton(col color.RGBA)

func PushColorButtonActive

func PushColorButtonActive(col color.RGBA)

func PushColorButtonHovered

func PushColorButtonHovered(col color.RGBA)

func PushColorFrameBg

func PushColorFrameBg(col color.RGBA)

func PushColorText

func PushColorText(col color.RGBA)

func PushColorTextDisabled

func PushColorTextDisabled(col color.RGBA)

func PushColorWindowBg

func PushColorWindowBg(col color.RGBA)

func PushFont

func PushFont(font *FontInfo) bool

func PushFramePadding

func PushFramePadding(width, height float32)

func PushItemSpacing

func PushItemSpacing(width, height float32)

func PushItemWidth

func PushItemWidth(width float32)

func PushSelectableTextAlign

func PushSelectableTextAlign(width, height float32)

Alignment for selectable text. Defaults to (0.0f,0.5f) for left-aligned,vertically centered.

func PushTextWrapPos

func PushTextWrapPos()

func PushWindowPadding

func PushWindowPadding(width, height float32)

func SameLine

func SameLine()

func SetItemDefaultFocus

func SetItemDefaultFocus()

func SetKeyboardFocusHere

func SetKeyboardFocusHere()

func SetKeyboardFocusHereV

func SetKeyboardFocusHereV(i int)

func SetMouseCursor

func SetMouseCursor(cursor MouseCursorType)

func SetNextWindowPos

func SetNextWindowPos(x, y float32)

func SetNextWindowSize

func SetNextWindowSize(width, height float32)

func SetNextWindowSizeV

func SetNextWindowSizeV(width, height float32, condition ExecCondition)

func ToVec2

func ToVec2(pt image.Point) imgui.Vec2

func ToVec4Color

func ToVec4Color(col color.RGBA) imgui.Vec4

func Update

func Update()

func Vec4ToRGBA

func Vec4ToRGBA(vec4 imgui.Vec4) color.RGBA

Types

type ArrowButtonWidget

type ArrowButtonWidget struct {
	// contains filtered or unexported fields
}

func ArrowButton

func ArrowButton(id string, dir Direction) *ArrowButtonWidget

func (*ArrowButtonWidget) Build

func (ab *ArrowButtonWidget) Build()

func (*ArrowButtonWidget) OnClick

func (b *ArrowButtonWidget) OnClick(onClick func()) *ArrowButtonWidget

type BulletTextWidget

type BulletTextWidget struct {
	// contains filtered or unexported fields
}

func BulletText

func BulletText(text string) *BulletTextWidget

func (*BulletTextWidget) Build

func (bt *BulletTextWidget) Build()

type BulletWidget

type BulletWidget struct{}

func Bullet

func Bullet() *BulletWidget

func (*BulletWidget) Build

func (b *BulletWidget) Build()

type ButtonWidget

type ButtonWidget struct {
	// contains filtered or unexported fields
}

func Button

func Button(id string) *ButtonWidget

func (*ButtonWidget) Build

func (b *ButtonWidget) Build()

func (*ButtonWidget) OnClick

func (b *ButtonWidget) OnClick(onClick func()) *ButtonWidget

func (*ButtonWidget) Size

func (b *ButtonWidget) Size(width, height float32) *ButtonWidget

type Canvas

type Canvas struct {
	// contains filtered or unexported fields
}

func GetCanvas

func GetCanvas() *Canvas

func (*Canvas) AddBezierCubic

func (c *Canvas) AddBezierCubic(pos0, cp0, cp1, pos1 image.Point, color color.RGBA, thickness float32, num_segments int)

func (*Canvas) AddCircle

func (c *Canvas) AddCircle(center image.Point, radius float32, color color.RGBA, thickness float32)

func (*Canvas) AddCircleFilled

func (c *Canvas) AddCircleFilled(center image.Point, radius float32, color color.RGBA)

func (*Canvas) AddImage

func (c *Canvas) AddImage(texture *Texture, pMin, pMax image.Point)

func (*Canvas) AddImageV

func (c *Canvas) AddImageV(texture *Texture, pMin, pMax image.Point, uvMin, uvMax image.Point, color color.RGBA)

func (*Canvas) AddLine

func (c *Canvas) AddLine(p1, p2 image.Point, color color.RGBA, thickness float32)

func (*Canvas) AddQuad

func (c *Canvas) AddQuad(p1, p2, p3, p4 image.Point, color color.RGBA, thickness float32)

func (*Canvas) AddQuadFilled

func (c *Canvas) AddQuadFilled(p1, p2, p3, p4 image.Point, color color.RGBA)

func (*Canvas) AddRect

func (c *Canvas) AddRect(pMin, pMax image.Point, color color.RGBA, rounding float32, rounding_corners DrawFlags, thickness float32)

func (*Canvas) AddRectFilled

func (c *Canvas) AddRectFilled(pMin, pMax image.Point, color color.RGBA, rounding float32, rounding_corners DrawFlags)

func (*Canvas) AddText

func (c *Canvas) AddText(pos image.Point, color color.RGBA, text string)

func (*Canvas) AddTriangle

func (c *Canvas) AddTriangle(p1, p2, p3 image.Point, color color.RGBA, thickness float32)

func (*Canvas) AddTriangleFilled

func (c *Canvas) AddTriangleFilled(p1, p2, p3 image.Point, color color.RGBA)

func (*Canvas) PathArcTo

func (c *Canvas) PathArcTo(center image.Point, radius, a_min, a_max float32, num_segments int)

func (*Canvas) PathArcToFast

func (c *Canvas) PathArcToFast(center image.Point, radius float32, a_min_of_12, a_max_of_12 int)

func (*Canvas) PathBezierCubicCurveTo

func (c *Canvas) PathBezierCubicCurveTo(p1, p2, p3 image.Point, num_segments int)

func (*Canvas) PathClear

func (c *Canvas) PathClear()

func (*Canvas) PathFillConvex

func (c *Canvas) PathFillConvex(color color.RGBA)

func (*Canvas) PathLineTo

func (c *Canvas) PathLineTo(pos image.Point)

func (*Canvas) PathLineToMergeDuplicate

func (c *Canvas) PathLineToMergeDuplicate(pos image.Point)

func (*Canvas) PathStroke

func (c *Canvas) PathStroke(color color.RGBA, closed bool, thickness float32)

type CheckboxWidget

type CheckboxWidget struct {
	// contains filtered or unexported fields
}

func Checkbox

func Checkbox(text string, selected *bool) *CheckboxWidget

func (*CheckboxWidget) Build

func (c *CheckboxWidget) Build()

func (*CheckboxWidget) OnChange

func (c *CheckboxWidget) OnChange(onChange func()) *CheckboxWidget

type ChildWidget

type ChildWidget struct {
	// contains filtered or unexported fields
}

func Child

func Child(id string) *ChildWidget

func (*ChildWidget) Border

func (c *ChildWidget) Border(border bool) *ChildWidget

func (*ChildWidget) Build

func (c *ChildWidget) Build()

func (*ChildWidget) Flags

func (c *ChildWidget) Flags(flags WindowFlags) *ChildWidget

func (*ChildWidget) Layout

func (c *ChildWidget) Layout(widgets ...Widget) *ChildWidget

func (*ChildWidget) Size

func (c *ChildWidget) Size(width, height float32) *ChildWidget

type CodeEditorWidget

type CodeEditorWidget struct {
	// contains filtered or unexported fields
}

func CodeEditor

func CodeEditor(title string) *CodeEditorWidget

func (*CodeEditorWidget) Copy

func (ce *CodeEditorWidget) Copy()

func (*CodeEditorWidget) Cut

func (ce *CodeEditorWidget) Cut()

func (*CodeEditorWidget) Delete

func (ce *CodeEditorWidget) Delete()

func (*CodeEditorWidget) GetCurrentLineText

func (ce *CodeEditorWidget) GetCurrentLineText() string

func (*CodeEditorWidget) GetCursorPos

func (ce *CodeEditorWidget) GetCursorPos() (int, int)

func (*CodeEditorWidget) GetScreenCursorPos

func (ce *CodeEditorWidget) GetScreenCursorPos() (int, int)

func (*CodeEditorWidget) GetSelectedText

func (ce *CodeEditorWidget) GetSelectedText() string

func (*CodeEditorWidget) GetSelectionStart

func (ce *CodeEditorWidget) GetSelectionStart() (int, int)

func (*CodeEditorWidget) GetText

func (ce *CodeEditorWidget) GetText() string

func (*CodeEditorWidget) GetWordUnderCursor

func (ce *CodeEditorWidget) GetWordUnderCursor() string

func (*CodeEditorWidget) HasSelection

func (ce *CodeEditorWidget) HasSelection() bool

func (*CodeEditorWidget) InsertText

func (ce *CodeEditorWidget) InsertText(text string)

func (*CodeEditorWidget) IsTextChanged

func (ce *CodeEditorWidget) IsTextChanged() bool

func (*CodeEditorWidget) Paste

func (ce *CodeEditorWidget) Paste()

func (*CodeEditorWidget) Render

func (ce *CodeEditorWidget) Render(width, height float32, border bool)

func (*CodeEditorWidget) SelectWordUnderCursor

func (ce *CodeEditorWidget) SelectWordUnderCursor()

func (*CodeEditorWidget) SetErrorMarkers

func (ce *CodeEditorWidget) SetErrorMarkers(markers imgui.ErrorMarkers)

func (*CodeEditorWidget) SetHandleKeyboardInputs

func (ce *CodeEditorWidget) SetHandleKeyboardInputs(b bool)

func (*CodeEditorWidget) SetLanguageDefinitionC

func (ce *CodeEditorWidget) SetLanguageDefinitionC()

func (*CodeEditorWidget) SetLanguageDefinitionCPP

func (ce *CodeEditorWidget) SetLanguageDefinitionCPP()

func (*CodeEditorWidget) SetLanguageDefinitionLua

func (ce *CodeEditorWidget) SetLanguageDefinitionLua()

func (*CodeEditorWidget) SetLanguageDefinitionSQL

func (ce *CodeEditorWidget) SetLanguageDefinitionSQL()

func (*CodeEditorWidget) SetShowWhitespaces

func (ce *CodeEditorWidget) SetShowWhitespaces(s bool)

func (*CodeEditorWidget) SetTabSize

func (ce *CodeEditorWidget) SetTabSize(size int)

func (*CodeEditorWidget) SetText

func (ce *CodeEditorWidget) SetText(str string)

type ColorEditFlags

type ColorEditFlags int

ColorEditFlags for ColorEdit3V(), etc.

const (
	// ColorEditFlagsNone default = 0.
	ColorEditFlagsNone ColorEditFlags = 0
	// ColorEditFlagsNoAlpha ignores Alpha component (read 3 components from the input pointer).
	ColorEditFlagsNoAlpha ColorEditFlags = 1 << 1
	// ColorEditFlagsNoPicker disables picker when clicking on colored square.
	ColorEditFlagsNoPicker ColorEditFlags = 1 << 2
	// ColorEditFlagsNoOptions disables toggling options menu when right-clicking on inputs/small preview.
	ColorEditFlagsNoOptions ColorEditFlags = 1 << 3
	// ColorEditFlagsNoSmallPreview disables colored square preview next to the inputs. (e.g. to show only the inputs).
	ColorEditFlagsNoSmallPreview ColorEditFlags = 1 << 4
	// ColorEditFlagsNoInputs disables inputs sliders/text widgets (e.g. to show only the small preview colored square).
	ColorEditFlagsNoInputs ColorEditFlags = 1 << 5
	// ColorEditFlagsNoTooltip disables tooltip when hovering the preview.
	ColorEditFlagsNoTooltip ColorEditFlags = 1 << 6
	// ColorEditFlagsNoLabel disables display of inline text label (the label is still forwarded to the tooltip and picker).
	ColorEditFlagsNoLabel ColorEditFlags = 1 << 7
	// ColorEditFlagsNoSidePreview disables bigger color preview on right side of the picker, use small colored square preview instead.
	ColorEditFlagsNoSidePreview ColorEditFlags = 1 << 8
	// ColorEditFlagsNoDragDrop disables drag and drop target. ColorButton: disable drag and drop source.
	ColorEditFlagsNoDragDrop ColorEditFlags = 1 << 9
	// ColorEditFlagsNoBorder disables border (which is enforced by default).
	ColorEditFlagsNoBorder ColorEditFlags = 1 << 10

	// ColorEditFlagsAlphaBar shows vertical alpha bar/gradient in picker.
	ColorEditFlagsAlphaBar ColorEditFlags = 1 << 16
	// ColorEditFlagsAlphaPreview displays preview as a transparent color over a checkerboard, instead of opaque.
	ColorEditFlagsAlphaPreview ColorEditFlags = 1 << 17
	// ColorEditFlagsAlphaPreviewHalf displays half opaque / half checkerboard, instead of opaque.
	ColorEditFlagsAlphaPreviewHalf ColorEditFlags = 1 << 18
	// ColorEditFlagsHDR = (WIP) surrently only disable 0.0f..1.0f limits in RGBA edition.
	// Note: you probably want to use ImGuiColorEditFlags_Float flag as well.
	ColorEditFlagsHDR ColorEditFlags = 1 << 19
	// ColorEditFlagsRGB sets the format as RGB.
	ColorEditFlagsRGB ColorEditFlags = 1 << 20
	// ColorEditFlagsHSV sets the format as HSV.
	ColorEditFlagsHSV ColorEditFlags = 1 << 21
	// ColorEditFlagsHEX sets the format as HEX.
	ColorEditFlagsHEX ColorEditFlags = 1 << 22
	// ColorEditFlagsUint8 _display_ values formatted as 0..255.
	ColorEditFlagsUint8 ColorEditFlags = 1 << 23
	// ColorEditFlagsFloat _display_ values formatted as 0.0f..1.0f floats instead of 0..255 integers. No round-trip of value via integers.
	ColorEditFlagsFloat ColorEditFlags = 1 << 24

	// ColorEditFlagsPickerHueBar shows bar for Hue, rectangle for Sat/Value.
	ColorEditFlagsPickerHueBar ColorEditFlags = 1 << 25
	// ColorEditFlagsPickerHueWheel shows wheel for Hue, triangle for Sat/Value.
	ColorEditFlagsPickerHueWheel ColorEditFlags = 1 << 26
	// ColorEditFlagsInputRGB enables input and output data in RGB format.
	ColorEditFlagsInputRGB ColorEditFlags = 1 << 27
	// ColorEditFlagsInputHSV enables input and output data in HSV format.
	ColorEditFlagsInputHSV ColorEditFlags = 1 << 28
)

type ColorEditWidget

type ColorEditWidget struct {
	// contains filtered or unexported fields
}

func ColorEdit

func ColorEdit(label string, color *color.RGBA) *ColorEditWidget

func (*ColorEditWidget) Build

func (ce *ColorEditWidget) Build()

func (*ColorEditWidget) Flags

func (*ColorEditWidget) OnChange

func (ce *ColorEditWidget) OnChange(cb func()) *ColorEditWidget

func (*ColorEditWidget) Size

func (ce *ColorEditWidget) Size(width float32) *ColorEditWidget

type ColumnWidget

type ColumnWidget struct {
	// contains filtered or unexported fields
}

func Column

func Column(widgets ...Widget) *ColumnWidget

Column layout will place all widgets one by one vertically.

func (*ColumnWidget) Build

func (g *ColumnWidget) Build()

type ComboCustomWidget

type ComboCustomWidget struct {
	// contains filtered or unexported fields
}

func ComboCustom

func ComboCustom(label, previewValue string) *ComboCustomWidget

func (*ComboCustomWidget) Build

func (cc *ComboCustomWidget) Build()

func (*ComboCustomWidget) Flags

func (*ComboCustomWidget) Layout

func (cc *ComboCustomWidget) Layout(widgets ...Widget) *ComboCustomWidget

func (*ComboCustomWidget) Size

func (cc *ComboCustomWidget) Size(width float32) *ComboCustomWidget

type ComboFlags

type ComboFlags int
const (
	// ComboFlagNone default ComboFlags = 0
	ComboFlagNone ComboFlags = 0
	// ComboFlagPopupAlignLeft aligns the popup toward the left by default.
	ComboFlagPopupAlignLeft ComboFlags = 1 << 0
	// ComboFlagHeightSmall has max ~4 items visible.
	// Tip: If you want your combo popup to be a specific size you can use SetNextWindowSizeConstraints() prior to calling BeginCombo().
	ComboFlagHeightSmall ComboFlags = 1 << 1
	// ComboFlagHeightRegular has max ~8 items visible (default).
	ComboFlagHeightRegular ComboFlags = 1 << 2
	// ComboFlagHeightLarge has max ~20 items visible.
	ComboFlagHeightLarge ComboFlags = 1 << 3
	// ComboFlagHeightLargest has as many fitting items as possible.
	ComboFlagHeightLargest ComboFlags = 1 << 4
	// ComboFlagNoArrowButton displays on the preview box without the square arrow button.
	ComboFlagNoArrowButton ComboFlags = 1 << 5
	// ComboFlagNoPreview displays only a square arrow button.
	ComboFlagNoPreview ComboFlags = 1 << 6
)

type ComboWidget

type ComboWidget struct {
	// contains filtered or unexported fields
}

func Combo

func Combo(label, previewValue string, items []string, selected *int32) *ComboWidget

func (*ComboWidget) Build

func (c *ComboWidget) Build()

func (*ComboWidget) Flags

func (c *ComboWidget) Flags(flags ComboFlags) *ComboWidget

func (*ComboWidget) OnChange

func (c *ComboWidget) OnChange(onChange func()) *ComboWidget

func (*ComboWidget) Size

func (c *ComboWidget) Size(width float32) *ComboWidget

type ConditionWidget

type ConditionWidget struct {
	// contains filtered or unexported fields
}

func Condition

func Condition(cond bool, layoutIf Layout, layoutElse Layout) *ConditionWidget

func (*ConditionWidget) Build

func (c *ConditionWidget) Build()

type ContextMenuWidget

type ContextMenuWidget struct {
	// contains filtered or unexported fields
}

func ContextMenu

func ContextMenu(label string) *ContextMenuWidget

func (*ContextMenuWidget) Build

func (c *ContextMenuWidget) Build()

func (*ContextMenuWidget) Layout

func (c *ContextMenuWidget) Layout(widgets ...Widget) *ContextMenuWidget

func (*ContextMenuWidget) MouseButton

func (c *ContextMenuWidget) MouseButton(mouseButton MouseButton) *ContextMenuWidget

type CustomWidget

type CustomWidget struct {
	// contains filtered or unexported fields
}

func Custom

func Custom(builder func()) *CustomWidget

func (*CustomWidget) Build

func (c *CustomWidget) Build()

type DatePickerWidget

type DatePickerWidget struct {
	// contains filtered or unexported fields
}

func DatePicker

func DatePicker(id string, date *time.Time) *DatePickerWidget

func (*DatePickerWidget) Build

func (d *DatePickerWidget) Build()

func (*DatePickerWidget) OnChange

func (d *DatePickerWidget) OnChange(onChange func()) *DatePickerWidget

func (*DatePickerWidget) Size

func (d *DatePickerWidget) Size(width float32) *DatePickerWidget

type DialogResult

type DialogResult uint8
const (
	DialogResultOK DialogResult = 1 << iota
	DialogResultCancel
	DialogResultYes
	DialogResultNo
)

type DialogResultCallback

type DialogResultCallback func(DialogResult)

type Direction

type Direction uint8

type Disposable

type Disposable interface {
	Dispose()
}

type DragIntWidget

type DragIntWidget struct {
	// contains filtered or unexported fields
}

func DragInt

func DragInt(label string, value *int32, min, max int32) *DragIntWidget

func (*DragIntWidget) Build

func (d *DragIntWidget) Build()

func (*DragIntWidget) Format

func (d *DragIntWidget) Format(format string) *DragIntWidget

func (*DragIntWidget) Speed

func (d *DragIntWidget) Speed(speed float32) *DragIntWidget

type DrawFlags

type DrawFlags int
const (
	DrawFlags_None                    DrawFlags = 0
	DrawFlags_Closed                  DrawFlags = 1 << 0 // PathStroke(), AddPolyline(): specify that shape should be closed (portant: this is always == 1 for legacy reason)
	DrawFlags_RoundCornersTopLeft     DrawFlags = 1 << 4 // AddRect(), AddRectFilled(), PathRect(): enable rounding top-left corner only (when rounding > 0.0f, we default to all corners). Was 0x01.
	DrawFlags_RoundCornersTopRight    DrawFlags = 1 << 5 // AddRect(), AddRectFilled(), PathRect(): enable rounding top-right corner only (when rounding > 0.0f, we default to all corners). Was 0x02.
	DrawFlags_RoundCornersBottomLeft  DrawFlags = 1 << 6 // AddRect(), AddRectFilled(), PathRect(): enable rounding bottom-left corner only (when rounding > 0.0f, we default to all corners). Was 0x04.
	DrawFlags_RoundCornersBottomRight DrawFlags = 1 << 7 // AddRect(), AddRectFilled(), PathRect(): enable rounding bottom-right corner only (when rounding > 0.0f, we default to all corners). Wax 0x08.
	DrawFlags_RoundCornersNone        DrawFlags = 1 << 8 // AddRect(), AddRectFilled(), PathRect(): disable rounding on all corners (when rounding > 0.0f). This is NOT zero, NOT an implicit flag!
	DrawFlags_RoundCornersTop         DrawFlags = DrawFlags_RoundCornersTopLeft | DrawFlags_RoundCornersTopRight
	DrawFlags_RoundCornersBottom      DrawFlags = DrawFlags_RoundCornersBottomLeft | DrawFlags_RoundCornersBottomRight
	DrawFlags_RoundCornersLeft        DrawFlags = DrawFlags_RoundCornersBottomLeft | DrawFlags_RoundCornersTopLeft
	DrawFlags_RoundCornersRight       DrawFlags = DrawFlags_RoundCornersBottomRight | DrawFlags_RoundCornersTopRight
	DrawFlags_RoundCornersAll         DrawFlags = DrawFlags_RoundCornersTopLeft | DrawFlags_RoundCornersTopRight | DrawFlags_RoundCornersBottomLeft | DrawFlags_RoundCornersBottomRight
	DrawFlags_RoundCornersDefault_    DrawFlags = DrawFlags_RoundCornersAll // Default to ALL corners if none of the _RoundCornersXX flags are specified.
	DrawFlags_RoundCornersMask_       DrawFlags = DrawFlags_RoundCornersAll | DrawFlags_RoundCornersNone
)

type DummyWidget

type DummyWidget struct {
	// contains filtered or unexported fields
}

func Dummy

func Dummy(width, height float32) *DummyWidget

func (*DummyWidget) Build

func (d *DummyWidget) Build()

type ExecCondition

type ExecCondition imgui.Condition
const (
	ConditionAlways       ExecCondition = ExecCondition(imgui.ConditionAlways)
	ConditionOnce         ExecCondition = ExecCondition(imgui.ConditionOnce)
	ConditionFirstUseEver ExecCondition = ExecCondition(imgui.ConditionFirstUseEver)
	ConditionAppearing    ExecCondition = ExecCondition(imgui.ConditionAppearing)
)

type FocusedFlags

type FocusedFlags int
const (
	// FocusedFlagsNone default FocusedFlags = 0
	FocusedFlagsNone FocusedFlags = 0
	// FocusedFlagsChildWindows matches if any children of the window is focused
	FocusedFlagsChildWindows FocusedFlags = 1 << 0
	// FocusedFlagsRootWindow tests from root window (top most parent of the current hierarchy)
	FocusedFlagsRootWindow FocusedFlags = 1 << 1
	// FocusedFlagsAnyWindow matches if any window is focused.
	FocusedFlagsAnyWindow FocusedFlags = 1 << 2
	// FocusedFlagsRootAndChildWindows combines FocusedFlagsRootWindow and FocusedFlagsChildWindows.
	FocusedFlagsRootAndChildWindows = FocusedFlagsRootWindow | FocusedFlagsChildWindows
)

type FontInfo

type FontInfo struct {
	// contains filtered or unexported fields
}

func AddFont

func AddFont(fontName string, size float32) *FontInfo

Add font by name, if the font is found, return *FontInfo, otherwise return nil.

func AddFontByMemory

func AddFontByMemory(fontName string, fontData []byte, size float32) *FontInfo

func (*FontInfo) String

func (f *FontInfo) String() string

type HSplitterWidget

type HSplitterWidget struct {
	// contains filtered or unexported fields
}

func HSplitter

func HSplitter(id string, delta *float32) *HSplitterWidget

func (*HSplitterWidget) Build

func (h *HSplitterWidget) Build()

func (*HSplitterWidget) Size

func (h *HSplitterWidget) Size(width, height float32) *HSplitterWidget

type HoveredFlags

type HoveredFlags int
const (
	// HoveredFlagsNone is the default and matches if directly over the item/window, not obstructed by another window, not obstructed by an active popup or modal blocking inputs under them.
	HoveredFlagsNone HoveredFlags = 0
	// HoveredFlagsChildWindows is for IsWindowHovered() and matches if any children of the window is hovered
	HoveredFlagsChildWindows HoveredFlags = 1 << 0
	// HoveredFlagsRootWindow is for IsWindowHovered() and tests from root window (top most parent of the current hierarchy)
	HoveredFlagsRootWindow HoveredFlags = 1 << 1
	// HoveredFlagsAnyWindow is for IsWindowHovered() and matches if any window is hovered
	HoveredFlagsAnyWindow HoveredFlags = 1 << 2
	// HoveredFlagsAllowWhenBlockedByPopup matches even if a popup window is normally blocking access to this item/window
	HoveredFlagsAllowWhenBlockedByPopup HoveredFlags = 1 << 3
	// HoveredFlagsAllowWhenBlockedByModal matches even if a modal popup window is normally blocking access to this item/window. UNIMPLEMENTED in imgui.
	// HoveredFlagsAllowWhenBlockedByModal  HoveredFlags   = 1 << 4
	// HoveredFlagsAllowWhenBlockedByActiveItem matches true even if an active item is blocking access to this item/window. Useful for Drag and Drop patterns.
	HoveredFlagsAllowWhenBlockedByActiveItem HoveredFlags = 1 << 5
	// HoveredFlagsAllowWhenOverlapped matches even if the position is obstructed or overlapped by another window
	HoveredFlagsAllowWhenOverlapped HoveredFlags = 1 << 6
	// HoveredFlagsAllowWhenDisabled matches even if the item is disabled
	HoveredFlagsAllowWhenDisabled HoveredFlags = 1 << 7
	// HoveredFlagsRectOnly combines HoveredFlagsAllowWhenBlockedByPopup, HoveredFlagsAllowWhenBlockedByActiveItem, and HoveredFlagsAllowWhenOverlapped.
	HoveredFlagsRectOnly HoveredFlags = HoveredFlagsAllowWhenBlockedByPopup | HoveredFlagsAllowWhenBlockedByActiveItem | HoveredFlagsAllowWhenOverlapped
	// HoveredFlagsRootAndChildWindows combines HoveredFlagsRootWindow and HoveredFlagsChildWindows.
	HoveredFlagsRootAndChildWindows HoveredFlags = HoveredFlagsRootWindow | HoveredFlagsChildWindows
)

type ImPlotYAxis

type ImPlotYAxis int
const (
	ImPlotYAxisLeft          ImPlotYAxis = 0 // left (default)
	ImPlotYAxisFirstOnRight  ImPlotYAxis = 1 // first on right side
	ImPlotYAxisSecondOnRight ImPlotYAxis = 2 // second on right side
)

type ImageButtonWidget

type ImageButtonWidget struct {
	// contains filtered or unexported fields
}

func ImageButton

func ImageButton(texture *Texture) *ImageButtonWidget

func (*ImageButtonWidget) BgColor

func (b *ImageButtonWidget) BgColor(bgColor color.RGBA) *ImageButtonWidget

func (*ImageButtonWidget) Build

func (i *ImageButtonWidget) Build()

func (*ImageButtonWidget) FramePadding

func (b *ImageButtonWidget) FramePadding(padding int) *ImageButtonWidget

func (*ImageButtonWidget) OnClick

func (b *ImageButtonWidget) OnClick(onClick func()) *ImageButtonWidget

func (*ImageButtonWidget) Size

func (b *ImageButtonWidget) Size(width, height float32) *ImageButtonWidget

func (*ImageButtonWidget) TintColor

func (b *ImageButtonWidget) TintColor(tintColor color.RGBA) *ImageButtonWidget

func (*ImageButtonWidget) UV

type ImageState

type ImageState struct {
	// contains filtered or unexported fields
}

func (*ImageState) Dispose

func (is *ImageState) Dispose()

type ImageWidget

type ImageWidget struct {
	// contains filtered or unexported fields
}

func Image

func Image(texture *Texture) *ImageWidget

func (*ImageWidget) BorderCol

func (i *ImageWidget) BorderCol(borderColor color.RGBA) *ImageWidget

func (*ImageWidget) Build

func (i *ImageWidget) Build()

func (*ImageWidget) Size

func (i *ImageWidget) Size(width, height float32) *ImageWidget

func (*ImageWidget) TintColor

func (i *ImageWidget) TintColor(tintColor color.RGBA) *ImageWidget

func (*ImageWidget) Uv

func (i *ImageWidget) Uv(uv0, uv1 image.Point) *ImageWidget

type ImageWithFileWidget

type ImageWithFileWidget struct {
	// contains filtered or unexported fields
}

func ImageWithFile

func ImageWithFile(imgPath string) *ImageWithFileWidget

func (*ImageWithFileWidget) Build

func (i *ImageWithFileWidget) Build()

func (*ImageWithFileWidget) Size

func (i *ImageWithFileWidget) Size(width, height float32) *ImageWithFileWidget

type ImageWithRgbaWidget

type ImageWithRgbaWidget struct {
	// contains filtered or unexported fields
}

func ImageWithRgba

func ImageWithRgba(rgba *image.RGBA) *ImageWithRgbaWidget

func (*ImageWithRgbaWidget) Build

func (i *ImageWithRgbaWidget) Build()

func (*ImageWithRgbaWidget) Size

func (i *ImageWithRgbaWidget) Size(width, height float32) *ImageWithRgbaWidget

type ImageWithUrlWidget

type ImageWithUrlWidget struct {
	// contains filtered or unexported fields
}

func ImageWithUrl

func ImageWithUrl(url string) *ImageWithUrlWidget

func (*ImageWithUrlWidget) Build

func (i *ImageWithUrlWidget) Build()

func (*ImageWithUrlWidget) LayoutForFailure

func (i *ImageWithUrlWidget) LayoutForFailure(widgets ...Widget) *ImageWithUrlWidget

func (*ImageWithUrlWidget) LayoutForLoading

func (i *ImageWithUrlWidget) LayoutForLoading(widgets ...Widget) *ImageWithUrlWidget

func (*ImageWithUrlWidget) OnFailure

func (i *ImageWithUrlWidget) OnFailure(onFailure func(error)) *ImageWithUrlWidget

func (*ImageWithUrlWidget) OnReady

func (i *ImageWithUrlWidget) OnReady(onReady func()) *ImageWithUrlWidget

Event trigger when image is downloaded and ready to display.

func (*ImageWithUrlWidget) Size

func (i *ImageWithUrlWidget) Size(width, height float32) *ImageWithUrlWidget

func (*ImageWithUrlWidget) Timeout

func (i *ImageWithUrlWidget) Timeout(downloadTimeout time.Duration) *ImageWithUrlWidget

type InputFloatWidget

type InputFloatWidget struct {
	// contains filtered or unexported fields
}

func InputFloat

func InputFloat(label string, value *float32) *InputFloatWidget

func (*InputFloatWidget) Build

func (i *InputFloatWidget) Build()

func (*InputFloatWidget) Flags

func (*InputFloatWidget) Format

func (i *InputFloatWidget) Format(format string) *InputFloatWidget

func (*InputFloatWidget) Size

func (i *InputFloatWidget) Size(width float32) *InputFloatWidget

type InputIntWidget

type InputIntWidget struct {
	// contains filtered or unexported fields
}

func InputInt

func InputInt(label string, value *int32) *InputIntWidget

func (*InputIntWidget) Build

func (i *InputIntWidget) Build()

func (*InputIntWidget) Flags

func (i *InputIntWidget) Flags(flags InputTextFlags) *InputIntWidget

func (*InputIntWidget) OnChange

func (i *InputIntWidget) OnChange(onChange func()) *InputIntWidget

func (*InputIntWidget) Size

func (i *InputIntWidget) Size(width float32) *InputIntWidget

type InputTextFlags

type InputTextFlags int
const (
	InputTextFlags_None                InputTextFlags = 0
	InputTextFlags_CharsDecimal        InputTextFlags = 1 << 0  // Allow 0123456789.+-*/
	InputTextFlags_CharsHexadecimal    InputTextFlags = 1 << 1  // Allow 0123456789ABCDEFabcdef
	InputTextFlags_CharsUppercase      InputTextFlags = 1 << 2  // Turn a..z into A..Z
	InputTextFlags_CharsNoBlank        InputTextFlags = 1 << 3  // Filter out spaces, tabs
	InputTextFlags_AutoSelectAll       InputTextFlags = 1 << 4  // Select entire text when first taking mouse focus
	InputTextFlags_EnterReturnsTrue    InputTextFlags = 1 << 5  // Return 'true' when Enter is pressed (as opposed to every time the value was modified). Consider looking at the IsItemDeactivatedAfterEdit() function.
	InputTextFlags_CallbackCompletion  InputTextFlags = 1 << 6  // Callback on pressing TAB (for completion handling)
	InputTextFlags_CallbackHistory     InputTextFlags = 1 << 7  // Callback on pressing Up/Down arrows (for history handling)
	InputTextFlags_CallbackAlways      InputTextFlags = 1 << 8  // Callback on each iteration. User code may query cursor position, modify text buffer.
	InputTextFlags_CallbackCharFilter  InputTextFlags = 1 << 9  // Callback on character inputs to replace or discard them. Modify 'EventChar' to replace or discard, or return 1 in callback to discard.
	InputTextFlags_AllowTabInput       InputTextFlags = 1 << 10 // Pressing TAB input a '\t' character into the text field
	InputTextFlags_CtrlEnterForNewLine InputTextFlags = 1 << 11 // In multi-line mode, unfocus with Enter, add new line with Ctrl+Enter (default is opposite: unfocus with Ctrl+Enter, add line with Enter).
	InputTextFlags_NoHorizontalScroll  InputTextFlags = 1 << 12 // Disable following the cursor horizontally
	InputTextFlags_AlwaysOverwrite     InputTextFlags = 1 << 13 // Overwrite mode
	InputTextFlags_ReadOnly            InputTextFlags = 1 << 14 // Read-only mode
	InputTextFlags_Password            InputTextFlags = 1 << 15 // Password mode, display all characters as '*'
	InputTextFlags_NoUndoRedo          InputTextFlags = 1 << 16 // Disable undo/redo. Note that input text owns the text data while active, if you want to provide your own undo/redo stack you need e.g. to call ClearActiveID().
	InputTextFlags_CharsScientific     InputTextFlags = 1 << 17 // Allow 0123456789.+-*/eE (Scientific notation input)
	InputTextFlags_CallbackResize      InputTextFlags = 1 << 18 // Callback on buffer capacity changes request (beyond 'buf_size' parameter value), allowing the string to grow. Notify when the string wants to be resized (for string types which hold a cache of their Size). You will be provided a new BufSize in the callback and NEED to honor it. (see misc/cpp/imgui_stdlib.h for an example of using this)
	InputTextFlags_CallbackEdit        InputTextFlags = 1 << 19 // Callback on any edit (note that InputText() already returns true on edit, the callback is useful mainly to manipulate the underlying buffer while focus is active)
)

type InputTextMultilineWidget

type InputTextMultilineWidget struct {
	// contains filtered or unexported fields
}

func InputTextMultiline

func InputTextMultiline(label string, text *string) *InputTextMultilineWidget

func (*InputTextMultilineWidget) Build

func (i *InputTextMultilineWidget) Build()

func (*InputTextMultilineWidget) Callback

func (i *InputTextMultilineWidget) Callback(cb imgui.InputTextCallback) *InputTextMultilineWidget

func (*InputTextMultilineWidget) Flags

func (*InputTextMultilineWidget) OnChange

func (i *InputTextMultilineWidget) OnChange(onChange func()) *InputTextMultilineWidget

func (*InputTextMultilineWidget) Size

type InputTextWidget

type InputTextWidget struct {
	// contains filtered or unexported fields
}

func InputText

func InputText(label string, value *string) *InputTextWidget

func (*InputTextWidget) AutoComplete

func (i *InputTextWidget) AutoComplete(candidates []string) *InputTextWidget

Enable auto complete popup by using fuzzy search of current value agains candidates Press enter to confirm the first candidate

func (*InputTextWidget) Build

func (i *InputTextWidget) Build()

func (*InputTextWidget) Callback

func (i *InputTextWidget) Callback(cb imgui.InputTextCallback) *InputTextWidget

func (*InputTextWidget) Flags

func (*InputTextWidget) Hint

func (i *InputTextWidget) Hint(hint string) *InputTextWidget

func (*InputTextWidget) OnChange

func (i *InputTextWidget) OnChange(onChange func()) *InputTextWidget

func (*InputTextWidget) Size

func (i *InputTextWidget) Size(width float32) *InputTextWidget

type InvisibleButtonWidget

type InvisibleButtonWidget struct {
	// contains filtered or unexported fields
}

func InvisibleButton

func InvisibleButton(id string) *InvisibleButtonWidget

func (*InvisibleButtonWidget) Build

func (ib *InvisibleButtonWidget) Build()

func (*InvisibleButtonWidget) OnClick

func (b *InvisibleButtonWidget) OnClick(onClick func()) *InvisibleButtonWidget

func (*InvisibleButtonWidget) Size

func (b *InvisibleButtonWidget) Size(width, height float32) *InvisibleButtonWidget

type Key

type Key int
const (
	KeyUnknown      Key = Key(glfw.KeyUnknown)
	KeySpace        Key = Key(glfw.KeySpace)
	KeyApostrophe   Key = Key(glfw.KeyApostrophe)
	KeyComma        Key = Key(glfw.KeyComma)
	KeyMinus        Key = Key(glfw.KeyMinus)
	KeyPeriod       Key = Key(glfw.KeyPeriod)
	KeySlash        Key = Key(glfw.KeySlash)
	Key0            Key = Key(glfw.Key0)
	Key1            Key = Key(glfw.Key1)
	Key2            Key = Key(glfw.Key2)
	Key3            Key = Key(glfw.Key3)
	Key4            Key = Key(glfw.Key4)
	Key5            Key = Key(glfw.Key5)
	Key6            Key = Key(glfw.Key6)
	Key7            Key = Key(glfw.Key7)
	Key8            Key = Key(glfw.Key8)
	Key9            Key = Key(glfw.Key9)
	KeySemicolon    Key = Key(glfw.KeySemicolon)
	KeyEqual        Key = Key(glfw.KeyEqual)
	KeyA            Key = Key(glfw.KeyA)
	KeyB            Key = Key(glfw.KeyB)
	KeyC            Key = Key(glfw.KeyC)
	KeyD            Key = Key(glfw.KeyD)
	KeyE            Key = Key(glfw.KeyE)
	KeyF            Key = Key(glfw.KeyF)
	KeyG            Key = Key(glfw.KeyG)
	KeyH            Key = Key(glfw.KeyH)
	KeyI            Key = Key(glfw.KeyI)
	KeyJ            Key = Key(glfw.KeyJ)
	KeyK            Key = Key(glfw.KeyK)
	KeyL            Key = Key(glfw.KeyL)
	KeyM            Key = Key(glfw.KeyM)
	KeyN            Key = Key(glfw.KeyN)
	KeyO            Key = Key(glfw.KeyO)
	KeyP            Key = Key(glfw.KeyP)
	KeyQ            Key = Key(glfw.KeyQ)
	KeyR            Key = Key(glfw.KeyR)
	KeyS            Key = Key(glfw.KeyS)
	KeyT            Key = Key(glfw.KeyT)
	KeyU            Key = Key(glfw.KeyU)
	KeyV            Key = Key(glfw.KeyV)
	KeyW            Key = Key(glfw.KeyW)
	KeyX            Key = Key(glfw.KeyX)
	KeyY            Key = Key(glfw.KeyY)
	KeyZ            Key = Key(glfw.KeyZ)
	KeyLeftBracket  Key = Key(glfw.KeyLeftBracket)
	KeyBackslash    Key = Key(glfw.KeyBackslash)
	KeyRightBracket Key = Key(glfw.KeyRightBracket)
	KeyGraveAccent  Key = Key(glfw.KeyGraveAccent)
	KeyWorld1       Key = Key(glfw.KeyWorld1)
	KeyWorld2       Key = Key(glfw.KeyWorld2)
	KeyEscape       Key = Key(glfw.KeyEscape)
	KeyEnter        Key = Key(glfw.KeyEnter)
	KeyTab          Key = Key(glfw.KeyTab)
	KeyBackspace    Key = Key(glfw.KeyBackspace)
	KeyInsert       Key = Key(glfw.KeyInsert)
	KeyDelete       Key = Key(glfw.KeyDelete)
	KeyRight        Key = Key(glfw.KeyRight)
	KeyLeft         Key = Key(glfw.KeyLeft)
	KeyDown         Key = Key(glfw.KeyDown)
	KeyUp           Key = Key(glfw.KeyUp)
	KeyPageUp       Key = Key(glfw.KeyPageUp)
	KeyPageDown     Key = Key(glfw.KeyPageDown)
	KeyHome         Key = Key(glfw.KeyHome)
	KeyEnd          Key = Key(glfw.KeyEnd)
	KeyCapsLock     Key = Key(glfw.KeyCapsLock)
	KeyScrollLock   Key = Key(glfw.KeyScrollLock)
	KeyNumLock      Key = Key(glfw.KeyNumLock)
	KeyPrintScreen  Key = Key(glfw.KeyPrintScreen)
	KeyPause        Key = Key(glfw.KeyPause)
	KeyF1           Key = Key(glfw.KeyF1)
	KeyF2           Key = Key(glfw.KeyF2)
	KeyF3           Key = Key(glfw.KeyF3)
	KeyF4           Key = Key(glfw.KeyF4)
	KeyF5           Key = Key(glfw.KeyF5)
	KeyF6           Key = Key(glfw.KeyF6)
	KeyF7           Key = Key(glfw.KeyF7)
	KeyF8           Key = Key(glfw.KeyF8)
	KeyF9           Key = Key(glfw.KeyF9)
	KeyF10          Key = Key(glfw.KeyF10)
	KeyF11          Key = Key(glfw.KeyF11)
	KeyF12          Key = Key(glfw.KeyF12)
	KeyF13          Key = Key(glfw.KeyF13)
	KeyF14          Key = Key(glfw.KeyF14)
	KeyF15          Key = Key(glfw.KeyF15)
	KeyF16          Key = Key(glfw.KeyF16)
	KeyF17          Key = Key(glfw.KeyF17)
	KeyF18          Key = Key(glfw.KeyF18)
	KeyF19          Key = Key(glfw.KeyF19)
	KeyF20          Key = Key(glfw.KeyF20)
	KeyF21          Key = Key(glfw.KeyF21)
	KeyF22          Key = Key(glfw.KeyF22)
	KeyF23          Key = Key(glfw.KeyF23)
	KeyF24          Key = Key(glfw.KeyF24)
	KeyF25          Key = Key(glfw.KeyF25)
	KeyKP0          Key = Key(glfw.KeyKP0)
	KeyKP1          Key = Key(glfw.KeyKP1)
	KeyKP2          Key = Key(glfw.KeyKP2)
	KeyKP3          Key = Key(glfw.KeyKP3)
	KeyKP4          Key = Key(glfw.KeyKP4)
	KeyKP5          Key = Key(glfw.KeyKP5)
	KeyKP6          Key = Key(glfw.KeyKP6)
	KeyKP7          Key = Key(glfw.KeyKP7)
	KeyKP8          Key = Key(glfw.KeyKP8)
	KeyKP9          Key = Key(glfw.KeyKP9)
	KeyKPDecimal    Key = Key(glfw.KeyKPDecimal)
	KeyKPDivide     Key = Key(glfw.KeyKPDivide)
	KeyKPMultiply   Key = Key(glfw.KeyKPMultiply)
	KeyKPSubtract   Key = Key(glfw.KeyKPSubtract)
	KeyKPAdd        Key = Key(glfw.KeyKPAdd)
	KeyKPEnter      Key = Key(glfw.KeyKPEnter)
	KeyKPEqual      Key = Key(glfw.KeyKPEqual)
	KeyLeftShift    Key = Key(glfw.KeyLeftShift)
	KeyLeftControl  Key = Key(glfw.KeyLeftControl)
	KeyLeftAlt      Key = Key(glfw.KeyLeftAlt)
	KeyLeftSuper    Key = Key(glfw.KeyLeftSuper)
	KeyRightShift   Key = Key(glfw.KeyRightShift)
	KeyRightControl Key = Key(glfw.KeyRightControl)
	KeyRightAlt     Key = Key(glfw.KeyRightAlt)
	KeyRightSuper   Key = Key(glfw.KeyRightSuper)
	KeyMenu         Key = Key(glfw.KeyMenu)
	KeyLast         Key = Key(glfw.KeyLast)
)

These key codes are inspired by the USB HID Usage Tables v1.12 (p. 53-60), but re-arranged to map to 7-bit ASCII for printable keys (function keys are put in the 256+ range).

type LabelWidget

type LabelWidget struct {
	// contains filtered or unexported fields
}

func Label

func Label(label string) *LabelWidget

func (*LabelWidget) Build

func (l *LabelWidget) Build()

func (*LabelWidget) Font

func (l *LabelWidget) Font(font *FontInfo) *LabelWidget

func (*LabelWidget) Wrapped

func (l *LabelWidget) Wrapped(wrapped bool) *LabelWidget

type Layout

type Layout []Widget

func PrepareMsgbox

func PrepareMsgbox() Layout

Embed various Msgboxs to layout. Invoke this function in the same layout level where you call g.Msgbox.

func RangeBuilder

func RangeBuilder(id string, values []interface{}, builder func(int, interface{}) Widget) Layout

Batch create widgets and render only which is visible.

func (Layout) Build

func (l Layout) Build()

type ListBoxState

type ListBoxState struct {
	// contains filtered or unexported fields
}

func (*ListBoxState) Dispose

func (s *ListBoxState) Dispose()

type ListBoxWidget

type ListBoxWidget struct {
	// contains filtered or unexported fields
}

func ListBox

func ListBox(id string, items []string) *ListBoxWidget

func (*ListBoxWidget) Border

func (l *ListBoxWidget) Border(b bool) *ListBoxWidget

func (*ListBoxWidget) Build

func (l *ListBoxWidget) Build()

func (*ListBoxWidget) ContextMenu

func (l *ListBoxWidget) ContextMenu(menuItems []string) *ListBoxWidget

func (*ListBoxWidget) OnChange

func (l *ListBoxWidget) OnChange(onChange func(selectedIndex int)) *ListBoxWidget

func (*ListBoxWidget) OnDClick

func (l *ListBoxWidget) OnDClick(onDClick func(selectedIndex int)) *ListBoxWidget

func (*ListBoxWidget) OnMenu

func (l *ListBoxWidget) OnMenu(onMenu func(selectedIndex int, menu string)) *ListBoxWidget

func (*ListBoxWidget) Size

func (l *ListBoxWidget) Size(width, height float32) *ListBoxWidget
type MainMenuBarWidget struct {
	// contains filtered or unexported fields
}
func MainMenuBar() *MainMenuBarWidget
func (m *MainMenuBarWidget) Build()
func (m *MainMenuBarWidget) Layout(widgets ...Widget) *MainMenuBarWidget

type MasterWindow

type MasterWindow struct {
	// contains filtered or unexported fields
}

func NewMasterWindow

func NewMasterWindow(title string, width, height int, flags MasterWindowFlags) *MasterWindow

func (*MasterWindow) GetPos

func (w *MasterWindow) GetPos() (x, y int)

Return position of master window.

func (*MasterWindow) GetSize

func (w *MasterWindow) GetSize() (width, height int)

Return size of master window.

func (*MasterWindow) Run

func (w *MasterWindow) Run(loopFunc func())

Call the main loop. loopFunc will be used to construct the ui.

func (*MasterWindow) SetBgColor

func (w *MasterWindow) SetBgColor(color color.RGBA)

Set background color of master window.

func (*MasterWindow) SetDropCallback

func (w *MasterWindow) SetDropCallback(cb func([]string))

func (*MasterWindow) SetPos

func (w *MasterWindow) SetPos(x, y int)

Set position of master window.

func (*MasterWindow) SetSize

func (w *MasterWindow) SetSize(x, y int)

type MasterWindowFlags

type MasterWindowFlags imgui.GLFWWindowFlags
const (
	// Specifies the window will be fixed size.
	MasterWindowFlagsNotResizable MasterWindowFlags = MasterWindowFlags(imgui.GLFWWindowFlagsNotResizable)
	// Specifies whether the window is maximized.
	MasterWindowFlagsMaximized MasterWindowFlags = MasterWindowFlags(imgui.GLFWWindowFlagsMaximized)
	// Specifies whether the window will be always-on-top.
	MasterWindowFlagsFloating MasterWindowFlags = MasterWindowFlags(imgui.GLFWWindowFlagsFloating)
	// Specifies whether the window will be frameless.
	MasterWindowFlagsFrameless MasterWindowFlags = MasterWindowFlags(imgui.GLFWWindowFlagsFrameless)
	// Specifies whether the window will be transparent.
	MasterWindowFlagsTransparent MasterWindowFlags = MasterWindowFlags(imgui.GLFWWindowFlagsTransparent)
)
type MenuBarWidget struct {
	// contains filtered or unexported fields
}
func MenuBar() *MenuBarWidget
func (m *MenuBarWidget) Build()
func (m *MenuBarWidget) Layout(widgets ...Widget) *MenuBarWidget
type MenuItemWidget struct {
	// contains filtered or unexported fields
}
func MenuItem(label string) *MenuItemWidget
func (m *MenuItemWidget) Build()
func (m *MenuItemWidget) Enabled(e bool) *MenuItemWidget
func (m *MenuItemWidget) OnClick(onClick func()) *MenuItemWidget
func (m *MenuItemWidget) Selected(s bool) *MenuItemWidget
type MenuWidget struct {
	// contains filtered or unexported fields
}
func Menu(label string) *MenuWidget
func (m *MenuWidget) Build()
func (m *MenuWidget) Enabled(e bool) *MenuWidget
func (m *MenuWidget) Layout(widgets ...Widget) *MenuWidget

type MouseButton

type MouseButton int
const (
	MouseButtonLeft   MouseButton = 0
	MouseButtonRight  MouseButton = 1
	MouseButtonMiddle MouseButton = 2
)

type MouseCursorType

type MouseCursorType int
const (
	// MouseCursorNone no mouse cursor
	MouseCursorNone MouseCursorType = -1
	// MouseCursorArrow standard arrow mouse cursor
	MouseCursorArrow MouseCursorType = 0
	// MouseCursorTextInput when hovering over InputText, etc.
	MouseCursorTextInput MouseCursorType = 1
	// MouseCursorResizeAll (Unused by imgui functions)
	MouseCursorResizeAll MouseCursorType = 2
	// MouseCursorResizeNS when hovering over an horizontal border
	MouseCursorResizeNS MouseCursorType = 3
	// MouseCursorResizeEW when hovering over a vertical border or a column
	MouseCursorResizeEW MouseCursorType = 4
	// MouseCursorResizeNESW when hovering over the bottom-left corner of a window
	MouseCursorResizeNESW MouseCursorType = 5
	// MouseCursorResizeNWSE when hovering over the bottom-right corner of a window
	MouseCursorResizeNWSE MouseCursorType = 6
	// MouseCursorHand (Unused by imgui functions. Use for e.g. hyperlinks)
	MouseCursorHand  MouseCursorType = 7
	MouseCursorCount MouseCursorType = 8
)

type MsgboxButtons

type MsgboxButtons uint8
const (
	MsgboxButtonsYesNo MsgboxButtons = 1 << iota
	MsgboxButtonsOkCancel
	MsgboxButtonsOk
)

type MsgboxState

type MsgboxState struct {
	// contains filtered or unexported fields
}

func (*MsgboxState) Dispose

func (ms *MsgboxState) Dispose()

type PlotBarHWidget

type PlotBarHWidget struct {
	// contains filtered or unexported fields
}

func PlotBarH

func PlotBarH(title string, data []float64) *PlotBarHWidget

func (*PlotBarHWidget) Height

func (p *PlotBarHWidget) Height(height float64) *PlotBarHWidget

func (*PlotBarHWidget) Offset

func (p *PlotBarHWidget) Offset(offset int) *PlotBarHWidget

func (*PlotBarHWidget) Plot

func (p *PlotBarHWidget) Plot()

func (*PlotBarHWidget) Shift

func (p *PlotBarHWidget) Shift(shift float64) *PlotBarHWidget

type PlotBarWidget

type PlotBarWidget struct {
	// contains filtered or unexported fields
}

func PlotBar

func PlotBar(title string, data []float64) *PlotBarWidget

func (*PlotBarWidget) Offset

func (p *PlotBarWidget) Offset(offset int) *PlotBarWidget

func (*PlotBarWidget) Plot

func (p *PlotBarWidget) Plot()

func (*PlotBarWidget) Shift

func (p *PlotBarWidget) Shift(shift float64) *PlotBarWidget

func (*PlotBarWidget) Width

func (p *PlotBarWidget) Width(width float64) *PlotBarWidget

type PlotCanvasWidget

type PlotCanvasWidget struct {
	// contains filtered or unexported fields
}

func Plot

func Plot(title string) *PlotCanvasWidget

func (*PlotCanvasWidget) AxisLimits

func (p *PlotCanvasWidget) AxisLimits(xmin, xmax, ymin, ymax float64, cond ExecCondition) *PlotCanvasWidget

func (*PlotCanvasWidget) Build

func (p *PlotCanvasWidget) Build()

func (*PlotCanvasWidget) Flags

func (p *PlotCanvasWidget) Flags(flags imgui.ImPlotFlags) *PlotCanvasWidget

func (*PlotCanvasWidget) Plots

func (p *PlotCanvasWidget) Plots(plots ...PlotWidget) *PlotCanvasWidget

func (*PlotCanvasWidget) Size

func (p *PlotCanvasWidget) Size(width, height int) *PlotCanvasWidget

func (*PlotCanvasWidget) XAxeFlags

func (p *PlotCanvasWidget) XAxeFlags(flags imgui.ImPlotAxisFlags) *PlotCanvasWidget

func (*PlotCanvasWidget) XTicks

func (p *PlotCanvasWidget) XTicks(ticks []PlotTicker, showDefault bool) *PlotCanvasWidget

func (*PlotCanvasWidget) YAxeFlags

func (p *PlotCanvasWidget) YAxeFlags(yFlags, y2Flags, y3Flags imgui.ImPlotAxisFlags) *PlotCanvasWidget

func (*PlotCanvasWidget) YTicks

func (p *PlotCanvasWidget) YTicks(ticks []PlotTicker, showDefault bool, yAxis ImPlotYAxis) *PlotCanvasWidget

type PlotLineWidget

type PlotLineWidget struct {
	// contains filtered or unexported fields
}

func PlotLine

func PlotLine(title string, values []float64) *PlotLineWidget

func (*PlotLineWidget) Offset

func (p *PlotLineWidget) Offset(offset int) *PlotLineWidget

func (*PlotLineWidget) Plot

func (p *PlotLineWidget) Plot()

func (*PlotLineWidget) X0

func (*PlotLineWidget) XScale

func (p *PlotLineWidget) XScale(scale float64) *PlotLineWidget

type PlotLineXYWidget

type PlotLineXYWidget struct {
	// contains filtered or unexported fields
}

func PlotLineXY

func PlotLineXY(title string, xvalues, yvalues []float64) *PlotLineXYWidget

func (*PlotLineXYWidget) Offset

func (p *PlotLineXYWidget) Offset(offset int) *PlotLineXYWidget

func (*PlotLineXYWidget) Plot

func (p *PlotLineXYWidget) Plot()

type PlotPieChartWidget

type PlotPieChartWidget struct {
	// contains filtered or unexported fields
}

func PlotPieChart

func PlotPieChart(labels []string, values []float64, x, y, radius float64) *PlotPieChartWidget

func (*PlotPieChartWidget) Angle0

func (*PlotPieChartWidget) LabelFormat

func (p *PlotPieChartWidget) LabelFormat(fmtStr string) *PlotPieChartWidget

func (*PlotPieChartWidget) Normalize

func (p *PlotPieChartWidget) Normalize(n bool) *PlotPieChartWidget

func (*PlotPieChartWidget) Plot

func (p *PlotPieChartWidget) Plot()

type PlotScatterWidget

type PlotScatterWidget struct {
	// contains filtered or unexported fields
}

func PlotScatter

func PlotScatter(label string, values []float64) *PlotScatterWidget

func (*PlotScatterWidget) Offset

func (p *PlotScatterWidget) Offset(offset int) *PlotScatterWidget

func (*PlotScatterWidget) Plot

func (p *PlotScatterWidget) Plot()

func (*PlotScatterWidget) X0

func (*PlotScatterWidget) XScale

type PlotScatterXYWidget

type PlotScatterXYWidget struct {
	// contains filtered or unexported fields
}

func PlotScatterXY

func PlotScatterXY(label string, xs, ys []float64) *PlotScatterXYWidget

func (*PlotScatterXYWidget) Offset

func (p *PlotScatterXYWidget) Offset(offset int) *PlotScatterXYWidget

func (*PlotScatterXYWidget) Plot

func (p *PlotScatterXYWidget) Plot()

type PlotTicker

type PlotTicker struct {
	Position float64
	Label    string
}

type PlotWidget

type PlotWidget interface {
	Plot()
}

type PopupModalWidget

type PopupModalWidget struct {
	// contains filtered or unexported fields
}

func PopupModal

func PopupModal(name string) *PopupModalWidget

func (*PopupModalWidget) Build

func (p *PopupModalWidget) Build()

func (*PopupModalWidget) Flags

func (*PopupModalWidget) IsOpen

func (p *PopupModalWidget) IsOpen(open *bool) *PopupModalWidget

func (*PopupModalWidget) Layout

func (p *PopupModalWidget) Layout(widgets ...Widget) *PopupModalWidget

type PopupWidget

type PopupWidget struct {
	// contains filtered or unexported fields
}
func Popup(name string) *PopupWidget

func (*PopupWidget) Build

func (p *PopupWidget) Build()

func (*PopupWidget) Flags

func (p *PopupWidget) Flags(flags WindowFlags) *PopupWidget

func (*PopupWidget) Layout

func (p *PopupWidget) Layout(widgets ...Widget) *PopupWidget

type ProgressBarWidget

type ProgressBarWidget struct {
	// contains filtered or unexported fields
}

func ProgressBar

func ProgressBar(fraction float32) *ProgressBarWidget

func (*ProgressBarWidget) Build

func (p *ProgressBarWidget) Build()

func (*ProgressBarWidget) Overlay

func (p *ProgressBarWidget) Overlay(overlay string) *ProgressBarWidget

func (*ProgressBarWidget) Size

func (p *ProgressBarWidget) Size(width, height float32) *ProgressBarWidget

type ProgressIndicatorState

type ProgressIndicatorState struct {
	// contains filtered or unexported fields
}

func (*ProgressIndicatorState) Dispose

func (ps *ProgressIndicatorState) Dispose()

func (*ProgressIndicatorState) Update

func (ps *ProgressIndicatorState) Update()

type ProgressIndicatorWidget

type ProgressIndicatorWidget struct {
	// contains filtered or unexported fields
}

func ProgressIndicator

func ProgressIndicator(id, label string, width, height, radius float32) *ProgressIndicatorWidget

func (*ProgressIndicatorWidget) Build

func (p *ProgressIndicatorWidget) Build()

type RadioButtonWidget

type RadioButtonWidget struct {
	// contains filtered or unexported fields
}

func RadioButton

func RadioButton(text string, active bool) *RadioButtonWidget

func (*RadioButtonWidget) Build

func (r *RadioButtonWidget) Build()

func (*RadioButtonWidget) OnChange

func (r *RadioButtonWidget) OnChange(onChange func()) *RadioButtonWidget

type RowWidget

type RowWidget struct {
	// contains filtered or unexported fields
}

func Row

func Row(widgets ...Widget) *RowWidget

func (*RowWidget) Build

func (l *RowWidget) Build()

type SelectableFlags

type SelectableFlags int
const (
	// SelectableFlagsNone default SelectableFlags = 0
	SelectableFlagsNone SelectableFlags = 0
	// SelectableFlagsDontClosePopups makes clicking the selectable not close any parent popup windows.
	SelectableFlagsDontClosePopups SelectableFlags = 1 << 0
	// SelectableFlagsSpanAllColumns allows the selectable frame to span all columns (text will still fit in current column).
	SelectableFlagsSpanAllColumns SelectableFlags = 1 << 1
	// SelectableFlagsAllowDoubleClick generates press events on double clicks too.
	SelectableFlagsAllowDoubleClick SelectableFlags = 1 << 2
	// SelectableFlagsDisabled disallows selection and displays text in a greyed out color.
	SelectableFlagsDisabled SelectableFlags = 1 << 3
)

type SelectableWidget

type SelectableWidget struct {
	// contains filtered or unexported fields
}

func Selectable

func Selectable(label string) *SelectableWidget

func (*SelectableWidget) Build

func (s *SelectableWidget) Build()

func (*SelectableWidget) Flags

func (*SelectableWidget) OnClick

func (s *SelectableWidget) OnClick(onClick func()) *SelectableWidget

func (*SelectableWidget) Selected

func (s *SelectableWidget) Selected(selected bool) *SelectableWidget

func (*SelectableWidget) Size

func (s *SelectableWidget) Size(width, height float32) *SelectableWidget

type SeparatorWidget

type SeparatorWidget struct{}

func Separator

func Separator() *SeparatorWidget

func (*SeparatorWidget) Build

func (s *SeparatorWidget) Build()

type SliderFlags

type SliderFlags int
const (
	SliderFlags_None            SliderFlags = 0
	SliderFlags_AlwaysClamp     SliderFlags = 1 << 4     // Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.
	SliderFlags_Logarithmic     SliderFlags = 1 << 5     // Make the widget logarithmic (linear otherwise). Consider using ImGuiSliderFlags_NoRoundToFormat with this if using a format-string with small amount of digits.
	SliderFlags_NoRoundToFormat SliderFlags = 1 << 6     // Disable rounding underlying value to match precision of the display format string (e.g. %.3f values are rounded to those 3 digits)
	SliderFlags_NoInput         SliderFlags = 1 << 7     // Disable CTRL+Click or Enter key allowing to input text directly into the widget
	SliderFlags_InvalidMask_    SliderFlags = 0x7000000F // [Internal] We treat using those bits as being potentially a 'float power' argument from the previous API that has got miscast to this enum, and will trigger an assert if needed.
)

type SliderFloatWidget

type SliderFloatWidget struct {
	// contains filtered or unexported fields
}

func SliderFloat

func SliderFloat(label string, value *float32, min, max float32) *SliderFloatWidget

func (*SliderFloatWidget) Build

func (sf *SliderFloatWidget) Build()

func (*SliderFloatWidget) Format

func (s *SliderFloatWidget) Format(format string) *SliderFloatWidget

func (*SliderFloatWidget) OnChange

func (sf *SliderFloatWidget) OnChange(onChange func()) *SliderFloatWidget

func (*SliderFloatWidget) Size

func (sf *SliderFloatWidget) Size(width float32) *SliderFloatWidget

type SliderIntWidget

type SliderIntWidget struct {
	// contains filtered or unexported fields
}

func SliderInt

func SliderInt(label string, value *int32, min, max int32) *SliderIntWidget

func (*SliderIntWidget) Build

func (s *SliderIntWidget) Build()

func (*SliderIntWidget) Format

func (s *SliderIntWidget) Format(format string) *SliderIntWidget

func (*SliderIntWidget) OnChange

func (s *SliderIntWidget) OnChange(onChange func()) *SliderIntWidget

func (*SliderIntWidget) Size

func (s *SliderIntWidget) Size(width float32) *SliderIntWidget

type SmallButtonWidget

type SmallButtonWidget struct {
	// contains filtered or unexported fields
}

func SmallButton

func SmallButton(id string) *SmallButtonWidget

func (*SmallButtonWidget) Build

func (sb *SmallButtonWidget) Build()

func (*SmallButtonWidget) OnClick

func (b *SmallButtonWidget) OnClick(onClick func()) *SmallButtonWidget

type SpacingWidget

type SpacingWidget struct{}

func Spacing

func Spacing() *SpacingWidget

func (*SpacingWidget) Build

func (s *SpacingWidget) Build()

type SplitDirection

type SplitDirection uint8
const (
	DirectionHorizontal SplitDirection = 1 << iota
	DirectionVertical
)

type SplitLayoutState

type SplitLayoutState struct {
	// contains filtered or unexported fields
}

func (*SplitLayoutState) Dispose

func (s *SplitLayoutState) Dispose()

type SplitLayoutWidget

type SplitLayoutWidget struct {
	// contains filtered or unexported fields
}

func SplitLayout

func SplitLayout(id string, direction SplitDirection, border bool, sashPos float32, layout1, layout2 Widget) *SplitLayoutWidget

func (*SplitLayoutWidget) Build

func (s *SplitLayoutWidget) Build()

type StyleSetter

type StyleSetter struct {
	// contains filtered or unexported fields
}

func Style

func Style() *StyleSetter

func (*StyleSetter) Build

func (ss *StyleSetter) Build()

func (*StyleSetter) SetColor

func (ss *StyleSetter) SetColor(colorId imgui.StyleColorID, col color.RGBA) *StyleSetter

func (*StyleSetter) SetFont

func (ss *StyleSetter) SetFont(font *FontInfo) *StyleSetter

func (*StyleSetter) SetStyle

func (ss *StyleSetter) SetStyle(varId imgui.StyleVarID, width, height float32) *StyleSetter

func (*StyleSetter) To

func (ss *StyleSetter) To(widgets ...Widget) *StyleSetter

type TabBarFlags

type TabBarFlags int
const (
	// TabBarFlagsNone default TabBarFlags = 0.
	TabBarFlagsNone TabBarFlags = 0
	// TabBarFlagsReorderable Allow manually dragging tabs to re-order them + New tabs are appended at the end of list
	TabBarFlagsReorderable TabBarFlags = 1 << 0
	// TabBarFlagsAutoSelectNewTabs Automatically select new tabs when they appear
	TabBarFlagsAutoSelectNewTabs TabBarFlags = 1 << 1
	// TabBarFlagsTabListPopupButton Disable buttons to open the tab list popup
	TabBarFlagsTabListPopupButton TabBarFlags = 1 << 2
	// TabBarFlagsNoCloseWithMiddleMouseButton Disable behavior of closing tabs (that are submitted with p_open != NULL)
	// with middle mouse button. You can still repro this behavior on user's side with if
	// (IsItemHovered() && IsMouseClicked(2)) *p_open TabBarFlags = false.
	TabBarFlagsNoCloseWithMiddleMouseButton TabBarFlags = 1 << 3
	// TabBarFlagsNoTabListScrollingButtons Disable scrolling buttons (apply when fitting policy is
	// TabBarFlagsFittingPolicyScroll)
	TabBarFlagsNoTabListScrollingButtons TabBarFlags = 1 << 4
	// TabBarFlagsNoTooltip Disable tooltips when hovering a tab
	TabBarFlagsNoTooltip TabBarFlags = 1 << 5
	// TabBarFlagsFittingPolicyResizeDown Resize tabs when they don't fit
	TabBarFlagsFittingPolicyResizeDown TabBarFlags = 1 << 6
	// TabBarFlagsFittingPolicyScroll Add scroll buttons when tabs don't fit
	TabBarFlagsFittingPolicyScroll TabBarFlags = 1 << 7
	// TabBarFlagsFittingPolicyMask combines
	// TabBarFlagsFittingPolicyResizeDown and TabBarFlagsFittingPolicyScroll
	TabBarFlagsFittingPolicyMask TabBarFlags = TabBarFlagsFittingPolicyResizeDown | TabBarFlagsFittingPolicyScroll
	// TabBarFlagsFittingPolicyDefault alias for TabBarFlagsFittingPolicyResizeDown
	TabBarFlagsFittingPolicyDefault TabBarFlags = TabBarFlagsFittingPolicyResizeDown
)

type TabBarWidget

type TabBarWidget struct {
	// contains filtered or unexported fields
}

func TabBar

func TabBar(id string) *TabBarWidget

func (*TabBarWidget) Build

func (t *TabBarWidget) Build()

func (*TabBarWidget) Flags

func (t *TabBarWidget) Flags(flags TabBarFlags) *TabBarWidget

func (*TabBarWidget) Layout

func (t *TabBarWidget) Layout(widgets ...Widget) *TabBarWidget

type TabItemFlags

type TabItemFlags int
const (
	// TabItemFlagsNone default TabItemFlags = 0
	TabItemFlagsNone TabItemFlags = 0
	// TabItemFlagsUnsavedDocument Append '*' to title without affecting the ID, as a convenience to avoid using the
	// ### operator. Also: tab is selected on closure and closure is deferred by one frame to allow code to undo it
	// without flicker.
	TabItemFlagsUnsavedDocument TabItemFlags = 1 << 0
	// TabItemFlagsSetSelected Trigger flag to programmatically make the tab selected when calling BeginTabItem()
	TabItemFlagsSetSelected TabItemFlags = 1 << 1
	// TabItemFlagsNoCloseWithMiddleMouseButton  Disable behavior of closing tabs (that are submitted with
	// p_open != NULL) with middle mouse button. You can still repro this behavior on user's side with if
	// (IsItemHovered() && IsMouseClicked(2)) *p_open TabItemFlags = false.
	TabItemFlagsNoCloseWithMiddleMouseButton TabItemFlags = 1 << 2
	// TabItemFlagsNoPushID Don't call PushID(tab->ID)/PopID() on BeginTabItem()/EndTabItem()
	TabItemFlagsNoPushID TabItemFlags = 1 << 3
)

type TabItemWidget

type TabItemWidget struct {
	// contains filtered or unexported fields
}

func TabItem

func TabItem(label string) *TabItemWidget

func (*TabItemWidget) Build

func (t *TabItemWidget) Build()

func (*TabItemWidget) Flags

func (t *TabItemWidget) Flags(flags TabItemFlags) *TabItemWidget

func (*TabItemWidget) IsOpen

func (t *TabItemWidget) IsOpen(open *bool) *TabItemWidget

func (*TabItemWidget) Layout

func (t *TabItemWidget) Layout(widgets ...Widget) *TabItemWidget

type TableColumnWidget

type TableColumnWidget struct {
	// contains filtered or unexported fields
}

func TableColumn

func TableColumn(label string) *TableColumnWidget

func (*TableColumnWidget) Build

func (c *TableColumnWidget) Build()

func (*TableColumnWidget) Flags

func (c *TableColumnWidget) Flags(flags imgui.TableColumnFlags) *TableColumnWidget

func (*TableColumnWidget) InnerWidthOrWeight

func (c *TableColumnWidget) InnerWidthOrWeight(w float32) *TableColumnWidget

func (*TableColumnWidget) UserId

type TableRowWidget

type TableRowWidget struct {
	// contains filtered or unexported fields
}

func TableRow

func TableRow(widgets ...Widget) *TableRowWidget

func (*TableRowWidget) BgColor

func (r *TableRowWidget) BgColor(c *color.RGBA) *TableRowWidget

func (*TableRowWidget) Build

func (r *TableRowWidget) Build()

func (*TableRowWidget) Flags

func (r *TableRowWidget) Flags(flags imgui.TableRowFlags) *TableRowWidget

func (*TableRowWidget) MinHeight

func (r *TableRowWidget) MinHeight(height float64) *TableRowWidget

type TableWidget

type TableWidget struct {
	// contains filtered or unexported fields
}

func Table

func Table(label string) *TableWidget

func (*TableWidget) Build

func (t *TableWidget) Build()

func (*TableWidget) Columns

func (t *TableWidget) Columns(cols ...*TableColumnWidget) *TableWidget

func (*TableWidget) FastMode

func (t *TableWidget) FastMode(b bool) *TableWidget

Display visible rows only to boost performance.

func (*TableWidget) Flags

func (t *TableWidget) Flags(flags imgui.TableFlags) *TableWidget

func (*TableWidget) Freeze

func (t *TableWidget) Freeze(col, row int) *TableWidget

Freeze columns/rows so they stay visible when scrolled.

func (*TableWidget) InnerWidth

func (t *TableWidget) InnerWidth(width float64) *TableWidget

func (*TableWidget) Rows

func (t *TableWidget) Rows(rows ...*TableRowWidget) *TableWidget

func (*TableWidget) Size

func (t *TableWidget) Size(width, height float32) *TableWidget

type Texture

type Texture struct {
	// contains filtered or unexported fields
}

func NewTextureFromRgba

func NewTextureFromRgba(rgba *image.RGBA) (*Texture, error)

Create new texture from rgba. Note: this function has to be invokded in a go routine. If call this in mainthread will result in stuck.

func ToTexture

func ToTexture(textureID imgui.TextureID) *Texture

ToTexture converts imgui.TextureID to Texture.

type TooltipWidget

type TooltipWidget struct {
	// contains filtered or unexported fields
}

func Tooltip

func Tooltip(tip string) *TooltipWidget

func (*TooltipWidget) Build

func (t *TooltipWidget) Build()

func (*TooltipWidget) Layout

func (t *TooltipWidget) Layout(widgets ...Widget) *TooltipWidget

type TreeNodeFlags

type TreeNodeFlags int
const (
	// TreeNodeFlagsNone default TreeNodeFlags = 0
	TreeNodeFlagsNone TreeNodeFlags = 0
	// TreeNodeFlagsSelected draws as selected.
	TreeNodeFlagsSelected TreeNodeFlags = 1 << 0
	// TreeNodeFlagsFramed draws full colored frame (e.g. for CollapsingHeader).
	TreeNodeFlagsFramed TreeNodeFlags = 1 << 1
	// TreeNodeFlagsAllowItemOverlap hit testing to allow subsequent widgets to overlap this one.
	TreeNodeFlagsAllowItemOverlap TreeNodeFlags = 1 << 2
	// TreeNodeFlagsNoTreePushOnOpen doesn't do a TreePush() when open
	// (e.g. for CollapsingHeader) TreeNodeFlags = no extra indent nor pushing on ID stack.
	TreeNodeFlagsNoTreePushOnOpen TreeNodeFlags = 1 << 3
	// TreeNodeFlagsNoAutoOpenOnLog doesn't automatically and temporarily open node when Logging is active
	// (by default logging will automatically open tree nodes).
	TreeNodeFlagsNoAutoOpenOnLog TreeNodeFlags = 1 << 4
	// TreeNodeFlagsDefaultOpen defaults node to be open.
	TreeNodeFlagsDefaultOpen TreeNodeFlags = 1 << 5
	// TreeNodeFlagsOpenOnDoubleClick needs double-click to open node.
	TreeNodeFlagsOpenOnDoubleClick TreeNodeFlags = 1 << 6
	// TreeNodeFlagsOpenOnArrow opens only when clicking on the arrow part.
	// If TreeNodeFlagsOpenOnDoubleClick is also set, single-click arrow or double-click all box to open.
	TreeNodeFlagsOpenOnArrow TreeNodeFlags = 1 << 7
	// TreeNodeFlagsLeaf allows no collapsing, no arrow (use as a convenience for leaf nodes).
	TreeNodeFlagsLeaf TreeNodeFlags = 1 << 8
	// TreeNodeFlagsBullet displays a bullet instead of an arrow.
	TreeNodeFlagsBullet TreeNodeFlags = 1 << 9
	// TreeNodeFlagsFramePadding uses FramePadding (even for an unframed text node) to
	// vertically align text baseline to regular widget height. Equivalent to calling AlignTextToFramePadding().
	TreeNodeFlagsFramePadding TreeNodeFlags = 1 << 10
	// TreeNodeFlagsSpanAvailWidth extends hit box to the right-most edge, even if not framed.
	// This is not the default in order to allow adding other items on the same line.
	// In the future we may refactor the hit system to be front-to-back, allowing natural overlaps
	// and then this can become the default.
	TreeNodeFlagsSpanAvailWidth TreeNodeFlags = 1 << 11
	// TreeNodeFlagsSpanFullWidth extends hit box to the left-most and right-most edges (bypass the indented area).
	TreeNodeFlagsSpanFullWidth TreeNodeFlags = 1 << 12
	// TreeNodeFlagsNavLeftJumpsBackHere (WIP) Nav: left direction may move to this TreeNode() from any of its child
	// (items submitted between TreeNode and TreePop)
	TreeNodeFlagsNavLeftJumpsBackHere TreeNodeFlags = 1 << 13
	// TreeNodeFlagsCollapsingHeader combines TreeNodeFlagsFramed and TreeNodeFlagsNoAutoOpenOnLog.
	TreeNodeFlagsCollapsingHeader TreeNodeFlags = TreeNodeFlagsFramed | TreeNodeFlagsNoTreePushOnOpen | TreeNodeFlagsNoAutoOpenOnLog
)

type TreeNodeWidget

type TreeNodeWidget struct {
	// contains filtered or unexported fields
}

func TreeNode

func TreeNode(label string) *TreeNodeWidget

func (*TreeNodeWidget) Build

func (t *TreeNodeWidget) Build()

func (*TreeNodeWidget) Event

func (t *TreeNodeWidget) Event(handler func()) *TreeNodeWidget

Create TreeNode with eventHandler You could detect events (e.g. IsItemClicked IsMouseDoubleClicked etc...) and handle them for TreeNode inside eventHandler

func (*TreeNodeWidget) Flags

func (t *TreeNodeWidget) Flags(flags TreeNodeFlags) *TreeNodeWidget

func (*TreeNodeWidget) Layout

func (t *TreeNodeWidget) Layout(widgets ...Widget) *TreeNodeWidget

type VSliderIntWidget

type VSliderIntWidget struct {
	// contains filtered or unexported fields
}

func VSliderInt

func VSliderInt(label string, value *int32, min, max int32) *VSliderIntWidget

func (*VSliderIntWidget) Build

func (vs *VSliderIntWidget) Build()

func (*VSliderIntWidget) Flags

func (vs *VSliderIntWidget) Flags(flags SliderFlags) *VSliderIntWidget

func (*VSliderIntWidget) Format

func (vs *VSliderIntWidget) Format(format string) *VSliderIntWidget

func (*VSliderIntWidget) OnChange

func (vs *VSliderIntWidget) OnChange(onChange func()) *VSliderIntWidget

func (*VSliderIntWidget) Size

func (vs *VSliderIntWidget) Size(width, height float32) *VSliderIntWidget

type VSplitterWidget

type VSplitterWidget struct {
	// contains filtered or unexported fields
}

func VSplitter

func VSplitter(id string, delta *float32) *VSplitterWidget

func (*VSplitterWidget) Build

func (v *VSplitterWidget) Build()

func (*VSplitterWidget) Size

func (v *VSplitterWidget) Size(width, height float32) *VSplitterWidget

type Widget

type Widget interface {
	Build()
}

type WindowFlags

type WindowFlags int
const (
	// WindowFlagsNone default WindowFlags = 0
	WindowFlagsNone WindowFlags = 0
	// WindowFlagsNoTitleBar disables title-bar.
	WindowFlagsNoTitleBar WindowFlags = 1 << 0
	// WindowFlagsNoResize disables user resizing with the lower-right grip.
	WindowFlagsNoResize WindowFlags = 1 << 1
	// WindowFlagsNoMove disables user moving the window.
	WindowFlagsNoMove WindowFlags = 1 << 2
	// WindowFlagsNoScrollbar disables scrollbars. Window can still scroll with mouse or programmatically.
	WindowFlagsNoScrollbar WindowFlags = 1 << 3
	// WindowFlagsNoScrollWithMouse disables user vertically scrolling with mouse wheel. On child window, mouse wheel
	// will be forwarded to the parent unless NoScrollbar is also set.
	WindowFlagsNoScrollWithMouse WindowFlags = 1 << 4
	// WindowFlagsNoCollapse disables user collapsing window by double-clicking on it.
	WindowFlagsNoCollapse WindowFlags = 1 << 5
	// WindowFlagsAlwaysAutoResize resizes every window to its content every frame.
	WindowFlagsAlwaysAutoResize WindowFlags = 1 << 6
	// WindowFlagsNoBackground disables drawing background color (WindowBg, etc.) and outside border. Similar as using
	// SetNextWindowBgAlpha(0.0f).
	WindowFlagsNoBackground WindowFlags = 1 << 7
	// WindowFlagsNoSavedSettings will never load/save settings in .ini file.
	WindowFlagsNoSavedSettings WindowFlags = 1 << 8
	// WindowFlagsNoMouseInputs disables catching mouse, hovering test with pass through.
	WindowFlagsNoMouseInputs WindowFlags = 1 << 9
	// WindowFlagsMenuBar has a menu-bar.
	WindowFlagsMenuBar WindowFlags = 1 << 10
	// WindowFlagsHorizontalScrollbar allows horizontal scrollbar to appear (off by default). You may use
	// SetNextWindowContentSize(ImVec2(width,0.0f)); prior to calling Begin() to specify width. Read code in imgui_demo
	// in the "Horizontal Scrolling" section.
	WindowFlagsHorizontalScrollbar WindowFlags = 1 << 11
	// WindowFlagsNoFocusOnAppearing disables taking focus when transitioning from hidden to visible state.
	WindowFlagsNoFocusOnAppearing WindowFlags = 1 << 12
	// WindowFlagsNoBringToFrontOnFocus disables bringing window to front when taking focus. e.g. clicking on it or
	// programmatically giving it focus.
	WindowFlagsNoBringToFrontOnFocus WindowFlags = 1 << 13
	// WindowFlagsAlwaysVerticalScrollbar always shows vertical scrollbar, even if ContentSize.y < Size.y .
	WindowFlagsAlwaysVerticalScrollbar WindowFlags = 1 << 14
	// WindowFlagsAlwaysHorizontalScrollbar always shows horizontal scrollbar, even if ContentSize.x < Size.x .
	WindowFlagsAlwaysHorizontalScrollbar WindowFlags = 1 << 15
	// WindowFlagsAlwaysUseWindowPadding ensures child windows without border uses style.WindowPadding (ignored by
	// default for non-bordered child windows, because more convenient).
	WindowFlagsAlwaysUseWindowPadding WindowFlags = 1 << 16
	// WindowFlagsNoNavInputs has no gamepad/keyboard navigation within the window.
	WindowFlagsNoNavInputs WindowFlags = 1 << 18
	// WindowFlagsNoNavFocus has no focusing toward this window with gamepad/keyboard navigation
	// (e.g. skipped by CTRL+TAB)
	WindowFlagsNoNavFocus WindowFlags = 1 << 19
	// WindowFlagsUnsavedDocument appends '*' to title without affecting the ID, as a convenience to avoid using the
	// ### operator. When used in a tab/docking context, tab is selected on closure and closure is deferred by one
	// frame to allow code to cancel the closure (with a confirmation popup, etc.) without flicker.
	WindowFlagsUnsavedDocument WindowFlags = 1 << 20

	// WindowFlagsNoNav combines WindowFlagsNoNavInputs and WindowFlagsNoNavFocus.
	WindowFlagsNoNav WindowFlags = WindowFlagsNoNavInputs | WindowFlagsNoNavFocus
	// WindowFlagsNoDecoration combines WindowFlagsNoTitleBar, WindowFlagsNoResize, WindowFlagsNoScrollbar and
	// WindowFlagsNoCollapse.
	WindowFlagsNoDecoration WindowFlags = WindowFlagsNoTitleBar | WindowFlagsNoResize | WindowFlagsNoScrollbar | WindowFlagsNoCollapse
	// WindowFlagsNoInputs combines WindowFlagsNoMouseInputs, WindowFlagsNoNavInputs and WindowFlagsNoNavFocus.
	WindowFlagsNoInputs WindowFlags = WindowFlagsNoMouseInputs | WindowFlagsNoNavInputs | WindowFlagsNoNavFocus
)

type WindowWidget

type WindowWidget struct {
	// contains filtered or unexported fields
}

func SingleWindow

func SingleWindow(title string) *WindowWidget

func SingleWindowWithMenuBar

func SingleWindowWithMenuBar(title string) *WindowWidget

func Window

func Window(title string) *WindowWidget

func (*WindowWidget) Flags

func (w *WindowWidget) Flags(flags WindowFlags) *WindowWidget

func (*WindowWidget) IsOpen

func (w *WindowWidget) IsOpen(open *bool) *WindowWidget

func (*WindowWidget) Layout

func (w *WindowWidget) Layout(widgets ...Widget)

func (*WindowWidget) Pos

func (w *WindowWidget) Pos(x, y float32) *WindowWidget

func (*WindowWidget) Size

func (w *WindowWidget) Size(width, height float32) *WindowWidget

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL