ui

package

Go to main page

Versions in this module

v0

v0.22.0

Jan 19, 2025

Changes in this version

type Element

+ func (e *Element) HasAncestor(ancestor *Element) bool

v0.21.0

Oct 6, 2024

v0.20.2

Sep 16, 2024

v0.20.1

Sep 14, 2024

v0.20.0

Sep 8, 2024

v0.19.1

Aug 15, 2024

v0.19.0

Aug 11, 2024

v0.18.0

Jan 25, 2024

v0.17.0

Jan 18, 2024

v0.16.0

Jan 14, 2024

v0.15.0

Dec 8, 2023

v0.14.0

Nov 15, 2023

v0.13.0

Oct 29, 2023

Changes in this version

type Canvas

+ func (c Canvas) ClipRect(position, size sprec.Vec2)

+ func (c Canvas) FillTextLine(text []rune, position sprec.Vec2, typography Typography)

+ type Character struct

+ Kern float32

+ Rune rune

+ Width float32

+ type ClipboardAction int

+ const ClipboardActionCopy

+ const ClipboardActionCut

+ const ClipboardActionPaste

+ func (a ClipboardAction) String() string

+ type ClipboardEvent struct

+ Action ClipboardAction

+ Text string

type Controller

+ func (c *Controller) OnClipboardEvent(window app.Window, event app.ClipboardEvent) bool

type Element

+ func (e *Element) IsFocused() bool

+ type ElementClipboardHandler interface

+ OnClipboardEvent func(element *Element, event ClipboardEvent) bool

+ type ElementHistoryHandler interface

+ OnRedo func(element *Element) bool

+ OnUndo func(element *Element) bool

+ type ElementStateHandler interface

+ OnSave func(element *Element) bool

type Font

+ func (f *Font) LineHeight(fontSize float32) float32

+ func (f *Font) LineIterator(characters []rune, fontSize float32) *LineIterator

+ func (f *Font) LineWidth(characters []rune, fontSize float32) float32

type KeyCode

+ const KeyCodeLeftSuper

+ const KeyCodeRightSuper

+ func (c KeyCode) String() string

type KeyModifier

+ const KeyModifierSuper

+ func (m KeyModifier) String() string

type KeyModifierSet

+ func KeyModifiers(entries ...KeyModifier) KeyModifierSet

+ func (s KeyModifierSet) Contains(modifier KeyModifier) bool

+ func (s KeyModifierSet) String() string

+ type KeyboardAction int

+ const KeyboardActionDown

+ const KeyboardActionRepeat

+ const KeyboardActionType

+ const KeyboardActionUp

+ func (a KeyboardAction) String() string

type KeyboardEvent

+ Action KeyboardAction

+ type LineIterator struct

+ func (i *LineIterator) Character() Character

+ func (i *LineIterator) Next() bool

+ type MouseAction int

+ const MouseActionDown

+ const MouseActionDrop

+ const MouseActionEnter

+ const MouseActionLeave

+ const MouseActionMove

+ const MouseActionScroll

+ const MouseActionUp

+ func (a MouseAction) String() string

type MouseButton

+ func (b MouseButton) String() string

type MouseEvent

+ Action MouseAction

+ Modifiers KeyModifierSet

+ X int

+ Y int

type Window

+ func (w *Window) BubbleFocus()

+ func (w *Window) Copy() bool

+ func (w *Window) Cut() bool

+ func (w *Window) Paste() bool

+ func (w *Window) Redo() bool

+ func (w *Window) Save() bool

+ func (w *Window) SetCloseInterceptor(interceptor func() bool)

+ func (w *Window) Undo() bool

type WindowHandler

+ OnClipboardEvent func(event ClipboardEvent) bool

v0.12.0

Sep 10, 2023

Changes in this version

type Canvas

+ func (c *Canvas) ElapsedTime() time.Duration

+ type Controller struct

+ func (c *Controller) OnCloseRequested(window app.Window)

