Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

gui

package module

Go to main page

Versions in this module

v1

v1.1.0

May 9, 2026

Changes in this version

+ var DropdownOptionsBoxMarginTop float32 = 4

type Dropdown

+ OptionsCornerRadius BoxCorners

type DropdownProps

+ OptionsCornerRadius BoxCorners

v1.0.0

Mar 30, 2026

Changes in this version

+ const Center

+ const EllipsisOverflow

+ const End

+ const FitContain

+ const FitCover

+ const Horizontal

+ const NoWrap

+ const ShaderRenderModeGradientLinear

+ const ShaderRenderModeGradientRadial

+ const ShaderRenderModeSolidColor

+ const ShaderRenderModeTexture

+ const Start

+ const Vertical

+ const Wrap

+ var Debug = false

+ var DebugLinesColor = rl.ColorAlpha(rl.Red, 0.5)

+ var DefaultCharSpacing float32 = 1

+ var DefaultDropdownCollapseIcon rl.Texture2D

+ var DefaultDropdownExpandIcon rl.Texture2D

+ var DefaultDropdownIconGap float32 = 15

+ var DefaultDropdownIconSizeFactor float32 = 0.7

+ var DefaultErrorColor = rl.Red

+ var DefaultFontBaselineCorrectionFactor float32 = 0

+ var DefaultFontSize float32 = 20

+ var DefaultScrollBoxThumbWidth float32 = 5

+ var DefaultSliderThumbWidth float32 = 20

+ var DefaultSliderTrackWidth float32 = 10

+ var DefaultTextColor = rl.Black

+ var ErrFontInvalid = errors.New("invalid font")

+ var FontTextureFilter = rl.FilterBilinear

+ var ImageTextureFilter = rl.FilterBilinear

+ var InfNegative = float32(math.Inf(-1))

+ var InfPositive = float32(math.Inf(1))

+ var ScrollBoxSpeed float32 = 30

+ var ScrollBoxThumbMargin float32 = 4

+ var SubWindowHeaderHeight float32 = 20

+ func Abs[N Number](v N) N

+ func AddChild[T Node](parent Node, child T) T

+ func AddNodeToHighPriorityList(node Node)

+ func AddPostRender(fn func())

+ func AddPostUpdate(fn func())

+ func BeginScissorMode(intersection rl.Rectangle)

+ func CacheNode(node Node)

+ func Clamp[N Number](v, min, max N) N

+ func CloseWindow()

+ func ColorContrast(color rl.Color, factor float32) rl.Color

+ func ColorHex(hexValue uint) rl.Color

+ func ColorToUniformVec4(color rl.Color) []float32

+ func ComputeLayout()

+ func ConsumeMouseButtonPressed(button rl.MouseButton)

+ func ConsumeMouseButtonReleased(button rl.MouseButton)

+ func DebuggingInfo(node Node)

+ func DrawRectangle(rect rl.Rectangle, borderWidth BoxSides, cornerRadius BoxCorners, ...)

+ func DrawRectangleWithGradient(rect rl.Rectangle, borderWidth BoxSides, cornerRadius BoxCorners, ...)

+ func DrawRectangleWithTexture(rect rl.Rectangle, borderWidth BoxSides, cornerRadius BoxCorners, ...)

+ func DrawTextEllipsis(bounds rl.Rectangle, alignX, alignY Alignment, font rl.Font, text string, ...)

+ func EffectBrighten(box *Box) func()

+ func EndScissorMode()

+ func GetDefaultFont() rl.Font

+ func GetNodeFromCache[N Node](id NodeID) N

+ func GetScreenSize() rl.Vector2

+ func InitWindow(size rl.Vector2, title string)

+ func IsMouseButtonPressed(button rl.MouseButton) bool

+ func IsMouseButtonPressedConsume(button rl.MouseButton) bool

+ func IsMouseButtonReleased(button rl.MouseButton) bool

