ImFontAtlas Struct Reference

#include <imgui.h>

Classes
struct	CustomRect

Public Types
typedef ImFontGlyphRangesBuilder	GlyphRangesBuilder

Public Member Functions
IMGUI_API int	AddCustomRectFontGlyph (ImFont *font, ImWchar id, int width, int height, float advance_x, const ImVec2 &offset=ImVec2(0, 0))
IMGUI_API int	AddCustomRectRegular (unsigned int id, int width, int height)
IMGUI_API ImFont *	AddFont (const ImFontConfig *font_cfg)
IMGUI_API ImFont *	AddFontDefault (const ImFontConfig *font_cfg=NULL)
IMGUI_API ImFont *	AddFontFromFileTTF (const char *filename, float size_pixels, const ImFontConfig *font_cfg=NULL, const ImWchar *glyph_ranges=NULL)
IMGUI_API ImFont *	AddFontFromMemoryCompressedBase85TTF (const char *compressed_font_data_base85, float size_pixels, const ImFontConfig *font_cfg=NULL, const ImWchar *glyph_ranges=NULL)
IMGUI_API ImFont *	AddFontFromMemoryCompressedTTF (const void *compressed_font_data, int compressed_font_size, float size_pixels, const ImFontConfig *font_cfg=NULL, const ImWchar *glyph_ranges=NULL)
IMGUI_API ImFont *	AddFontFromMemoryTTF (void *font_data, int font_size, float size_pixels, const ImFontConfig *font_cfg=NULL, const ImWchar *glyph_ranges=NULL)
IMGUI_API bool	Build ()
IMGUI_API void	CalcCustomRectUV (const CustomRect *rect, ImVec2 *out_uv_min, ImVec2 *out_uv_max)
IMGUI_API void	Clear ()
IMGUI_API void	ClearFonts ()
IMGUI_API void	ClearInputData ()
IMGUI_API void	ClearTexData ()
const CustomRect *	GetCustomRectByIndex (int index) const
IMGUI_API const ImWchar *	GetGlyphRangesChineseFull ()
IMGUI_API const ImWchar *	GetGlyphRangesChineseSimplifiedCommon ()
IMGUI_API const ImWchar *	GetGlyphRangesCyrillic ()
IMGUI_API const ImWchar *	GetGlyphRangesDefault ()
IMGUI_API const ImWchar *	GetGlyphRangesJapanese ()
IMGUI_API const ImWchar *	GetGlyphRangesKorean ()
IMGUI_API const ImWchar *	GetGlyphRangesThai ()
IMGUI_API bool	GetMouseCursorTexData (ImGuiMouseCursor cursor, ImVec2 *out_offset, ImVec2 *out_size, ImVec2 out_uv_border[2], ImVec2 out_uv_fill[2])
IMGUI_API void	GetTexDataAsAlpha8 (unsigned char **out_pixels, int *out_width, int *out_height, int *out_bytes_per_pixel=NULL)
IMGUI_API void	GetTexDataAsRGBA32 (unsigned char **out_pixels, int *out_width, int *out_height, int *out_bytes_per_pixel=NULL)
IMGUI_API	ImFontAtlas ()
bool	IsBuilt ()
void	SetTexID (ImTextureID id)
IMGUI_API	~ImFontAtlas ()

Public Attributes
ImVector< ImFontConfig >	ConfigData
int	CustomRectIds [1]
ImVector< CustomRect >	CustomRects
ImFontAtlasFlags	Flags
ImVector< ImFont * >	Fonts
bool	Locked
int	TexDesiredWidth
int	TexGlyphPadding
int	TexHeight
ImTextureID	TexID
unsigned char *	TexPixelsAlpha8
unsigned int *	TexPixelsRGBA32
ImVec2	TexUvScale
ImVec2	TexUvWhitePixel
int	TexWidth

Detailed Description

Definition at line 1974 of file imgui.h.

Member Typedef Documentation

GlyphRangesBuilder

typedef ImFontGlyphRangesBuilder ImFontAtlas::GlyphRangesBuilder

Definition at line 2065 of file imgui.h.

Constructor & Destructor Documentation

ImFontAtlas()

ImFontAtlas::ImFontAtlas

(

)

Definition at line 1422 of file imgui_draw.cpp.

~ImFontAtlas()

ImFontAtlas::~ImFontAtlas

(

)

Definition at line 1439 of file imgui_draw.cpp.

Member Function Documentation

AddCustomRectFontGlyph()

int ImFontAtlas::AddCustomRectFontGlyph	(	ImFont *	font,
		ImWchar	id,
		int	width,
		int	height,
		float	advance_x,
		const ImVec2 &	offset = ImVec2(0,0)
	)

Definition at line 1667 of file imgui_draw.cpp.

AddCustomRectRegular()

int ImFontAtlas::AddCustomRectRegular	(	unsigned int	id,
		int	width,
		int	height
	)

Definition at line 1654 of file imgui_draw.cpp.

AddFont()

ImFont * ImFontAtlas::AddFont

(

const ImFontConfig *

font_cfg

)

Definition at line 1534 of file imgui_draw.cpp.

AddFontDefault()

ImFont * ImFontAtlas::AddFontDefault

(

const ImFontConfig *

font_cfg = NULL

)

Definition at line 1579 of file imgui_draw.cpp.

AddFontFromFileTTF()

ImFont * ImFontAtlas::AddFontFromFileTTF	(	const char *	filename,
		float	size_pixels,
		const ImFontConfig *	font_cfg = NULL,
		const ImWchar *	glyph_ranges = NULL
	)

Definition at line 1597 of file imgui_draw.cpp.

AddFontFromMemoryCompressedBase85TTF()

ImFont * ImFontAtlas::AddFontFromMemoryCompressedBase85TTF	(	const char *	compressed_font_data_base85,
		float	size_pixels,
		const ImFontConfig *	font_cfg = NULL,
		const ImWchar *	glyph_ranges = NULL
	)

Definition at line 1644 of file imgui_draw.cpp.

AddFontFromMemoryCompressedTTF()

ImFont * ImFontAtlas::AddFontFromMemoryCompressedTTF	(	const void *	compressed_font_data,
		int	compressed_font_size,
		float	size_pixels,
		const ImFontConfig *	font_cfg = NULL,
		const ImWchar *	glyph_ranges = NULL
	)

Definition at line 1632 of file imgui_draw.cpp.

AddFontFromMemoryTTF()

ImFont * ImFontAtlas::AddFontFromMemoryTTF	(	void *	font_data,
		int	font_size,
		float	size_pixels,
		const ImFontConfig *	font_cfg = NULL,
		const ImWchar *	glyph_ranges = NULL
	)

Definition at line 1619 of file imgui_draw.cpp.

Build()

bool ImFontAtlas::Build

(

)

Definition at line 1713 of file imgui_draw.cpp.

CalcCustomRectUV()

void ImFontAtlas::CalcCustomRectUV	(	const CustomRect *	rect,
		ImVec2 *	out_uv_min,
		ImVec2 *	out_uv_max
	)

Definition at line 1683 of file imgui_draw.cpp.

Clear()

void ImFontAtlas::Clear

(

)

Definition at line 1487 of file imgui_draw.cpp.

ClearFonts()

void ImFontAtlas::ClearFonts

(

)

Definition at line 1479 of file imgui_draw.cpp.

ClearInputData()

void ImFontAtlas::ClearInputData

(

)

Definition at line 1445 of file imgui_draw.cpp.

ClearTexData()

void ImFontAtlas::ClearTexData

(

)

Definition at line 1468 of file imgui_draw.cpp.

GetCustomRectByIndex()

const CustomRect* ImFontAtlas::GetCustomRectByIndex ( int  index ) const

inline

Definition at line 2035 of file imgui.h.

GetGlyphRangesChineseFull()

const ImWchar * ImFontAtlas::GetGlyphRangesChineseFull

(

)

Definition at line 2083 of file imgui_draw.cpp.

GetGlyphRangesChineseSimplifiedCommon()

const ImWchar * ImFontAtlas::GetGlyphRangesChineseSimplifiedCommon