+ func (c *Controller) OnCreate(appWindow app.Window)

+ func (c *Controller) OnDestroy(window app.Window)

+ func (c *Controller) OnFramebufferResize(window app.Window, width, height int)

+ func (c *Controller) OnKeyboardEvent(window app.Window, event app.KeyboardEvent) bool

+ func (c *Controller) OnMouseEvent(window app.Window, event app.MouseEvent) bool

+ func (c *Controller) OnRender(window app.Window)

+ func (c *Controller) OnResize(window app.Window, width, height int)

type Spacing

+ func SymmetricSpacing(horizontal, vertical int) Spacing

+ func UniformSpacing(spacing int) Spacing

v0.11.0

Jul 22, 2023

Changes in this version

+ func WrappedLocator(delegate resource.ReadLocator) resource.ReadLocator

type Canvas

+ func (c *Canvas) DrawBounds(element *Element, padding bool) DrawBounds

+ type DrawBounds struct

+ Position sprec.Vec2

+ Size sprec.Vec2

+ func (b DrawBounds) Height() float32

+ func (b DrawBounds) Width() float32

+ func (b DrawBounds) X() float32

+ func (b DrawBounds) Y() float32

v0.10.0

May 13, 2023

Changes in this version

type ShaderCollection

+ ContourSet func() ShaderSet

+ ShapeBlankSet func() ShaderSet

+ ShapeShadedSet func() ShaderSet

+ TextSet func() ShaderSet

type Window

+ func (w *Window) GrantFocus(element *Element)

v0.9.0

Sep 25, 2022

v0.8.0

Jun 19, 2022

Changes in this version

type Color

+ func (c Color) Overlay(color Color) Color

type Element

+ func (e *Element) AbsoluteBounds() Bounds

+ func (e *Element) HierarchyEnabled() bool

+ func (e *Element) HierarchyVisible() bool

+ func (e *Element) Invalidate()

+ func (e *Element) PrependSibling(sibling *Element)

+ func (e *Element) Window() *Window

type Size

+ func (s Size) Inverse() Size

type Spacing

+ func (s Spacing) Size() Size

type Window

+ func (w *Window) CreateElement() *Element

v0.7.0

May 18, 2022

v0.6.0

May 14, 2022

v0.5.0

May 2, 2022

Changes in this version

type Canvas

+ func (c Canvas) Fill(fill Fill)

+ func (c Canvas) FillText(text string, position sprec.Vec2, typography Typography)

+ func (c Canvas) Rotate(angle sprec.Angle)

+ func (c Canvas) Scale(amount sprec.Vec2)

+ func (c Canvas) SetClipRect(left, right, top, bottom float32)

+ func (c Canvas) Stroke()

type Color

+ func MixColors(first, second Color, alpha float32) Color

v0.4.0

Apr 28, 2022

Changes in this version

type Canvas

+ func (c Canvas) ResetTransform()

+ func (c Canvas) SetClipBounds(left, right, top, bottom float32)

+ func (c Canvas) SetTransform(transform sprec.Mat4)

+ type Config struct

+ func NewConfig(locator ResourceLocator, renderAPI render.API, shaders ShaderCollection) *Config

type Context

+ func (c *Context) CreateContext() *Context

+ func (c *Context) CreateFont(font *opentype.Font) (*Font, error)

+ func (c *Context) CreateFontCollection(collection *opentype.Collection) (*FontCollection, error)

+ func (c *Context) Destroy()

+ func (c *Context) OpenFont(uri string) (*Font, error)

+ type ContourMesh struct

+ func (m *ContourMesh) Allocate(api render.API)

+ func (m *ContourMesh) Append(vertex ContourVertex)

+ func (m *ContourMesh) Offset() int

+ func (m *ContourMesh) Release()

+ func (m *ContourMesh) Reset()

+ func (m *ContourMesh) Update()

+ type ContourVertex struct

type Font

+ func (f *Font) Destroy()