+ func IsMouseButtonReleasedConsume(button rl.MouseButton) bool

+ func IsNodeHovered(node Node) bool

+ func IsNodeInHighPriorityList(node Node) bool

+ func IsNodeVisible(node Node) bool

+ func LoadAssets()

+ func LoadFont(fileName string, fontSize int32, codepointCount int, codepoints ...rune) (rl.Font, error)

+ func LoadFontFS(fileSystem fs.FS, filePath string, fontSize int32, codepointCount int, ...) (rl.Font, error)

+ func LoadFontFromMemory(fileExtension string, fileData []byte, fontSize int32, codepointCount int, ...) (rl.Font, error)

+ func LoadImage(filePath string, fileSystem fs.FS) (*rl.Image, error)

+ func LoadImageTexture(filePath string, fileSystem fs.FS) (rl.Texture2D, error)

+ func MoveNodeToTopOfHighPriorityList(node Node)

+ func Must2[T1, T2 any](v1 T1, v2 T2, err error) (T1, T2)

+ func Must[T any](v T, err error) T

+ func Pointer[T any](value T) *T

+ func Rect(x, y, width, height float32) rl.Rectangle

+ func RectPosition(rect rl.Rectangle) rl.Vector2

+ func RectSize(rect rl.Rectangle) rl.Vector2

+ func RemoveNodeFromCache(id NodeID)

+ func RemoveNodeFromHighPriorityList(node Node)

+ func RemoveSubWindow(subWindow *SubWindow)

+ func Render()

+ func ResetIDs()

+ func ResetLayout()

+ func RestartIDs()

+ func SetDefaultFont(font rl.Font)

+ func SetMouseCursor(cursor rl.MouseCursor)

+ func TernaryLazy[T any](condition bool, a, b func() T) T

+ func Ternary[T any](condition bool, a, b T) T

+ func UnloadAssets()

+ func UnloadImage(filePath string, fileSystem fs.FS)

+ func UnloadImageTexture(filePath string, fileSystem fs.FS)

+ func Update()

+ func UpdateScreenSize()

+ func Vec2(x, y float32) rl.Vector2

+ func WrapText(bounds rl.Rectangle, font rl.Font, text string, fontSize float32, ...) string

+ type Alignment uint8

+ const AlignCenter

+ const AlignEnd

+ const AlignStart

+ type Box struct

+ BgColor rl.Color

+ BorderColor rl.Color

+ BorderWidth BoxSides

+ CornerRadius BoxCorners

+ Gradient Gradient

+ HideOverflow bool

+ Invisible bool

+ Texture rl.Texture2D

+ TextureTint rl.Color

+ func NewBox(props BoxProps) *Box

+ func NewBoxImage(props BoxProps, imagePath string, fileSystem fs.FS) *Box

+ func (n *Box) AbsPos() rl.Vector2

+ func (n *Box) ApplyProps(props BoxProps)

+ func (n *Box) ComputeMinInnerSizeX() float32

+ func (n *Box) ComputeMinInnerSizeY() float32

+ func (n *Box) GetChild(idx int) Node

+ func (n *Box) GetComputedChildCount() int

+ func (n *Box) ID() NodeID

+ func (n *Box) InnerRect() rl.Rectangle

+ func (n *Box) Rect() rl.Rectangle

+ func (n *Box) Render()

+ func (n *Box) TotalArea() rl.Rectangle

+ func (n *Box) Update()

+ type BoxCorners struct

+ BottomLeft float32

+ BottomRight float32

+ TopLeft float32

+ TopRight float32

+ func NewBoxCorners(v ...float32) BoxCorners

+ func NewBoxCornersOverride(boxCorners BoxCorners, topLeft, topRight, bottomRight, bottomLeft float32) BoxCorners

+ func Radius(v ...float32) BoxCorners

+ func RadiusOverride(radius BoxCorners, topLeft, topRight, bottomRight, bottomLeft float32) BoxCorners

