Open 3D Engine AtomLyIntegration Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Classes | Public Member Functions | Static Public Attributes | Friends | List of all members
AZ::AtomFont Class Reference

#include <AtomFont.h>

Inherits ICryFont, AzFramework::FontQueryInterface, and Data::AssetBus::Handler.

Classes

struct  GlyphSize
 

Public Member Functions

 AtomFont (ISystem *system)
 
void Release () override
 
IFFont * NewFont (const char *fontName) override
 
IFFont * GetFont (const char *fontName) const override
 
FontFamilyPtr LoadFontFamily (const char *fontFamilyName) override
 
FontFamilyPtr GetFontFamily (const char *fontFamilyName) override
 
void AddCharsToFontTextures (FontFamilyPtr fontFamily, const char *chars, int glyphSizeX=ICryFont::defaultGlyphSizeX, int glyphSizeY=ICryFont::defaultGlyphSizeY) override
 
AZStd::string GetLoadedFontNames () const override
 
void OnLanguageChanged () override
 
void ReloadAllFonts () override
 
AzFramework::FontDrawInterface * GetFontDrawInterface (AzFramework::FontId fontId) const override
 
AzFramework::FontDrawInterface * GetDefaultFontDrawInterface () const override
 
void UnregisterFont (const char *fontName)
 

Static Public Attributes

static const GlyphSize defaultGlyphSize
 

Friends

class FFont
 

Detailed Description

AtomFont is the font system manager. AtomFont manages the lifetime of FFont instances, each of which represents an individual font (e.g Courier New Italic) AtomFont also knows about font families (e.g Courier New + [Italic, Bold, Normal, Bold Italic]), languages, etc, and manages their loading & saving together.

Member Data Documentation

◆ defaultGlyphSize

const GlyphSize AZ::AtomFont::defaultGlyphSize
static

Default glyph size indicates that glyphs in the font texture should be rendered at the maximum resolution supported by the font texture's glyph cell/slot configuration (configured via font XML).

The documentation for this class was generated from the following file: