Copyright	(c) 2018 Schell Scivally
License	MIT
Maintainer	Schell Scivally <schell@takt.com>
Safe Haskell	None
Language	Haskell2010

Typograffiti

Contents

Some simple default text rendering operations
Transforming rendered text
Getting low
Types
Errors

Description

This module provides easy freetype2-based font rendering with a nice Haskell interface.

Synopsis

data RenderedText t m = RenderedText {
- drawRenderedText :: t -> m ()
- sizeOfRenderedText :: V2 Int
}
data TextRenderingData t = TextRenderingData {
- textRenderingDataAllocWord :: Atlas -> String -> IO (Either TypograffitiError (AllocatedRendering t))
- textRenderingDataFontMap :: Map (FilePath, GlyphSize) (Font t)
- textRenderingDataCharSet :: Set Char
}
data FontStore t
newDefaultFontStore :: (MonadIO m, MonadError TypograffitiError m, Integral i) => IO (V2 i) -> m (FontStore [TextTransform])
getTextRendering :: (MonadIO m, MonadError TypograffitiError m, Layout t) => FontStore t -> FilePath -> GlyphSize -> String -> m (RenderedText t m)
data TextTransform
- = TextTransformMultiply (V4 Float)
- | TextTransformSpatial SpatialTransform
move :: Float -> Float -> TextTransform
scale :: Float -> Float -> TextTransform
rotate :: Float -> TextTransform
color :: Float -> Float -> Float -> Float -> TextTransform
alpha :: Float -> TextTransform
class Layout t where
allocAtlas :: (MonadIO m, MonadError TypograffitiError m) => FilePath -> GlyphSize -> String -> m Atlas
loadText :: forall m t. (MonadIO m, MonadError TypograffitiError m, Layout t) => (Atlas -> String -> m (AllocatedRendering t)) -> Atlas -> WordCache t -> String -> m (t -> IO (), V2 Int, WordCache t)
unloadMissingWords :: MonadIO m => WordCache t -> String -> m (WordCache t)
stringTris :: (MonadIO m, MonadError TypograffitiError m) => Atlas -> Bool -> String -> m (Vector (V2 Float, V2 Float))
makeDefaultAllocateWord :: (MonadIO m, MonadError TypograffitiError m, Integral i) => IO (V2 i) -> m (Atlas -> String -> IO (Either TypograffitiError (AllocatedRendering [TextTransform])))
asciiChars :: String
data GlyphSize
- = GlyphSizeByChar CharSize
- | GlyphSizeInPixels Int Int
data CharSize = CharSize {
- charSizeWidth :: Int
- charSizeHeight :: Int
- charSizeWidthDPI :: Int
- charSizeHeightDPI :: Int
}
data Atlas = Atlas {
- atlasTexture :: GLuint
- atlasTextureSize :: V2 Int
- atlasLibrary :: FT_Library
- atlasFontFace :: FT_Face
- atlasMetrics :: IntMap GlyphMetrics
- atlasGlyphSize :: GlyphSize
- atlasFilePath :: FilePath
}
newtype WordCache t = WordCache {
- unWordCache :: Map String (AllocatedRendering t)
}
data AllocatedRendering t = AllocatedRendering {
- arDraw :: t -> IO ()
- arRelease :: IO ()
- arSize :: V2 Int
}
data TypograffitiError
- = TypograffitiErrorNoGlyphMetricsForChar Char
- | TypograffitiErrorFreetype String String
- | TypograffitiErrorGL String

Some simple default text rendering operations

data RenderedText t m Source #

A pre-rendered bit of text, ready to display given some post compilition transformations. Also contains the text size.

Constructors

RenderedText
Fields drawRenderedText :: t -> m () sizeOfRenderedText :: V2 Int

data TextRenderingData t Source #

Constructors

TextRenderingData
Fields textRenderingDataAllocWord :: Atlas -> String -> IO (Either TypograffitiError (AllocatedRendering t)) The operation used to alloc a word. Generate geometry, use a shader program, set uniforms, etc. textRenderingDataFontMap :: Map (FilePath, GlyphSize) (Font t) The cached fonts. textRenderingDataCharSet :: Set Char The character set to have available in all allocated Atlas types.

data FontStore t Source #