+ type BoxProps struct

+ AllocChildren uint

+ BgColor rl.Color

+ BorderColor rl.Color

+ BorderWidth BoxSides

+ ChildAlignX Alignment

+ ChildAlignY Alignment

+ ChildGap float32

+ ChildWrap bool

+ CornerRadius BoxCorners

+ DebugID string

+ Gradient Gradient

+ HideOverflow bool

+ ID NodeID

+ Ignored bool

+ Invisible bool

+ Orientation Orientation

+ Padding BoxSides

+ SizingX SizingProp

+ SizingY SizingProp

+ Texture rl.Texture2D

+ TextureFit TextureFit

+ TextureTint rl.Color

+ type BoxSides struct

+ Bottom float32

+ Left float32

+ Right float32

+ Top float32

+ func Border(v ...float32) BoxSides

+ func BorderOverride(borders BoxSides, top, right, bottom, left float32) BoxSides

+ func NewBoxSides(v ...float32) BoxSides

+ func NewBoxSidesOverride(boxSides BoxSides, top, right, bottom, left float32) BoxSides

+ func Padding(v ...float32) BoxSides

+ func PaddingOverride(padding BoxSides, top, right, bottom, left float32) BoxSides

+ func (b BoxSides) X() float32

+ func (b BoxSides) Y() float32

+ type Button struct

+ func NewButton(props ButtonProps) *Button

+ func (n *Button) ApplyProps(props ButtonProps)

+ func (n *Button) IsLeftButtonDown() bool

+ func (n *Button) IsLeftButtonPressed() bool

+ func (n *Button) IsLeftButtonReleased() bool

+ func (n *Button) IsLeftButtonUp() bool

+ func (n *Button) IsRightButtonDown() bool

+ func (n *Button) IsRightButtonPressed() bool

+ func (n *Button) IsRightButtonReleased() bool

+ func (n *Button) IsRightButtonUp() bool

+ func (n *Button) Render()

+ func (n *Button) Update()

+ type ButtonProps struct

+ OnHover EffectFunc

+ OnPress EffectFunc

+ type ChildlessNode struct

+ func (n *ChildlessNode) AddChild(thisPanics Node)

+ type Color = rl.Color

+ type Dropdown struct

+ func NewDropdown(props DropdownProps, placeholder string, options []string, selected int16) *Dropdown

+ func (n *Dropdown) ApplyProps(props DropdownProps)

+ func (n *Dropdown) Close()

+ func (n *Dropdown) ComputeMinInnerSizeX() float32

+ func (n *Dropdown) ComputeMinInnerSizeY() float32

+ func (n *Dropdown) GetNumberOfOptions() int

+ func (n *Dropdown) GetSelected() string

+ func (n *Dropdown) GetSelectedIdx() int

+ func (n *Dropdown) HasChanged() bool

+ func (n *Dropdown) HasSelection() bool

+ func (n *Dropdown) IsOpen() bool

+ func (n *Dropdown) Open()

+ func (n *Dropdown) Render()

+ func (n *Dropdown) TotalArea() rl.Rectangle

+ func (n *Dropdown) Update()

+ type DropdownProps struct

+ CollapseIcon rl.Texture2D

+ ExpandIcon rl.Texture2D

+ IconGap float32

+ IconSize float32

+ type EffectFunc func(box *Box) func()

+ type FontConfig struct

+ FgColor rl.Color

+ func (c *FontConfig) ApplyProps(props FontConfigProps)

+ type FontConfigProps struct

+ BaselineCorrectionFactor float32

+ CharSpacing float32

+ FgColor rl.Color

+ Font rl.Font

+ FontSize float32

+ type Gradient struct

+ Angle float32

+ EndColor rl.Color

+ StartColor rl.Color

+ func GradientLinear(startColor, endColor rl.Color, angleDegrees float32) Gradient

+ func GradientRadial(centerColor, edgeColor rl.Color) Gradient

