font

Documentation

Index

• Constants
• func MakeGPUSpriteMap(font *LbxFont) (*ebiten.Image, int, int, int, int)
• func MakeGPUSpriteMapWithPalette(font *LbxFont, palette color.Palette) (*ebiten.Image, int, int, int, int)
• type Font
  • func MakeOptimizedFont(font *LbxFont) *Font
  • func MakeOptimizedFontWithPalette(font *LbxFont, palette color.Palette) *Font
  • func (font *Font) CreateWrappedText(maxWidth float64, scale float64, text string) WrappedText
  • func (font *Font) Height() int
  • func (font *Font) MeasureTextWidth(text string, scale float64) float64
  • func (font *Font) Print(image *ebiten.Image, x float64, y float64, scale float64, ...)
  • func (font *Font) PrintCenter(image *ebiten.Image, x float64, y float64, scale float64, ...)
  • func (font *Font) PrintDropShadow(destination *ebiten.Image, x float64, y float64, scale float64, ...)
  • func (font *Font) PrintOptions(image *ebiten.Image, x float64, y float64, scale float64, ...)
  • func (font *Font) PrintOutline(destination *ebiten.Image, edgeShader *ebiten.Shader, x float64, y float64, ...)
  • func (font *Font) PrintRight(image *ebiten.Image, x float64, y float64, scale float64, ...)
  • func (font *Font) PrintWrap(image *ebiten.Image, x float64, y float64, maxWidth float64, scale float64, ...)
  • func (font *Font) PrintWrapCenter(image *ebiten.Image, x float64, y float64, maxWidth float64, scale float64, ...)
  • func (font *Font) RenderWrapped(image *ebiten.Image, x float64, y float64, wrapped WrappedText, ...)
• type FontJustify
• type FontOptions
• type Glyph
  • func (glyph *Glyph) MakeImage() image.Image
  • func (glyph *Glyph) MakeImageWithPalette(palette color.Palette) image.Image
• type LbxFont
  • func ReadFont(lbxFile *lbx.LbxFile, entry int, fontIndex int) (*LbxFont, error)
  • func ReadFonts(lbxFile *lbx.LbxFile, entry int) ([]*LbxFont, error)
  • func (font *LbxFont) GlyphCount() int
  • func (font *LbxFont) GlyphForRune(r rune) *Glyph
• type WrappedText
  • func (text *WrappedText) Clear()

Constants

const NewLine = 0x14

FIXME: put this somewhere else

Functions

func MakeGPUSpriteMap

func MakeGPUSpriteMap(font *LbxFont) (*ebiten.Image, int, int, int, int)

func MakeGPUSpriteMapWithPalette

func MakeGPUSpriteMapWithPalette(font *LbxFont, palette color.Palette) (*ebiten.Image, int, int, int, int)

Types

type Font

type Font struct {
	Image       *ebiten.Image
	GlyphWidth  int
	GlyphHeight int
	Rows        int
	Columns     int
	Glyphs      []Glyph
	// contains filtered or unexported fields
}

func MakeOptimizedFont

func MakeOptimizedFont(font *LbxFont) *Font

func MakeOptimizedFontWithPalette

func MakeOptimizedFontWithPalette(font *LbxFont, palette color.Palette) *Font

func (*Font) CreateWrappedText

func (font *Font) CreateWrappedText(maxWidth float64, scale float64, text string) WrappedText

precompute an object that can be used to render a wrapped string

func (*Font) Height

func (font *Font) Height() int

func (*Font) MeasureTextWidth

func (font *Font) MeasureTextWidth(text string, scale float64) float64

func (*Font) Print

func (font *Font) Print(image *ebiten.Image, x float64, y float64, scale float64, colorScale ebiten.ColorScale, text string)

print the text with no border/outline

func (*Font) PrintCenter

func (font *Font) PrintCenter(image *ebiten.Image, x float64, y float64, scale float64, colorScale ebiten.ColorScale, text string)

func (*Font) PrintDropShadow

func (font *Font) PrintDropShadow(destination *ebiten.Image, x float64, y float64, scale float64, colorScale ebiten.ColorScale, text string)

func (*Font) PrintOptions

func (font *Font) PrintOptions(image *ebiten.Image, x float64, y float64, scale float64, colorScale ebiten.ColorScale, options FontOptions, text string)

func (*Font) PrintOutline

func (font *Font) PrintOutline(destination *ebiten.Image, edgeShader *ebiten.Shader, x float64, y float64, scale float64, colorScale ebiten.ColorScale, text string)

draws a 1px outline around each glyph the edge shader should be shaders.ShaderEdgeGlow, although it should probably be changed to shaders.ShaderOutline just use PrintDropShadow for now

func (*Font) PrintRight

func (font *Font) PrintRight(image *ebiten.Image, x float64, y float64, scale float64, colorScale ebiten.ColorScale, text string)

func (*Font) PrintWrap

func (font *Font) PrintWrap(image *ebiten.Image, x float64, y float64, maxWidth float64, scale float64, colorScale ebiten.ColorScale, options FontOptions, text string)

func (*Font) PrintWrapCenter

func (font *Font) PrintWrapCenter(image *ebiten.Image, x float64, y float64, maxWidth float64, scale float64, colorScale ebiten.ColorScale, text string)

func (*Font) RenderWrapped

func (font *Font) RenderWrapped(image *ebiten.Image, x float64, y float64, wrapped WrappedText, colorScale ebiten.ColorScale, options FontOptions)

type FontJustify

type FontJustify int

const (
	FontJustifyLeft FontJustify = iota
	FontJustifyCenter
	FontJustifyRight
)

type FontOptions

type FontOptions struct {
	// left is default
	Justify FontJustify
	// no shadow is default
	DropShadow bool
	// if DropShadow is true, this is the color of the shadow, which defaults to black
	ShadowColor color.Color
}

for rendering, to specify justification, wrapping and shadows

type Glyph

type Glyph struct {
	Data   []byte
	Width  int
	Height int
}

func (*Glyph) MakeImage

func (glyph *Glyph) MakeImage() image.Image

func (*Glyph) MakeImageWithPalette

func (glyph *Glyph) MakeImageWithPalette(palette color.Palette) image.Image

type LbxFont

type LbxFont struct {
	Height            int
	HorizontalSpacing int
	VerticalSpacing   int
	Glyphs            []Glyph
}

func ReadFont

func ReadFont(lbxFile *lbx.LbxFile, entry int, fontIndex int) (*LbxFont, error)

func ReadFonts

func ReadFonts(lbxFile *lbx.LbxFile, entry int) ([]*LbxFont, error)

func (*LbxFont) GlyphCount

func (font *LbxFont) GlyphCount() int

func (*LbxFont) GlyphForRune

func (font *LbxFont) GlyphForRune(r rune) *Glyph

type WrappedText

type WrappedText struct {
	Lines       []string
	TotalHeight float64
	MaxWidth    float64
	Scale       float64
}

func (*WrappedText) Clear

func (text *WrappedText) Clear()