Safe Haskell	None
Language	Haskell2010

Graphics.Rendering.MiniTypeset.FontTexture

Description

Store font glyphs in OpenGL textures

TODO: add (optional) subpixel rendering support (pre-render say 4 versions of the same glyphs with fractional horizontal offsets)

Synopsis

data BufLoc = BufLoc {
- _locGlyph :: !Glyph
- _locBufIdx :: !Int
- _locBufXY :: !(Int, Int)
- _locBufSiz :: !(Int, Int)
- _locBufOfs :: !(Int, Int)
- _locHM :: !(HorizontalMetrics Float)
}
data TexBuf = TexBuf {
- _bufTexObj :: !TextureObject
- _bufSize :: !(Int, Int)
}
allocateTexBuf :: FontTexture -> IO TexBuf
data TexCursor = TexCursor {
- _curBufIdx :: !Int
- _curX :: !Int
- _curY :: !Int
- _cutMaxHt :: !Int
}
zeroCursor :: TexCursor
data FontTexture = FontTexture {
- _ftexFont :: !Font
- _ftexName :: !String
- _ftexHeight :: !Float
- _ftexScaling :: !Scaling
- _ftexVM :: !(VerticalMetrics Float)
- _ftexChars :: !(UnicodeCache (Maybe BufLoc))
- _ftexBufSize :: !(Int, Int)
- _ftexCursor :: !(IORef TexCursor)
- _ftexBufs :: !(IORef [TexBuf])
}
scaleU :: Float -> Unscaled -> Float
defaultTextureSize :: (Int, Int)
newFontTexture :: Font -> Float -> String -> IO FontTexture
newFontTexture' :: Font -> Float -> String -> (Int, Int) -> IO FontTexture
lookupFontTexture :: FontTexture -> Char -> IO BufLoc
mbLookupFontTexture :: FontTexture -> Char -> IO (Maybe BufLoc)
testRenderFullTextureQuad :: FontTexture -> Int -> IO ()

Documentation

data BufLoc Source #

The location of a glyph in a font texture collection

Constructors

BufLoc
Fields _locGlyph :: !Glyph _locBufIdx :: !Int which buffer _locBufXY :: !(Int, Int) position within the texture (buffer) _locBufSiz :: !(Int, Int) size of the bounding box _locBufOfs :: !(Int, Int) offset relative to the bounding box _locHM :: !(HorizontalMetrics Float) for convenience, we cache the glyph metrics

Instances

Show BufLoc Source #
Instance details Defined in Graphics.Rendering.MiniTypeset.FontTexture Methods showsPrec :: Int -> BufLoc -> ShowS # show :: BufLoc -> String # showList :: [BufLoc] -> ShowS #

data TexBuf Source #

A single texture buffer

Constructors

TexBuf
Fields _bufTexObj :: !TextureObject _bufSize :: !(Int, Int)

Instances

Show TexBuf Source #
Instance details Defined in Graphics.Rendering.MiniTypeset.FontTexture Methods showsPrec :: Int -> TexBuf -> ShowS # show :: TexBuf -> String # showList :: [TexBuf] -> ShowS #

allocateTexBuf :: FontTexture -> IO TexBuf Source #

data TexCursor Source #

Constructors

TexCursor
Fields _curBufIdx :: !Int which buffer we are filling currently _curX :: !Int next X position _curY :: !Int current Y position _cutMaxHt :: !Int maximal bitmap height in this row

Instances

Show TexCursor Source #
Instance details Defined in Graphics.Rendering.MiniTypeset.FontTexture Methods showsPrec :: Int -> TexCursor -> ShowS # show :: TexCursor -> String # showList :: [TexCursor] -> ShowS #

zeroCursor :: TexCursor Source #

data FontTexture Source #

A font texture collection: possibly several textures containing bitmaps a given font with a given height.

Constructors

FontTexture
Fields _ftexFont :: !Font _ftexName :: !String _ftexHeight :: !Float _ftexScaling :: !Scaling _ftexVM :: !(VerticalMetrics Float) _ftexChars :: !(UnicodeCache (Maybe BufLoc)) _ftexBufSize :: !(Int, Int) _ftexCursor :: !(IORef TexCursor) _ftexBufs :: !(IORef [TexBuf])

Instances

Show FontTexture Source #
Instance details Defined in Graphics.Rendering.MiniTypeset.FontTexture Methods showsPrec :: Int -> FontTexture -> ShowS # show :: FontTexture -> String # showList :: [FontTexture] -> ShowS #

scaleU :: Float -> Unscaled -> Float Source #

defaultTextureSize :: (Int, Int) Source #

newFontTexture :: Font -> Float -> String -> IO FontTexture Source #

newFontTexture' :: Font -> Float -> String -> (Int, Int) -> IO FontTexture Source #

Creates a new (empty) font texture

lookupFontTexture :: FontTexture -> Char -> IO BufLoc Source #

Finds a character in the font texture (rendering it first if necessary). If the glyph is not present in the font, we return the "not defined glyph" instead.

mbLookupFontTexture :: FontTexture -> Char -> IO (Maybe BufLoc) Source #

Finds a character in the font texture (rendering it first if necessary)

testRenderFullTextureQuad :: FontTexture -> Int -> IO () Source #

Renders the given font texture as a quad (useful for debugging)