+ func NewGradientLinear(startColor, endColor rl.Color, angleDegrees float32) Gradient

+ func NewGradientRadial(centerColor, edgeColor rl.Color) Gradient

+ func (g Gradient) IsVisible() bool

+ func (g Gradient) Kind() GradientKind

+ type GradientKind uint8

+ const GradientKindLinear

+ const GradientKindRadial

+ type Node interface

+ ComputeMinInnerSizeX func() float32

+ ComputeMinInnerSizeY func() float32

+ ID func() NodeID

+ Render func()

+ TotalArea func() rl.Rectangle

+ Update func()

+ func GetHighestPriorityNodeUnderMouse() Node

+ type NodeID uint64

+ const NodeIDManual

+ const NodeIDUnset

+ func NewID(id string) NodeID

+ type NodeIDGenerator struct

+ func (g *NodeIDGenerator) GetID() NodeID

+ func (g *NodeIDGenerator) Reset()

+ func (g *NodeIDGenerator) Restart()

+ type Number interface

+ type Orientation uint8

+ const OrientationHorizontal

+ const OrientationVertical

+ type ScrollBox struct

+ ThumbColor rl.Color

+ ThumbCornerRadius BoxCorners

+ func NewScrollBox(props ScrollBoxProps) *ScrollBox

+ func (n *ScrollBox) ApplyProps(props ScrollBoxProps)

+ func (n *ScrollBox) Render()

+ func (n *ScrollBox) Update()

+ type ScrollBoxProps struct

+ HideScrollBar bool

+ ScrollOrientation Orientation

+ ThumbColor rl.Color

+ ThumbCornerRadius float32

+ ThumbWidth float32

+ type Sizing struct

+ type SizingMode uint8

+ const SizingAspectRatio

+ const SizingFixed

+ const SizingGrow

+ const SizingPercentage

+ const SizingShrink

+ const SizingUnset

+ type SizingProp struct

+ func AspectRatio(ratio float32) SizingProp

+ func Fixed(size float32) SizingProp

+ func Grow(v ...float32) SizingProp

+ func NewSizingAspectRatio(ratio float32) SizingProp

+ func NewSizingFixed(size float32) SizingProp

+ func NewSizingGrow(v ...float32) SizingProp

+ func NewSizingPercentage(percentage uint8, v ...float32) SizingProp

+ func NewSizingShrink(v ...float32) SizingProp

+ func Percentage(percentage uint8, v ...float32) SizingProp

+ func Shrink(v ...float32) SizingProp

+ type Slider struct

+ ThumbColor rl.Color

+ ThumbCornerRadius BoxCorners

+ TrackActiveColor rl.Color

+ TrackCornerRadius BoxCorners

+ TrackInactiveColor rl.Color

+ func NewSlider(props SliderProps, min, max, value float32) *Slider

+ func (n *Slider) ApplyProps(props SliderProps)

+ func (n *Slider) ComputeMinInnerSizeX() float32

+ func (n *Slider) ComputeMinInnerSizeY() float32

+ func (n *Slider) GetProgress() float32

+ func (n *Slider) GetValue() float32

+ func (n *Slider) HasChanged() bool

+ func (n *Slider) IsChanging() bool

+ func (n *Slider) Render()

+ func (n *Slider) SetProgress(progress float32)

+ func (n *Slider) SetValue(value float32)

+ func (n *Slider) Update()

+ type SliderProps struct

+ Orientation Orientation

+ Step float32

+ ThumbColor rl.Color

+ ThumbCornerRadius BoxCorners

+ ThumbWidth float32

+ TrackActiveColor rl.Color

+ TrackCornerRadius BoxCorners

+ TrackInactiveColor rl.Color

+ TrackWidth float32

+ type Spacer struct

+ func NewSpacerX(sizing ...SizingProp) *Spacer

+ func NewSpacerY(sizing ...SizingProp) *Spacer