Stored fonts at specific sizes.

newDefaultFontStore :: (MonadIO m, MonadError TypograffitiError m, Integral i) => IO (V2 i) -> m (FontStore [TextTransform]) Source #

getTextRendering Source #

Arguments

:: (MonadIO m, MonadError TypograffitiError m, Layout t)
=> FontStore t	The font store.
-> FilePath	The path to the font to use for rendering.
-> GlyphSize	The size of the font glyphs.
-> String	The string to render.
-> m (RenderedText t m)	The rendered text, ready to draw to the screen.

Transforming rendered text

data TextTransform Source #

Constructors

TextTransformMultiply (V4 Float)
TextTransformSpatial SpatialTransform

Instances

Layout [TextTransform] Source #
Instance details Defined in Typograffiti.Cache Methods translate :: [TextTransform] -> V2 Float -> [TextTransform] Source #

move :: Float -> Float -> TextTransform Source #

scale :: Float -> Float -> TextTransform Source #

rotate :: Float -> TextTransform Source #

color :: Float -> Float -> Float -> Float -> TextTransform Source #

alpha :: Float -> TextTransform Source #

class Layout t where Source #

Generic operations for text layout.

Minimal complete definition

translate

Methods

translate :: t -> V2 Float -> t Source #

Instances

Layout [TextTransform] Source #
Instance details Defined in Typograffiti.Cache Methods translate :: [TextTransform] -> V2 Float -> [TextTransform] Source #

Getting low

allocAtlas Source #

Arguments

:: (MonadIO m, MonadError TypograffitiError m)
=> FilePath	Path to the font file to use for this Atlas.
-> GlyphSize	Size of glyphs in this Atlas.
-> String	The characters to include in this `Atlas`.
-> m Atlas

Allocate a new Atlas. When creating a new Atlas you must pass all the characters that you might need during the life of the Atlas. Character texturization only happens once.

loadText Source #

Arguments

:: (MonadIO m, MonadError TypograffitiError m, Layout t)
=> (Atlas -> String -> m (AllocatedRendering t))	Operation used to allocate a word.
-> Atlas	The character atlas that holds our letters.
-> WordCache t	The WordCache to load AllocatedRenderings into.
-> String	The string to render. This string may contain newlines, which will be respected.
-> m (t -> IO (), V2 Int, WordCache t)	Returns a function for rendering the text, the size of the text and the new WordCache with the allocated renderings of the text.

Constructs a Renderer2 from the given color and string. The WordMap record of the given Atlas is used to construct the string geometry, greatly improving performance and allowing longer strings to be compiled and renderered in real time. To create a new Atlas see allocAtlas.

Note that since word geometries are stored in the Atlas WordMap and multiple renderers can reference the same Atlas, the returned Renderer2 contains a clean up operation that does nothing. It is expected that the programmer will call freeAtlas manually when the Atlas is no longer needed.

unloadMissingWords Source #

Arguments

:: MonadIO m
=> WordCache t	The WordCache to unload words from.
-> String	The source string.
-> m (WordCache t)

Unload any words from the cache that are not contained in the source string.

stringTris Source #

Arguments

:: (MonadIO m, MonadError TypograffitiError m)
=> Atlas	The font atlas.
-> Bool	Whether or not to use kerning.
-> String	The string.
-> m (Vector (V2 Float, V2 Float))

Generate the geometry of the given string.

makeDefaultAllocateWord Source #

Arguments

:: (MonadIO m, MonadError TypograffitiError m, Integral i)
=> IO (V2 i)	A monadic operation that returns the current context's dimentions. This is used to set the orthographic projection for rendering text.
-> m (Atlas -> String -> IO (Either TypograffitiError (AllocatedRendering [TextTransform])))

asciiChars :: String Source #

A string containing all standard ASCII characters. This is often passed as the String parameter in allocAtlas.

Types

data GlyphSize Source #

Constructors

GlyphSizeByChar CharSize
GlyphSizeInPixels Int Int

Instances

