Copyright	(c) 2015 Siniša Biđin
License	MIT
Stability	experimental
Safe Haskell	None
Language	Haskell2010

SDL.Raw.Font

Contents

General
Loading fonts
Font attributes
Getting text size
Rendering text
Other

Description

Raw bindings to the SDL2_ttf library. No error-handling is done here. For more information about specific function behaviour, see the SDL2_ttf documentation.

Synopsis

init :: forall m. MonadIO m => m CInt
wasInit :: forall m. MonadIO m => m CInt
quit :: forall m. MonadIO m => m ()
getVersion :: forall m. MonadIO m => m (Ptr Version)
data Font
type FontPath = CString
type PointSize = CInt
openFont :: MonadIO m => FontPath -> PointSize -> m (Ptr Font)
type Free = CInt
openFont_RW :: MonadIO m => Ptr RWops -> Free -> PointSize -> m (Ptr Font)
type Index = CLong
openFontIndex :: MonadIO m => FontPath -> PointSize -> Index -> m (Ptr Font)
openFontIndex_RW :: MonadIO m => Ptr RWops -> Free -> PointSize -> Index -> m (Ptr Font)
closeFont :: MonadIO m => Ptr Font -> m ()
getFontStyle :: MonadIO m => Ptr Font -> m CInt
setFontStyle :: MonadIO m => Ptr Font -> CInt -> m ()
pattern TTF_STYLE_NORMAL :: forall a. (Eq a, Num a) => a
pattern TTF_STYLE_BOLD :: forall a. (Eq a, Num a) => a
pattern TTF_STYLE_ITALIC :: forall a. (Eq a, Num a) => a
pattern TTF_STYLE_UNDERLINE :: forall a. (Eq a, Num a) => a
pattern TTF_STYLE_STRIKETHROUGH :: forall a. (Eq a, Num a) => a
getFontOutline :: MonadIO m => Ptr Font -> m CInt
setFontOutline :: MonadIO m => Ptr Font -> CInt -> m ()
getFontHinting :: MonadIO m => Ptr Font -> m CInt
setFontHinting :: MonadIO m => Ptr Font -> CInt -> m ()
pattern TTF_HINTING_NORMAL :: forall a. (Eq a, Num a) => a
pattern TTF_HINTING_LIGHT :: forall a. (Eq a, Num a) => a
pattern TTF_HINTING_MONO :: forall a. (Eq a, Num a) => a
pattern TTF_HINTING_NONE :: forall a. (Eq a, Num a) => a
getFontKerning :: MonadIO m => Ptr Font -> m CInt
setFontKerning :: MonadIO m => Ptr Font -> CInt -> m ()
fontHeight :: MonadIO m => Ptr Font -> m CInt
fontAscent :: MonadIO m => Ptr Font -> m CInt
fontDescent :: MonadIO m => Ptr Font -> m CInt
fontLineSkip :: MonadIO m => Ptr Font -> m CInt
fontFaces :: MonadIO m => Ptr Font -> m CLong
fontFaceIsFixedWidth :: MonadIO m => Ptr Font -> m CInt
fontFaceFamilyName :: MonadIO m => Ptr Font -> m CString
fontFaceStyleName :: MonadIO m => Ptr Font -> m CString
glyphIsProvided :: MonadIO m => Ptr Font -> CUShort -> m CInt
glyphMetrics :: MonadIO m => Ptr Font -> CUShort -> Ptr CInt -> Ptr CInt -> Ptr CInt -> Ptr CInt -> Ptr CInt -> m CInt
getFontKerningSize :: MonadIO m => Ptr Font -> CInt -> CInt -> m CInt
sizeText :: MonadIO m => Ptr Font -> CString -> Ptr CInt -> Ptr CInt -> m CInt
sizeUTF8 :: MonadIO m => Ptr Font -> CString -> Ptr CInt -> Ptr CInt -> m CInt
sizeUNICODE :: MonadIO m => Ptr Font -> Ptr CUShort -> Ptr CInt -> Ptr CInt -> m CInt
renderText_Solid :: MonadIO m => Ptr Font -> CString -> Ptr Color -> m (Ptr Surface)
renderText_Shaded :: MonadIO m => Ptr Font -> CString -> Ptr Color -> Ptr Color -> m (Ptr Surface)
renderText_Blended :: MonadIO m => Ptr Font -> CString -> Ptr Color -> m (Ptr Surface)
renderText_Blended_Wrapped :: MonadIO m => Ptr Font -> CString -> Ptr Color -> CUInt -> m (Ptr Surface)
renderUTF8_Solid :: MonadIO m => Ptr Font -> CString -> Ptr Color -> m (Ptr Surface)
renderUTF8_Shaded :: MonadIO m => Ptr Font -> CString -> Ptr Color -> Ptr Color -> m (Ptr Surface)
renderUTF8_Blended :: MonadIO m => Ptr Font -> CString -> Ptr Color -> m (Ptr Surface)
renderUTF8_Blended_Wrapped :: MonadIO m => Ptr Font -> CString -> Ptr Color -> CUInt -> m (Ptr Surface)
renderUNICODE_Solid :: MonadIO m => Ptr Font -> Ptr CUShort -> Ptr Color -> m (Ptr Surface)
renderUNICODE_Shaded :: MonadIO m => Ptr Font -> Ptr CUShort -> Ptr Color -> Ptr Color -> m (Ptr Surface)
renderUNICODE_Blended :: MonadIO m => Ptr Font -> Ptr CUShort -> Ptr Color -> m (Ptr Surface)
renderUNICODE_Blended_Wrapped :: MonadIO m => Ptr Font -> Ptr CUShort -> Ptr Color -> CUInt -> m (Ptr Surface)
renderGlyph_Solid :: MonadIO m => Ptr Font -> CUShort -> Ptr Color -> m (Ptr Surface)
renderGlyph_Shaded :: MonadIO m => Ptr Font -> CUShort -> Ptr Color -> Ptr Color -> m (Ptr Surface)
renderGlyph_Blended :: MonadIO m => Ptr Font -> CUShort -> Ptr Color -> m (Ptr Surface)
byteSwappedUNICODE :: MonadIO m => CInt -> m ()
pattern UNICODE_BOM_NATIVE :: forall a. (Eq a, Num a) => a
pattern UNICODE_BOM_SWAPPED :: forall a. (Eq a, Num a) => a

