DearImGui.Raw.Font.Config

Font configuration

IO functions to modify font config values.

Documentation

newtype FontConfig

Font configuration data handle

Wraps ImFontConfig*.

Constructors

FontConfig (Ptr ImFontConfig)

new :: MonadIO m => m FontConfig

Create an instance of config

destroy :: MonadIO m => FontConfig -> m ()

Destroy an instance of config

Should be used after font atlas building.

Changing settings

setFontDataOwnedByAtlas :: MonadIO m => FontConfig -> CBool -> m ()

TTF/OTF data ownership taken by the container ImFontAtlas (will delete memory itself).

By default, it is true

setFontNo :: MonadIO m => FontConfig -> CInt -> m ()

Index of font within TTF/OTF file

By default, it is 0

setSizePixels :: MonadIO m => FontConfig -> CFloat -> m ()

Size in pixels for rasterizer (more or less maps to the resulting font height).

Implicitly set by addFont... functions.

setOversampleH :: MonadIO m => FontConfig -> CInt -> m ()

Rasterize at higher quality for sub-pixel positioning. Note the difference between 2 and 3 is minimal so you can reduce this to 2 to save memory. Read https://github.com/nothings/stb/blob/master/tests/oversample/README.md for details.

By default, it is 3

setOversampleV :: MonadIO m => FontConfig -> CInt -> m ()

Rasterize at higher quality for sub-pixel positioning. This is not really useful as we don't use sub-pixel positions on the Y axis.

By default, it is 1

setPixelSnapH :: MonadIO m => FontConfig -> CBool -> m ()

Align every glyph to pixel boundary. Useful e.g. if you are merging a non-pixel aligned font with the default font. If enabled, you can set OversampleH/V to 1.

By default, it is false

setGlyphExtraSpacing :: MonadIO m => FontConfig -> Ptr ImVec2 -> m ()

Extra spacing (in pixels) between glyphs. Only X axis is supported for now.

By default, it is 0, 0

setGlyphOffset :: MonadIO m => FontConfig -> Ptr ImVec2 -> m ()

Offset all glyphs from this font input.

By default, it is 0, 0

setGlyphRanges :: MonadIO m => FontConfig -> GlyphRanges -> m ()

Pointer to a user-provided list of Unicode range (2 value per range, values are inclusive, zero-terminated list). THE ARRAY DATA NEEDS TO PERSIST AS LONG AS THE FONT IS ALIVE.

By default, it is NULL

setGlyphMinAdvanceX :: MonadIO m => FontConfig -> CFloat -> m ()

Minimum AdvanceX for glyphs, set Min to align font icons, set both Min/Max to enforce mono-space font

By default, it is 0

setGlyphMaxAdvanceX :: MonadIO m => FontConfig -> CFloat -> m ()

Maximum AdvanceX for glyphs

By default, it is FLT_MAX

setMergeMode :: MonadIO m => FontConfig -> CBool -> m ()

Merge into previous ImFont, so you can combine multiple inputs font into one ImFont (e.g. ASCII font + icons + Japanese glyphs). You may want to use GlyphOffset.y when merge font of different heights.

By default, it is false

setFontBuilderFlags :: MonadIO m => FontConfig -> CUInt -> m ()

Settings for custom font builder. THIS IS BUILDER IMPLEMENTATION DEPENDENT.

By default, it is 0. Leave it so if unsure.

setRasterizerMultiply :: MonadIO m => FontConfig -> CFloat -> m ()

Brighten (>1.0f) or darken (<1.0f) font output. Brightening small fonts may be a good workaround to make them more readable.

By default, it is 1.0f

setEllipsisChar :: MonadIO m => FontConfig -> ImWchar -> m ()

Explicitly specify unicode codepoint of ellipsis character. When fonts are being merged first specified ellipsis will be used.

By default, it is -1