Lothario
/
axmol
mirror of https://github.com/axmolengine/axmol.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve text rendering (#652) 

* Improve text-rendering
a. Separate outline texture data upload for GL and Metal backend
b. Fix memory leak of FontAtlas::_currentPageDataRGBA
b. Add FontFreeType::setMissingGlyphCharacter for rendering a missing char
d. Improve FontFreetype::renderCharAt with memcpy
This commit is contained in:
一线灵 2022-06-13 01:44:31 +08:00 committed by GitHub
parent 43d0ae94ac
commit bd2cff3dfd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 134 additions and 166 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

203
core/2d/CCFontAtlas.cpp
View File

@ -30,6 +30,7 @@
#elif CC_TARGET_PLATFORM == CC_PLATFORM_ANDROID
# include "platform/android/jni/Java_org_cocos2dx_lib_Cocos2dxHelper.h"
#endif
#include <algorithm>
#include "2d/CCFontFreeType.h"
#include "base/ccUTF8.h"
#include "base/CCDirector.h"
@ -55,16 +56,30 @@ FontAtlas::FontAtlas(Font* theFont) : _font(theFont)
_fontAscender = _fontFreeType->getFontAscender();
_letterEdgeExtend = 2;
if (_fontFreeType->isDistanceFieldEnabled())
{
_letterPadding += 2 * FontFreeType::DistanceMapSpread;
}
auto outlineSize = _fontFreeType->getOutlineSize();
if (outlineSize > 0)
{
_strideShift = 1;
_pixelFormat = backend::PixelFormat::LA8;
_currentPageDataSize = CacheTextureWidth * CacheTextureHeight << _strideShift;
#if defined(CC_USE_METAL)
_currentPageDataSizeRGBA = CacheTextureWidth * CacheTextureHeight * 4;
#endif
_lineHeight += 2 * outlineSize;
}
else
{
_strideShift = 0;
_pixelFormat = backend::PixelFormat::A8;
_currentPageDataSize = CacheTextureWidth * CacheTextureHeight;
}
if (_fontFreeType->isDistanceFieldEnabled())
{
_letterPadding += 2 * FontFreeType::DistanceMapSpread;
}
#if CC_ENABLE_CACHE_TEXTURE_DATA
auto eventDispatcher = Director::getInstance()->getEventDispatcher();
@ -78,37 +93,17 @@ FontAtlas::FontAtlas(Font* theFont) : _font(theFont)
void FontAtlas::reinit()
{
if (_currentPageData)
{
delete[] _currentPageData;
_currentPageData = nullptr;
}
if (!_currentPageData)
_currentPageData = new uint8_t[_currentPageDataSize];
_currentPage = -1;
CC_SAFE_DELETE_ARRAY(_currentPageDataRGBA);
#if defined(CC_USE_METAL)
if (_strideShift && !_currentPageDataRGBA)
_currentPageDataRGBA = new uint8_t[_currentPageDataSizeRGBA];
#endif
auto texture = new Texture2D;
_currentPageDataSize = CacheTextureWidth * CacheTextureHeight;
auto outlineSize = _fontFreeType->getOutlineSize();
if (outlineSize > 0)
{
_currentPageDataSize *= 2;
_currentPageDataSizeRGBA = _currentPageDataSize * 2;
_currentPageDataRGBA = new unsigned char[_currentPageDataSizeRGBA];
memset(_currentPageDataRGBA, 0, _currentPageDataSizeRGBA);
}
_currentPageData = new unsigned char[_currentPageDataSize];
memset(_currentPageData, 0, _currentPageDataSize);
initTextureWithZeros(texture);
addTexture(texture, 0);
texture->release();
addNewPage();
}
FontAtlas::~FontAtlas()
{
#if CC_ENABLE_CACHE_TEXTURE_DATA
@ -123,30 +118,10 @@ FontAtlas::~FontAtlas()
_font->release();
releaseTextures();
delete[] _currentPageData;
}
void FontAtlas::initTextureWithZeros(Texture2D* texture)
{
char* zeros = nullptr;
backend::PixelFormat pixelFormat;
float outlineSize = _fontFreeType->getOutlineSize();
size_t zeroBytes = 0;
if (outlineSize > 0)
{
// metal do no support AI88 format
pixelFormat = backend::PixelFormat::RGBA8;
zeroBytes = CacheTextureWidth * CacheTextureWidth * 4;
}
else
{
pixelFormat = backend::PixelFormat::A8;
zeroBytes = CacheTextureWidth * CacheTextureWidth;
}
zeros = new char[zeroBytes]();
// std::fill(zeros, zeros + cnt, 0);
texture->initWithData(zeros, zeroBytes, pixelFormat, CacheTextureWidth, CacheTextureHeight);
delete[] zeros;
CC_SAFE_DELETE_ARRAY(_currentPageData);
#if defined(CC_USE_METAL)
CC_SAFE_DELETE_ARRAY(_currentPageDataRGBA);
#endif
}
void FontAtlas::reset()
@ -154,7 +129,6 @@ void FontAtlas::reset()
releaseTextures();
_currLineHeight = 0;
_currentPage = 0;
_currentPageOrigX = 0;
_currentPageOrigY = 0;
_letterDefinitions.clear();
@ -222,44 +196,15 @@ bool FontAtlas::getLetterDefinitionForChar(char32_t utf32Char, FontLetterDefinit
void FontAtlas::findNewCharacters(const std::u32string& u32Text, std::unordered_set<char32_t>& charset)
{
std::u32string newChars;
// find new characters
if (_letterDefinitions.empty())
{
// fixed #16169: new android project crash in android 5.0.2 device (Nexus 7) when use 3.12.
// While using clang compiler with gnustl_static on android, the copy assignment operator of `std::u32string`
// will affect the memory validity, it means after `newChars` is destroyed, the memory of `u32Text` holds
// will be a dead region. `u32text` represents the variable in `Label::_utf32Text`, when somewhere
// allocates memory by `malloc, realloc, new, new[]`, the generated memory address may be the same
// as `Label::_utf32Text` holds. If doing a `memset` or other memory operations, the orignal `Label::_utf32Text`
// will be in an unknown state. Meanwhile, a bunch lots of logic which depends on `Label::_utf32Text`
// will be broken.
// newChars = u32Text;
// Using `append` method is a workaround for this issue. So please be carefuly while using the assignment
// operator of `std::u32string`.
newChars.append(u32Text);
std::copy(u32Text.begin(), u32Text.end(), std::inserter(charset, charset.end()));
}
else
{
auto length = u32Text.length();
newChars.reserve(length);
for (size_t i = 0; i < length; ++i)
{
auto outIterator = _letterDefinitions.find(u32Text[i]);
if (outIterator == _letterDefinitions.end())
{
newChars.push_back(u32Text[i]);
}
}
}
if (!newChars.empty())
{
for (auto u32Code : newChars)
charset.insert(u32Code);
for (auto charCode : u32Text)
if (_letterDefinitions.find(charCode) == _letterDefinitions.end())
charset.insert(charCode);
}
}
@ -282,14 +227,14 @@ bool FontAtlas::prepareLetterDefinitions(const std::u32string& utf32Text)
int adjustForDistanceMap = _letterPadding / 2;
int adjustForExtend = _letterEdgeExtend / 2;
int32_t bitmapWidth;
int32_t bitmapHeight;
int32_t bitmapWidth = 0;
int32_t bitmapHeight = 0;
int glyphHeight;
Rect tempRect;
FontLetterDefinition tempDef;
auto scaleFactor = CC_CONTENT_SCALE_FACTOR();
auto pixelFormat = _fontFreeType->getOutlineSize() > 0 ? backend::PixelFormat::LA8 : backend::PixelFormat::A8;
auto pixelFormat = _pixelFormat;
int startY = (int)_currentPageOrigY;
@ -314,25 +259,7 @@ bool FontAtlas::prepareLetterDefinitions(const std::u32string& utf32Text)
updateTextureContent(pixelFormat, startY);
startY = 0;
_currentPageOrigY = 0;
memset(_currentPageData, 0, _currentPageDataSize);
_currentPage++;
auto tex = new Texture2D;
initTextureWithZeros(tex);
if (_antialiasEnabled)
{
tex->setAntiAliasTexParameters();
}
else
{
tex->setAliasTexParameters();
}
addTexture(tex, _currentPage);
tex->release();
addNewPage();
}
}
glyphHeight = static_cast<int>(bitmapHeight) + _letterPadding + _letterEdgeExtend;
@ -353,9 +280,11 @@ bool FontAtlas::prepareLetterDefinitions(const std::u32string& utf32Text)
tempDef.U = tempDef.U / scaleFactor;
tempDef.V = tempDef.V / scaleFactor;
tempDef.rotated = false;
updateTextureContent(pixelFormat, startY);
}
else
{
{ // don't render anythings
if (bitmap)
delete[] bitmap;
if (tempDef.xAdvance)
@ -377,15 +306,18 @@ bool FontAtlas::prepareLetterDefinitions(const std::u32string& utf32Text)
_letterDefinitions[charCode] = tempDef;
}
updateTextureContent(pixelFormat, startY);
return true;
}
void FontAtlas::updateTextureContent(backend::PixelFormat format, int startY)
{
#if !defined(CC_USE_METAL)
auto data = _currentPageData + (CacheTextureWidth * (int)startY << _strideShift);
_atlasTextures[_currentPage]->updateWithSubData(data, 0, startY, CacheTextureWidth,
(int)_currentPageOrigY - startY + _currLineHeight);
#else
unsigned char* data = nullptr;
auto outlineSize = _fontFreeType->getOutlineSize();
if (outlineSize > 0 && format == backend::PixelFormat::LA8)
if (_strideShift)
{
int nLen = CacheTextureWidth * ((int)_currentPageOrigY - startY + _currLineHeight);
data = _currentPageData + CacheTextureWidth * (int)startY * 2;
@ -404,9 +336,44 @@ void FontAtlas::updateTextureContent(backend::PixelFormat format, int startY)
_atlasTextures[_currentPage]->updateWithSubData(data, 0, startY, CacheTextureWidth,
(int)_currentPageOrigY - startY + _currLineHeight);
}
#endif
}
void FontAtlas::addTexture(Texture2D* texture, int slot)
void FontAtlas::addNewPage()
{
auto texture = new Texture2D();
memset(_currentPageData, 0, _currentPageDataSize);
#if !defined(CC_USE_METAL)
texture->initWithData(_currentPageData, _currentPageDataSize, _pixelFormat, CacheTextureWidth, CacheTextureHeight);
#else
if (_strideShift)
{
memset(_currentPageDataRGBA, 0, _currentPageDataSizeRGBA);
texture->initWithData(_currentPageDataRGBA, _currentPageDataSizeRGBA, backend::PixelFormat::RGBA8,
CacheTextureWidth, CacheTextureHeight);
}
else
{
texture->initWithData(_currentPageData, _currentPageDataSize, _pixelFormat, CacheTextureWidth,
CacheTextureHeight);
}
#endif
if (_antialiasEnabled)
texture->setAntiAliasTexParameters();
else
texture->setAliasTexParameters();
setTexture(++_currentPage, texture);
texture->release();
_currentPageOrigY = 0;
}
void FontAtlas::setTexture(unsigned int slot, Texture2D* texture)
{
texture->retain();
_atlasTextures[slot] = texture;

39
core/2d/CCFontAtlas.h
View File

@ -81,14 +81,18 @@ public:
bool prepareLetterDefinitions(const std::u32string& utf16String);
const std::unordered_map<ssize_t, Texture2D*>& getTextures() const { return _atlasTextures; }
void addTexture(Texture2D* texture, int slot);
const std::unordered_map<unsigned int, Texture2D*>& getTextures() const { return _atlasTextures; }
void addNewPage();
void setTexture(unsigned int slot, Texture2D* texture);
Texture2D* getTexture(int slot);
float getLineHeight() const { return _lineHeight; }
void setLineHeight(float newHeight);
std::string_view getFontName() const;
Texture2D* getTexture(int slot);
const Font* getFont() const { return _font; }
/** listen the event that renderer was recreated on Android/WP8
@ -122,8 +126,6 @@ protected:
void findNewCharacters(const std::u32string& u32Text, std::unordered_set<char32_t>& charCodeSet);
void initTextureWithZeros(Texture2D* texture);
/**
* Scale each font letter by scaleFactor.
*
@ -133,22 +135,29 @@ protected:
void updateTextureContent(backend::PixelFormat format, int startY);
std::unordered_map<ssize_t, Texture2D*> _atlasTextures;
std::unordered_map<unsigned int, Texture2D*> _atlasTextures;
std::unordered_map<char32_t, FontLetterDefinition> _letterDefinitions;
float _lineHeight = 0.f;
Font* _font = nullptr;
FontFreeType* _fontFreeType = nullptr;
// Dynamic GlyphCollection related stuff
int _currentPage = 0;
unsigned char* _currentPageData = nullptr;
unsigned char* _currentPageDataRGBA = nullptr;
int _currentPageDataSize = 0;
int _currentPageDataSizeRGBA = 0;
float _currentPageOrigX = 0;
float _currentPageOrigY = 0;
int _letterPadding = 0;
int _letterEdgeExtend = 0;
int _currentPage = -1;
backend::PixelFormat _pixelFormat = backend::PixelFormat::NONE;
int _strideShift = 0;
uint8_t* _currentPageData = nullptr;
int _currentPageDataSize = 0;
#if defined(CC_USE_METAL)
// Notes:
// Metal backend doesn't support PixelFormat::LA8
// Currently we use RGBA for texture data upload
uint8_t* _currentPageDataRGBA = nullptr;
int _currentPageDataSizeRGBA = 0;
#endif
float _currentPageOrigX = 0;
float _currentPageOrigY = 0;
int _letterPadding = 0;
int _letterEdgeExtend = 0;
int _fontAscender = 0;
EventListenerCustom* _rendererRecreatedListener = nullptr;

2
core/2d/CCFontCharMap.cpp
View File

@ -137,7 +137,7 @@ FontAtlas* FontCharMap::newFontAtlas()
}
}
tempAtlas->addTexture(_texture, 0);
tempAtlas->setTexture(0, _texture);
return tempAtlas;
}

2
core/2d/CCFontFNT.cpp
View File

@ -756,7 +756,7 @@ FontAtlas* FontFNT::newFontAtlas()
}
// add the texture
tempAtlas->addTexture(tempTexture, 0);
tempAtlas->setTexture(0, tempTexture);
// done
return tempAtlas;

48
core/2d/CCFontFreeType.cpp
View File

@ -45,6 +45,9 @@ bool FontFreeType::_streamParsingEnabled = true;
bool FontFreeType::_doNativeBytecodeHinting = true;
const int FontFreeType::DistanceMapSpread = 6;
// By default, will render square when character glyph missing in current font
char32_t FontFreeType::_mssingGlyphCharacter = 0;
using namespace std::string_view_literals;
constexpr std::string_view _glyphASCII =
"\"!#$%&'()*+,-./"
@ -234,7 +237,7 @@ bool FontFreeType::loadFontFace(std::string_view fontPath, float fontSize)
// store the face globally
_fontFace = face;
_fontSize = fontSize;
_fontName = fontPath;
_fontName = fontPath;
// Notes:
// a. Since freetype 2.8.1 the TT matrics isn't sync to size_matrics, see the function 'tt_size_request' in
@ -397,7 +400,15 @@ unsigned char* FontFreeType::getGlyphBitmap(char32_t charCode,
charUTF8 = "\\n";
cocos2d::log("The font face: %s doesn't contains char: <%s>", _fontFace->charmap->face->family_name,
charUTF8.c_str());
return nullptr;
if (_mssingGlyphCharacter != 0)
{
if (_mssingGlyphCharacter == 0x1A)
return nullptr; // don't render anything for this character
// Try get new glyph index with missing glyph character code
glyphIndex = FT_Get_Char_Index(_fontFace, static_cast<FT_ULong>(_mssingGlyphCharacter));
}
}
#endif
if (FT_Load_Glyph(_fontFace, glyphIndex, FT_LOAD_RENDER | FT_LOAD_NO_AUTOHINT))
@ -560,28 +571,16 @@ void FontFreeType::renderCharAt(unsigned char* dest,
int32_t bitmapWidth,
int32_t bitmapHeight)
{
int iX = posX;
const int iX = posX;
int iY = posY;
if (_outlineSize > 0)
{
unsigned char tempChar;
for (int32_t y = 0; y < bitmapHeight; ++y)
{
int32_t bitmap_y = y * bitmapWidth;
for (int x = 0; x < bitmapWidth; ++x)
{
tempChar = bitmap[(bitmap_y + x) * 2];
dest[(iX + (iY * FontAtlas::CacheTextureWidth)) * 2] = tempChar;
tempChar = bitmap[(bitmap_y + x) * 2 + 1];
dest[(iX + (iY * FontAtlas::CacheTextureWidth)) * 2 + 1] = tempChar;
iX += 1;
}
iX = posX;
iY += 1;
memcpy(dest + (iX + (iY * FontAtlas::CacheTextureWidth)) * 2, bitmap + bitmap_y * 2, bitmapWidth * 2);
++iY;
}
delete[] bitmap;
}
@ -590,19 +589,8 @@ void FontFreeType::renderCharAt(unsigned char* dest,
for (int32_t y = 0; y < bitmapHeight; ++y)
{
int32_t bitmap_y = y * bitmapWidth;
for (int x = 0; x < bitmapWidth; ++x)
{
unsigned char cTemp = bitmap[bitmap_y + x];
// the final pixel
dest[(iX + (iY * FontAtlas::CacheTextureWidth))] = cTemp;
iX += 1;
}
iX = posX;
iY += 1;
memcpy(dest + (iX + (iY * FontAtlas::CacheTextureWidth)), bitmap + bitmap_y, bitmapWidth);
++iY;
}
}
}

3
core/2d/CCFontFreeType.h
View File

@ -63,6 +63,8 @@ public:
static void setStreamParsingEnabled(bool bEnabled) { _streamParsingEnabled = bEnabled; }
static bool isStreamParsingEnabled() { return _streamParsingEnabled; }
static void setMissingGlyphCharacter(char32_t charCode) { _mssingGlyphCharacter = charCode; };
/*
**TrueType fonts with native bytecode hinting**
*
@ -113,6 +115,7 @@ private:
static bool _FTInitialized;
static bool _streamParsingEnabled;
static bool _doNativeBytecodeHinting;
static char32_t _mssingGlyphCharacter;
FontFreeType(bool distanceFieldEnabled = false, float outline = 0);
virtual ~FontFreeType();

1
core/adxe.h
View File

@ -119,6 +119,7 @@ THE SOFTWARE.
#include "2d/CCClippingRectangleNode.h"
#include "2d/CCDrawNode.h"
#include "2d/CCFontFNT.h"
#include "2d/CCFontFreeType.h"
#include "2d/CCLabel.h"
#include "2d/CCLabelAtlas.h"
#include "2d/CCLayer.h"

2
extensions/fairygui/UIPackage.cpp
View File

@ -876,7 +876,7 @@ void UIPackage::loadFont(PackageItem* item)
}
if (mainTexture != nullptr)
fontAtlas->addTexture(mainTexture, 0);
fontAtlas->setTexture(0, mainTexture);
fontAtlas->setLineHeight(lineHeight);
item->bitmapFont->_originalFontSize = fontSize;