type FontCollection

+ func (c *FontCollection) Destroy()

+ type Material struct

+ func (m *Material) Allocate(api render.API)

+ func (m *Material) Release()

+ type ShaderCollection struct

+ ContourMaterial ShaderSet

+ ShapeBlankMaterial ShaderSet

+ ShapeMaterial ShaderSet

+ TextMaterial ShaderSet

+ type ShaderSet struct

+ FragmentShader func() string

+ VertexShader func() string

+ type ShapeMesh struct

+ func (m *ShapeMesh) Allocate(api render.API)

+ func (m *ShapeMesh) Append(vertex ShapeVertex)

+ func (m *ShapeMesh) Offset() int

+ func (m *ShapeMesh) Release()

+ func (m *ShapeMesh) Reset()

+ func (m *ShapeMesh) Update()

+ type ShapeVertex struct

+ type TextMesh struct

+ func (m *TextMesh) Allocate(api render.API)

+ func (m *TextMesh) Append(vertex TextVertex)

+ func (m *TextMesh) Offset() int

+ func (m *TextMesh) Release()

+ func (m *TextMesh) Reset()

+ func (m *TextMesh) Update()

+ type TextVertex struct

v0.3.0

Mar 20, 2022

Changes in this version

+ const MouseEventTypeDrop

+ const MouseEventTypeScroll

type Canvas

+ Contour func() Contour

+ DrawSurface func(surface Surface)

+ Shape func() Shape

+ Text func() Text

type Color

+ func ColorWithAlpha(color Color, a uint8) Color

type Context

+ func (c *Context) CreateImage(img image.Image) (Image, error)

+ type Contour interface

+ Begin func()

+ Circle func(position Position, radius int, stroke Stroke)

+ CloseLoop func()

+ CubeTo func(control1, control2, position Position, stroke Stroke)

+ End func()

+ LineTo func(position Position, stroke Stroke)

+ MoveTo func(position Position, stroke Stroke)

+ QuadTo func(control, position Position, stroke Stroke)

+ Rectangle func(position Position, size Size, stroke Stroke)

+ RoundRectangle func(position Position, size Size, roundness RectRoundness, stroke Stroke)

+ Triangle func(a, b, c Position, stroke Stroke)

type Element

+ func (e *Element) Focusable() bool

+ func (e *Element) SetFocusable(focusable bool)

+ type ElementKeyboardHandler interface

+ OnKeyboardEvent func(element *Element, event KeyboardEvent) bool

+ type FSResourceLocator struct

+ func NewFSResourceLocator(filesys fs.FS) *FSResourceLocator

+ func (l *FSResourceLocator) OpenResource(uri string) (io.ReadCloser, error)

type FileResourceLocator

+ func NewFileResourceLocator(dir string) *FileResourceLocator

+ type FilepathPayload = app.FilepathPayload

+ type Fill struct

+ Color Color

+ Image Image

+ ImageOffset Position

+ ImageSize Size

+ Rule FillRule

+ type FillLayout struct

+ func NewFillLayout() *FillLayout

+ func (l *FillLayout) Apply(element *Element)

+ type FillRule int

+ const FillRuleEvenOdd

+ const FillRuleNonZero

+ const FillRuleSimple

type Font

+ TextSize func(text string, fontSize int) Size

type Image

+ Destroy func()

type MouseEvent

+ Payload interface{}

+ ScrollX float64

+ ScrollY float64

+ type RectRoundness struct

+ BottomLeftRadius int

+ BottomRightRadius int

+ TopLeftRadius int

+ TopRightRadius int

+ type Shape interface

+ Begin func(fill Fill)

+ Circle func(position Position, radius int)

+ CubeTo func(control1, control2, position Position)

+ End func()

+ LineTo func(position Position)

+ MoveTo func(position Position)

+ QuadTo func(control, position Position)

+ Rectangle func(position Position, size Size)

+ RoundRectangle func(position Position, size Size, roundness RectRoundness)

