structure

Documentation

Index

• type Layer
• type Layers
  • func (l Layers) Draw(screen *ebiten.Image)
• type Scene
• type SceneGame
  • func (s *SceneGame) Draw(screen *ebiten.Image)
  • func (s *SceneGame) Layout(outsideWidth, outsideHeight int) (screenWidth, screenHeight int)
  • func (s *SceneGame) Update() (err error)

Types

type Layer

type Layer interface {
	// Draw is called every frame to render the game to screen.
	Draw(screen *ebiten.Image)
}

Layer represents a visually distinct layer of the UI that can be rendered independently of the rest.

type Layers

type Layers []Layer

Layers is a collection of Layers, which can be rendered in order.

func (Layers) Draw

func (l Layers) Draw(screen *ebiten.Image)

Draw invokes the Draw method of each Layer in the collection in order.

type Scene

type Scene interface {
	// Update is called every frame to update the state of the game.
	Update() (Scene, error)

	// Draw is called every frame to render the game to screen.
	Draw(screen *ebiten.Image)
}

Scene describes a single "scene" or screen in the game, such as a particular menu or level.

type SceneGame

type SceneGame struct {
	Scene Scene
}

SceneGame is an Ebiten Game implementation that defers all drawing and updating logic to a "Scene".

The Scene's Update() method returns the next Scene to be rendered, allowing the game to transition between different views based on the current state.

func (*SceneGame) Draw

func (s *SceneGame) Draw(screen *ebiten.Image)

func (*SceneGame) Layout

func (s *SceneGame) Layout(outsideWidth, outsideHeight int) (screenWidth, screenHeight int)

func (*SceneGame) Update

func (s *SceneGame) Update() (err error)