Categorygithub.com/go-gl/gltext
modulepackage
0.0.0-20170328174336-01a355945a70
Repository: https://github.com/go-gl/gltext.git
Documentation: pkg.go.dev

# README

gltext

Note: This package is experimental and subject to change. Use at your own discretion.

The gltext package offers a simple set of text rendering utilities for OpenGL programs. It deals with TrueType and Bitmap (raster) fonts. Text can be rendered in various directions (Left-to-right, right-to-left and top-to-bottom). This allows for correct display of text for various languages.

The package supports the full set of unicode characters, provided the loaded font does as well.

TODO

Known bugs

  • Determining the height of truetype glyphs is not entirely accurate. It is unclear at this point how to get to this information reliably. Specifically the parts in LoadTruetype at truetype.go#L54+. The vertical glyph bounds computed by freetype-go are not correct for certain fonts. Right now we manually offset the value by added 4 to the height. This is an unreliable hack and should be fixed.
  • freetype-go does not expose AdvanceHeight for vertically rendered fonts. This may mean that the Advance size for top-to-bottom fonts is incorrect.

Dependencies

This packages uses freetype-go which is licensed under GPLv2 e FTL licenses. You can choose which one is a better fit for your use case but FTL requires you to give some form of credit to Freetype.org

You can read the GPLv2 and FTL licenses for more information about the requirements.

Usage

go get github.com/go-gl/gltext

Refer to go-gl/examples/gltext for usage examples.

License

Copyright 2012 The go-gl Authors. All rights reserved. Use of this source code is governed by a BSD-style license that can be found in the LICENSE file.

# Functions

IsPow2 returns true if the given value is a power-of-two.
LoadBitmap loads a bitmap (raster) font from the given sprite sheet and config files.
LoadTruetype loads a truetype font from the given stream and applies the given font scale in points.
Pow2 returns the first power-of-two value >= to n.
Pow2Image returns the given image, scaled to the smallest power-of-two dimensions larger or equal to the input dimensions.

# Constants

E.g.: Latin.
E.g.: Arabic.
E.g.: Chinese.

# Structs

A Font allows rendering of text to an OpenGL context.
FontConfig describes raster font metadata.
A Glyph describes metrics for a single font glyph.

# Type aliases

A Charset represents a set of glyph descriptors for a font.
Direction represents the direction in which strings should be rendered.