+ func (n *Spacer) Render()

+ type SubWindow struct

+ DebugID string

+ HeaderColor rl.Color

+ func AddSubWindow(subWindow *SubWindow, position rl.Vector2) *SubWindow

+ func NewSubWindow(props SubWindowProps) *SubWindow

+ func (w *SubWindow) ComputeLayout()

+ func (w *SubWindow) Drag(delta rl.Vector2)

+ func (w *SubWindow) GetAutoID() NodeID

+ func (w *SubWindow) HeaderBounds() rl.Rectangle

+ func (w *SubWindow) Hide()

+ func (w *SubWindow) IsHidden() bool

+ func (w *SubWindow) Move(position rl.Vector2)

+ func (w *SubWindow) Rect() rl.Rectangle

+ func (w *SubWindow) Render()

+ func (w *SubWindow) ResetIDs()

+ func (w *SubWindow) ResetLayout()

+ func (w *SubWindow) RestartIDs()

+ func (w *SubWindow) Root() *Box

+ func (w *SubWindow) SetHidden(hidden bool)

+ func (w *SubWindow) SetRoot(root *Box) *Box

+ func (w *SubWindow) SetSizingX(sizing SizingProp)

+ func (w *SubWindow) SetSizingY(sizing SizingProp)

+ func (w *SubWindow) Show()

+ func (w *SubWindow) Translate(delta rl.Vector2)

+ func (w *SubWindow) Update()

+ type SubWindowProps struct

+ Closable bool

+ DebugID string

+ Floating bool

+ HeaderColor rl.Color

+ Hidden bool

+ SizingX SizingProp

+ SizingY SizingProp

+ ZIndex ZIndex

+ type Text struct

+ func NewText(props TextProps, text string) *Text

+ func (n *Text) ApplyProps(props TextProps)

+ func (n *Text) ComputeMinInnerSizeX() float32

+ func (n *Text) ComputeMinInnerSizeY() float32

+ func (n *Text) Render()

+ func (n *Text) SetText(text string)

+ type TextInput struct

+ ErrorColor rl.Color

+ ErrorMessage string

+ PlaceholderColor rl.Color

+ func NewTextInput(props TextInputProps, placeholder, value string) *TextInput

+ func (n *TextInput) ApplyProps(props TextInputProps)

+ func (n *TextInput) Blur()

+ func (n *TextInput) ComputeMinInnerSizeY() float32

+ func (n *TextInput) Focus()

+ func (n *TextInput) HasChanged() bool

+ func (n *TextInput) Render()

+ func (n *TextInput) SetValue(value string)

+ func (n *TextInput) Submitted() bool

+ func (n *TextInput) Update()

+ func (n *TextInput) Value() string

+ type TextInputProps struct

+ ErrorColor rl.Color

+ PlaceholderColor rl.Color

+ type TextProps struct

+ Wrapping TextWrapping

+ type TextWrapping uint8

+ const TextEllipsisOverflow

+ const TextNoWrap

+ const TextWrap

+ type TextureFit uint8

+ const TextureFitContain

+ const TextureFitCover

+ type Toggle struct

+ OffColor rl.Color

+ OnColor rl.Color

+ func NewCheckBox(props ToggleProps, value bool) *Toggle

+ func NewToggle(props ToggleProps, value bool) *Toggle

+ func (n *Toggle) ApplyProps(props ToggleProps)

+ func (n *Toggle) GetValue() bool

+ func (n *Toggle) HasChanged() bool

+ func (n *Toggle) Render()

+ func (n *Toggle) SetValue(value bool)

+ func (n *Toggle) Toggle()

+ func (n *Toggle) Update()

+ type ToggleProps struct

+ OffColor rl.Color

+ OnColor rl.Color

+ type ZIndex = int16

+ const ZIndexBase

+ const ZIndexEphemeral

+ const ZIndexPopup

+ const ZIndexRoot