imgui

Class ImFontAtlas

java.lang.Object

imgui.ImFontAtlas

public final class ImFontAtlas
extends java.lang.Object

Load and rasterize multiple TTF/OTF fonts into a same texture. The font atlas will build a single texture holding: - One or more fonts. - Custom graphics data needed to render the shapes needed by Dear ImGui. - Mouse cursor shapes for software cursor rendering (unless setting 'Flags |= ImFontAtlasFlags_NoMouseCursors' in the font atlas). It is the user-code responsibility to setup/build the atlas, then upload the pixel data into a texture accessible by your graphics api. - Optionally, call any of the AddFont*** functions. If you don't call any, the default font embedded in the code will be loaded for you. - Call GetTexDataAsAlpha8() or GetTexDataAsRGBA32() to build and retrieve pixels data. - Upload the pixels data into a texture within your graphics system (see imgui_impl_xxxx.cpp examples) - Call SetTexID(my_tex_id); and pass the pointer/identifier to your texture in a format natural to your graphics API. This value will be passed back to you during rendering to identify the texture. Read FAQ entry about ImTextureID for more details. Common pitfalls: - If you pass a 'glyph_ranges' array to AddFont*** functions, you need to make sure that your array persist up until the atlas is build (when calling GetTexData*** or Build()). We only copy the pointer, not the data. - Important: By default, AddFontFromMemoryTTF() takes ownership of the data. Even though we are not writing to it, we will free the pointer on destruction. You can set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed, - Even though many functions are suffixed with "TTF", OTF data is supported just as well. - This is an old API and it is currently awkward for those and and various other reasons! We will address them in the future!

Constructor Summary

Constructors

Constructor and Description
ImFontAtlas() This class will create a native structure.

Method Summary

