Typograffiti.Cache

This module provides a method of caching rendererd text, making it suitable for interactive rendering. You can use the defaultCache or provide your own.

Documentation

class Layout t where

Generic operations for text layout.

Minimal complete definition

translate

Methods

translate :: t -> V2 Float -> t

Instances

Layout [TextTransform]

Defined in Typograffiti.Cache

Methods

translate :: [TextTransform] -> V2 Float -> [TextTransform]

data AllocatedRendering t

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.

newtype WordCache t

Constructors

WordCache

Fields

• unWordCache :: Map String (AllocatedRendering t)

Instances

Semigroup (WordCache t)

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)

Defined in Typograffiti.Cache

Methods

mempty :: WordCache t

mappend :: WordCache t -> WordCache t -> WordCache t

mconcat :: [WordCache t] -> WordCache t

loadWords

Arguments

:: (MonadIO m, MonadError TypograffitiError m)

=> (Atlas -> String -> m (AllocatedRendering t))

Operation used to allocate a word.

-> Atlas

The character atlas that holds our letters, which is used to generate the word geometry.

-> WordCache t

The atlas to load the words into.

-> String

The string of words to load, with each word separated by spaces.

-> m (WordCache t)

Load a string of words into the WordCache.

unloadMissingWords

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.

loadText

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.

data SpatialTransform

Constructors

SpatialTransformTranslate (V2 Float)

SpatialTransformScale (V2 Float)

SpatialTransformRotate Float

data TextTransform

Constructors

TextTransformMultiply (V4 Float)

TextTransformSpatial SpatialTransform

Instances

Layout [TextTransform]

Defined in Typograffiti.Cache

Methods

translate :: [TextTransform] -> V2 Float -> [TextTransform]

move :: Float -> Float -> TextTransform

scale :: Float -> Float -> TextTransform

rotate :: Float -> TextTransform

color :: Float -> Float -> Float -> Float -> TextTransform

alpha :: Float -> TextTransform

transformToUniforms :: [TextTransform] -> (M44 Float, V4 Float)

vertexShader :: ByteString

fragmentShader :: ByteString

makeDefaultAllocateWord

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])))