struct ImGui::ImFontConfig
- ImGui::ImFontConfig
- Struct
- Value
- Object
Overview
Included Modules
- ImGui::ClassType(LibImGui::ImFontConfig)
Defined in:
obj.crConstructors
Instance Method Summary
- #dst_font : ImFont
- #dst_font=(dst_font : ImFont)
-
#ellipsis_char : ImWchar
-1 Explicitly specify unicode codepoint of ellipsis character.
- #ellipsis_char=(ellipsis_char : ImWchar)
-
#font_builder_flags : UInt32
0 Settings for custom font builder.
- #font_builder_flags=(font_builder_flags : UInt32)
-
#font_data : Pointer(Void)
TTF/OTF data
- #font_data=(font_data : Pointer(Void))
-
#font_data_owned_by_atlas : Bool
true TTF/OTF data ownership taken by the container ImFontAtlas (will delete memory itself).
- #font_data_owned_by_atlas=(font_data_owned_by_atlas : Bool)
-
#font_data_size : Int32
TTF/OTF data size
- #font_data_size=(font_data_size : Int32)
-
#font_no : Int32
0 Index of font within TTF/OTF file
- #font_no=(font_no : Int32)
-
#glyph_extra_spacing : ImVec2
0, 0 Extra spacing (in pixels) between glyphs.
- #glyph_extra_spacing=(glyph_extra_spacing : ImVec2)
-
#glyph_max_advance_x : Float32
FLT_MAX Maximum AdvanceX for glyphs
- #glyph_max_advance_x=(glyph_max_advance_x : Float32)
-
#glyph_min_advance_x : Float32
0 Minimum AdvanceX for glyphs, set Min to align font icons, set both Min/Max to enforce mono-space font
- #glyph_min_advance_x=(glyph_min_advance_x : Float32)
-
#glyph_offset : ImVec2
0, 0 Offset all glyphs from this font input.
- #glyph_offset=(glyph_offset : ImVec2)
-
#glyph_ranges : Pointer(ImWchar)
NULL THE ARRAY DATA NEEDS TO PERSIST AS LONG AS THE FONT IS ALIVE.
- #glyph_ranges=(glyph_ranges : Pointer(ImWchar))
-
#merge_mode : Bool
false Merge into previous ImFont, so you can combine multiple inputs font into one ImFont (e.g.
- #merge_mode=(merge_mode : Bool)
-
#name : Slice(LibC::Char)
Name (strictly to ease debugging)
- #name=(name : Slice(LibC::Char))
-
#oversample_h : Int32
2 Rasterize at higher quality for sub-pixel positioning.
- #oversample_h=(oversample_h : Int32)
-
#oversample_v : Int32
1 Rasterize at higher quality for sub-pixel positioning.
- #oversample_v=(oversample_v : Int32)
-
#pixel_snap_h : Bool
false Align every glyph to pixel boundary.
- #pixel_snap_h=(pixel_snap_h : Bool)
-
#rasterizer_density : Float32
1.0f DPI scale for rasterization, not altering other font metrics: make it easy to swap between e.g.
- #rasterizer_density=(rasterizer_density : Float32)
-
#rasterizer_multiply : Float32
1.0f Linearly brighten (>1.0f) or darken (<1.0f) font output.
- #rasterizer_multiply=(rasterizer_multiply : Float32)
-
#size_pixels : Float32
Size in pixels for rasterizer (more or less maps to the resulting font height).
- #size_pixels=(size_pixels : Float32)
- #to_unsafe : Pointer(T)
Constructor Detail
Instance Method Detail
-1 Explicitly specify unicode codepoint of ellipsis character. When fonts are being merged first specified ellipsis will be used.
0 Settings for custom font builder. THIS IS BUILDER IMPLEMENTATION DEPENDENT. Leave as zero if unsure.
true TTF/OTF data ownership taken by the container ImFontAtlas (will delete memory itself).
0, 0 Extra spacing (in pixels) between glyphs. Only X axis is supported for now.
0 Minimum AdvanceX for glyphs, set Min to align font icons, set both Min/Max to enforce mono-space font
NULL THE ARRAY DATA NEEDS TO PERSIST AS LONG AS THE FONT IS ALIVE. Pointer to a user-provided list of Unicode range (2 value per range, values are inclusive, zero-terminated list).
false 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.
2 Rasterize at higher quality for sub-pixel positioning. Note the difference between 2 and 3 is minimal. You can reduce this to 1 for large glyphs save memory. Read https://github.com/nothings/stb/blob/master/tests/oversample/README.md for details.
1 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.
false 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.
1.0f DPI scale for rasterization, not altering other font metrics: make it easy to swap between e.g. a 100% and a 400% fonts for a zooming display. IMPORTANT: If you increase this it is expected that you increase font scale accordingly, otherwise quality may look lowered.
1.0f Linearly brighten (>1.0f) or darken (<1.0f) font output. Brightening small fonts may be a good workaround to make them more readable. This is a silly thing we may remove in the future.
Size in pixels for rasterizer (more or less maps to the resulting font height).