Modulesdl2-ttf-2.1.3Haskell2010

SDL.Font

Bindings to the SDL2_ttf library http://www.libsdl.org/projects/SDL_ttf/docs/SDL_ttf.html which itself is a wrapper around the FreeType library. The bindings should allow you to load fonts and render Text in various styles to an SDL Surface.

You can safely assume that any monadic function listed here is capable of throwing an SDLException in case it encounters an error.

Contents

General
Loading
Rendering
Attributes
Glyphs

Synopsis

value initialize
value version
value quit
newtype Font
type PointSize
value load
type Index
value loadIndex
value decode
value decodeIndex
value free
type Color
value solid
value shaded
value blended
value size
data Style
value getStyle
value setStyle
type Outline
value getOutline
value setOutline
data Hinting
value getHinting
value setHinting
type Kerning
value getKerning
value setKerning
value isMonospace
value familyName
value styleName
value height
value ascent
value descent
value lineSkip
value getKerningSize
value glyphProvided
value glyphIndex
value glyphMetrics
value solidGlyph
value shadedGlyph
value blendedGlyph
value blendedWrapped

Packagesdl2-ttf-2.1.3
Exports43
LanguageHaskell2010
LicenceBSD-3-Clause
SourceFont.hs

General

valueinitialize :: MonadIO m => m ()

Source#

Initializes the library.

Unless noted otherwise, this must be called before any other part of the library is used.

You may call this multiple times.

valueversion :: (Integral a, MonadIO m) => m (a, a, a)

Source#

Gets the major, minor, patch versions of the linked SDL2_ttf library.

You may call this without initializing the library with initialize.

valuequit :: MonadIO m => m ()

Source#

Cleans up any resources still in use by the library.

If called, you must call initialize again before using any other parts of the library.

Loading

Use the following functions to load TTF and FON file formats.

newtypenewtype Font

Source#

Represents a loaded font.

Constructors

Font
- unwrap :: Ptr Font

Instances2Eq, Show

Eq FontDefined in sdl2-ttf-2.1.3 · SDL.Font
Show FontDefined in sdl2-ttf-2.1.3 · SDL.Font

typetype PointSize = Int

Source#

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

valueload :: MonadIO m => FilePath -> PointSize -> m Font

Source#

Given a path to a font file, loads it for use as a Font at a certain PointSize.

typetype Index = Int

Source#

Designates a font face, the default and first one being 0.

valueloadIndex :: MonadIO m => FilePath -> PointSize -> Index -> m Font

Source#

Given a path to a font file, loads one of its font faces (designated by the given index) for use as a Font at a certain PointSize.

The first face is always index 0, and is the one chosen by default when using load.

valuedecode :: MonadIO m => ByteString -> PointSize -> m Font

Source#

Same as load, but accepts a ByteString containing a font instead.

valuedecodeIndex :: MonadIO m => ByteString -> PointSize -> Index -> m Font

Source#

Same as loadIndex, but accepts a ByteString containing a font instead.

valuefree :: MonadIO m => Font -> m ()

Source#

Frees a loaded Font.

Rendering

Use the following functions to render text to a Surface.

The methods available are described in more detail in the original SDL2_ttf documentation here.

typetype Color = V4 Word8

Source#

Color as an RGBA byte vector.

valuesolid :: MonadIO m => Font -> Color -> Text -> m Surface

Source#

Renders Text using the quick and dirty method.

Is the fastest of the rendering methods, but results in text that isn't as smooth.

valueshaded :: MonadIO m => Font -> Color -> Color -> Text -> m Surface

Source#

Uses the slow and nice, but with a solid box method.

Renders slower than solid, but in about the same time as blended.

Results in a Surface containing antialiased text of a foreground color surrounded by a box of a background color. This Surface will blit as fast as the one from solid.

valueblended :: MonadIO m => Font -> Color -> Text -> m Surface

Source#

The slow slow slow, but ultra nice over another image method, blended renders text at high quality.

The text is antialiased and surrounded by a transparent box. Renders slower than solid, but in about the same time as shaded.

The resulting Surface will blit slower than the ones from solid or shaded.

valuesize :: MonadIO m => Font -> Text -> m (Int, Int)

Source#

Use this function to discover how wide and tall a Surface needs to be in order to accommodate a given text when it is rendered.

Note that no actual rendering takes place.

The values returned are the width and height, respectively, in pixels. The height returned is the same one returned by height.

Attributes

datadata Style

Source#

Possible styles that can be applied to a Font.

Bold Italic Underline Strikethrough

Instances8Bounded, Enum, Eq, Ord, Read, Show, …

