2 CGUITTFont FreeType class for Irrlicht
3 Copyright (c) 2009-2010 John Norman
4 Copyright (c) 2016 Nathanaƫl Courant
6 This software is provided 'as-is', without any express or implied
7 warranty. In no event will the authors be held liable for any
8 damages arising from the use of this software.
10 Permission is granted to anyone to use this software for any
11 purpose, including commercial applications, and to alter it and
12 redistribute it freely, subject to the following restrictions:
14 1. The origin of this software must not be misrepresented; you
15 must not claim that you wrote the original software. If you use
16 this software in a product, an acknowledgment in the product
17 documentation would be appreciated but is not required.
19 2. Altered source versions must be plainly marked as such, and
20 must not be misrepresented as being the original software.
22 3. This notice may not be removed or altered from any source
25 The original version of this class can be located at:
26 http://irrlicht.suckerfreegames.com/
29 john@suckerfreegames.com
32 #ifndef __C_GUI_TTFONT_H_INCLUDED__
33 #define __C_GUI_TTFONT_H_INCLUDED__
38 #include "util/enriched_string.h"
39 #include FT_FREETYPE_H
48 //! Class to assist in deleting glyphs.
49 class CGUITTAssistDelete
52 template <class T, typename TAlloc>
53 static void Delete(core::array<T, TAlloc>& a)
56 allocator.deallocate(a.pointer());
60 //! Structure representing a single TrueType glyph.
64 SGUITTGlyph() : isLoaded(false), glyph_page(0), surface(0), parent(0) {}
67 ~SGUITTGlyph() { unload(); }
69 //! Preload the glyph.
70 //! The preload process occurs when the program tries to cache the glyph from FT_Library.
71 //! However, it simply defines the SGUITTGlyph's properties and will only create the page
72 //! textures if necessary. The actual creation of the textures should only occur right
73 //! before the batch draw call.
74 void preload(u32 char_index, FT_Face face, video::IVideoDriver* driver, u32 font_size, const FT_Int32 loadFlags);
76 //! Unloads the glyph.
79 //! Creates the IImage object from the FT_Bitmap.
80 video::IImage* createGlyphImage(const FT_Bitmap& bits, video::IVideoDriver* driver) const;
82 //! If true, the glyph has been loaded.
85 //! The page the glyph is on.
88 //! The source rectangle for the glyph.
89 core::recti source_rect;
91 //! The offset of glyph when drawn.
92 core::vector2di offset;
94 //! Glyph advance information.
97 //! This is just the temporary image holder. After this glyph is paged,
98 //! it will be dropped.
99 mutable video::IImage* surface;
101 //! The pointer pointing to the parent (CGUITTFont)
105 //! Holds a sheet of glyphs.
106 class CGUITTGlyphPage
109 CGUITTGlyphPage(video::IVideoDriver* Driver, const io::path& texture_name) :texture(0), available_slots(0), used_slots(0), dirty(false), driver(Driver), name(texture_name) {}
115 driver->removeTexture(texture);
116 else texture->drop();
120 //! Create the actual page texture,
121 bool createPageTexture(const u8& pixel_mode, const core::dimension2du& texture_size)
126 bool flgmip = driver->getTextureCreationFlag(video::ETCF_CREATE_MIP_MAPS);
127 driver->setTextureCreationFlag(video::ETCF_CREATE_MIP_MAPS, false);
128 #if IRRLICHT_VERSION_MAJOR == 1 && IRRLICHT_VERSION_MINOR > 8
129 bool flgcpy = driver->getTextureCreationFlag(video::ETCF_ALLOW_MEMORY_COPY);
130 driver->setTextureCreationFlag(video::ETCF_ALLOW_MEMORY_COPY, true);
133 // Set the texture color format.
136 case FT_PIXEL_MODE_MONO:
137 texture = driver->addTexture(texture_size, name, video::ECF_A1R5G5B5);
139 case FT_PIXEL_MODE_GRAY:
141 texture = driver->addTexture(texture_size, name, video::ECF_A8R8G8B8);
145 // Restore our texture creation flags.
146 driver->setTextureCreationFlag(video::ETCF_CREATE_MIP_MAPS, flgmip);
147 #if IRRLICHT_VERSION_MAJOR == 1 && IRRLICHT_VERSION_MINOR > 8
148 driver->setTextureCreationFlag(video::ETCF_ALLOW_MEMORY_COPY, flgcpy);
150 return texture ? true : false;
153 //! Add the glyph to a list of glyphs to be paged.
154 //! This collection will be cleared after updateTexture is called.
155 void pushGlyphToBePaged(const SGUITTGlyph* glyph)
157 glyph_to_be_paged.push_back(glyph);
160 //! Updates the texture atlas with new glyphs.
165 void* ptr = texture->lock();
166 video::ECOLOR_FORMAT format = texture->getColorFormat();
167 core::dimension2du size = texture->getOriginalSize();
168 video::IImage* pageholder = driver->createImageFromData(format, size, ptr, true, false);
170 for (u32 i = 0; i < glyph_to_be_paged.size(); ++i)
172 const SGUITTGlyph* glyph = glyph_to_be_paged[i];
173 if (glyph && glyph->isLoaded)
177 glyph->surface->copyTo(pageholder, glyph->source_rect.UpperLeftCorner);
178 glyph->surface->drop();
183 ; // TODO: add error message?
184 //currently, if we failed to create the image, just ignore this operation.
191 glyph_to_be_paged.clear();
195 video::ITexture* texture;
200 core::array<core::vector2di> render_positions;
201 core::array<core::recti> render_source_rects;
204 core::array<const SGUITTGlyph*> glyph_to_be_paged;
205 video::IVideoDriver* driver;
209 //! Class representing a TrueType font.
210 class CGUITTFont : public IGUIFont
213 //! Creates a new TrueType font and returns a pointer to it. The pointer must be drop()'ed when finished.
214 //! \param env The IGUIEnvironment the font loads out of.
215 //! \param filename The filename of the font.
216 //! \param size The size of the font glyphs in pixels. Since this is the size of the individual glyphs, the true height of the font may change depending on the characters used.
217 //! \param antialias set the use_monochrome (opposite to antialias) flag
218 //! \param transparency set the use_transparency flag
219 //! \return Returns a pointer to a CGUITTFont. Will return 0 if the font failed to load.
220 static CGUITTFont* createTTFont(IGUIEnvironment *env, const io::path& filename, const u32 size, const bool antialias = true, const bool transparency = true, const u32 shadow = 0, const u32 shadow_alpha = 255);
221 static CGUITTFont* createTTFont(IrrlichtDevice *device, const io::path& filename, const u32 size, const bool antialias = true, const bool transparency = true);
222 static CGUITTFont* create(IGUIEnvironment *env, const io::path& filename, const u32 size, const bool antialias = true, const bool transparency = true);
223 static CGUITTFont* create(IrrlichtDevice *device, const io::path& filename, const u32 size, const bool antialias = true, const bool transparency = true);
226 virtual ~CGUITTFont();
228 //! Sets the amount of glyphs to batch load.
229 virtual void setBatchLoadSize(u32 batch_size) { batch_load_size = batch_size; }
231 //! Sets the maximum texture size for a page of glyphs.
232 virtual void setMaxPageTextureSize(const core::dimension2du& texture_size) { max_page_texture_size = texture_size; }
234 //! Get the font size.
235 virtual u32 getFontSize() const { return size; }
237 //! Check the font's transparency.
238 virtual bool isTransparent() const { return use_transparency; }
240 //! Check if the font auto-hinting is enabled.
241 //! Auto-hinting is FreeType's built-in font hinting engine.
242 virtual bool useAutoHinting() const { return use_auto_hinting; }
244 //! Check if the font hinting is enabled.
245 virtual bool useHinting() const { return use_hinting; }
247 //! Check if the font is being loaded as a monochrome font.
248 //! The font can either be a 256 color grayscale font, or a 2 color monochrome font.
249 virtual bool useMonochrome() const { return use_monochrome; }
251 //! Tells the font to allow transparency when rendering.
253 //! \param flag If true, the font draws using transparency.
254 virtual void setTransparency(const bool flag);
256 //! Tells the font to use monochrome rendering.
258 //! \param flag If true, the font draws using a monochrome image. If false, the font uses a grayscale image.
259 virtual void setMonochrome(const bool flag);
261 //! Enables or disables font hinting.
262 //! Default: Hinting and auto-hinting true.
263 //! \param enable If false, font hinting is turned off. If true, font hinting is turned on.
264 //! \param enable_auto_hinting If true, FreeType uses its own auto-hinting algorithm. If false, it tries to use the algorithm specified by the font.
265 virtual void setFontHinting(const bool enable, const bool enable_auto_hinting = true);
267 //! Draws some text and clips it to the specified rectangle if wanted.
268 virtual void draw(const core::stringw& text, const core::rect<s32>& position,
269 video::SColor color, bool hcenter=false, bool vcenter=false,
270 const core::rect<s32>* clip=0);
272 virtual void draw(const EnrichedString& text, const core::rect<s32>& position,
273 video::SColor color, bool hcenter=false, bool vcenter=false,
274 const core::rect<s32>* clip=0);
276 //! Returns the dimension of a character produced by this font.
277 virtual core::dimension2d<u32> getCharDimension(const wchar_t ch) const;
279 //! Returns the dimension of a text string.
280 virtual core::dimension2d<u32> getDimension(const wchar_t* text) const;
281 virtual core::dimension2d<u32> getDimension(const core::ustring& text) const;
283 //! Calculates the index of the character in the text which is on a specific position.
284 virtual s32 getCharacterFromPos(const wchar_t* text, s32 pixel_x) const;
285 virtual s32 getCharacterFromPos(const core::ustring& text, s32 pixel_x) const;
287 //! Sets global kerning width for the font.
288 virtual void setKerningWidth(s32 kerning);
290 //! Sets global kerning height for the font.
291 virtual void setKerningHeight(s32 kerning);
293 //! Gets kerning values (distance between letters) for the font. If no parameters are provided,
294 virtual s32 getKerningWidth(const wchar_t* thisLetter=0, const wchar_t* previousLetter=0) const;
295 virtual s32 getKerningWidth(const uchar32_t thisLetter=0, const uchar32_t previousLetter=0) const;
297 //! Returns the distance between letters
298 virtual s32 getKerningHeight() const;
300 //! Define which characters should not be drawn by the font.
301 virtual void setInvisibleCharacters(const wchar_t *s);
302 virtual void setInvisibleCharacters(const core::ustring& s);
304 //! Get the last glyph page if there's still available slots.
305 //! If not, it will return zero.
306 CGUITTGlyphPage* getLastGlyphPage() const;
308 //! Create a new glyph page texture.
309 //! \param pixel_mode the pixel mode defined by FT_Pixel_Mode
310 //should be better typed. fix later.
311 CGUITTGlyphPage* createGlyphPage(const u8& pixel_mode);
313 //! Get the last glyph page's index.
314 u32 getLastGlyphPageIndex() const { return Glyph_Pages.size() - 1; }
316 //! Create corresponding character's software image copy from the font,
317 //! so you can use this data just like any ordinary video::IImage.
318 //! \param ch The character you need
319 virtual video::IImage* createTextureFromChar(const uchar32_t& ch);
321 //! This function is for debugging mostly. If the page doesn't exist it returns zero.
322 //! \param page_index Simply return the texture handle of a given page index.
323 virtual video::ITexture* getPageTextureByIndex(const u32& page_index) const;
325 //! Add a list of scene nodes generated by putting font textures on the 3D planes.
326 virtual core::array<scene::ISceneNode*> addTextSceneNode
327 (const wchar_t* text, scene::ISceneManager* smgr, scene::ISceneNode* parent = 0,
328 const video::SColor& color = video::SColor(255, 0, 0, 0), bool center = false );
332 bool use_transparency;
334 bool use_auto_hinting;
337 core::dimension2du max_page_texture_size;
340 // Manages the FreeType library.
341 static FT_Library c_library;
342 static core::map<io::path, SGUITTFace*> c_faces;
343 static bool c_libraryLoaded;
344 static scene::IMesh* shared_plane_ptr_;
345 static scene::SMesh shared_plane_;
347 CGUITTFont(IGUIEnvironment *env);
348 bool load(const io::path& filename, const u32 size, const bool antialias, const bool transparency);
350 void update_glyph_pages() const;
351 void update_load_flags()
353 // Set up our loading flags.
354 load_flags = FT_LOAD_DEFAULT | FT_LOAD_RENDER;
355 if (!useHinting()) load_flags |= FT_LOAD_NO_HINTING;
356 if (!useAutoHinting()) load_flags |= FT_LOAD_NO_AUTOHINT;
357 if (useMonochrome()) load_flags |= FT_LOAD_MONOCHROME | FT_LOAD_TARGET_MONO | FT_RENDER_MODE_MONO;
358 else load_flags |= FT_LOAD_TARGET_NORMAL;
360 u32 getWidthFromCharacter(wchar_t c) const;
361 u32 getWidthFromCharacter(uchar32_t c) const;
362 u32 getHeightFromCharacter(wchar_t c) const;
363 u32 getHeightFromCharacter(uchar32_t c) const;
364 u32 getGlyphIndexByChar(wchar_t c) const;
365 u32 getGlyphIndexByChar(uchar32_t c) const;
366 core::vector2di getKerning(const wchar_t thisLetter, const wchar_t previousLetter) const;
367 core::vector2di getKerning(const uchar32_t thisLetter, const uchar32_t previousLetter) const;
368 core::dimension2d<u32> getDimensionUntilEndOfLine(const wchar_t* p) const;
370 void createSharedPlane();
372 irr::IrrlichtDevice* Device;
373 gui::IGUIEnvironment* Environment;
374 video::IVideoDriver* Driver;
377 FT_Size_Metrics font_metrics;
380 mutable core::array<CGUITTGlyphPage*> Glyph_Pages;
381 mutable core::array<SGUITTGlyph> Glyphs;
383 s32 GlobalKerningWidth;
384 s32 GlobalKerningHeight;
385 core::ustring Invisible;
390 } // end namespace gui
391 } // end namespace irr
393 #endif // __C_GUI_TTFONT_H_INCLUDED__