(

)

Definition at line 2111 of file imgui_draw.cpp.

GetGlyphRangesCyrillic()

const ImWchar * ImFontAtlas::GetGlyphRangesCyrillic

(

)

Definition at line 2235 of file imgui_draw.cpp.

GetGlyphRangesDefault()

const ImWchar * ImFontAtlas::GetGlyphRangesDefault

(

)

Definition at line 2061 of file imgui_draw.cpp.

GetGlyphRangesJapanese()

const ImWchar * ImFontAtlas::GetGlyphRangesJapanese

(

)

Definition at line 2177 of file imgui_draw.cpp.

GetGlyphRangesKorean()

const ImWchar * ImFontAtlas::GetGlyphRangesKorean

(

)

Definition at line 2071 of file imgui_draw.cpp.

GetGlyphRangesThai()

const ImWchar * ImFontAtlas::GetGlyphRangesThai

(

)

Definition at line 2248 of file imgui_draw.cpp.

GetMouseCursorTexData()

bool ImFontAtlas::GetMouseCursorTexData	(	ImGuiMouseCursor	cursor,
		ImVec2 *	out_offset,
		ImVec2 *	out_size,
		ImVec2	out_uv_border[2],
		ImVec2	out_uv_fill[2]
	)

Definition at line 1691 of file imgui_draw.cpp.

GetTexDataAsAlpha8()

void ImFontAtlas::GetTexDataAsAlpha8	(	unsigned char **	out_pixels,
		int *	out_width,
		int *	out_height,
		int *	out_bytes_per_pixel = NULL
	)

Definition at line 1494 of file imgui_draw.cpp.

GetTexDataAsRGBA32()

void ImFontAtlas::GetTexDataAsRGBA32	(	unsigned char **	out_pixels,
		int *	out_width,
		int *	out_height,
		int *	out_bytes_per_pixel = NULL
	)

Definition at line 1510 of file imgui_draw.cpp.

IsBuilt()

bool ImFontAtlas::IsBuilt ( )

inline

Definition at line 1997 of file imgui.h.

SetTexID()

void ImFontAtlas::SetTexID ( ImTextureID  id )

inline

Definition at line 1998 of file imgui.h.

Member Data Documentation

ConfigData

ImVector<ImFontConfig> ImFontAtlas::ConfigData

Definition at line 2061 of file imgui.h.

CustomRectIds

int ImFontAtlas::CustomRectIds[1]

Definition at line 2062 of file imgui.h.

CustomRects

ImVector<CustomRect> ImFontAtlas::CustomRects

Definition at line 2060 of file imgui.h.

Flags

ImFontAtlasFlags ImFontAtlas::Flags

Definition at line 2046 of file imgui.h.

Fonts

ImVector<ImFont*> ImFontAtlas::Fonts

Definition at line 2059 of file imgui.h.

Locked

bool ImFontAtlas::Locked

Definition at line 2045 of file imgui.h.

TexDesiredWidth

int ImFontAtlas::TexDesiredWidth

Definition at line 2048 of file imgui.h.

TexGlyphPadding

int ImFontAtlas::TexGlyphPadding

Definition at line 2049 of file imgui.h.

TexHeight

int ImFontAtlas::TexHeight

Definition at line 2056 of file imgui.h.

TexID

ImTextureID ImFontAtlas::TexID

Definition at line 2047 of file imgui.h.

TexPixelsAlpha8

unsigned char* ImFontAtlas::TexPixelsAlpha8

Definition at line 2053 of file imgui.h.

TexPixelsRGBA32

unsigned int* ImFontAtlas::TexPixelsRGBA32

Definition at line 2054 of file imgui.h.

TexUvScale

ImVec2 ImFontAtlas::TexUvScale

Definition at line 2057 of file imgui.h.

TexUvWhitePixel

ImVec2 ImFontAtlas::TexUvWhitePixel

Definition at line 2058 of file imgui.h.

TexWidth

int ImFontAtlas::TexWidth

Definition at line 2055 of file imgui.h.

---

The documentation for this struct was generated from the following files:

• imgui.h
• imgui_draw.cpp