Bounded StyleDefined in sdl2-ttf-2.1.3 · SDL.Font
Enum StyleDefined in sdl2-ttf-2.1.3 · SDL.Font
Eq StyleDefined in sdl2-ttf-2.1.3 · SDL.Font
Ord StyleDefined in sdl2-ttf-2.1.3 · SDL.Font
Read StyleDefined in sdl2-ttf-2.1.3 · SDL.Font
Show StyleDefined in sdl2-ttf-2.1.3 · SDL.Font
Generic StyleDefined in sdl2-ttf-2.1.3 · SDL.Font
type Rep Style = D1 ('MetaData "Style" "SDL.Font" "sdl2-ttf-2.1.3-IEITQen7nJi6YI8I1ihRrB" 'False) ((C1 ('MetaCons "Bold" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Italic" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "Underline" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Strikethrough" 'PrefixI 'False) U1))Defined in sdl2-ttf-2.1.3 · SDL.Font

valuegetStyle :: MonadIO m => Font -> m [Style]

Source#

Gets the rendering styles of a given Font.

If none were ever set, this will be an empty list.

valuesetStyle :: MonadIO m => Font -> [Style] -> m ()

Source#

Sets the rendering style of a Font.

Use an empty list to reset the style.

typetype Outline = Int

Source#

The size of the Font outline, in pixels.

Use 0 to turn off outlining.

valuegetOutline :: MonadIO m => Font -> m Outline

Source#

Gets the current outline size of a given Font.

valuesetOutline :: MonadIO m => Font -> Outline -> m ()

Source#

Sets the outline size for a given Font.

Use 0 to turn off outlining.

datadata Hinting

Source#

The hinting setting of a Font.

Normal Light Mono None

Instances8Bounded, Enum, Eq, Ord, Read, Show, …

Bounded HintingDefined in sdl2-ttf-2.1.3 · SDL.Font
Enum HintingDefined in sdl2-ttf-2.1.3 · SDL.Font
Eq HintingDefined in sdl2-ttf-2.1.3 · SDL.Font
Ord HintingDefined in sdl2-ttf-2.1.3 · SDL.Font
Read HintingDefined in sdl2-ttf-2.1.3 · SDL.Font
Show HintingDefined in sdl2-ttf-2.1.3 · SDL.Font
Generic HintingDefined in sdl2-ttf-2.1.3 · SDL.Font
type Rep Hinting = D1 ('MetaData "Hinting" "SDL.Font" "sdl2-ttf-2.1.3-IEITQen7nJi6YI8I1ihRrB" 'False) ((C1 ('MetaCons "Normal" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Light" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "Mono" 'PrefixI 'False) U1 :+: C1 ('MetaCons "None" 'PrefixI 'False) U1))Defined in sdl2-ttf-2.1.3 · SDL.Font

valuegetHinting :: MonadIO m => Font -> m Hinting

Source#

Gets the hinting setting of a given Font.

valuesetHinting :: MonadIO m => Font -> Hinting -> m ()

Source#

Sets the hinting setting of a font.

typetype Kerning = Bool

Source#

Whether kerning is enabled or not.

The default for a newly-loaded Font is enabled.

valuegetKerning :: MonadIO m => Font -> m Kerning

Source#

Gets the current kerning setting of a given Font.

valuesetKerning :: MonadIO m => Font -> Kerning -> m ()

Source#

Sets the kerning setting for a given Font.

Use False to turn off kerning.

valueisMonospace :: MonadIO m => Font -> m Bool

Source#

Tests whether the current face of a Font is a fixed width font or not.

valuefamilyName :: MonadIO m => Font -> m (Maybe Text)

Source#

Gets the current font face family name, if any.

valuestyleName :: MonadIO m => Font -> m (Maybe Text)

Source#

Gets the current font face style name, if any.

valueheight :: MonadIO m => Font -> m Int

Source#

Gets the maximum pixel height of all glyphs of a given Font.

valueascent :: MonadIO m => Font -> m Int

Source#

Gets the maximum pixel ascent of all glyphs of a given Font.

This can be interpreted as the distance from the top of the font to the baseline.

valuedescent :: MonadIO m => Font -> m Int

Source#

Gets the maximum pixel descent of all glyphs of a given Font.

Also interpreted as the distance from the baseline to the bottom of the font.

valuelineSkip :: MonadIO m => Font -> m Int

Source#

Gets the recommended pixel height of a rendered line of text of a given Font.

This is usually larger than what height would return.

valuegetKerningSize :: MonadIO m => Font -> Index -> Index -> m Int

Source#

From a given Font get the kerning size of two glyphs.

Glyphs

Functions that work with individual glyphs.

valueglyphProvided :: MonadIO m => Font -> Char -> m Bool

Source#

Does a Font provide a certain unicode character?

valueglyphIndex :: MonadIO m => Font -> Char -> m (Maybe Int)

Source#

Same as glyphProvided, but returns an index of the glyph for the given character instead, if one is provided.

valueglyphMetrics

:: MonadIO m
=> Font
-> Char
-> m (Maybe (Int, Int, Int, Int, Int))

Source#

Get glyph metrics for a given unicode character. The values returned are:

minimum x offset
maximum x offset
minimum y offset
maximum y offset
advance offset

You can see more information about these values in the original SDL2_ttf documentation here.

valuesolidGlyph :: MonadIO m => Font -> Color -> Char -> m Surface

Source#

Same as solid, but renders a single glyph instead.

valueshadedGlyph :: MonadIO m => Font -> Color -> Color -> Char -> m Surface

Source#

Same as shaded, but renders a single glyph instead.

valueblendedGlyph :: MonadIO m => Font -> Color -> Char -> m Surface

Source#

Same as blended, but renders a single glyph instead.

valueblendedWrapped :: MonadIO m => Font -> Color -> Int -> Text -> m Surface

Source#

Same as blended, but renders across multiple lines. Text is wrapped to multiple lines on line endings and on word boundaries if it extends beyond wrapLength in pixels.