win

Documentation

Index

• type Option
  • func Resizable() Option
  • func ShowFPS() Option
  • func Size(width, height int) Option
  • func Title(title string) Option
• type Win
  • func NewWindow(opts ...Option) (*Win, error)
  • func (w *Win) Closed() bool
  • func (w *Win) Run()
  • func (w *Win) SetRenderer(r *rend.Renderer)
  • func (w *Win) Stop()

Types

type Option

type Option func(*options)

Option is a functional option to the window constructor New.

func Resizable

func Resizable() Option

Resizable option makes the window resizable by the user.

func ShowFPS

func ShowFPS() Option

ShowFPS sets the window to show FPS.

func Size

func Size(width, height int) Option

Size option sets the width and height of the window.

func Title

func Title(title string) Option

Title option sets the title (caption) of the window.

type Win

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

Win represents a window.

func NewWindow

func NewWindow(opts ...Option) (*Win, error)

NewWindow constructs a new graphical window.

func (*Win) Closed

func (w *Win) Closed() bool

Closed asserts if the given window is closed.

func (*Win) Run

func (w *Win) Run()

Run runs the given window and enters event handling loop and blocks until it should be close and destroyed.

func (*Win) SetRenderer

func (w *Win) SetRenderer(r *rend.Renderer)

SetRenderer sets fn as the renderer callback

func (*Win) Stop

func (w *Win) Stop()

Stop stops the given window.