Graphics.Rendering.MiniTypeset.MultiFont

Typically, we use multiple fonts to compose a document. Some examples for this are:

• bold, italic, etc typefaces as separate font files
• greek, cyrillic and other non-latin alphabets
• a monospace font
• mathematical symbols

We can also use different font sizes, for example subscript, superscript, etc.

This module provides a layer on the top FontTexture to support this.

For a good trade-off between simplicity and generality, we opt to encode a glyph as a Unicode code point together with a user-defined style attribute, and let the user provide a mapping from this to different physical font files.

Documentation

stdFontTextureSize :: Int -> (Int, Int)

given a font height (in pixels), we return how big texture(s) should we allocate for this

data UserFontConfig fontfile style

The user-defined types fontfile and style should encode the available font files and styles. They should be an enumerated type for efficiency. fontfile must have Eq and Ord instances, too.

Constructors

UserFontConfig

Fields

• _ufcFontFiles :: fontfile -> FilePath

  the mapping from abstract to physical font files

• _ufcCharMap :: style -> Char -> fontfile

  the mapping from characters to font files

• _ufcStyleMap :: BasicStyle -> style

  mapping the basic style into the user styles

• _ufcLineGapFactor :: !Double

  extend or shrink the font default line gap

data MultiFont fontfile style

Constructors

MultiFont

Fields

• _mfUserConfig :: !(UserFontConfig fontfile style)

  the user-defined configuration

• _mfFontTexs :: !(IORef (Map fontfile (IntMap FontTexture)))

  mapping from font files and heights to textures

mfCharMap :: MultiFont fontfile style -> style -> Char -> fontfile

mfLineGapFactor :: MultiFont fontfile style -> Double

newMultiFont :: Ord fontfile => UserFontConfig fontfile style -> IO (MultiFont fontfile style)

loadFontFile :: FilePath -> IO Font

mapInsert :: Ord k => a -> (a -> a) -> k -> Map k a -> Map k a

mapIntLookup :: Ord k => k -> Int -> Map k (IntMap a) -> Maybe a

encodeXYHeight :: (Int, Int) -> Int

mfAddNewFontTex :: Ord fontfile => MultiFont fontfile style -> (fontfile, (Int, Int)) -> IO ()

Multifont glyphs

data MultiFontGlyph

Constructors

MFG !FontTexture !BufLoc

Instances

Show MultiFontGlyph

Defined in Graphics.Rendering.MiniTypeset.MultiFont

Methods

showsPrec :: Int -> MultiFontGlyph -> ShowS

show :: MultiFontGlyph -> String

showList :: [MultiFontGlyph] -> ShowS

mfgLineGapFactor :: MultiFontGlyph -> Double

lkpMultiFont :: Ord fontfile => MultiFont fontfile style -> Int -> style -> Char -> IO MultiFontGlyph

lkpMultiFont' :: Ord fontfile => MultiFont fontfile style -> (Int, Int) -> style -> Char -> IO MultiFontGlyph