ImFontConfig (imgui-binding 1.82.1 API)

java.lang.Object
- imgui.binding.ImGuiStruct
- - imgui.binding.ImGuiStructDestroyable
  - - imgui.ImFontConfig

public final class ImFontConfig
extends ImGuiStructDestroyable

Field Summary
- Fields inherited from class imgui.binding.ImGuiStruct
  ptr

Constructor Summary

Constructors
Constructor and Description

ImFontConfig()
This class will create a native structure.

Constructors
Constructor and Description
`ImFontConfig()` This class will create a native structure.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected long`	`create()`
`short`	`getEllipsisChar()` Explicitly specify unicode codepoint of ellipsis character.
`int`	`getFontBuilderFlags()` Settings for custom font builder.
`byte[]`	`getFontData()` TTF/OTF data
`boolean`	`getFontDataOwnedByAtlas()` TTF/OTF data ownership taken by the container ImFontAtlas (will delete memory itself).
`int`	`getFontDataSize()` TTF/OTF data size
`int`	`getFontNo()` Index of font within TTF/OTF file
`ImVec2`	`getGlyphExtraSpacing()` Extra spacing (in pixels) between glyphs.
`void`	`getGlyphExtraSpacing(ImVec2 dstImVec2)` Extra spacing (in pixels) between glyphs.
`float`	`getGlyphExtraSpacingX()` Extra spacing (in pixels) between glyphs.
`float`	`getGlyphExtraSpacingY()` Extra spacing (in pixels) between glyphs.
`float`	`getGlyphMaxAdvanceX()` Maximum AdvanceX for glyphs
`float`	`getGlyphMinAdvanceX()` Minimum AdvanceX for glyphs, set Min to align font icons, set both Min/Max to enforce mono-space font
`ImVec2`	`getGlyphOffset()` Offset all glyphs from this font input.
`void`	`getGlyphOffset(ImVec2 dstImVec2)` Offset all glyphs from this font input.
`float`	`getGlyphOffsetX()` Offset all glyphs from this font input.
`float`	`getGlyphOffsetY()` Offset all glyphs from this font input.
`short[]`	`getGlyphRanges()` Pointer to a user-provided list of Unicode range (2 value per range, values are inclusive, zero-terminated list).
`boolean`	`getMergeMode()` Merge into previous ImFont, so you can combine multiple inputs font into one ImFont (e.g.
`int`	`getOversampleH()` Rasterize at higher quality for sub-pixel positioning.
`int`	`getOversampleV()` Rasterize at higher quality for sub-pixel positioning.
`boolean`	`getPixelSnapH()` Align every glyph to pixel boundary.
`float`	`getRasterizerMultiply()` Brighten (`>`1.0f) or darken (`<`1.0f) font output.
`float`	`getSizePixels()` Size in pixels for rasterizer (more or less maps to the resulting font height).
`void`	`setEllipsisChar(int ellipsisChar)` Explicitly specify unicode codepoint of ellipsis character.
`void`	`setFontBuilderFlags(int fontBuilderFlags)` Settings for custom font builder.
`void`	`setFontData(byte[] fontData)` TTF/OTF data
`void`	`setFontDataOwnedByAtlas(boolean isFontDataOwnedByAtlas)` TTF/OTF data ownership taken by the container ImFontAtlas (will delete memory itself).
`void`	`setFontDataSize(int fontDataSize)` TTF/OTF data size
`void`	`setFontNo(int fontNo)` Index of font within TTF/OTF file
`void`	`setGlyphExtraSpacing(float x, float y)` Extra spacing (in pixels) between glyphs.
`void`	`setGlyphMaxAdvanceX(float glyphMaxAdvanceX)` Maximum AdvanceX for glyphs
`void`	`setGlyphMinAdvanceX(float glyphMinAdvanceX)` Minimum AdvanceX for glyphs, set Min to align font icons, set both Min/Max to enforce mono-space font
`void`	`setGlyphOffset(float x, float y)` Offset all glyphs from this font input.
`void`	`setGlyphRanges(short[] glyphRanges)` Pointer to a user-provided list of Unicode range (2 value per range, values are inclusive, zero-terminated list).
`void`	`setMergeMode(boolean mergeMode)` Merge into previous ImFont, so you can combine multiple inputs font into one ImFont (e.g.
`void`	`setName(java.lang.String name)` Name (strictly to ease debugging)
`void`	`setOversampleH(int oversampleH)` Rasterize at higher quality for sub-pixel positioning.
`void`	`setOversampleV(int oversampleV)` Rasterize at higher quality for sub-pixel positioning.
`void`	`setPixelSnapH(boolean isPixelSnapH)` Align every glyph to pixel boundary.
`void`	`setRasterizerMultiply(float rasterizerMultiply)` Brighten (`>`1.0f) or darken (`<`1.0f) font output.
`void`	`setSizePixels(float sizePixels)` Size in pixels for rasterizer (more or less maps to the resulting font height).

Methods inherited from class imgui.binding.ImGuiStructDestroyable
destroy

Methods inherited from class imgui.binding.ImGuiStruct
isNotValidPtr, isValidPtr

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ImFontConfig
```
public ImFontConfig()
```
    This class will create a native structure. Call ImGuiStructDestroyable.destroy() method to manually free used memory.
- Method Detail
  - create
```
protected long create()
```
    Specified by:
    
    create in class ImGuiStructDestroyable
  - getFontData
```
public byte[] getFontData()
```
    TTF/OTF data
  - setFontData
```
public void setFontData(byte[] fontData)
```
    TTF/OTF data
  - getFontDataSize
```
public int getFontDataSize()
```
    TTF/OTF data size
  - setFontDataSize
```
public void setFontDataSize(int fontDataSize)
```
    TTF/OTF data size
  - getFontDataOwnedByAtlas
```
public boolean getFontDataOwnedByAtlas()
```
    TTF/OTF data ownership taken by the container ImFontAtlas (will delete memory itself).
  - setFontDataOwnedByAtlas
```
public void setFontDataOwnedByAtlas(boolean isFontDataOwnedByAtlas)
```
    TTF/OTF data ownership taken by the container ImFontAtlas (will delete memory itself).
    BINDING NOTICE: By default binding will set this value to false. If this is not done, Dear ImGui will try to free memory allocated by JVM to store fonts data while running ImGui.destroyContext(). This will result into a native exception, since JVM by itself controls it's own resources.
  - getFontNo
```
public int getFontNo()
```
    Index of font within TTF/OTF file
  - setFontNo
```
public void setFontNo(int fontNo)
```
    Index of font within TTF/OTF file
  - getSizePixels
```
public float getSizePixels()
```
    Size in pixels for rasterizer (more or less maps to the resulting font height).
  - setSizePixels
```
public void setSizePixels(float sizePixels)
```
    Size in pixels for rasterizer (more or less maps to the resulting font height).
  - getOversampleH
```
public int getOversampleH()
```
    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.
  - setOversampleH
```
public void setOversampleH(int oversampleH)
```
    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.
  - getOversampleV
```
public int getOversampleV()
```
    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.
  - setOversampleV
```
public void setOversampleV(int oversampleV)
```
    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.
  - getPixelSnapH
```
public boolean getPixelSnapH()
```
    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.
  - setPixelSnapH
```
public void setPixelSnapH(boolean isPixelSnapH)
```
    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.
  - getGlyphExtraSpacing
```
public ImVec2 getGlyphExtraSpacing()
```
    Extra spacing (in pixels) between glyphs. Only X axis is supported for now.
  - getGlyphExtraSpacing
```
public void getGlyphExtraSpacing(ImVec2 dstImVec2)
```
    Extra spacing (in pixels) between glyphs. Only X axis is supported for now.
  - getGlyphExtraSpacingX
```
public float getGlyphExtraSpacingX()
```
    Extra spacing (in pixels) between glyphs. Only X axis is supported for now.
  - getGlyphExtraSpacingY
```
public float getGlyphExtraSpacingY()
```
    Extra spacing (in pixels) between glyphs. Only X axis is supported for now.
  - setGlyphExtraSpacing
```
public void setGlyphExtraSpacing(float x,
                                 float y)