General

init :: forall m. MonadIO m => m CInt #

wasInit :: forall m. MonadIO m => m CInt #

quit :: forall m. MonadIO m => m () #

getVersion :: forall m. MonadIO m => m (Ptr Version) #

Loading fonts

data Font #

The raw, underlying TTF_Font struct.

type FontPath = CString #

A path to a font file.

type PointSize = CInt #

Point size (based on 72DPI). Translates to pixel height.

openFont :: MonadIO m => FontPath -> PointSize -> m (Ptr Font) #

type Free = CInt #

Should the Ptr RWops be freed after an operation? 1 for yes, 0 for no.

openFont_RW :: MonadIO m => Ptr RWops -> Free -> PointSize -> m (Ptr Font) #

type Index = CLong #

Indicates the font face we're loading. First face is always 0.

openFontIndex :: MonadIO m => FontPath -> PointSize -> Index -> m (Ptr Font) #

openFontIndex_RW :: MonadIO m => Ptr RWops -> Free -> PointSize -> Index -> m (Ptr Font) #

closeFont :: MonadIO m => Ptr Font -> m () #

Font attributes

getFontStyle :: MonadIO m => Ptr Font -> m CInt #

setFontStyle :: MonadIO m => Ptr Font -> CInt -> m () #

pattern TTF_STYLE_NORMAL :: forall a. (Eq a, Num a) => a #

pattern TTF_STYLE_BOLD :: forall a. (Eq a, Num a) => a #

pattern TTF_STYLE_ITALIC :: forall a. (Eq a, Num a) => a #

pattern TTF_STYLE_UNDERLINE :: forall a. (Eq a, Num a) => a #

pattern TTF_STYLE_STRIKETHROUGH :: forall a. (Eq a, Num a) => a #

getFontOutline :: MonadIO m => Ptr Font -> m CInt #

setFontOutline :: MonadIO m => Ptr Font -> CInt -> m () #

getFontHinting :: MonadIO m => Ptr Font -> m CInt #

setFontHinting :: MonadIO m => Ptr Font -> CInt -> m () #

pattern TTF_HINTING_NORMAL :: forall a. (Eq a, Num a) => a #

