README
¶
ebiten-anim
Create a SpriteSheet to easily select parts of an image and create animations from them.
Usage
📖 Docs
Look at the example to see how to use the library.
// Create a spritesheet
SpriteSheet = anim.NewSpriteSheet(sprites, 8, 10, anim.SpriteSheetOptions{
Scale: 16,
})
// Create an animation
frames := make([]anim.Frame, 5)
for x := 0; x <= 4; x++ {
frames[x] = anim.NewFrame(SpriteSheet.GetSprite(x, 0), time.Second / 20)
}
Animation := anim.NewAnimation(frames)
// Update the animation
Animation.Update()
// Pause/play the animation
Animation.Pause()
Animation.Play()
// Draw the animation
Animation.Draw(screen, &ebiten.DrawImageOptions{})
// You can also just draw frames from the spritesheet without using animations
// This might be useful to avoid cluttering your Draw function with Image.SubImage
screen.DrawImage(SpriteSheet.GetSprite(0, 0), &ebiten.DrawImageOptions{})
Documentation
¶
Overview ¶
Package anim provides a simple way to create animations for use with ebiten
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Animation ¶
Animation stores a list of Frames and other data regarding timing
func NewAnimation ¶
NewAnimation returns a new Animation
type Frame ¶
Frame stores a single frame of an Animation. It contains an image and how long it should be drawn for
type SpriteSheet ¶
type SpriteSheet struct {
Image *ebiten.Image // original image which was passed on creation
PaddedImage *ebiten.Image
Sprites []*ebiten.Image
SpriteWidth int // how big each sprite is
SpriteHeight int
SpritesWide int // how many sprites are in the sheet
SpritesHigh int
Scale int
OutlineThickness int
OutlineColor color.RGBA
}
SpriteSheet stores the image and information about the sizing of the SpriteSheet
func NewSpriteSheet ¶
func NewSpriteSheet(img *ebiten.Image, origSpriteWidth, origSpriteHeight int, options SpriteSheetOptions) *SpriteSheet
NewSpriteSheet returns a new SpriteSheet
func (*SpriteSheet) GetSprite ¶
func (s *SpriteSheet) GetSprite(x, y int) *ebiten.Image
GetSprite returns the sprite at the position x,y in the tilesheet
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
examples
|
|
|
scaleAndOutline
Package main 👍
|
Package main 👍 |
|
spinningMelon
Package main 👍
|
Package main 👍 |
|
tiles
Package main 👍
|
Package main 👍 |
Click to show internal directories.
Click to hide internal directories.