draws

Documentation

Index

• Constants
• Variables
• func NewImageImageFromFile(fsys fs.FS, name string) image.Image
• type Anchor
• type Animation
  • func NewAnimation(srcs any) Animation
  • func NewAnimationFromFile(fsys fs.FS, name string) Animation
  • func (a Animation) IsEmpty() bool
• type Blank
  • func (b Blank) Draw(dst Image, op Op)
  • func (b Blank) IsEmpty() bool
  • func (b Blank) Size() Vector2
• type Button
  • func NewButton(sprite Sprite, onClick func(), mode ButtonMode) Button
  • func (b *Button) Draw(dst Image, op Op)
  • func (b *Button) Hover() bool
  • func (b *Button) Update()
• type ButtonMode
• type Frames
  • func NewFramesFromFilename(fsys fs.FS, name string) Frames
• type Image
  • func NewImage(w, h float64) Image
  • func NewImageColored(src Image, color color.Color) Image
  • func NewImageFromFile(fsys fs.FS, name string) Image
  • func NewImageFromURL(url string) (Image, error)
  • func NewImageXFlipped(src Image) Image
  • func NewImageYFlipped(src Image) Image
  • func (i Image) Draw(dst Image, op Op)
  • func (i Image) IsEmpty() bool
  • func (i Image) Size() Vector2
• type Op
• type Position
• type Source
• type Sprite
  • func NewSprite(src Source) Sprite
  • func NewSpriteFromFile(fsys fs.FS, name string) Sprite
  • func NewSpriteFromURL(url string) (Sprite, error)
  • func (s Sprite) Draw(dst Image, op Op)
  • func (s Sprite) H() float64
  • func (s Sprite) In(p Vector2) bool
  • func (s Sprite) LeftTop(screenSize Vector2) (v Vector2)
  • func (s *Sprite) Locate(x, y float64, anchor Anchor)
  • func (s Sprite) Max() Vector2
  • func (s Sprite) Min() (min Vector2)
  • func (s *Sprite) Move(x, y float64)
  • func (s *Sprite) MultiplyScale(scale float64)
  • func (s *Sprite) SetSize(w, h float64)
  • func (s Sprite) Size() Vector2
  • func (s Sprite) SrcSize() Vector2
  • func (s Sprite) W() float64
• type Text
  • func NewText(t string, face font.Face) Text
  • func (t Text) Draw(dst Image, op Op)
  • func (t Text) IsEmpty() bool
  • func (t Text) Size() Vector2
• type Timer
  • func NewTimer(maxTick, period int) Timer
  • func (t Timer) Age() float64
  • func (t Timer) Frame(animation Animation) Sprite
  • func (t Timer) IsDone() bool
  • func (t Timer) Progress(start, end float64) float64
  • func (t *Timer) Reset()
  • func (t *Timer) Ticker()
• type Vector2
  • func IntVec2(x, y int) Vector2
  • func Scalar(v float64) Vector2
  • func Vec2(x, y float64) Vector2
  • func (v Vector2) Add(w Vector2) Vector2
  • func (v Vector2) Div(w Vector2) Vector2
  • func (v Vector2) Mul(w Vector2) Vector2
  • func (v Vector2) Scale(scale float64) Vector2
  • func (v Vector2) Sub(w Vector2) Vector2
  • func (v Vector2) XY() (float64, float64)
  • func (v Vector2) XYInt() (int, int)

Constants

const (
	Left = iota
	Center
	Right
)

const (
	Top = iota
	Middle
	Bottom
)

const (
	ButtonModePressed = iota
	ButtonModeClicked // onClick goes called when mouse button is pressed and released.
)

Variables

var (
	LeftTop      = struct{ X, Y int }{Left, Top}
	LeftMiddle   = struct{ X, Y int }{Left, Middle}
	LeftBottom   = struct{ X, Y int }{Left, Bottom}
	CenterTop    = struct{ X, Y int }{Center, Top}
	CenterMiddle = struct{ X, Y int }{Center, Middle}
	CenterBottom = struct{ X, Y int }{Center, Bottom}
	RightTop     = struct{ X, Y int }{Right, Top}
	RightMiddle  = struct{ X, Y int }{Right, Middle}
	RightBottom  = struct{ X, Y int }{Right, Bottom}
)

https://go.dev/play/p/6FsxRuznEtE

Functions

func NewImageImageFromFile

func NewImageImageFromFile(fsys fs.FS, name string) image.Image

Types

type Anchor

type Anchor struct{ X, Y int }

type Animation

type Animation []Sprite

func NewAnimation

func NewAnimation(srcs any) Animation

func NewAnimationFromFile

func NewAnimationFromFile(fsys fs.FS, name string) Animation

func (Animation) IsEmpty

func (a Animation) IsEmpty() bool

type Blank

type Blank struct{ Size_ Vector2 }

Blank is for wrapping Sprite with specific Outer size.

func (Blank) Draw

func (b Blank) Draw(dst Image, op Op)

func (Blank) IsEmpty

func (b Blank) IsEmpty() bool

func (Blank) Size

func (b Blank) Size() Vector2

type Button

type Button struct {
	Sprite
	// contains filtered or unexported fields
}

func NewButton

func NewButton(sprite Sprite, onClick func(), mode ButtonMode) Button

func (*Button) Draw

func (b *Button) Draw(dst Image, op Op)

