gui

Documentation

Index

• type Assets
  • func (assets Assets) GetSprite(spriteName string) *graphics.Sprite
  • func (assets *Assets) RegisterAssets(dirPath string, fs embed.FS) error

Types

type Assets

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

func (Assets) GetSprite

func (assets Assets) GetSprite(spriteName string) *graphics.Sprite

GetSprite Returns sprite for the given spriteName. spriteName shall be passed without extension. See example in RegisterAssets.

func (*Assets) RegisterAssets

func (assets *Assets) RegisterAssets(dirPath string, fs embed.FS) error

RegisterAssets Loads assets from given directory and filesystem for further usage currently supports only png files which are recognized as sprites dirPath is a relative path to directory from fs root. It is used as prefix for further calls. Example:

fs ~ assetsDir/
     ├── logo.png
     ├── character/
         ├── male.png
         ├── female.png
         └── alien.png

gameAssets := new(Assets)
gameAssets.RegisterAssets("assetsDir", fs)

maleSprite := gameAssets.GetSprite("character/male")
femaleSprite := gameAssets.GetSprite("character/female")
alienSprite := gameAssets.GetSprite("character/alien")
logoSprite := gameAssets.GetSprite("logo")