Eq GlyphSize Source #
Instance details Defined in Typograffiti.Glyph Methods (==) :: GlyphSize -> GlyphSize -> Bool # (/=) :: GlyphSize -> GlyphSize -> Bool #
Ord GlyphSize Source #
Instance details Defined in Typograffiti.Glyph Methods compare :: GlyphSize -> GlyphSize -> Ordering # (<) :: GlyphSize -> GlyphSize -> Bool # (<=) :: GlyphSize -> GlyphSize -> Bool # (>) :: GlyphSize -> GlyphSize -> Bool # (>=) :: GlyphSize -> GlyphSize -> Bool # max :: GlyphSize -> GlyphSize -> GlyphSize # min :: GlyphSize -> GlyphSize -> GlyphSize #
Show GlyphSize Source #
Instance details Defined in Typograffiti.Glyph Methods showsPrec :: Int -> GlyphSize -> ShowS # show :: GlyphSize -> String # showList :: [GlyphSize] -> ShowS #

data CharSize Source #

The size of one freetype font character. https://www.freetype.org/freetype2/docs/tutorial/step1.html#section-5

Constructors

CharSize
Fields charSizeWidth :: Int Width of a character specified in 1/64 of points. charSizeHeight :: Int Height of a character specified in 1/64 of points. charSizeWidthDPI :: Int Horizontal device resolution charSizeHeightDPI :: Int Vertical device resolution

Instances

Eq CharSize Source #
Instance details Defined in Typograffiti.Glyph Methods (==) :: CharSize -> CharSize -> Bool # (/=) :: CharSize -> CharSize -> Bool #
Ord CharSize Source #
Instance details Defined in Typograffiti.Glyph Methods compare :: CharSize -> CharSize -> Ordering # (<) :: CharSize -> CharSize -> Bool # (<=) :: CharSize -> CharSize -> Bool # (>) :: CharSize -> CharSize -> Bool # (>=) :: CharSize -> CharSize -> Bool # max :: CharSize -> CharSize -> CharSize # min :: CharSize -> CharSize -> CharSize #
Show CharSize Source #
Instance details Defined in Typograffiti.Glyph Methods showsPrec :: Int -> CharSize -> ShowS # show :: CharSize -> String # showList :: [CharSize] -> ShowS #

data Atlas Source #

Constructors

Atlas
Fields atlasTexture :: GLuint atlasTextureSize :: V2 Int atlasLibrary :: FT_Library atlasFontFace :: FT_Face atlasMetrics :: IntMap GlyphMetrics atlasGlyphSize :: GlyphSize atlasFilePath :: FilePath

newtype WordCache t Source #

Constructors

WordCache
Fields unWordCache :: Map String (AllocatedRendering t)

Instances

Semigroup (WordCache t) Source #
Instance details Defined in Typograffiti.Cache Methods (<>) :: WordCache t -> WordCache t -> WordCache t # sconcat :: NonEmpty (WordCache t) -> WordCache t # stimes :: Integral b => b -> WordCache t -> WordCache t #
Monoid (WordCache t) Source #
Instance details Defined in Typograffiti.Cache Methods mempty :: WordCache t # mappend :: WordCache t -> WordCache t -> WordCache t # mconcat :: [WordCache t] -> WordCache t #

data AllocatedRendering t Source #

Holds an allocated draw function for some amount of text. The function takes one parameter that can be used to transform the text in various ways. This type is generic and can be used to take advantage of your own font rendering shaders.

Constructors

AllocatedRendering
Fields arDraw :: t -> IO () Draw the text with some transformation in some monad. arRelease :: IO () Release the allocated draw function in some monad. arSize :: V2 Int The size (in pixels) of the drawn text.

Errors

data TypograffitiError Source #

Constructors

TypograffitiErrorNoGlyphMetricsForChar Char	The are no glyph metrics for this character. This probably means the character has not been loaded into the atlas.
TypograffitiErrorFreetype String String	There was a problem while interacting with the freetype2 library.
TypograffitiErrorGL String	There was a problem while interacting with OpenGL.

Instances

Eq TypograffitiError Source #
Instance details Defined in Typograffiti.Atlas Methods (==) :: TypograffitiError -> TypograffitiError -> Bool # (/=) :: TypograffitiError -> TypograffitiError -> Bool #
Show TypograffitiError Source #
Instance details Defined in Typograffiti.Atlas Methods showsPrec :: Int -> TypograffitiError -> ShowS # show :: TypograffitiError -> String # showList :: [TypograffitiError] -> ShowS #