GLUT-2.7.0.3: A binding for the OpenGL Utility Toolkit

Copyright | (c) Sven Panne 2002-2013
License | BSD3
Maintainer | Sven Panne <svenpanne@gmail.com>
Stability | stable
Portability | portable
Safe Haskell | None
Language | Haskell2010

Graphics.UI.GLUT.Fonts

Description

GLUT supports two types of font rendering: stroke fonts, meaning each character is rendered as a set of line segments; and bitmap fonts, where each character is a bitmap generated with `bitmap`. Stroke fonts have the advantage that because they are geometry, they can be arbitrarily scale and rendered. Bitmap fonts are less flexible since they are rendered as bitmaps but are usually faster than stroke fonts.

Synopsis

- class Font a where
  - renderString :: MonadIO m => a -> String -> m ()
  - stringWidth :: MonadIO m => a -> String -> m GLint
  - fontHeight :: MonadIO m => a -> m GLfloat
- data BitmapFont
  - = Fixed8By13
  - | Fixed9By15
  - | TimesRoman10
  - | TimesRoman24
  - | Helvetica10
  - | Helvetica12
  - | Helvetica18
- data StrokeFont
  - = Roman
  - | MonoRoman

# Documentation

class Font a where

Methods

renderString :: MonadIO m => a -> String -> m ()

Render the string in the named font, without using any display lists. Rendering a nonexistent character has no effect.

If the font is a bitmap font, `renderString` automatically sets the OpenGL unpack pixel storage modes it needs appropriately and saves and restores the previous modes before returning. The generated call to `bitmap` will adjust the current raster position based on the width of the string. If the font is a stroke font, `translate` is used to translate the current model view matrix to advance the width of the string.

stringWidth :: MonadIO m => a -> String -> m GLint

For a bitmap font, return the width in pixels of a string. For a stroke font, return the width in units. While the width of characters in a font may vary (though fixed width fonts do not vary), the maximum height characteristics of a particular font are fixed.

fontHeight :: MonadIO m => a -> m GLfloat

(freeglut only) For a bitmap font, return the maximum height of the characters in the given font measured in pixels. For a stroke font, return the width in units.

Instances

Font StrokeFont |
Font BitmapFont |

data BitmapFont

The bitmap fonts available in GLUT. The exact bitmap to be used is defined by the standard X glyph bitmaps for the X font with the given name.

Constructors

Fixed8By13 | A fixed width font with every character fitting in an 8 by 13 pixel rectangle. (`-misc-fixed-medium-r-normal--13-120-75-75-C-80-iso8859-1`)
Fixed9By15 | A fixed width font with every character fitting in an 9 by 15 pixel rectangle. (`-misc-fixed-medium-r-normal--15-140-75-75-C-90-iso8859-1`)
TimesRoman10 | A 10-point proportional spaced Times Roman font. (`-adobe-times-medium-r-normal--10-100-75-75-p-54-iso8859-1`)
TimesRoman24 | A 24-point proportional spaced Times Roman font. (`-adobe-times-medium-r-normal--24-240-75-75-p-124-iso8859-1`)
Helvetica10 | A 10-point proportional spaced Helvetica font. (`-adobe-helvetica-medium-r-normal--10-100-75-75-p-56-iso8859-1`)
Helvetica12 | A 12-point proportional spaced Helvetica font. (`-adobe-helvetica-medium-r-normal--12-120-75-75-p-67-iso8859-1`)
Helvetica18 | A 18-point proportional spaced Helvetica font. (`-adobe-helvetica-medium-r-normal--18-180-75-75-p-98-iso8859-1`)

Instances

Eq BitmapFont |
Ord BitmapFont |
Show BitmapFont |
Font BitmapFont |

data StrokeFont

The stroke fonts available in GLUT.

Constructors

Roman | A proportionally spaced Roman Simplex font for ASCII characters 32 through 127. The maximum top character in the font is 119.05 units; the bottom descends 33.33 units.
MonoRoman | A mono-spaced spaced Roman Simplex font (same characters as `Roman`) for ASCII characters 32 through 127. The maximum top character in the font is 119.05 units; the bottom descends 33.33 units. Each character is 104.76 units wide.

Instances

Eq StrokeFont |
Ord StrokeFont |
Show StrokeFont |
Font StrokeFont |