+ Triangle func(a, b, c Position)

+ type Stroke struct

+ Color Color

+ Size int

+ type Surface interface

+ Render func(x, y, width, height int)

+ type Text interface

+ Begin func(typography Typography)

+ End func()

+ Line func(value string, position Position)

+ type Typography struct

+ Color Color

+ Font Font

+ Size int

type Window

+ func (w *Window) DiscardFocus()

+ func (w *Window) IsElementFocused(element *Element) bool

v0.2.0

Aug 5, 2021

Changes in this version

+ const KeyCode0

+ const KeyCode1

+ const KeyCode2

+ const KeyCode3

+ const KeyCode4

+ const KeyCode5

+ const KeyCode6

+ const KeyCode7

+ const KeyCode8

+ const KeyCode9

+ const KeyCodeA

+ const KeyCodeApostrophe

+ const KeyCodeArrowDown

+ const KeyCodeArrowLeft

+ const KeyCodeArrowRight

+ const KeyCodeArrowUp

+ const KeyCodeB

+ const KeyCodeBackslash

+ const KeyCodeBackspace

+ const KeyCodeC

+ const KeyCodeCaps

+ const KeyCodeComma

+ const KeyCodeD

+ const KeyCodeDelete

+ const KeyCodeE

+ const KeyCodeEnd

+ const KeyCodeEnter

+ const KeyCodeEqual

+ const KeyCodeEscape

+ const KeyCodeF

+ const KeyCodeF1

+ const KeyCodeF10

+ const KeyCodeF11

+ const KeyCodeF12

+ const KeyCodeF2

+ const KeyCodeF3

+ const KeyCodeF4

+ const KeyCodeF5

+ const KeyCodeF6

+ const KeyCodeF7

+ const KeyCodeF8

+ const KeyCodeF9

+ const KeyCodeG

+ const KeyCodeGraveAccent

+ const KeyCodeH

+ const KeyCodeHome

+ const KeyCodeI

+ const KeyCodeInsert

+ const KeyCodeJ

+ const KeyCodeK

+ const KeyCodeL

+ const KeyCodeLeftAlt

+ const KeyCodeLeftBracket

+ const KeyCodeLeftControl

+ const KeyCodeLeftShift

+ const KeyCodeM

+ const KeyCodeMinus

+ const KeyCodeN

+ const KeyCodeO

+ const KeyCodeP

+ const KeyCodePageDown

+ const KeyCodePageUp

+ const KeyCodePeriod

+ const KeyCodeQ

+ const KeyCodeR

+ const KeyCodeRightAlt

+ const KeyCodeRightBracket

+ const KeyCodeRightControl

+ const KeyCodeRightShift

+ const KeyCodeS

+ const KeyCodeSemicolon

+ const KeyCodeSlash

+ const KeyCodeSpace

+ const KeyCodeT

+ const KeyCodeTab

+ const KeyCodeU

+ const KeyCodeV

+ const KeyCodeW

+ const KeyCodeX

+ const KeyCodeY

+ const KeyCodeZ

+ const KeyModifierAlt

+ const KeyModifierCapsLock

+ const KeyModifierControl

+ const KeyModifierShift

+ const KeyboardEventTypeKeyDown

+ const KeyboardEventTypeKeyUp

+ const KeyboardEventTypeRepeat

+ const KeyboardEventTypeType

+ const MouseButtonLeft

+ const MouseButtonMiddle

+ const MouseButtonRight

+ const MouseEventTypeDown

+ const MouseEventTypeDrag

+ const MouseEventTypeDragCancel

+ const MouseEventTypeEnter

+ const MouseEventTypeLeave

+ const MouseEventTypeMove

+ const MouseEventTypeUp

+ func NewController(locator ResourceLocator, graphics Graphics, initFn InitFunc) app.Controller

+ func NewWindow(appWindow app.Window, locator ResourceLocator, graphics Graphics) (*Window, WindowHandler)