func (*Button) Hover

func (b *Button) Hover() bool

func (*Button) Update

func (b *Button) Update()

type ButtonMode

type ButtonMode int

type Frames

type Frames = []Image

func NewFramesFromFilename

func NewFramesFromFilename(fsys fs.FS, name string) Frames

Read frames if there is a directory and the directory has entries. Read a single image if there is no directory or the directory has no entries.

type Image

type Image struct{ *ebiten.Image }

func NewImage

func NewImage(w, h float64) Image

func NewImageColored

func NewImageColored(src Image, color color.Color) Image

func NewImageFromFile

func NewImageFromFile(fsys fs.FS, name string) Image

NewImageFromFile returns nil when fails to load file from given path. ebiten.NewImageFromImage will panic when input is nil.

func NewImageFromURL

func NewImageFromURL(url string) (Image, error)

func NewImageXFlipped

func NewImageXFlipped(src Image) Image

func NewImageYFlipped

func NewImageYFlipped(src Image) Image

func (Image) Draw

func (i Image) Draw(dst Image, op Op)

func (Image) IsEmpty

func (i Image) IsEmpty() bool

func (Image) Size

func (i Image) Size() Vector2

type Op

type Op struct {
	colorm.DrawImageOptions
	ColorM colorm.ColorM
}

type Op = ebiten.DrawImageOptions

type Position

type Position = Vector2

Unit of Position is pixel. cf. Location: unit is percent.

type Source

type Source interface {
	Size() Vector2
	Draw(Image, Op)
	IsEmpty() bool // Whether the source is nil.
}

Image, Text, and Blank implement Source.

type Sprite

type Sprite struct {
	Source
	Scale  Vector2
	Filter ebiten.Filter
	Position
	Anchor Anchor
}

Sprite is an image or a text drawn in a screen based on its position and scale. DrawImageOptions is not commutative. Do Translate at the final stage.

func NewSprite

func NewSprite(src Source) Sprite

func NewSpriteFromFile

func NewSpriteFromFile(fsys fs.FS, name string) Sprite

func NewSpriteFromURL

func NewSpriteFromURL(url string) (Sprite, error)

func (Sprite) Draw

func (s Sprite) Draw(dst Image, op Op)

func (Sprite) H

func (s Sprite) H() float64

func (Sprite) In

func (s Sprite) In(p Vector2) bool

func (Sprite) LeftTop

func (s Sprite) LeftTop(screenSize Vector2) (v Vector2)

func (*Sprite) Locate

func (s *Sprite) Locate(x, y float64, anchor Anchor)

func (Sprite) Max

func (s Sprite) Max() Vector2

func (Sprite) Min

func (s Sprite) Min() (min Vector2)

func (*Sprite) Move

func (s *Sprite) Move(x, y float64)

func (*Sprite) MultiplyScale

func (s *Sprite) MultiplyScale(scale float64)

func (*Sprite) SetSize

func (s *Sprite) SetSize(w, h float64)

func (Sprite) Size

func (s Sprite) Size() Vector2

func (Sprite) SrcSize

func (s Sprite) SrcSize() Vector2

func (Sprite) W

func (s Sprite) W() float64

type Text

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

func NewText

func NewText(t string, face font.Face) Text

func (Text) Draw

func (t Text) Draw(dst Image, op Op)

issue: ebiten/v2/text.DrawWithOptions does not support ColorM.

func (Text) IsEmpty

func (t Text) IsEmpty() bool

func (Text) Size

func (t Text) Size() Vector2

Append new line when each function has more than one line and functions are not strictly related.

type Timer

type Timer struct {
	Tick    int
	MaxTick int
	Period  int
}

MaxTick, Period == {+, +}: finite drawing with animation. e.g., Judgment. MaxTick, Period == {+, 0}: finite drawing with no animation. e.g., Combo. MaxTick, Period == {0, +}: infinite drawing with animation. e.g., Dancer. MaxTick, Period == {0, 0}: infinite drawing with no animation. e.g., Stage.

func NewTimer

func NewTimer(maxTick, period int) Timer

All timer starts at maxTick, hence IsDone() is true at the beginning.

func (Timer) Age

func (t Timer) Age() float64

For visual effects.

func (Timer) Frame

func (t Timer) Frame(animation Animation) Sprite

For Animation.

func (Timer) IsDone

func (t Timer) IsDone() bool

func (Timer) Progress

func (t Timer) Progress(start, end float64) float64

func (*Timer) Reset

func (t *Timer) Reset()

func (*Timer) Ticker

func (t *Timer) Ticker()

type Vector2

type Vector2 struct{ X, Y float64 }

func IntVec2

func IntVec2(x, y int) Vector2

Input integers.

func Scalar

func Scalar(v float64) Vector2

func Vec2

func Vec2(x, y float64) Vector2

func (Vector2) Add

func (v Vector2) Add(w Vector2) Vector2

func (Vector2) Div

func (v Vector2) Div(w Vector2) Vector2

func (Vector2) Mul

func (v Vector2) Mul(w Vector2) Vector2

func (Vector2) Scale

func (v Vector2) Scale(scale float64) Vector2

func (Vector2) Sub

func (v Vector2) Sub(w Vector2) Vector2

func (Vector2) XY

func (v Vector2) XY() (float64, float64)

func (Vector2) XYInt

func (v Vector2) XYInt() (int, int)

Output integers.