Modifier and Type	Method and Description
int	addCustomRectFontGlyph(ImFont imFont, short id, int width, int height, float advanceX) Id needs to be < 0x110000 to register a rectangle to map into a specific font.
int	addCustomRectFontGlyph(ImFont imFont, short id, int width, int height, float advanceX, float offsetX, float offsetY) Id needs to be < 0x110000 to register a rectangle to map into a specific font.
int	addCustomRectRegular(int id, int width, int height) Id needs to be >= 0x110000.
ImFont	addFont(ImFontConfig imFontConfig)
ImFont	addFontDefault()
ImFont	addFontDefault(ImFontConfig imFontConfig)
ImFont	addFontFromFileTTF(java.lang.String filename, float sizePixels)
ImFont	addFontFromFileTTF(java.lang.String filename, float sizePixels, ImFontConfig imFontConfig)
ImFont	addFontFromFileTTF(java.lang.String filename, float sizePixels, ImFontConfig imFontConfig, short[] glyphRanges)
ImFont	addFontFromFileTTF(java.lang.String filename, float sizePixels, short[] glyphRanges)
ImFont	addFontFromMemoryCompressedBase85TTF(java.lang.String compressedFontDataBase85, float sizePixels) 'compressed_font_data_base85' still owned by caller.
ImFont	addFontFromMemoryCompressedBase85TTF(java.lang.String compressedFontDataBase85, float sizePixels, ImFontConfig imFontConfig) 'compressed_font_data' still owned by caller.
ImFont	addFontFromMemoryCompressedBase85TTF(java.lang.String compressedFontDataBase85, float sizePixels, ImFontConfig imFontConfig, short[] glyphRanges) 'compressed_font_data_base85' still owned by caller.
ImFont	addFontFromMemoryCompressedBase85TTF(java.lang.String compressedFontDataBase85, float sizePixels, short[] glyphRanges) 'compressed_font_data_base85' still owned by caller.
ImFont	addFontFromMemoryCompressedTTF(byte[] compressedFontData, float sizePixels) 'compressed_font_data' still owned by caller.
ImFont	addFontFromMemoryCompressedTTF(byte[] compressedFontData, float sizePixels, ImFontConfig imFontConfig) 'compressed_font_data' still owned by caller.
ImFont	addFontFromMemoryCompressedTTF(byte[] compressedFontData, float sizePixels, ImFontConfig imFontConfig, short[] glyphRanges) 'compressed_font_data' still owned by caller.
ImFont	addFontFromMemoryCompressedTTF(byte[] compressedFontData, float sizePixels, short[] glyphRanges) 'compressed_font_data' still owned by caller.
ImFont	addFontFromMemoryTTF(byte[] fontData, float sizePixels) Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
ImFont	addFontFromMemoryTTF(byte[] fontData, float sizePixels, ImFontConfig imFontConfig) Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
ImFont	addFontFromMemoryTTF(byte[] fontData, float sizePixels, ImFontConfig imFontConfig, short[] glyphRanges) Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
ImFont	addFontFromMemoryTTF(byte[] fontData, float sizePixels, short[] glyphRanges) Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas.
boolean	build() Build pixels data.
void	clear() Clear all input and output.
void	clearFonts() Clear output font data (glyphs storage, UV coordinates).
void	clearInputData() Clear input data (all ImFontConfig structures including sizes, TTF data, glyph ranges, etc.) = all the data used to build the texture and fonts.
void	clearTexData() Clear output texture data (CPU side).
void	destroy()
int	getFlags() Build flags (see ImFontAtlasFlags_)
short[]	getGlyphRangesChineseFull() Default + Half-Width + Japanese Hiragana/Katakana + full set of about 21000 CJK Unified Ideographs
short[]	getGlyphRangesChineseSimplifiedCommon() Default + Half-Width + Japanese Hiragana/Katakana + set of 2500 CJK Unified Ideographs for common simplified Chinese
short[]	getGlyphRangesCyrillic() Default + about 400 Cyrillic characters
short[]	getGlyphRangesDefault() Basic Latin, Extended Latin
short[]	getGlyphRangesJapanese() Default + Hiragana, Katakana, Half-Width, Selection of 1946 Ideographs
short[]	getGlyphRangesKorean() Default + Korean characters
short[]	getGlyphRangesThai() Default + Thai characters
short[]	getGlyphRangesVietnamese() Default + Vietnamese characters
boolean	getLocked() Marked as Locked by ImGui::NewFrame() so attempt to modify the atlas will assert.
java.nio.ByteBuffer	getTexDataAsAlpha8(ImInt outWidth, ImInt outHeight) 1 byte-per-pixel
java.nio.ByteBuffer	getTexDataAsAlpha8(ImInt outWidth, ImInt outHeight, ImInt outBytesPerPixel) 1 byte-per-pixel
java.nio.ByteBuffer	getTexDataAsRGBA32(ImInt outWidth, ImInt outHeight) 4 bytes-per-pixel
java.nio.ByteBuffer	getTexDataAsRGBA32(ImInt outWidth, ImInt outHeight, ImInt outBytesPerPixel) 4 bytes-per-pixel
int	getTexDesiredWidth() Texture width desired by user before Build().
int	getTexGlyphPadding() Padding between glyphs within texture in pixels.
int	getTexID() User data to refer to the texture once it has been uploaded to user's graphic systems.
boolean	isBuilt()
void	setFlags(int imFontAtlasFlags) Build flags (see ImFontAtlasFlags_)
void	setLocked(boolean locked) Marked as Locked by ImGui::NewFrame() so attempt to modify the atlas will assert.
void	setTexDesiredWidth(int texDesiredWidth) Texture width desired by user before Build().
void	setTexGlyphPadding(int texGlyphPadding) Padding between glyphs within texture in pixels.
void	setTexID(int textureID)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImFontAtlas

public ImFontAtlas()

This class will create a native structure. Call destroy() method to manually free used memory.

Method Detail

destroy

public void destroy()

addFont

public ImFont addFont(ImFontConfig imFontConfig)

addFontDefault

public ImFont addFontDefault()

addFontDefault

public ImFont addFontDefault(ImFontConfig imFontConfig)

addFontFromFileTTF

public ImFont addFontFromFileTTF(java.lang.String filename,
                                 float sizePixels)

addFontFromFileTTF

public ImFont addFontFromFileTTF(java.lang.String filename,
                                 float sizePixels,
                                 ImFontConfig imFontConfig)

addFontFromFileTTF

public ImFont addFontFromFileTTF(java.lang.String filename,
                                 float sizePixels,
                                 short[] glyphRanges)

addFontFromFileTTF

