cocos-enhance-kit/docs/versioned_docs/version-2.0.0/breaking-change.md
2024-10-25 18:30:34 +08:00

4.0 KiB
Raw Permalink Blame History

sidebar_position description
5 一般情况下都不需要了解。

破坏性变更

在添加新特性的过程中,有些变化在所难免,你可以浏览本文档以进行评估是否会对项目造成影响。

默认禁用原生 TTF 渲染器

引擎的 Label 在使用 Char 缓存模式并且使用 TTF 字体时,会使用一个原生 TTF 渲染器。

这个渲染器理论上能提升原生平台的 Label 性能,但仅在 Char 缓存模式并且还要使用 TTF 字体时才生效,这也导致了在原生平台上字体样式可能与其它平台不一致的问题。

在重构 CHAR 缓存模式时考虑到这些因素和人力有限的原因,我们暂时不打算适配这个原生 TTF 渲染器,所以直接默认禁用了原生 TTF 渲染器,这个禁用是官方提供的接口,不会造成其它问题。

大部分项目可以不用关心

cc.macro.ENABLE_NATIVE_TTF_RENDERER = false;

动态图集的一些变化

对动态图集的重构虽然保留了所有原有的公开接口,但实现细节与以前不同了。

如果你的项目有在细致地管理动态图集,请注意以下几点:

  • 如果你有手动修改 cc.dynamicAtlasManager.maxAtlasCount 属性,请考虑删除

社区版会根据设备最大纹理数和 Char 缓存模式字符图集的相关设置自动调整动态合图的最大图集数量。

这不意味着你不能手动调整了,而是建议你阅读新动态图集和新 Char 缓存模式相关的文档后再考虑是否有必要进行调整。

关于这个你可以查看 提升项目性能 了解。

  • 动态图集重复纹理的判断从 texture._id 改为使用 texture._uuid

具体的设计原因和原理可查看动态合图的原理文档。

  • cc.dynamicAtlasManager.insertSpriteFrame(spriteFrame) 不再检查纹理的 packable 属性

并不是说 packable 属性无效了,而是 insertSpriteFrame 现在作为将纹理强制加入动态图集的接口使用。

  • 如果你的项目依赖动态图集的内部实现细节,请重新检查相关代码

比如你的项目依赖一些动态图集未公开的类或者接口(引擎在 creator.d.ts 声明了的则是已经公开的),则可能需要重新编写。

Char 缓存模式的一些变化

对 Char 缓存模式也进行了重构,内部变化比较大。

  • 暂不支持自定义材质

如果项目中有组件在使用 Char 缓存模式并且设置了自定义材质则可能会失效,具体原因可前往 新的 Char 缓存模式 文档进行了解。

  • 如果你的项目依赖 Char 缓存模式的内部实现细节,请重新检查相关代码

比如你的项目依赖一些 Char 缓存模式未公开的类或者接口(引擎在 creator.d.ts 声明了的则是已经公开的),则可能需要重新编写。

材质 Hash 计算的变化

在之前,材质的 Hash 发生变化时不会同时更新现有的材质变体 Hash这导致在修改前创建的变体不能与修改后创建的变体合批因为 Hash 不同)。

为了兼顾原生平台与 Web 平台,我们通过使材质本身的 Hash 值不变,并且改变变体的 Hash 计算方式来解决这个问题。

但这引入了新的问题:完全相同的两个材质不能合批。

比如你复制了一个 multi-2d-sprite 材质,分别使用这两个材质的组件不再会进行合批。

这种情况比较少见,如果你的项目发生了这种情况,可以手动将新材质的 Hash 值设置为旧材质的 Hash 值,即可让这两个材质合批。

启用多线程时的破坏性改动

资源管线

当你启用多线程驱动资源管线时,cacheManager 的接口有以下不同:

  • getTemp 方法被 getTempAsync 方法代替,请检查你项目中相关的用法。
  • 启用多线程之后,会使用多线程版的缓存管理器,如果你的项目访问了未暴露的内部属性,请检查相关的用法。