DearImGui.Raw.Font.GlyphRanges

Font glyph ranges builder

Helper to build glyph ranges from text/string data. Feed your application strings/characters to it then call buildRanges.

Low-level example of usage:

  -- import ImGui.Fonts
  -- import ImGui.Raw.GlyphRangesBuilder as GRB

  builder <- GRB.new

  GRB.addRanges builder getGlyphRangesDefault
  liftIO $ withCString Привет $ GRB.addText builder
  rangesVec <- GRB.buildRanges builder
  let ranges = GRB.fromRangesVector rangesVec

  addFontFromFileTTF'
    ".imguimiscfontsDroidSans.ttf" 12
    Nothing
    (Just ranges)

  -- it is strictly necessary to explicitly build the atlas
  buildFontAtlas

  -- resource destruction comes only after the building
  GRB.destroyRangesVector rangesVec
  GRB.destroy builder

Documentation

newtype GlyphRanges

Glyph ranges handle

Wraps ImWchar*.

Constructors

GlyphRanges (Ptr ImWchar)

Built-in ranges

data Builtin

Builtin glyph ranges tags.

Constructors

Latin

Korean

Japanese

ChineseFull

ChineseSimplifiedCommon

Cyrillic

Thai

Vietnamese

Instances

Bounded Builtin

Defined in DearImGui.Raw.Font.GlyphRanges

Methods

minBound :: Builtin

maxBound :: Builtin

Enum Builtin

Defined in DearImGui.Raw.Font.GlyphRanges

Methods

succ :: Builtin -> Builtin

pred :: Builtin -> Builtin

toEnum :: Int -> Builtin

fromEnum :: Builtin -> Int

enumFrom :: Builtin -> [Builtin]

enumFromThen :: Builtin -> Builtin -> [Builtin]

enumFromTo :: Builtin -> Builtin -> [Builtin]

enumFromThenTo :: Builtin -> Builtin -> Builtin -> [Builtin]

Show Builtin

Defined in DearImGui.Raw.Font.GlyphRanges

Methods

showsPrec :: Int -> Builtin -> ShowS

show :: Builtin -> String

showList :: [Builtin] -> ShowS

Eq Builtin

Defined in DearImGui.Raw.Font.GlyphRanges

Methods

(==) :: Builtin -> Builtin -> Bool

(/=) :: Builtin -> Builtin -> Bool

Ord Builtin

Defined in DearImGui.Raw.Font.GlyphRanges

Methods

compare :: Builtin -> Builtin -> Ordering

(<) :: Builtin -> Builtin -> Bool

(<=) :: Builtin -> Builtin -> Bool

(>) :: Builtin -> Builtin -> Bool

(>=) :: Builtin -> Builtin -> Bool

max :: Builtin -> Builtin -> Builtin

min :: Builtin -> Builtin -> Builtin

getBuiltin :: Builtin -> GlyphRanges

Get builtin glyph ranges from a tag.

builtinSetup :: Builtin -> Maybe GlyphRanges

Special case of getBuiltin, but for font source setup.

Preparing a builder

newtype GlyphRangesBuilder

Glyph ranges builder handle

Wraps ImFontGlyphRangesBuilder*.

Constructors

GlyphRangesBuilder (Ptr ImFontGlyphRangesBuilder)

new :: MonadIO m => m GlyphRangesBuilder

Create an instance of builder

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

Destroy an instance of builder

Should be used after font atlas building.

addChar :: MonadIO m => GlyphRangesBuilder -> ImWchar -> m ()

Add character

addText :: MonadIO m => GlyphRangesBuilder -> CString -> m ()

Add string (each character of the UTF-8 string are added)

addRanges :: MonadIO m => GlyphRangesBuilder -> GlyphRanges -> m ()

Add ranges, e.g. 'addRanges builder getGlyphRangesDefault' to force add all of ASCII/Latin+Ext

Extracting data

newtype GlyphRangesVector

Glyph ranges vector handle to keep builder output

Wraps ImVectorImWchar*.

Constructors

GlyphRangesVector (Ptr ())

buildRangesVector :: MonadIO m => GlyphRangesBuilder -> m GlyphRangesVector

Build new ranges and create ranges vector instance, containing them

fromRangesVector :: GlyphRangesVector -> GlyphRanges

Extract glyph ranges from a vector

Should be used before vector destruction.

destroyRangesVector :: MonadIO m => GlyphRangesVector -> m ()

Destroy a ranges vector instance

Should be used after font atlas building.