ebitenutil

Documentation

Overview

Package ebitenutil provides utility functions for Ebitengine.

Index

• func DebugPrint(image *ebiten.Image, str string)
• func DebugPrintAt(image *ebiten.Image, str string, x, y int)
• func DrawCircle(dst *ebiten.Image, cx, cy, r float64, clr color.Color)
• func DrawLine(dst *ebiten.Image, x1, y1, x2, y2 float64, clr color.Color)
• func DrawRect(dst *ebiten.Image, x, y, width, height float64, clr color.Color)
• func NewImageFromFile(path string) (*ebiten.Image, image.Image, error)
• func NewImageFromFileSystem(fs fs.FS, path string) (*ebiten.Image, image.Image, error)
• func NewImageFromReader(reader io.Reader) (*ebiten.Image, image.Image, error)
• func NewImageFromURL(url string) (*ebiten.Image, error)
• type ReadSeekCloser
  • func OpenFile(path string) (ReadSeekCloser, error)

Functions

func DebugPrint

func DebugPrint(image *ebiten.Image, str string)

DebugPrint draws the string str on the image at (0, 0) position (the upper-left corner in most cases).

The available runes are in U+0000 to U+00FF, which is C0 Controls and Basic Latin and C1 Controls and Latin-1 Supplement.

func DebugPrintAt

func DebugPrintAt(image *ebiten.Image, str string, x, y int)

DebugPrintAt draws the string str on the image at (x, y) position.

The available runes are in U+0000 to U+00FF, which is C0 Controls and Basic Latin and C1 Controls and Latin-1 Supplement.

func DrawCircle

func DrawCircle(dst *ebiten.Image, cx, cy, r float64, clr color.Color)

DrawCircle draws a circle on given destination dst.

DrawCircle is intended to be used mainly for debugging or prototyping purpose.

Deprecated: as of v2.5. Use vector.DrawFilledCircle without anti-aliasing instead.

func DrawLine

func DrawLine(dst *ebiten.Image, x1, y1, x2, y2 float64, clr color.Color)

DrawLine draws a line segment on the given destination dst.

DrawLine is intended to be used mainly for debugging or prototyping purpose.

Deprecated: as of v2.5. Use vector.StrokeLine without anti-aliasing instead.

func DrawRect

func DrawRect(dst *ebiten.Image, x, y, width, height float64, clr color.Color)

DrawRect draws a rectangle on the given destination dst.

DrawRect is intended to be used mainly for debugging or prototyping purpose.

Deprecated: as of v2.5. Use vector.DrawFilledRect without anti-aliasing instead.

func NewImageFromFile

func NewImageFromFile(path string) (*ebiten.Image, image.Image, error)

NewImageFromFile loads the file with path and returns ebiten.Image and image.Image.

Image decoders must be imported when using NewImageFromFile. For example, if you want to load a PNG image, you'd need to add `_ "image/png"` to the import section.

How to solve path depends on your environment. This varies on your desktop or web browser. Note that this doesn't work on mobiles.

For productions, instead of using NewImageFromFile, it is safer to embed your resources with go:embed.

func NewImageFromFileSystem

func NewImageFromFileSystem(fs fs.FS, path string) (*ebiten.Image, image.Image, error)

NewImageFromFileSystem create an image from the specified file system.

Image decoders must be imported when using NewImageFromReader. For example, if you want to load a PNG image, you'd need to add `_ "image/png"` to the import section.

func NewImageFromReader

func NewImageFromReader(reader io.Reader) (*ebiten.Image, image.Image, error)

NewImageFromReader loads from the io.Reader and returns ebiten.Image and image.Image.

Image decoders must be imported when using NewImageFromReader. For example, if you want to load a PNG image, you'd need to add `_ "image/png"` to the import section.

func NewImageFromURL

func NewImageFromURL(url string) (*ebiten.Image, error)

NewImageFromURL creates a new ebiten.Image from the given URL.

Image decoders must be imported when using NewImageFromURL. For example, if you want to load a PNG image, you'd need to add `_ "image/png"` to the import section.

Types

type ReadSeekCloser

type ReadSeekCloser interface {
	io.ReadSeeker
	io.Closer
}

ReadSeekCloser is io.ReadSeeker and io.Closer.

Deprecated: as of v2.4. Use io.ReadSeekCloser instead.

func OpenFile

func OpenFile(path string) (ReadSeekCloser, error)

OpenFile opens a file and returns a stream for its data.

The path parts should be separated with slash '/' on any environments.

OpenFile doesn't work on mobiles.

Deprecated: as of v2.4. Use os.Open on desktops and http.Get on browsers instead.