pattern TTF_HINTING_LIGHT :: forall a. (Eq a, Num a) => a #

pattern TTF_HINTING_MONO :: forall a. (Eq a, Num a) => a #

pattern TTF_HINTING_NONE :: forall a. (Eq a, Num a) => a #

getFontKerning :: MonadIO m => Ptr Font -> m CInt #

setFontKerning :: MonadIO m => Ptr Font -> CInt -> m () #

fontHeight :: MonadIO m => Ptr Font -> m CInt #

fontAscent :: MonadIO m => Ptr Font -> m CInt #

fontDescent :: MonadIO m => Ptr Font -> m CInt #

fontLineSkip :: MonadIO m => Ptr Font -> m CInt #

fontFaces :: MonadIO m => Ptr Font -> m CLong #

fontFaceIsFixedWidth :: MonadIO m => Ptr Font -> m CInt #

fontFaceFamilyName :: MonadIO m => Ptr Font -> m CString #

fontFaceStyleName :: MonadIO m => Ptr Font -> m CString #

glyphIsProvided :: MonadIO m => Ptr Font -> CUShort -> m CInt #

glyphMetrics :: MonadIO m => Ptr Font -> CUShort -> Ptr CInt -> Ptr CInt -> Ptr CInt -> Ptr CInt -> Ptr CInt -> m CInt #

getFontKerningSize :: MonadIO m => Ptr Font -> CInt -> CInt -> m CInt #

Getting text size

sizeText :: MonadIO m => Ptr Font -> CString -> Ptr CInt -> Ptr CInt -> m CInt #

sizeUTF8 :: MonadIO m => Ptr Font -> CString -> Ptr CInt -> Ptr CInt -> m CInt #

sizeUNICODE :: MonadIO m => Ptr Font -> Ptr CUShort -> Ptr CInt -> Ptr CInt -> m CInt #

Rendering text

renderText_Solid :: MonadIO m => Ptr Font -> CString -> Ptr Color -> m (Ptr Surface) #

renderText_Shaded :: MonadIO m => Ptr Font -> CString -> Ptr Color -> Ptr Color -> m (Ptr Surface) #

renderText_Blended :: MonadIO m => Ptr Font -> CString -> Ptr Color -> m (Ptr Surface) #

renderText_Blended_Wrapped :: MonadIO m => Ptr Font -> CString -> Ptr Color -> CUInt -> m (Ptr Surface) #

renderUTF8_Solid :: MonadIO m => Ptr Font -> CString -> Ptr Color -> m (Ptr Surface) #

renderUTF8_Shaded :: MonadIO m => Ptr Font -> CString -> Ptr Color -> Ptr Color -> m (Ptr Surface) #

renderUTF8_Blended :: MonadIO m => Ptr Font -> CString -> Ptr Color -> m (Ptr Surface) #

renderUTF8_Blended_Wrapped :: MonadIO m => Ptr Font -> CString -> Ptr Color -> CUInt -> m (Ptr Surface) #

renderUNICODE_Solid :: MonadIO m => Ptr Font -> Ptr CUShort -> Ptr Color -> m (Ptr Surface) #

renderUNICODE_Shaded :: MonadIO m => Ptr Font -> Ptr CUShort -> Ptr Color -> Ptr Color -> m (Ptr Surface) #

renderUNICODE_Blended :: MonadIO m => Ptr Font -> Ptr CUShort -> Ptr Color -> m (Ptr Surface) #

renderUNICODE_Blended_Wrapped :: MonadIO m => Ptr Font -> Ptr CUShort -> Ptr Color -> CUInt -> m (Ptr Surface) #

renderGlyph_Solid :: MonadIO m => Ptr Font -> CUShort -> Ptr Color -> m (Ptr Surface) #

renderGlyph_Shaded :: MonadIO m => Ptr Font -> CUShort -> Ptr Color -> Ptr Color -> m (Ptr Surface) #

renderGlyph_Blended :: MonadIO m => Ptr Font -> CUShort -> Ptr Color -> m (Ptr Surface) #

Other

byteSwappedUNICODE :: MonadIO m => CInt -> m () #

pattern UNICODE_BOM_NATIVE :: forall a. (Eq a, Num a) => a #

pattern UNICODE_BOM_SWAPPED :: forall a. (Eq a, Num a) => a #