+ type Bounds struct

+ func NewBounds(x, y, width, height int) Bounds

+ func (b Bounds) Contains(position Position) bool

+ func (b Bounds) Grow(size Size) Bounds

+ func (b Bounds) Intersect(other Bounds) Bounds

+ func (b Bounds) Resize(width, height int) Bounds

+ func (b Bounds) Shrink(size Size) Bounds

+ func (b Bounds) String() string

+ func (b Bounds) Translate(delta Position) Bounds

+ type Canvas interface

+ Clip func(bounds Bounds)

+ DrawCircle func(position Position, radius int)

+ DrawImage func(image Image, position Position, size Size)

+ DrawLine func(start, end Position)

+ DrawRectangle func(position Position, size Size)

+ DrawRoundRectangle func(position Position, size Size, radius int)

+ DrawText func(text string, position Position)

+ DrawTriangle func(a, b, c Position)

+ FillCircle func(position Position, radius int)

+ FillRectangle func(position Position, size Size)

+ FillRoundRectangle func(position Position, size Size, radius int)

+ FillTriangle func(a, b, c Position)

+ Font func() Font

+ FontSize func() int

+ Pop func()

+ Push func()

+ SetFont func(font Font)

+ SetFontSize func(size int)

+ SetSolidColor func(color Color)

+ SetStrokeColor func(color Color)

+ SetStrokeSize func(size int)

+ SolidColor func() Color

+ StrokeColor func() Color

+ StrokeSize func() int

+ TextSize func(text string) Size

+ Translate func(delta Position)

+ type Color struct

+ A uint8

+ B uint8

+ G uint8

+ R uint8

+ func Aqua() Color

+ func Black() Color

+ func Blue() Color

+ func Fuchsia() Color

+ func Gray() Color

+ func Green() Color

+ func Lime() Color

+ func Maroon() Color

+ func Navy() Color

+ func Olive() Color

+ func Purple() Color

+ func RGB(r, g, b uint8) Color

+ func RGBA(r, g, b, a uint8) Color

+ func Red() Color

+ func Silver() Color

+ func Teal() Color

+ func Transparent() Color

+ func White() Color

+ func Yellow() Color

+ func (c Color) Opaque() bool

+ func (c Color) Translucent() bool

+ func (c Color) Transparent() bool

+ type Context struct

+ func (c *Context) CreateElement() *Element

+ func (c *Context) GetFont(family, subFamily string) (Font, bool)

+ func (c *Context) OpenFontCollection(uri string) (*FontCollection, error)

+ func (c *Context) OpenImage(uri string) (Image, error)

+ func (c *Context) Schedule(fn func())

+ func (c *Context) Window() *Window

+ type Element struct

+ func (e *Element) AppendChild(child *Element)

+ func (e *Element) AppendSibling(sibling *Element)

+ func (e *Element) Bounds() Bounds

+ func (e *Element) ContentBounds() Bounds

+ func (e *Element) Context() *Context

+ func (e *Element) Destroy()

+ func (e *Element) Detach()

+ func (e *Element) Enabled() bool

+ func (e *Element) Essence() Essence

+ func (e *Element) FirstChild() *Element

+ func (e *Element) ID() string

+ func (e *Element) IdealSize() Size

+ func (e *Element) InjectEssence(target interface{})

+ func (e *Element) LastChild() *Element

+ func (e *Element) Layout() Layout

+ func (e *Element) LayoutConfig() LayoutConfig

+ func (e *Element) LeftSibling() *Element

+ func (e *Element) Margin() Spacing

+ func (e *Element) Materialized() bool

+ func (e *Element) Padding() Spacing

+ func (e *Element) Parent() *Element

+ func (e *Element) PrependChild(child *Element)

+ func (e *Element) RemoveChild(child *Element)

+ func (e *Element) RightSibling() *Element

+ func (e *Element) SetBounds(bounds Bounds)