```
    Extra spacing (in pixels) between glyphs. Only X axis is supported for now.
  - getGlyphOffset
```
public ImVec2 getGlyphOffset()
```
    Offset all glyphs from this font input.
  - getGlyphOffset
```
public void getGlyphOffset(ImVec2 dstImVec2)
```
    Offset all glyphs from this font input.
  - getGlyphOffsetX
```
public float getGlyphOffsetX()
```
    Offset all glyphs from this font input.
  - getGlyphOffsetY
```
public float getGlyphOffsetY()
```
    Offset all glyphs from this font input.
  - setGlyphOffset
```
public void setGlyphOffset(float x,
                           float y)
```
    Offset all glyphs from this font input.
  - getGlyphRanges
```
public short[] getGlyphRanges()
```
    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.
  - setGlyphRanges
```
public void setGlyphRanges(short[] glyphRanges)
```
    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.
  - getGlyphMinAdvanceX
```
public float getGlyphMinAdvanceX()
```
    Minimum AdvanceX for glyphs, set Min to align font icons, set both Min/Max to enforce mono-space font
  - setGlyphMinAdvanceX
```
public void setGlyphMinAdvanceX(float glyphMinAdvanceX)
```
    Minimum AdvanceX for glyphs, set Min to align font icons, set both Min/Max to enforce mono-space font
  - getGlyphMaxAdvanceX
```
public float getGlyphMaxAdvanceX()
```
    Maximum AdvanceX for glyphs
  - setGlyphMaxAdvanceX
```
public void setGlyphMaxAdvanceX(float glyphMaxAdvanceX)
```
    Maximum AdvanceX for glyphs
  - getMergeMode
```
public boolean getMergeMode()
```
    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.
  - setMergeMode
```
public void setMergeMode(boolean mergeMode)
```
    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.
  - getFontBuilderFlags
```
public int getFontBuilderFlags()
```
    Settings for custom font builder. THIS IS BUILDER IMPLEMENTATION DEPENDENT. Leave as zero if unsure.
  - setFontBuilderFlags
```
public void setFontBuilderFlags(int fontBuilderFlags)
```
    Settings for custom font builder. THIS IS BUILDER IMPLEMENTATION DEPENDENT. Leave as zero if unsure.
  - getRasterizerMultiply
```
public float getRasterizerMultiply()
```
    Brighten (>1.0f) or darken (<1.0f) font output. Brightening small fonts may be a good workaround to make them more readable.
  - setRasterizerMultiply
```
public void setRasterizerMultiply(float rasterizerMultiply)
```
    Brighten (>1.0f) or darken (<1.0f) font output. Brightening small fonts may be a good workaround to make them more readable.
  - getEllipsisChar
```
public short getEllipsisChar()
```
    Explicitly specify unicode codepoint of ellipsis character. When fonts are being merged first specified ellipsis will be used.
  - setEllipsisChar
```
public void setEllipsisChar(int ellipsisChar)
```
    Explicitly specify unicode codepoint of ellipsis character. When fonts are being merged first specified ellipsis will be used.
  - setName
```
public void setName(java.lang.String name)
```
    Name (strictly to ease debugging)

Class ImFontConfig

Field Summary

Fields inherited from class imgui.binding.ImGuiStruct

Constructor Summary

Method Summary

Methods inherited from class imgui.binding.ImGuiStructDestroyable

Methods inherited from class imgui.binding.ImGuiStruct

Methods inherited from class java.lang.Object

Constructor Detail

ImFontConfig

Method Detail

create

getFontData

setFontData

getFontDataSize

setFontDataSize

getFontDataOwnedByAtlas

setFontDataOwnedByAtlas

getFontNo

setFontNo

getSizePixels

setSizePixels

getOversampleH

setOversampleH

getOversampleV

setOversampleV

getPixelSnapH

setPixelSnapH

getGlyphExtraSpacing

getGlyphExtraSpacing

getGlyphExtraSpacingX

getGlyphExtraSpacingY

setGlyphExtraSpacing

getGlyphOffset

getGlyphOffset

getGlyphOffsetX

getGlyphOffsetY

setGlyphOffset

getGlyphRanges

setGlyphRanges

getGlyphMinAdvanceX

setGlyphMinAdvanceX

getGlyphMaxAdvanceX

setGlyphMaxAdvanceX

getMergeMode

setMergeMode

getFontBuilderFlags

setFontBuilderFlags

getRasterizerMultiply

setRasterizerMultiply

getEllipsisChar

setEllipsisChar

setName