imgui

Class ImFont

java.lang.Object

imgui.binding.ImGuiStruct

imgui.binding.ImGuiStructDestroyable

imgui.ImFont

public final class ImFont
extends ImGuiStructDestroyable

Font runtime data and rendering ImFontAtlas automatically loads a default embedded font for you when you call GetTexDataAsAlpha8() or GetTexDataAsRGBA32().

Field Summary

Fields inherited from class imgui.binding.ImGuiStruct

ptr

Constructor Summary

Constructors

Constructor and Description
ImFont()
ImFont(long ptr)

Method Summary

Modifier and Type	Method and Description
ImVec2	calcTextSizeA(float size, float maxWidth, float wrapWidth, java.lang.String text)
void	calcTextSizeA(ImVec2 dstImVec2, float size, float maxWidth, float wrapWidth, java.lang.String text) 'max_width' stops rendering after a certain width (could be turned into a 2d size).
float	calcTextSizeAX(float size, float maxWidth, float wrapWidth, java.lang.String text) 'max_width' stops rendering after a certain width (could be turned into a 2d size).
float	calcTextSizeAY(float size, float maxWidth, float wrapWidth, java.lang.String text) 'max_width' stops rendering after a certain width (could be turned into a 2d size).
java.lang.String	calcWordWrapPositionA(float scale, java.lang.String text, java.lang.String textEnd, float wrapWidth)
protected long	create()
ImFontGlyph	findGlyph(int c)
ImFontGlyph	findGlyphNoFallback(int c)
float	getAscent() Ascent: distance from top to bottom of e.g.
float	getCharAdvance(int c)
short	getConfigDataCount() Number of ImFontConfig involved in creating this font.
java.lang.String	getDebugName()
float	getDescent() Ascent: distance from top to bottom of e.g.
boolean	getDirtyLookupTables()
short	getDotChar() Character used for ellipsis rendering (if a single '...' character isn't found)
short	getEllipsisChar() Character used for ellipsis rendering.
float	getFallbackAdvanceX() = FallbackGlyph.AdvanceX
short	getFallbackChar() Replacement character if a glyph isn't found.
ImFontGlyph	getFallbackGlyph() = FindGlyph(FontFallbackChar)
float	getFontSize() Height of characters/line, set during loading (don't change after loading)
int	getMetricsTotalSurface() Total surface in pixels to get an idea of the font rasterization/texture cost (not exact, we approximate the cost of padding between glyphs)
float	getScale() Base font scale, multiplied by the per-window font scale which you can adjust with SetWindowFontScale()
boolean	isLoaded()
void	renderChar(ImDrawList drawList, float size, float posX, float posY, int col, int c)
void	renderText(ImDrawList drawList, float size, float posX, float posY, int col, float clipRectX, float clipRectY, float clipRectW, float clipRectZ, java.lang.String text, java.lang.String textEnd)
void	renderText(ImDrawList drawList, float size, float posX, float posY, int col, float clipRectX, float clipRectY, float clipRectW, float clipRectZ, java.lang.String text, java.lang.String textEnd, float wrapWidth)
void	renderText(ImDrawList drawList, float size, float posX, float posY, int col, float clipRectX, float clipRectY, float clipRectW, float clipRectZ, java.lang.String text, java.lang.String textEnd, float wrapWidth, boolean cpuFineClip)
void	setAscent(float ascent) Ascent: distance from top to bottom of e.g.
void	setDescent(float descent) Ascent: distance from top to bottom of e.g.
void	setDirtyLookupTables(boolean dirtyLookupTables)
void	setDotChar(int dotChar) Character used for ellipsis rendering (if a single '...' character isn't found)
void	setEllipsisChar(int ellipsisChar) Character used for ellipsis rendering.
void	setFallbackAdvanceX(float fallbackAdvanceX) = FallbackGlyph.AdvanceX
void	setMetricsTotalSurface(int metricsTotalSurface) Total surface in pixels to get an idea of the font rasterization/texture cost (not exact, we approximate the cost of padding between glyphs)
void	setScale(float scale) Base font scale, multiplied by the per-window font scale which you can adjust with SetWindowFontScale()

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

ImFont

public ImFont()

ImFont

public ImFont(long ptr)

Method Detail

create

protected long create()

Specified by:

create in class ImGuiStructDestroyable

getFallbackAdvanceX

public float getFallbackAdvanceX()

= FallbackGlyph.AdvanceX

setFallbackAdvanceX

public void setFallbackAdvanceX(float fallbackAdvanceX)

= FallbackGlyph.AdvanceX

getFontSize

public float getFontSize()

Height of characters/line, set during loading (don't change after loading)

getFallbackGlyph

public ImFontGlyph getFallbackGlyph()

= FindGlyph(FontFallbackChar)

getConfigDataCount

public short getConfigDataCount()

Number of ImFontConfig involved in creating this font. Bigger than 1 when merging multiple font sources into one ImFont.

getFallbackChar

public short getFallbackChar()

Replacement character if a glyph isn't found.

getEllipsisChar

public short getEllipsisChar()

Character used for ellipsis rendering.

setEllipsisChar

public void setEllipsisChar(int ellipsisChar)

Character used for ellipsis rendering.

getDotChar

public short getDotChar()

Character used for ellipsis rendering (if a single '...' character isn't found)

setDotChar

public void setDotChar(int dotChar)

Character used for ellipsis rendering (if a single '...' character isn't found)

getDirtyLookupTables

public boolean getDirtyLookupTables()

setDirtyLookupTables

public void setDirtyLookupTables(boolean dirtyLookupTables)

getScale

public float getScale()

Base font scale, multiplied by the per-window font scale which you can adjust with SetWindowFontScale()

setScale

public void setScale(float scale)

Base font scale, multiplied by the per-window font scale which you can adjust with SetWindowFontScale()

getAscent

public float getAscent()

Ascent: distance from top to bottom of e.g. 'A' [0..FontSize]

setAscent

public void setAscent(float ascent)

Ascent: distance from top to bottom of e.g. 'A' [0..FontSize]

getDescent

public float getDescent()

Ascent: distance from top to bottom of e.g. 'A' [0..FontSize]

setDescent

public void setDescent(float descent)

Ascent: distance from top to bottom of e.g. 'A' [0..FontSize]

getMetricsTotalSurface

public int getMetricsTotalSurface()

Total surface in pixels to get an idea of the font rasterization/texture cost (not exact, we approximate the cost of padding between glyphs)

setMetricsTotalSurface

public void setMetricsTotalSurface(int metricsTotalSurface)

Total surface in pixels to get an idea of the font rasterization/texture cost (not exact, we approximate the cost of padding between glyphs)

findGlyph

public ImFontGlyph findGlyph(int c)

findGlyphNoFallback

public ImFontGlyph findGlyphNoFallback(int c)

getCharAdvance

public float getCharAdvance(int c)

isLoaded

public boolean isLoaded()

getDebugName

public java.lang.String getDebugName()

calcTextSizeA

public ImVec2 calcTextSizeA(float size,
                            float maxWidth,
                            float wrapWidth,
                            java.lang.String text)

calcTextSizeA

public void calcTextSizeA(ImVec2 dstImVec2,
                          float size,
                          float maxWidth,
                          float wrapWidth,
                          java.lang.String text)

'max_width' stops rendering after a certain width (could be turned into a 2d size). FLT_MAX to disable. 'wrap_width' enable automatic word-wrapping across multiple lines to fit into given width. 0.0f to disable.

calcTextSizeAX

public float calcTextSizeAX(float size,
                            float maxWidth,
                            float wrapWidth,
                            java.lang.String text)

'max_width' stops rendering after a certain width (could be turned into a 2d size). FLT_MAX to disable. 'wrap_width' enable automatic word-wrapping across multiple lines to fit into given width. 0.0f to disable.

calcTextSizeAY

public float calcTextSizeAY(float size,
                            float maxWidth,
                            float wrapWidth,
                            java.lang.String text)

'max_width' stops rendering after a certain width (could be turned into a 2d size). FLT_MAX to disable. 'wrap_width' enable automatic word-wrapping across multiple lines to fit into given width. 0.0f to disable.

calcWordWrapPositionA

public java.lang.String calcWordWrapPositionA(float scale,
                                              java.lang.String text,
                                              java.lang.String textEnd,
                                              float wrapWidth)

renderChar

public void renderChar(ImDrawList drawList,
                       float size,
                       float posX,
                       float posY,
                       int col,
                       int c)

renderText

public void renderText(ImDrawList drawList,
                       float size,
                       float posX,
                       float posY,
                       int col,
                       float clipRectX,
                       float clipRectY,
                       float clipRectW,
                       float clipRectZ,
                       java.lang.String text,
                       java.lang.String textEnd)

renderText

public void renderText(ImDrawList drawList,
                       float size,
                       float posX,
                       float posY,
                       int col,
                       float clipRectX,
                       float clipRectY,
                       float clipRectW,
                       float clipRectZ,
                       java.lang.String text,
                       java.lang.String textEnd,
                       float wrapWidth)

renderText

public void renderText(ImDrawList drawList,
                       float size,
                       float posX,
                       float posY,
                       int col,
                       float clipRectX,
                       float clipRectY,
                       float clipRectW,
                       float clipRectZ,
                       java.lang.String text,
                       java.lang.String textEnd,
                       float wrapWidth,
                       boolean cpuFineClip)