+ func (e *Element) SetEnabled(enabled bool)

+ func (e *Element) SetEssence(essence Essence)

+ func (e *Element) SetID(id string)

+ func (e *Element) SetIdealSize(size Size)

+ func (e *Element) SetLayout(layout Layout)

+ func (e *Element) SetLayoutConfig(layoutConfig LayoutConfig)

+ func (e *Element) SetMargin(margin Spacing)

+ func (e *Element) SetMaterialized(materialized bool)

+ func (e *Element) SetPadding(padding Spacing)

+ func (e *Element) SetVisible(visible bool)

+ func (e *Element) Visible() bool

+ type ElementMouseHandler interface

+ OnMouseEvent func(element *Element, event MouseEvent) bool

+ type ElementRenderHandler interface

+ OnRender func(element *Element, canvas Canvas)

+ type ElementResizeHandler interface

+ OnResize func(element *Element, bounds Bounds)

+ type Essence interface

+ type FileResourceLocator struct

+ func (l FileResourceLocator) OpenResource(uri string) (io.ReadCloser, error)

+ type Font interface

+ Family func() string

+ SubFamily func() string

+ type FontCollection struct

+ func (c *FontCollection) Fonts() []Font

+ type Graphics interface

+ Begin func()

+ Canvas func() Canvas

+ Create func()

+ CreateFont func(font *opentype.Font) (Font, error)

+ CreateImage func(img image.Image) (Image, error)

+ Destroy func()

+ End func()

+ ReleaseFont func(font Font) error

+ ReleaseImage func(resource Image) error

+ Resize func(size Size)

+ ResizeFramebuffer func(size Size)

+ type Image interface

+ Size func() Size

+ type InitFunc func(window *Window)

+ type KeyCode = app.KeyCode

+ type KeyModifier = app.KeyModifier

+ type KeyModifierSet = app.KeyModifierSet

+ type KeyboardEvent struct

+ Code KeyCode

+ Modifiers KeyModifierSet

+ Rune rune

+ Type KeyboardEventType

+ func (e KeyboardEvent) String() string

+ type KeyboardEventType = app.KeyboardEventType

+ type Layout interface

+ Apply func(element *Element)

+ type LayoutConfig interface

+ type MouseButton = app.MouseButton

+ type MouseEvent struct

+ Button MouseButton

+ Index int

+ Position Position

+ Type MouseEventType

+ func (e MouseEvent) String() string

+ type MouseEventType = app.MouseEventType

+ type Position struct

+ X int

+ Y int

+ func NewPosition(x, y int) Position

+ func (p Position) Inverse() Position

+ func (p Position) String() string

+ func (p Position) Translate(dX, dY int) Position

+ type ResourceLocator interface

+ OpenResource func(uri string) (io.ReadCloser, error)

+ type Size struct

+ Height int

+ Width int

+ func NewSize(width, height int) Size

+ func (s Size) Empty() bool

+ func (s Size) Grow(dWidth, dHeight int) Size

+ func (s Size) Shrink(dWidth, dHeight int) Size

+ func (s Size) String() string

+ type Spacing struct

+ Bottom int

+ Left int

+ Right int

+ Top int

+ func (s Spacing) Horizontal() int

+ func (s Spacing) String() string

+ func (s Spacing) Vertical() int

+ type Window struct

+ func (w *Window) Context() *Context

+ func (w *Window) FindElementByID(id string) (*Element, bool)

+ func (w *Window) GetElementByID(id string) *Element

+ func (w *Window) Root() *Element

+ func (w *Window) SetRoot(root *Element)

+ func (w *Window) SetSize(size Size)

+ func (w *Window) Size() Size

+ type WindowHandler interface

+ OnCloseRequested func()

+ OnFramebufferResize func(size Size)

+ OnKeyboardEvent func(event KeyboardEvent) bool

+ OnMouseEvent func(event MouseEvent) bool

+ OnRender func()

+ OnResize func(size Size)

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