Implement GlyphFace rendering capabilities #371

shlzxjp · 2024-12-09T10:46:14Z

实现GlyphFace渲染能力，用于渲染外部提供的文字path和emoji。通过GlyphFace隔离Font渲染和排版，统一内外部文本渲染流程。

domchen · 2024-12-09T11:26:18Z

drawers/src/layertree/CustomLayerTree.cpp

@@ -19,6 +19,7 @@
 #include "CustomLayer.h"
 #include "base/LayerTreeDrawers.h"
 #include "drawers/AppHost.h"
+#include "tgfx/core/FontGlyphFace.h"


这个接口我们不公开，属于内部实现。

domchen · 2024-12-09T11:27:02Z

drawers/src/layertree/CustomLayerTree.cpp

@@ -66,7 +67,8 @@ std::unique_ptr<tgfx::LayerContent> CustomLayer::onUpdateContent() {
      xOffset += emptyAdvance;
    }
  }
-  tgfx::GlyphRun glyphRun(_font, std::move(glyphs), std::move(positions));
+  tgfx::GlyphRun glyphRun(std::make_shared<tgfx::FontGlyphFace>(_font), std::move(glyphs),


还是让它正常通过font可以构造，我们有两个构造函数，内部转成FontGlyphFace就行。

domchen · 2024-12-09T11:28:54Z

include/tgfx/core/Canvas.h

@@ -279,6 +280,18 @@ class Canvas {
  void drawGlyphs(const GlyphID glyphs[], const Point positions[], size_t glyphCount,
                  const Font& font, const Paint& paint);

+  /**
+   * Draws an array of glyphIDs using GlyphFace, with paths and images provided by GlyphFace and


注释修改一下：Draws an array of glyphs from glyphIDs at positions using clip, matrix, glyphFace, and paint. GlyphFace的类注释上可以详细再写它是提供Path和Image的这些相关信息

domchen · 2024-12-09T11:41:33Z

include/tgfx/core/GlyphRun.h

   */
-  GlyphRun(Font font, std::vector<GlyphID> glyphIDs, std::vector<Point> positions)
-      : font(font), glyphs(glyphIDs), positions(positions) {
+  GlyphRun(std::shared_ptr<GlyphFace> glyphFace, std::vector<GlyphID> glyphIDs,


不要删除原本的Font构造函数，提供两个版本，和Canvas上一样。

domchen · 2024-12-09T11:42:25Z

resources/assets/image1.png

重命名一下文件吧，glyph1, glyph2, glyph3

domchen · 2024-12-09T11:46:35Z

include/tgfx/core/Canvas.h

+   * @param paint Blend, color, and so on, used to draw.
+   * @note The lengths of `glyphIDs` and `positions` must be the same.
+   */
+  void drawGlyphs(const std::vector<GlyphID>& glyphIDs, const std::vector<Point>& positions,


除了GlyphFace参数不一样，其他都保持和另外一个drawGlyphs方法的参数一致，这里不用std::vector<>是为了减少拷贝，不然上层业务如果不是用std:vector的数据结构，还得拷贝构造一个，然后内部又多拷贝一次。用指针的方式传进来比较通用，只有内部拷贝一次。

domchen · 2024-12-09T11:47:35Z

include/tgfx/core/GlyphFace.h

+  /**
+   * Returns the Font if this GlyphFace is a FontGlyphFace, otherwise returns std::nullopt.
+   */
+  virtual std::optional<Font> asFont() const = 0;


可以定义成 virtual bool asFont(Font* font) const = 0; 这样方便一个if同时取出Font以及失败的return。

domchen · 2024-12-09T11:49:18Z

src/core/Canvas.cpp

@@ -333,12 +332,31 @@ void Canvas::drawGlyphs(const GlyphID glyphs[], const Point positions[], size_t
  if (glyphCount == 0 || paint.nothingToDraw()) {
    return;
  }
-  GlyphRun glyphRun(font, {glyphs, glyphs + glyphCount}, {positions, positions + glyphCount});
+  GlyphRun glyphRun(std::make_shared<FontGlyphFace>(font), {glyphs, glyphs + glyphCount},


这个原版的drawGlyphs不用单独实现了，就直接创建一下FontGlyphFace，然后转发给另一个函数统一处理。

domchen · 2024-12-09T11:54:44Z

src/core/GlyphRunList.cpp

    if (hasScale) {
      // Scale the glyphs before measuring to prevent precision loss with small font sizes.
-      font = font.makeWithSize(font.getSize() * resolutionScale);
+      glyphFace = glyphFace->makeScaled(resolutionScale);


这后面补充一个DEBUG_ASSERT(), 防止外部继承的返回nullptr。

domchen · 2024-12-09T11:57:02Z

src/core/GlyphRunList.h

+    if (_glyphRuns.empty()) {
+      return false;
+    }


这里不用再判空了，GlyphRunList是内部类，在所有创建它的实例之前都已经做过了判空，这里直接访问就好了。包括glyphFace也不用在判空了。

domchen · 2024-12-09T11:59:51Z

src/core/GlyphRunList.cpp

+    if (glyphFace == nullptr) {
+      continue;
+    }


这个也没有必要再判空了。内部类，应该在构造它之前就做好判空，另外我们还有构造函数里的DEBUG_ASSERT二次验证。

domchen · 2024-12-09T12:00:16Z

src/core/GlyphRunList.h

+    if (_glyphRuns.empty()) {
+      return false;
+    }
+    const auto& glyphFace = _glyphRuns[0].glyphFace;
+    return glyphFace ? glyphFace->hasOutlines() : false;


这边同上，不需要多余的判空。

domchen · 2024-12-09T12:01:07Z

src/core/TextBlob.cpp

@@ -71,13 +73,18 @@ std::shared_ptr<TextBlob> TextBlob::MakeFrom(GlyphRun glyphRun) {

 enum class FontType { Path, Color, Other };

-static FontType GetFontType(const Font& font) {
-  if (font.hasColor()) {
+static FontType GetFontType(const std::shared_ptr<GlyphFace>& font) {


变量名叫face吧。返回值可以重命名为GlyphFaceType

domchen · 2024-12-09T12:05:47Z

src/core/vectors/coregraphics/CGMask.cpp

+    auto glyphFace = glyphRun.glyphFace;
+    if (glyphFace == nullptr || glyphFace->asFont() == std::nullopt) {
+      continue;
+    }
+
+    const auto& font = glyphFace->asFont();
+    if (font->isFauxBold() || font->getTypeface() == nullptr) {


你应该在构造FontGlyphFace的时候就不允许Font->getTypeface()==nullptr的Font对象能够成功构造一个GlyphFace，这样可以简化后续的判断。所以FontGlyphFace那边加个静态方法来构造吧，隐藏掉构造函数。这样确保只要GlyphFace不为空，它就应该是有效的。

domchen · 2024-12-09T12:08:16Z

src/core/vectors/coregraphics/CGMask.cpp

+    auto glyphFace = glyphRun.glyphFace;
+    if (glyphFace == nullptr || glyphFace->asFont() == std::nullopt) {
+      continue;
+    }


前面已经做过判空了，这里不用重复判空，应该是直接asFont，然后加个DEBUG_ASSERT不允结果失败。因为会走到里的只有CoreGraphics生成的Font。

domchen · 2024-12-09T12:10:13Z

src/gpu/RenderContext.cpp

+    if (glyphFace == nullptr) {
+      continue;
+    }


能被我们内部类GlyphRunList包装进来的GlyphRun就是都判空过了，这里不需要判空。有需要可以考虑再加个DEBUG_ASSERT确保提醒到位。

domchen · 2024-12-09T12:11:31Z

src/layers/TextLayer.cpp

@@ -422,7 +423,7 @@ void TextLayer::buildGlyphRunList(const std::vector<std::shared_ptr<GlyphInfo>>&
    if (glyphRunMap.find(typefaceID) == glyphRunMap.end()) {
      auto font = _font;
      font.setTypeface(typeface);
-      glyphRunMap[typefaceID] = GlyphRun(font, {}, {});
+      glyphRunMap[typefaceID] = GlyphRun(std::make_shared<FontGlyphFace>(font), {}, {});


这里还原一下，用原来的GlyphRun构造函数就行。

domchen · 2024-12-09T12:23:01Z

include/tgfx/core/GlyphFace.h

+/**
+* GlyphFace is a provider for glyphs. It provides the glyph path, image, and bounds, etc.
+*/


修改一下注释： GlyphFace is a render-only font that contains only the necessary information to render glyphs. It can be implemented externally to render glyphs from a custom font or used as a wrapper around a Font object.

domchen · 2024-12-10T06:05:32Z

include/tgfx/core/GlyphFace.h

+
+namespace tgfx {
+/**
+ * GlyphFace is a render-only font that contains only the necessary information to render glyphs. It can be implemented externally to render glyphs from a custom font or used as a wrapper around a Font object.


忘记换行了

domchen · 2024-12-10T06:07:20Z

include/tgfx/core/GlyphFace.h

+   * Returns true if the font has color glyphs, for example, color emojis.
+   */
+  virtual bool hasColor() const = 0;
+
+  /**
+   * Returns true if the font has outline glyphs, meaning it can generate paths.


更新注释里的 the font 为 the glyph face

domchen · 2024-12-10T06:11:05Z

include/tgfx/core/GlyphFace.h

+   * Returns the font object represented by this GlyphFace.
+   * If the GlyphFace is not a font object, returns false and sets the font pointer to null.
+   * If the GlyphFace is a font object, returns true and sets the font pointer to the font object.


修改注释： Checks if the GlyphFace is backed by a Font object. If so, sets the font pointer to the backing Font object and returns true. Otherwise, returns false and leaves the font pointer unchanged.

domchen · 2024-12-10T06:18:35Z

src/core/FontGlyphFace.h

+namespace tgfx {
+class FontGlyphFace final : public GlyphFace {
+ public:
+  static std::shared_ptr<FontGlyphFace> Make(const Font& font);


这个方法重命名为Wrap，移动到父类GlyphFace上作为公开API，之前GlyphRun的修改可以还原回去。

domchen · 2024-12-10T06:20:12Z

src/core/GlyphRunList.cpp

+    if (glyphFace == nullptr) {
+      continue;
+    }


这里不需要判空，已经判空过了。只有后面那句makeScaled之后防止意外加个DEBUG_ASSERT判空。

domchen · 2024-12-10T06:27:36Z

src/core/TextBlob.cpp

  for (auto& run : glyphRuns) {
    if (run.glyphs.size() != run.positions.size()) {
      return nullptr;
    }
    if (run.glyphs.empty()) {
      continue;
    }
-    auto currentFontType = GetFontType(run.font);
-    if (currentFontType != fontType) {
+    auto currentFontType = GetGlyphFaceType(run.glyphFace);


这里要补充上glyphFace==nullptr的 return判断。我们之前GlyphRunList里并没有判断Font是否为空。现在内部到处都用到了这个判断，所以所有创建GlyphRunList的地方都要检查一遍，补上内部glyphFace属性的判空。GlyphRunList构造函数里的DEBUG_ASSERT只是最后的提醒措施，外部构造的地方还是要都检查一遍。

domchen · 2024-12-10T06:29:07Z

src/core/vectors/coregraphics/CGMask.cpp

-    if (font.isFauxBold() || font.getTypeface() == nullptr) {
+    Font font;
+    bool success = glyphRun.glyphFace->asFont(&font);
+    if (!success || font.isFauxBold() || font.getTypeface() == nullptr) {


这句里的font.getTypeface()可以不用判断了，因为Wrap的结果是如果typeface为空，不会得到一个有效的GlyphFace。
但这里的success确实是需要判断的，因为可能有外部的自定义GlyphFace进入到这里，这里asFont失败了return，上层的Mask就会调用getPath方法再去尝试绘制。

domchen · 2024-12-10T06:36:07Z

src/core/vectors/coregraphics/CGMask.cpp

+    Font font;
+    bool success = glyphRun.glyphFace->asFont(&font);
+    if (!success) {
+      CGContextRestoreGState(cgContext);
+      continue;
+    }
+    DEBUG_ASSERT(font.getTypeface() != nullptr);


这边的判断不需要，上面已经for循环判断过，只要存在一个asFont失败就会return。所以直接asFont就行了，不用声明返回值success。后面的DEBUG_ASSERT也不需要。typeface永远不会为空。只单独给success加DEBUG_ASSERT会导致release版本里出现变量没有使用的报错。所以这边success变量最好不要声明。

# Conflicts: # include/tgfx/core/Canvas.h # src/core/Canvas.cpp

…mentation. (#371)" This reverts commit 6fecb4a.

shlzxjp added 12 commits December 6, 2024 19:46

Implement RenderFont

194d822

RenderFont renamed to GlyphFace.

a49135f

format code.

ace00c1

Add glyph face tese

4032de2

Modify unit test cases.

c225220

Add asFont method for GlyphFace class.

fa33273

Update version.json

bd287e5

Merge branch 'main' into feature/xjp_render_font

847a778

Fix compilation errors.

9ed1938

Fix ios compilation error>

b36088b

Merge branch 'main' into feature/xjp_glyph_face

10ed5ea

fix ios compilation error.

cc2ddb2

shlzxjp requested review from kevingpqi123, domchen, Hparty and lvpengwei as code owners December 9, 2024 10:46

fix ios compilation error.

fcecbfb

domchen reviewed Dec 9, 2024

View reviewed changes

resources/assets/image1.png Outdated

Copy link

Collaborator

domchen Dec 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

重命名一下文件吧，glyph1, glyph2, glyph3

domchen reviewed Dec 9, 2024

View reviewed changes

shlzxjp added 3 commits December 10, 2024 13:14

Modify comment.

ea7f358

format code.

797b3f3

Merge branch 'main' into feature/xjp_glyph_face

7ed665c

domchen reviewed Dec 10, 2024

View reviewed changes

Modify comment.

9333349

shlzxjp requested a review from domchen December 10, 2024 08:12

shlzxjp and others added 4 commits December 10, 2024 16:39

Merge branch 'main' into feature/xjp_glyph_face

f5d1bf1

Update some comments.

413e3d8

Fix the FontGlyphFace::makeScale() method when the scale factor < 0.

09d3c05

Merge branch 'main' into feature/xjp_glyph_face

f5f46a2

# Conflicts: # include/tgfx/core/Canvas.h # src/core/Canvas.cpp

domchen force-pushed the feature/xjp_glyph_face branch from 7eec5cb to f5f46a2 Compare December 10, 2024 09:09

Remove an unused header.

7de4b86

domchen approved these changes Dec 10, 2024

View reviewed changes

domchen merged commit 6fecb4a into main Dec 10, 2024
8 checks passed

domchen deleted the feature/xjp_glyph_face branch December 10, 2024 09:20

Fjie added a commit that referenced this pull request Dec 12, 2024

Revert "Add a render-only GlyphFace class to enable custom font imple…

dd4aa29

…mentation. (#371)" This reverts commit 6fecb4a.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement GlyphFace rendering capabilities #371

Implement GlyphFace rendering capabilities #371

shlzxjp commented Dec 9, 2024

domchen Dec 9, 2024

domchen Dec 9, 2024

domchen Dec 9, 2024

domchen Dec 9, 2024

domchen Dec 9, 2024

domchen Dec 9, 2024

domchen Dec 9, 2024 •

edited

Loading

domchen Dec 9, 2024

domchen Dec 9, 2024

domchen Dec 9, 2024 •

edited

Loading

domchen Dec 9, 2024

domchen Dec 9, 2024

domchen Dec 9, 2024 •

edited

Loading

domchen Dec 9, 2024

domchen Dec 9, 2024

domchen Dec 9, 2024 •

edited

Loading

domchen Dec 9, 2024

domchen Dec 9, 2024

domchen Dec 10, 2024

domchen Dec 10, 2024

domchen Dec 10, 2024

domchen Dec 10, 2024

domchen Dec 10, 2024

domchen Dec 10, 2024

domchen Dec 10, 2024 •

edited

Loading

domchen Dec 10, 2024 •

edited

Loading

Implement GlyphFace rendering capabilities #371

Implement GlyphFace rendering capabilities #371

Conversation

shlzxjp commented Dec 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

domchen Dec 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

domchen Dec 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

domchen Dec 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

domchen Dec 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

domchen Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

domchen Dec 10, 2024 • edited Loading

Choose a reason for hiding this comment

domchen Dec 9, 2024 •

edited

Loading

domchen Dec 9, 2024 •

edited

Loading

domchen Dec 9, 2024 •

edited

Loading

domchen Dec 9, 2024 •

edited

Loading

domchen Dec 10, 2024 •

edited

Loading

domchen Dec 10, 2024 •

edited

Loading