public ImFont addFontFromFileTTF(java.lang.String filename,
                                 float sizePixels,
                                 ImFontConfig imFontConfig,
                                 short[] glyphRanges)

addFontFromMemoryTTF

public ImFont addFontFromMemoryTTF(byte[] fontData,
                                   float sizePixels)

Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas. Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.

addFontFromMemoryTTF

public ImFont addFontFromMemoryTTF(byte[] fontData,
                                   float sizePixels,
                                   ImFontConfig imFontConfig)

Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas. Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.

addFontFromMemoryTTF

public ImFont addFontFromMemoryTTF(byte[] fontData,
                                   float sizePixels,
                                   short[] glyphRanges)

Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas. Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.

addFontFromMemoryTTF

public ImFont addFontFromMemoryTTF(byte[] fontData,
                                   float sizePixels,
                                   ImFontConfig imFontConfig,
                                   short[] glyphRanges)

Note: Transfer ownership of 'ttf_data' to ImFontAtlas! Will be deleted after destruction of the atlas. Set font_cfg->FontDataOwnedByAtlas=false to keep ownership of your data and it won't be freed.

addFontFromMemoryCompressedTTF

public ImFont addFontFromMemoryCompressedTTF(byte[] compressedFontData,
                                             float sizePixels)

'compressed_font_data' still owned by caller. Compress with binary_to_compressed_c.cpp.

addFontFromMemoryCompressedTTF

public ImFont addFontFromMemoryCompressedTTF(byte[] compressedFontData,
                                             float sizePixels,
                                             ImFontConfig imFontConfig)

'compressed_font_data' still owned by caller. Compress with binary_to_compressed_c.cpp.

addFontFromMemoryCompressedTTF

public ImFont addFontFromMemoryCompressedTTF(byte[] compressedFontData,
                                             float sizePixels,
                                             short[] glyphRanges)

'compressed_font_data' still owned by caller. Compress with binary_to_compressed_c.cpp.

addFontFromMemoryCompressedTTF

public ImFont addFontFromMemoryCompressedTTF(byte[] compressedFontData,
                                             float sizePixels,
                                             ImFontConfig imFontConfig,
                                             short[] glyphRanges)

'compressed_font_data' still owned by caller. Compress with binary_to_compressed_c.cpp.

addFontFromMemoryCompressedBase85TTF

public ImFont addFontFromMemoryCompressedBase85TTF(java.lang.String compressedFontDataBase85,
                                                   float sizePixels)

'compressed_font_data_base85' still owned by caller. Compress with binary_to_compressed_c.cpp with -base85 parameter.

addFontFromMemoryCompressedBase85TTF

public ImFont addFontFromMemoryCompressedBase85TTF(java.lang.String compressedFontDataBase85,
                                                   float sizePixels,
                                                   ImFontConfig imFontConfig)

'compressed_font_data' still owned by caller. Compress with binary_to_compressed_c.cpp.

addFontFromMemoryCompressedBase85TTF

public ImFont addFontFromMemoryCompressedBase85TTF(java.lang.String compressedFontDataBase85,
                                                   float sizePixels,
                                                   short[] glyphRanges)

'compressed_font_data_base85' still owned by caller. Compress with binary_to_compressed_c.cpp with -base85 parameter.

addFontFromMemoryCompressedBase85TTF

public ImFont addFontFromMemoryCompressedBase85TTF(java.lang.String compressedFontDataBase85,
                                                   float sizePixels,
                                                   ImFontConfig imFontConfig,
                                                   short[] glyphRanges)

'compressed_font_data_base85' still owned by caller. Compress with binary_to_compressed_c.cpp with -base85 parameter.

clearInputData

public void clearInputData()

Clear input data (all ImFontConfig structures including sizes, TTF data, glyph ranges, etc.) = all the data used to build the texture and fonts.

clearTexData

public void clearTexData()

Clear output texture data (CPU side). Saves RAM once the texture has been copied to graphics memory.

clearFonts

public void clearFonts()

Clear output font data (glyphs storage, UV coordinates).

clear

public void clear()

Clear all input and output.

build

public boolean build()

Build pixels data. This is called automatically for you by the GetTexData*** functions.

getTexDataAsAlpha8

