Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  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

oak

package module

Go to main page

Versions in this module

v4

v4.1.1

Oct 6, 2024

v4.1.0

Aug 23, 2022

v4.0.2

Jun 11, 2022

v4.0.1

Jun 5, 2022

v4.0.0

May 21, 2022

Changes in this version

+ var FocusGain = event.RegisterEvent[struct{}]()

+ var FocusLoss = event.RegisterEvent[struct{}]()

+ var InputChange = event.RegisterEvent[InputType]()

+ var OnStop = event.RegisterEvent[struct{}]()

+ var ViewportUpdate = event.RegisterEvent[intgeom.Point2]()

+ func AddScene(name string, sc scene.Scene) error

+ func Bounds() intgeom.Point2

+ func GetCursorPosition() (x, y float64) — linux/amd64, windows/amd64

+ func HideCursor() error — linux/amd64, windows/amd64

+ func Init(scene string, configOptions ...ConfigOption) error

+ func IsDown(k key.Code) bool

+ func IsHeld(k key.Code) (bool, time.Duration)

+ func MoveWindow(x, y, w, h int) error — linux/amd64, windows/amd64

+ func ScreenShot() *image.RGBA

+ func SetBackground(b Background)

+ func SetBorderless(bs bool) error — linux/amd64, windows/amd64

+ func SetColorBackground(img image.Image)

+ func SetFS(filesystem fs.FS)

+ func SetFullScreen(fs bool) error — linux/amd64, windows/amd64

+ func SetIcon(icon image.Image) error — linux/amd64, windows/amd64

+ func SetLoadingRenderable(r render.Renderable)

+ func SetTitle(title string) error — linux/amd64, windows/amd64

+ func SetTopMost(on bool) error — linux/amd64, windows/amd64

+ func SetViewport(pt intgeom.Point2)

+ func SetViewportBounds(rect intgeom.Rect2)

+ func ShiftViewport(pt intgeom.Point2)

+ func UpdateViewSize(w, h int) error

+ type Assets struct

+ AudioPath string

+ ImagePath string

+ type Background interface

+ GetRGBA func() *image.RGBA

+ type BatchLoadOptions struct

+ BlankOutAudio bool

+ MaxImageFileSize int64

+ type Config struct

+ Assets Assets

+ BatchLoad bool

+ BatchLoadOptions BatchLoadOptions

+ Borderless bool

+ Debug Debug

+ DrawFrameRate int

+ Driver Driver

+ EnableDebugConsole bool

+ FrameRate int

+ Fullscreen bool

+ GestureSupport bool

+ IdleDrawFrameRate int

+ Language string

+ LoadBuiltinCommands bool

+ Screen Screen

+ SkipRNGSeed bool

+ Title string

+ TopMost bool

+ TrackInputChanges bool

+ UnlimitedDrawFrameRate bool

+ func NewConfig(opts ...ConfigOption) (Config, error)

+ type ConfigOption func(Config) (Config, error)

+ func FileConfig(filePath string) ConfigOption

+ func ReaderConfig(r io.Reader) ConfigOption

+ type Debug struct

+ Filter string

+ Level string

+ type Driver func(f func(screen.Screen))

+ type InputType int32

+ const InputJoystick

+ const InputKeyboard

+ const InputMouse

+ const InputNone

+ type Screen struct

+ Height int

+ Scale float64

+ Width int

+ X int

+ Y int

+ type Viewport struct

+ Bounds intgeom.Rect2

+ BoundsEnforced bool

+ Position intgeom.Point2

+ type Window struct

+ CallerMap *event.CallerMap

+ CollisionTree *collision.Tree

+ ControllerID int32

+ DrawFrameRate int

+ DrawStack *render.DrawStack

+ DrawTicker *time.Ticker

+ Driver Driver

+ ErrorScene string

+ FirstSceneInput interface{}

+ FrameRate int

+ IdleDrawFrameRate int

+ LastMouseEvent mouse.Event

+ LastMousePress mouse.Event

+ LastRelativeMouseEvent mouse.Event

+ LoadingR render.Renderable

+ MouseTree *collision.Tree

+ ParentContext context.Context

+ SceneMap *scene.Map

+ ScreenHeight int

+ ScreenWidth int

+ UseAspectRatio bool

+ func NewWindow() *Window

+ func (w *Window) AddScene(name string, s scene.Scene) error

+ func (w *Window) Bounds() intgeom.Point2

+ func (w *Window) ChangeWindow(width, height int) error

+ func (w *Window) ClearScreenFilter()

+ func (w *Window) DoBetweenDraws(f func())

+ func (w *Window) EventHandler() event.Handler

+ func (w *Window) GetBackgroundImage() image.Image

+ func (w *Window) GoToScene(nextScene string)

+ func (w *Window) InFocus() bool

+ func (w *Window) Init(firstScene string, configOptions ...ConfigOption) error

+ func (w *Window) MostRecentInput() InputType

+ func (w *Window) NextScene()

+ func (w *Window) Propagate(ev event.EventID[*mouse.Event], me mouse.Event)

+ func (w *Window) Quit()

+ func (w *Window) RecordGIF(hundredths int) (stop func() *gif.GIF)

+ func (w *Window) RemoveViewportBounds()

+ func (w *Window) ScreenShot() *image.RGBA

+ func (w *Window) SetAspectRatio(xToY float64)

+ func (w *Window) SetBackground(b Background)

+ func (w *Window) SetColorBackground(img image.Image)

+ func (w *Window) SetDrawFilter(screenFilter mod.Filter)

+ func (w *Window) SetLoadingRenderable(r render.Renderable)

+ func (w *Window) SetLogicHandler(h event.Handler)

+ func (w *Window) SetPalette(palette color.Palette)

+ func (w *Window) SetViewport(pt intgeom.Point2)

+ func (w *Window) SetViewportBounds(rect intgeom.Rect2)

+ func (w *Window) ShiftViewport(delta intgeom.Point2)

+ func (w *Window) TriggerKeyDown(e okey.Event)

+ func (w *Window) TriggerKeyHeld(e okey.Event)

+ func (w *Window) TriggerKeyUp(e okey.Event)

+ func (w *Window) TriggerMouseEvent(mevent omouse.Event)

+ func (w *Window) UpdateViewSize(width, height int) error

+ func (w *Window) Viewport() intgeom.Point2

+ func (w *Window) ViewportBounds() (rect intgeom.Rect2, ok bool)

v4.0.0-alpha.2

Apr 23, 2022

Other modules containing this package

github.com/oakmound/oak

github.com/oakmound/oak/v2

github.com/oakmound/oak/v3