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 textBegin) 'max_width' stops rendering after a certain width (could be turned into a 2d size).
ImVec2	calcTextSizeA(float size, float maxWidth, float wrapWidth, java.lang.String textBegin, java.lang.String textEnd) 'max_width' stops rendering after a certain width (could be turned into a 2d size).
void	calcTextSizeA(ImVec2 dst, float size, float maxWidth, float wrapWidth, java.lang.String textBegin) 'max_width' stops rendering after a certain width (could be turned into a 2d size).
void	calcTextSizeA(ImVec2 dst, float size, float maxWidth, float wrapWidth, java.lang.String textBegin, java.lang.String textEnd) '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 textBegin) '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 textBegin, java.lang.String textEnd) '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 textBegin) '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 textBegin, java.lang.String textEnd) '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()
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
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	renderChar(ImDrawList drawList, float size, ImVec2 pos, int col, int c)
void	renderText(ImDrawList drawList, float size, float posX, float posY, int col, float clipRectX, float clipRectY, float clipRectZ, float clipRectW, java.lang.String textBegin, java.lang.String textEnd)
void	renderText(ImDrawList drawList, float size, float posX, float posY, int col, float clipRectX, float clipRectY, float clipRectZ, float clipRectW, java.lang.String textBegin, java.lang.String textEnd, boolean cpuFineClip)
void	renderText(ImDrawList drawList, float size, float posX, float posY, int col, float clipRectX, float clipRectY, float clipRectZ, float clipRectW, java.lang.String textBegin, java.lang.String textEnd, float wrapWidth)
void	renderText(ImDrawList drawList, float size, float posX, float posY, int col, float clipRectX, float clipRectY, float clipRectZ, float clipRectW, java.lang.String textBegin, java.lang.String textEnd, float wrapWidth, boolean cpuFineClip)
void	renderText(ImDrawList drawList, float size, ImVec2 pos, int col, ImVec4 clipRect, java.lang.String textBegin, java.lang.String textEnd)
void	renderText(ImDrawList drawList, float size, ImVec2 pos, int col, ImVec4 clipRect, java.lang.String textBegin, java.lang.String textEnd, boolean cpuFineClip)
void	renderText(ImDrawList drawList, float size, ImVec2 pos, int col, ImVec4 clipRect, java.lang.String textBegin, java.lang.String textEnd, float wrapWidth)
void	renderText(ImDrawList drawList, float size, ImVec2 pos, int col, ImVec4 clipRect, java.lang.String textBegin, java.lang.String textEnd, float wrapWidth, boolean cpuFineClip)
void	setAscent(float value) Ascent: distance from top to bottom of e.g.
void	setConfigDataCount(short value) Number of ImFontConfig involved in creating this font.
void	setDescent(float value)
void	setDirtyLookupTables(boolean value)
void	setDotChar(short value) Character used for ellipsis rendering (if a single '...' character isn't found)
void	setEllipsisChar(short value) Character used for ellipsis rendering.
void	setFallbackAdvanceX(float value) = FallbackGlyph.AdvanceX
void	setFallbackGlyph(ImFontGlyph value) = FindGlyph(FontFallbackChar)
void	setFontSize(float value) Height of characters/line, set during loading (don't change after loading)
void	setMetricsTotalSurface(int value) 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 value) 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 value)

= FallbackGlyph.AdvanceX

getFontSize

public float getFontSize()

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

setFontSize

public void setFontSize(float value)

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

getFallbackGlyph

public ImFontGlyph getFallbackGlyph()

= FindGlyph(FontFallbackChar)

setFallbackGlyph

public void setFallbackGlyph(ImFontGlyph value)

= 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.

setConfigDataCount

public void setConfigDataCount(short value)

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

getEllipsisChar

public short getEllipsisChar()

Character used for ellipsis rendering.

setEllipsisChar

public void setEllipsisChar(short value)

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(short value)

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

getDirtyLookupTables

public boolean getDirtyLookupTables()

setDirtyLookupTables

public void setDirtyLookupTables(boolean value)

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 value)

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 value)

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

getDescent

public float getDescent()

setDescent

public void setDescent(float value)

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 value)

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 textBegin)

'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 textBegin)

'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 textBegin)

'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.

calcTextSizeA

public void calcTextSizeA(ImVec2 dst,
                          float size,
                          float maxWidth,
                          float wrapWidth,
                          java.lang.String textBegin)

'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.

calcTextSizeA

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

'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 textBegin,
                            java.lang.String textEnd)

'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 textBegin,
                            java.lang.String textEnd)

'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.

calcTextSizeA

public void calcTextSizeA(ImVec2 dst,
                          float size,
                          float maxWidth,
                          float wrapWidth,
                          java.lang.String textBegin,
                          java.lang.String textEnd)

'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,
                       ImVec2 pos,
                       int col,
                       int c)

renderChar

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

renderText

public void renderText(ImDrawList drawList,
                       float size,
                       ImVec2 pos,
                       int col,
                       ImVec4 clipRect,
                       java.lang.String textBegin,
                       java.lang.String textEnd)

renderText

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

renderText

public void renderText(ImDrawList drawList,
                       float size,
                       ImVec2 pos,
                       int col,
                       ImVec4 clipRect,
                       java.lang.String textBegin,
                       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 clipRectZ,
                       float clipRectW,
                       java.lang.String textBegin,
                       java.lang.String textEnd,
                       float wrapWidth)

renderText

public void renderText(ImDrawList drawList,
                       float size,
                       ImVec2 pos,
                       int col,
                       ImVec4 clipRect,
                       java.lang.String textBegin,
                       java.lang.String textEnd,
                       float wrapWidth,
                       boolean cpuFineClip)

renderText

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

renderText

public void renderText(ImDrawList drawList,
                       float size,
                       ImVec2 pos,
                       int col,
                       ImVec4 clipRect,
                       java.lang.String textBegin,
                       java.lang.String textEnd,
                       boolean cpuFineClip)

renderText

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