public java.nio.ByteBuffer getTexDataAsAlpha8(ImInt outWidth,
                                              ImInt outHeight)

1 byte-per-pixel

getTexDataAsAlpha8

public java.nio.ByteBuffer getTexDataAsAlpha8(ImInt outWidth,
                                              ImInt outHeight,
                                              ImInt outBytesPerPixel)

1 byte-per-pixel

getTexDataAsRGBA32

public java.nio.ByteBuffer getTexDataAsRGBA32(ImInt outWidth,
                                              ImInt outHeight)

4 bytes-per-pixel

getTexDataAsRGBA32

public java.nio.ByteBuffer getTexDataAsRGBA32(ImInt outWidth,
                                              ImInt outHeight,
                                              ImInt outBytesPerPixel)

4 bytes-per-pixel

isBuilt

public boolean isBuilt()

setTexID

public void setTexID(int textureID)

getGlyphRangesDefault

public short[] getGlyphRangesDefault()

Basic Latin, Extended Latin

getGlyphRangesKorean

public short[] getGlyphRangesKorean()

Default + Korean characters

getGlyphRangesJapanese

public short[] getGlyphRangesJapanese()

Default + Hiragana, Katakana, Half-Width, Selection of 1946 Ideographs

getGlyphRangesChineseFull

public short[] getGlyphRangesChineseFull()

Default + Half-Width + Japanese Hiragana/Katakana + full set of about 21000 CJK Unified Ideographs

getGlyphRangesChineseSimplifiedCommon

public short[] getGlyphRangesChineseSimplifiedCommon()

Default + Half-Width + Japanese Hiragana/Katakana + set of 2500 CJK Unified Ideographs for common simplified Chinese

getGlyphRangesCyrillic

public short[] getGlyphRangesCyrillic()

Default + about 400 Cyrillic characters

getGlyphRangesThai

public short[] getGlyphRangesThai()

Default + Thai characters

getGlyphRangesVietnamese

public short[] getGlyphRangesVietnamese()

Default + Vietnamese characters

addCustomRectRegular

public int addCustomRectRegular(int id,
                                int width,
                                int height)

Id needs to be >= 0x110000. Id >= 0x80000000 are reserved for ImGui and ImDrawList

addCustomRectFontGlyph

public int addCustomRectFontGlyph(ImFont imFont,
                                  short id,
                                  int width,
                                  int height,
                                  float advanceX)

Id needs to be < 0x110000 to register a rectangle to map into a specific font.

addCustomRectFontGlyph

public int addCustomRectFontGlyph(ImFont imFont,
                                  short id,
                                  int width,
                                  int height,
                                  float advanceX,
                                  float offsetX,
                                  float offsetY)

Id needs to be < 0x110000 to register a rectangle to map into a specific font.

getLocked

public boolean getLocked()

Marked as Locked by ImGui::NewFrame() so attempt to modify the atlas will assert.

setLocked

public void setLocked(boolean locked)

Marked as Locked by ImGui::NewFrame() so attempt to modify the atlas will assert.

getFlags

public int getFlags()

Build flags (see ImFontAtlasFlags_)

setFlags

public void setFlags(int imFontAtlasFlags)

Build flags (see ImFontAtlasFlags_)

getTexID

public int getTexID()

User data to refer to the texture once it has been uploaded to user's graphic systems. It is passed back to you during rendering via the ImDrawCmd structure.

getTexDesiredWidth

public int getTexDesiredWidth()

Texture width desired by user before Build(). Must be a power-of-two. If have many glyphs your graphics API have texture size restrictions you may want to increase texture width to decrease height.

setTexDesiredWidth

public void setTexDesiredWidth(int texDesiredWidth)

Texture width desired by user before Build(). Must be a power-of-two. If have many glyphs your graphics API have texture size restrictions you may want to increase texture width to decrease height.

getTexGlyphPadding

public int getTexGlyphPadding()

Padding between glyphs within texture in pixels. Defaults to 1. If your rendering method doesn't rely on bilinear filtering you may set this to 0.

setTexGlyphPadding

public void setTexGlyphPadding(int texGlyphPadding)

Padding between glyphs within texture in pixels. Defaults to 1. If your rendering method doesn't rely on bilinear filtering you may set this to 0.