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

platform

package

Go to main page

Versions in this module

v0

v0.12.1

Jul 10, 2025

Changes in this version

+ var ErrCurrentlyPlayingSpeech = errors.New("Speech is currently playing")

type Platform

+ TryEnqueueSpeechMP3 func(mp3 []byte, finished func()) error

v0.12.0

May 27, 2025

Changes in this version

type KeyboardState

+ func (k *KeyboardState) KeyAlt() bool

+ func (k *KeyboardState) KeyControl() bool

+ func (k *KeyboardState) KeyShift() bool

+ func (k *KeyboardState) KeySuper() bool

v0.11.10

Apr 15, 2025

Changes in this version

type MouseState

+ DeltaPos [2]float32

type Platform

+ SetMousePosition func([2]float32)

+ StartMouseDeltaMode func()

+ StopMouseDeltaMode func()

v0.11.9

Mar 22, 2025

v0.11.8

Feb 19, 2025

Changes in this version

type Platform

+ AddMP3 func(mp3 []byte) (int, error)

v0.11.7

Feb 1, 2025

v0.11.6

Oct 22, 2024

v0.11.5

Sep 21, 2024

Changes in this version

+ const KeyF13

+ const KeyF14

+ const KeyF15

+ const KeyF16

+ const KeyInsert

v0.11.4

Aug 24, 2024

v0.11.3

Aug 17, 2024

v0.11.2

Aug 14, 2024

v0.11.1

Aug 4, 2024

v0.11.0

Jul 31, 2024

Changes in this version

+ const AudioSampleRate

+ const KeyAlt

+ const KeyBackspace

+ const KeyControl

+ const KeyDelete

+ const KeyDownArrow

+ const KeyEnd

+ const KeyEnter

+ const KeyEscape

+ const KeyF1

+ const KeyF10

+ const KeyF11

+ const KeyF12

+ const KeyF2

+ const KeyF3

+ const KeyF4

+ const KeyF5

+ const KeyF6

+ const KeyF7

+ const KeyF8

+ const KeyF9

+ const KeyHome

+ const KeyLeftArrow

+ const KeyPageDown

+ const KeyPageUp

+ const KeyRightArrow

+ const KeyShift

+ const KeySuper

+ const KeyTab

+ const KeyUpArrow

+ const KeyV

+ const MouseButtonCount

+ const MouseButtonPrimary

+ const MouseButtonSecondary

+ const MouseButtonTertiary

+ type Config struct

+ AudioEnabled bool

+ EnableMSAA bool

+ FullScreenMonitor int

+ InitialWindowPosition [2]int

+ InitialWindowSize [2]int

+ StartInFullScreen bool

+ type Key int

+ type KeyboardState struct

+ HeldFKeys map[Key]interface{}

+ Input string

+ Pressed map[Key]interface{}

+ func (k *KeyboardState) IsFKeyHeld(key Key) bool

+ func (k *KeyboardState) WasPressed(key Key) bool

+ type MouseState struct

+ Clicked [MouseButtonCount]bool

+ DoubleClicked [MouseButtonCount]bool

+ Down [MouseButtonCount]bool

+ DragDelta [2]float32

+ Dragging [MouseButtonCount]bool

+ Pos [2]float32

+ Released [MouseButtonCount]bool

+ Wheel [2]float32

+ func (ms *MouseState) SetCursor(id imgui.MouseCursorID)

+ type Platform interface

+ AddPCM func(pcm []byte, rate int) (int, error)

+ CancelShouldStop func()

+ DPIScale func() float32

+ DisplaySize func() [2]float32

+ Dispose func()

+ EnableFullScreen func(fullscreen bool)

+ EnableVSync func(sync bool)

+ EndCaptureMouse func()

+ FramebufferSize func() [2]float32

+ GetAllMonitorNames func() []string

+ GetClipboard func() imgui.Clipboard

+ GetKeyboard func() *KeyboardState

+ GetMouse func() *MouseState

+ InputCharacters func() string

+ IsFullScreen func() bool

+ NewFrame func()

+ PlayAudioOnce func(id int)

+ PostRender func()

+ ProcessEvents func() bool

+ SetAudioVolume func(vol int)

+ SetWindowTitle func(text string)

+ ShouldStop func() bool

+ StartCaptureMouse func(e math.Extent2D)

+ StartPlayAudioContinuous func(id int)

+ StopPlayAudio func(id int)

+ WindowPosition func() [2]int

+ WindowSize func() [2]int

+ func New(config *Config, lg *log.Logger) (Platform, error)