piebiten

Documentation

Overview

Package piebiten enables running your game using the Ebitengine backend.

Ebitengine is a cross-platform game engine that supports Windows, macOS, Linux, FreeBSD, web browsers, Android, iOS, and even Nintendo Switch.

To launch your game, use Run or RunOrErr.

This package also provides advanced functions for integrating Pi with your own Ebitengine-based game, such as CopyCanvasToEbitenImage.

Index

• Variables
• func CopyCanvasToEbitenImage(canvas pi.Canvas, dst *ebiten.Image)
• func Run()
• func RunOrErr() error
• type Audio
  • func StartAudioBackend(ctx *ebitenaudio.Context) Audio

Variables

var RememberWindow = false

RememberWindow determines whether the game should open at its last window position, size, and monitor when set to true

Functions

func CopyCanvasToEbitenImage

func CopyCanvasToEbitenImage(canvas pi.Canvas, dst *ebiten.Image)

CopyCanvasToEbitenImage copies the canvas to dst using the current palette in pi.Palette and the palette mapping in pi.PaletteMapping.

func Run

func Run()

Run starts the Ebitengine backend. It panics if something goes wrong.

If you want to handle errors gracefully, use RunOrErr instead.

This function must be called from the first goroutine (the main thread).

func RunOrErr

func RunOrErr() error

RunOrErr starts the Ebitengine backend and returns an error if something goes wrong.

This function must be called from the first goroutine (the main thread).

Types

type Audio

type Audio interface {
	piaudio.BackendInterface
	// OnBeforeUpdate must be called at the start of Ebitengine's Update function.
	OnBeforeUpdate()
	// OnAfterUpdate must be called at the end of Ebitengine's Update function.
	OnAfterUpdate()
}

func StartAudioBackend

func StartAudioBackend(ctx *ebitenaudio.Context) Audio

StartAudioBackend starts the audio backend with the given Ebitengine audio.Context. Use if you want only piaudio functionality without Pi's graphics.

audio.Context must have a sample rate of 48000.