etxt

ETXT

ETXT est un package pour le rendu de texte vectorial ¹ à Golang conçu pour être utilisé avec EBITENCINE , le moteur de jeu 2D fabriqué par Hajime Hoshi.

Alors que l'EBitEngine inclut déjà le package EBITEN / V2 / Text / V2 , ETXT présente certains avantages:

• Rend la taille du texte facile à modifier.
• Met l'accent sur l'obtention de l'échelle d'affichage correctement.
• Se débarrasser de font.Face pour de bon.
• Fournit une documentation et des exemples de haute qualité.
• Aide avec des extras comme un faux gras, un faux oblique, un emballage de ligne de base, des polices intégrées, une quantification des glyphes, un espacement des lignes, etc.
• Expose que les caches, les rasterisers et les Sizers pour vous adapter si vous avez des besoins plus avancés.

Ce que ETXT ne fait pas:

• Pas de mise en page générale du texte. Des fonctionnalités telles que Bidi, la détail, la mise en forme, les tests généraux, la justification et d'autres ne sont pas couverts et, dans la plupart des cas, ne sont pas un objectif principal pour ce package.
• Mauvais ou pas de support pour les scripts complexes (par exemple arabe) ni les dispositions de texte verticales (par exemple japonais). Remarquez que l'ebiten / v2 / text / v2 s'entend beaucoup mieux à cet égard.
• Rien de ce que les gens veulent réellement: les ombres et les contours, la correction gamma, l'antialiasage des sous-pixels, la rupture de la ligne de knuth-plass, le meilleur support pour les shaders, etc. Certains peuvent déjà être grossièrement truqués, certains seront ajoutés à l'avenir ... mais c'est la situation en ce moment.

Si vous n'êtes pas familier avec les termes et concepts de typographie, je recommande fortement de lire les premiers chapitres des conventions de glyphe Freetype; L'une des meilleures références sur le sujet que vous pouvez trouver sur Internet.

Exemple de code

Moins de conversation et plus de code!

 package main

import ( "math" ; "image/color" )
import "github.com/hajimehoshi/ebiten/v2"
import "github.com/tinne26/etxt"
import "github.com/tinne26/fonts/liberation/lbrtserif"

const WordsPerSec = 2.71828
var Words = [] string {
	"solitude" , "joy" , "ride" , "whisper" , "leaves" , "cookie" ,
	"hearts" , "disdain" , "simple" , "death" , "sea" , "shallow" ,
	"self" , "rhyme" , "childish" , "sky" , "tic" , "tac" , "boom" ,
}

// ---- Ebitengine's Game interface implementation ----

type Game struct { text * etxt. Renderer ; wordIndex float64 }

func ( self * Game ) Layout ( winWidth int , winHeight int ) ( int , int ) {
	scale := ebiten . DeviceScaleFactor () // *
	// * ebiten.Monitor().DeviceScaleFactor() in >=v2.7.0
	self . text . SetScale ( scale ) // relevant for HiDPI
	canvasWidth  := int ( math . Ceil ( float64 ( winWidth ) * scale ))
	canvasHeight := int ( math . Ceil ( float64 ( winHeight ) * scale ))
	return canvasWidth , canvasHeight
}

func ( self * Game ) Update () error {
	newIndex := ( self . wordIndex + WordsPerSec / 60.0 )
	self . wordIndex = math . Mod ( newIndex , float64 ( len ( Words )))
	return nil
}

func ( self * Game ) Draw ( canvas * ebiten. Image ) {
	// background color
	canvas . Fill (color. RGBA { 229 , 255 , 222 , 255 })
	
	// get screen center position
	bounds := canvas . Bounds () // assumes origin (0, 0)
	x , y := bounds . Dx () / 2 , bounds . Dy () / 2

	// draw text
	word := Words [ int ( self . wordIndex )]
	self . text . Draw ( canvas , word , x , y )
}

// ---- main function ----

func main () {
	// create text renderer, set the font and cache
	renderer := etxt . NewRenderer ()
	renderer . SetFont ( lbrtserif . Font ())
	renderer . Utils (). SetCache8MiB ()
	
	// adjust main text style properties
	renderer . SetColor (color. RGBA { 239 , 91 , 91 , 255 })
	renderer . SetAlign ( etxt . Center )
	renderer . SetSize ( 72 )

	// set up Ebitengine and start the game
	ebiten . SetWindowTitle ( "etxt/examples/ebiten/words" )
	err := ebiten . RunGame ( & Game { text : renderer })
	if err != nil { panic ( err ) }
}

Vous pouvez essayer de l'exécuter vous-même avec ² :

 go run github.com/tinne26/etxt/examples/ebiten/words@latest

Alternativement, vous pouvez aller sur https://tinne26.github.io/etxt-examples/ et cliquez sur le premier exemple de la version Web.

Ceci est un exemple très simple et autonome. Si vous voulez en savoir plus, assurez-vous de jeter un œil à ETXT / Exemples!

Puis-je utiliser ce package sans EBITEngine?

Ouais, vous pouvez le compiler avec -tags gtxt . Notez que gtxt permettra à un dessin de texte sur le CPU, alors n'essayez pas de l'utiliser pour des applications en temps réel. En particulier, soyez prudent de ne pas utiliser accidentellement gtxt avec l'ebitEngine (ils sont compatibles dans de nombreux cas, mais les performances mourront).

Tests, contributions et autres

• Pour les tests, consultez les instructions sur etxt/test .
• Si vous avez des questions ou des suggestions d'amélioration, n'hésitez pas à parler, je suis toujours heureux d'expliquer ou de discuter.
• Sinon, je ne cherche pas de contributeurs ni d'aide générale.

Notes de bas de page

1. Si vous utilisez des polices vectoriales de type pixel-art, lisez ces conseils. ↩

2. Vous aurez besoin de Golang> = 1.18, et si vous n'avez jamais utilisé d'EbitEngine auparavant, vous devrez peut-être installer certaines dépendances (généralement uniquement sur Linux ou FreeBSD). ↩