pixelutils

README

pixelutils

A collection of random things I think could be useful for those using the Pixel library.

Available Tools

Check out the wiki to see how to use these tools.

• Sprite Packer: Runtime packer based on rectpack2D.
• ID Generator: Thread safe integer ID generator.
• Ticker: My attempt for an easy-to-use framerate limiter.
• Sprite Loader: A simple sprite/picture data loader based on the Pixel example.
• Voronoi Diagrams: A pixel-compatible interface built on Voronoi Diagrams.

Planned

• AStar Pathfinding

Contribution

Feel free to add any tools that you've created for Pixel, I just ask that they're documented well and an usage wiki entry is added.

Documentation

Index

• Constants
• func LoadPictureData(path string) (data *pixel.PictureData, err error)
• func LoadSprite(path string) (sprite *pixel.Sprite, err error)
• type IDGen
  • func (gen *IDGen) Gen() (id int)
• type Ticker
  • func NewTicker(targetFPS int64) *Ticker
  • func NewTickerV(targetFPS, maxPrevFPS int64) *Ticker
  • func (ticker Ticker) AvgFramerate() float64
  • func (ticker Ticker) Deltat() float64
  • func (ticker Ticker) Framerate() float64
  • func (ticker Ticker) PrevFramerates() []float32
  • func (ticker *Ticker) Reset()
  • func (ticker *Ticker) SetTargetFPS(target int64)
  • func (ticker Ticker) TargetFrametime() time.Duration
  • func (ticker *Ticker) Tick() (deltat, framerate float64)
  • func (ticker *Ticker) Wait()
• type Voronoi
  • func NewVoronoi() (v *Voronoi)
  • func (v *Voronoi) Compute(boundingBox pixel.Rect, closeCells bool) VoronoiCellMap
  • func (v *Voronoi) Insert(id interface{}, pos pixel.Vec)
• type VoronoiCell
• type VoronoiCellMap

Constants

const (
	MAX_PREV_FPS = 500
)

Functions

func LoadPictureData

func LoadPictureData(path string) (data *pixel.PictureData, err error)

Helper to load a sprite from a file and make Pixel.PictureData from it

func LoadSprite

func LoadSprite(path string) (sprite *pixel.Sprite, err error)

Helper to load a sprite from file and make a Pixel.Sprite from it

Types

type IDGen

type IDGen struct {
	sync.Mutex
	// contains filtered or unexported fields
}

IDGen is a simple, thread safe, integer id generator

func (*IDGen) Gen

func (gen *IDGen) Gen() (id int)

Gen generates the next id and returns it

type Ticker

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

func NewTicker

func NewTicker(targetFPS int64) *Ticker

NewTicker returns a new ticker with the given target fps and 500 stored previous framerates.

func NewTickerV

func NewTickerV(targetFPS, maxPrevFPS int64) *Ticker

NewTickerV returns a new ticker with the given target fps and a custom amount of stored previous framerates.

If maxPrevFPS is <= 0, don't store any previous framerates.

func (Ticker) AvgFramerate

func (ticker Ticker) AvgFramerate() float64

Return the average framerate

func (Ticker) Deltat

func (ticker Ticker) Deltat() float64

Return the last Deltat

func (Ticker) Framerate

func (ticker Ticker) Framerate() float64

Return the last framerate

func (Ticker) PrevFramerates

func (ticker Ticker) PrevFramerates() []float32

Return the list of previous framerates

func (*Ticker) Reset

func (ticker *Ticker) Reset()

Reset the ticker

func (*Ticker) SetTargetFPS

func (ticker *Ticker) SetTargetFPS(target int64)

SetTargetFPS sets the target ticker rate; will be less than or equal to target.

func (Ticker) TargetFrametime

func (ticker Ticker) TargetFrametime() time.Duration

Return the current target frametime

func (*Ticker) Tick

func (ticker *Ticker) Tick() (deltat, framerate float64)

Tick ticks the tickers and calculates the framerate and framedelta

func (*Ticker) Wait

func (ticker *Ticker) Wait()

Wait for the timer to complete its timeout

type Voronoi

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

func NewVoronoi

func NewVoronoi() (v *Voronoi)

Creates and returns a new pixel-compatible Voronoi

func (*Voronoi) Compute

func (v *Voronoi) Compute(boundingBox pixel.Rect, closeCells bool) VoronoiCellMap

Computes the voronoi diagram, constrained by the given bounding box, from the nodes inserted into the list

If closeCells == true, edges from bounding box will be included in the diagram.

func (*Voronoi) Insert

func (v *Voronoi) Insert(id interface{}, pos pixel.Vec)

Inserts the vector into the voronoi list with the given identifier

type VoronoiCell

type VoronoiCell struct {
	ID        interface{}
	Site      pixel.Vec
	Halfedges []pixel.Line
}

type VoronoiCellMap

type VoronoiCellMap map[interface{}]VoronoiCell