diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index cdbe4660..5ef0fe12 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -35,6 +35,12 @@ const config = { ({ docs: { sidebarPath: require.resolve('./sidebars.js'), + includeCurrentVersion: false, + versions: { + "1.0.0": { + label: "v1.0.0", + } + } }, blog: { showReadingTime: true, @@ -74,12 +80,12 @@ const config = { label: '演示', position: 'right', }, - // { - // type: 'docsVersionDropdown', - // position: 'right', - // dropdownItemsAfter: [{ to: '/versions', label: 'All versions' }], - // dropdownActiveClassDisabled: true, - // }, + { + type: 'docsVersionDropdown', + position: 'right', + // dropdownItemsAfter: [{ to: '/versions', label: 'All versions' }], + dropdownActiveClassDisabled: true, + }, // { to: '/blog', label: 'Blog', position: 'left' }, { href: 'https://github.com/smallmain/cocos-service-pack', diff --git a/docs/src/css/custom.css b/docs/src/css/custom.css index 7f835bc9..ab42eafb 100644 --- a/docs/src/css/custom.css +++ b/docs/src/css/custom.css @@ -25,7 +25,7 @@ } .navbar__title { - font-weight: 500; + font-weight: 600; } .navbar__link { @@ -109,7 +109,7 @@ html[data-theme=light] .navbar__item.header-github-link { .navbar__item.header-github-link { padding-left: 1.6rem; padding-bottom: 0.2rem; - margin-left: 0.6rem; + margin-left: 1rem; margin-right: -1rem; background: url(data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjgiIGhlaWdodD0iMjciIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI+PHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0xMy42MDEgMGExMy41OTcgMTMuNTk3IDAgMCAwLTQuMjk4IDI2LjQ5OGMuNjc2LjEyNi45MjgtLjI5NS45MjgtLjY1NSAwLS4zMjUtLjAxMS0xLjM5NC0uMDE4LTIuNTMxLTMuNzgzLjgyMi00LjU4LTEuNjAzLTQuNTgtMS42MDMtLjYxOS0xLjU3Ni0xLjUxLTEuOTktMS41MS0xLjk5LTEuMjM0LS44NDUuMDkyLS44MjcuMDkyLS44MjcgMS4zNjYuMDk3IDIuMDg1IDEuNCAyLjA4NSAxLjQgMS4yMTMgMi4wNzkgMy4xODEgMS40OCAzLjk1NiAxLjEyNi4xMjMtLjg3OC40NzUtMS40NzcuODY0LTEuODE3LTMuMDEtLjM0LTYuMTk2LTEuNTA2LTYuMTk2LTYuNzE2YTUuMjU3IDUuMjU3IDAgMCAxIDEuNDAzLTMuNjU0Yy0uMTQyLS4zNDItLjYwOC0xLjcyNS4xMy0zLjYwMiAwIDAgMS4xNDItLjM2NSAzLjc0IDEuMzkzYTEyLjkyIDEyLjkyIDAgMCAxIDYuODEgMGMyLjU4NS0xLjc0OSAzLjczNi0xLjM5MyAzLjczNi0xLjM5My43MzkgMS44NzMuMjc1IDMuMjU1LjEzMyAzLjYwMmE1LjI1NSA1LjI1NSAwIDAgMSAxLjM5OCAzLjY1YzAgNS4yMjMtMy4xOCA2LjM3MS02LjIwNyA2LjcxLjQ4Ni40Mi45MiAxLjI0OS45MiAyLjUxNiAwIDEuODItLjAxMyAzLjI4NS0uMDEzIDMuNzMxIDAgLjM2My4yNDMuNzg2LjkzMi42NTNBMTMuNTk2IDEzLjU5NiAwIDAgMCAxMy42MDEgMHoiIGZpbGw9IiNmZmYiLz48cGF0aCBkPSJNNS4xNTQgMTkuNTJjLS4wMy4wNjgtLjEzNS4wODgtLjIyNS4wNDNzLS4xNTYtLjEzNy0uMTI0LS4yMDVjLjAzMS0uMDY3LjEzNy0uMDg3LjIyNS0uMDQyLjA4OC4wNDUuMTU1LjEzNy4xMjIuMjA0aC4wMDJ6bS41NTEuNjE1Yy0uMDY1LjA2LS4xOTEuMDMyLS4yNzktLjA2M2EuMjA3LjIwNyAwIDAgMS0uMDM4LS4yODFjLjA2Ny0uMDYxLjE4OS0uMDMyLjI3OS4wNjMuMDkuMDk0LjEwNi4yMjUuMDM4LjI4MXptLjUzNi43ODNjLS4wODMuMDU5LS4yMjUgMC0uMzA0LS4xMTctLjA3OS0uMTE3LS4wODMtLjI2NSAwLS4zMjQuMDg0LS4wNTguMjI1IDAgLjMwNC4xMTUuMDc5LjExNS4wODQuMjY4IDAgLjMyNnptLjc0My43NTdhLjI1NS4yNTUgMCAwIDEtLjM1OC0uMDZjLS4xMi0uMTExLS4xNTMtLjI2Ni0uMDc2LS4zNDguMDc2LS4wOC4yMjUtLjA2LjM1LjA1Mi4xMjcuMTEzLjE1NC4yNjYuMDc1LjM0N2wuMDEuMDA5em0xLjAwNC40MzljLS4wMzMuMTA2LS4xODQuMTU1LS4zNC4xMS0uMTU1LS4wNDUtLjI1NC0uMTctLjIyNS0uMjc5LjAzLS4xMDguMTg1LS4xNTcuMzQtLjExLjE1Ni4wNDcuMjU1LjE3LjIyNS4yNzl6bTEuMTEyLjA4MWMwIC4xMTMtLjEyNi4yMDUtLjI4OC4yMDctLjE2Mi4wMDItLjI5Mi0uMDg1LS4yOTUtLjE5OC0uMDAyLS4xMTMuMTI2LS4yMDUuMjktLjIwNy4xNjUtLjAwMi4yOTMuMDg4LjI5My4xOTh6bTEuMDM2LS4xNzVjLjAyLjExLS4wOTIuMjI1LS4yNTIuMjUyLS4xNi4wMjctLjMwNC0uMDM5LS4zMjQtLjE0OS0uMDItLjExLjA5NC0uMjI1LjI1Mi0uMjUyLjE1OC0uMDI3LjMwNC4wMzguMzI0LjE0OHoiIGZpbGw9IiNmZmYiLz48L3N2Zz4=) 0/20px 20px no-repeat; } diff --git a/docs/versioned_docs/version-1.0.0/assets/plugin-uninstall.png b/docs/versioned_docs/version-1.0.0/assets/plugin-uninstall.png new file mode 100644 index 00000000..ef7a4bff Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/assets/plugin-uninstall.png differ diff --git a/docs/versioned_docs/version-1.0.0/installation-guide/_category_.json b/docs/versioned_docs/version-1.0.0/installation-guide/_category_.json new file mode 100644 index 00000000..af2c1ac7 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/installation-guide/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "安装指南", + "position": 2, + "collapsed": false, + "link": { + "type": "doc", + "id": "installation-intro" + } +} diff --git a/docs/versioned_docs/version-1.0.0/installation-guide/assets/custom-engine.png b/docs/versioned_docs/version-1.0.0/installation-guide/assets/custom-engine.png new file mode 100644 index 00000000..d1b7eed7 Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/installation-guide/assets/custom-engine.png differ diff --git a/docs/versioned_docs/version-1.0.0/installation-guide/assets/dts.png b/docs/versioned_docs/version-1.0.0/installation-guide/assets/dts.png new file mode 100644 index 00000000..d5d0755d Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/installation-guide/assets/dts.png differ diff --git a/docs/versioned_docs/version-1.0.0/installation-guide/assets/ide-cocos-path.png b/docs/versioned_docs/version-1.0.0/installation-guide/assets/ide-cocos-path.png new file mode 100644 index 00000000..932e8b96 Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/installation-guide/assets/ide-cocos-path.png differ diff --git a/docs/versioned_docs/version-1.0.0/installation-guide/assets/installed-console.png b/docs/versioned_docs/version-1.0.0/installation-guide/assets/installed-console.png new file mode 100644 index 00000000..5efb109e Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/installation-guide/assets/installed-console.png differ diff --git a/docs/versioned_docs/version-1.0.0/installation-guide/assets/plugin-info.png b/docs/versioned_docs/version-1.0.0/installation-guide/assets/plugin-info.png new file mode 100644 index 00000000..75535f2b Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/installation-guide/assets/plugin-info.png differ diff --git a/docs/versioned_docs/version-1.0.0/installation-guide/assets/plugin-install.png b/docs/versioned_docs/version-1.0.0/installation-guide/assets/plugin-install.png new file mode 100644 index 00000000..81bb108f Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/installation-guide/assets/plugin-install.png differ diff --git a/docs/versioned_docs/version-1.0.0/installation-guide/installation-engine-plugin.md b/docs/versioned_docs/version-1.0.0/installation-guide/installation-engine-plugin.md new file mode 100644 index 00000000..fc84706d --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/installation-guide/installation-engine-plugin.md @@ -0,0 +1,75 @@ +--- +sidebar_position: 1 +description: "推荐使用此方式进行一键安装。" +--- + +# 使用引擎扩展安装 + +--- +## 前往 Cocos Store 下载 + +在 Cocos Store 搜索名为 **Cocos Service Pack** 的引擎扩展，或者 [点此跳转](pathname://TODO)。 + +这个扩展不是免费的，**但其唯一的作用就是帮助你管理服务包的版本（查看、安装和卸载服务包）。** + +:::tip 常见问题 + +- **Service Pack 不是开源项目吗？？？** + + Service Pack 是完全开源的项目，这个引擎扩展只会为你提供自动化的安装方式，以后也只会有版本管理方面的功能。 + + 你可以选择 [手动安装](./installation-manual.md)，也只需要几步即可完成。 + +- **如何反馈有关这个扩展的问题或建议** + + 若遇到与这个扩展相关的问题或者建议，不要在服务包的 Github 仓库反馈，请在扩展的 **商店评论区** 进行反馈。 + + 因为这个扩展的收益是个人的，所以也只由个人维护。 + +::: + +--- +## 查询信息 + +安装好扩展后，可在 Cocos Creator 的菜单栏依次点击 **扩展 - 服务包管理 - 查看信息**，会打印当前环境信息。 + +![plugin-info](./assets/plugin-info.png) + +你可以看到当前引擎版本支持一键安装的服务包版本，已安装的服务包版本等信息。 + +--- +## 一键安装 + +安装好扩展后，可在 Cocos Creator 的菜单栏依次点击 **扩展 - 服务包管理 - 安装服务包 - 安装最新版本**，会自动开始安装服务包。 + +![plugin-install](./assets/plugin-install.png) + +如果你的项目使用的不是最新版本的服务包，你也可以选择 **安装其它版本**。 + +:::note 扩展做了什么事 + +扩展帮您自动完成了手动安装时需要做的所有步骤，包括自定义引擎和放置 TypeScript 类型提示文件。 + +::: + +预览项目并检查 Devtools Console 打印的是否为 `Cocos Creator SP v2.4.x`，是的话则已经成功安装。 + +![installedconsole](./assets/installed-console.png) + +接下来推荐你从 [入门教程](../start-guide/start-guide-intro.mdx) 开始了解服务包为你的开发都带来了哪些新特性！ + +--- +## 支持的引擎版本 + +服务包只会适配引擎的最新版本，如果需要在其它引擎版本上安装服务包，一般需要使用 Git Patch。 + +而这个扩展会额外适配其他引擎版本，让你可以在更多版本的引擎上一键安装。 + +**该扩展至少会维护两个 Cocos Creator 版本，分别是 v2.4.6 与最新版本。** + +选择维护这两个版本是因为在 v2.4.7 这个版本出现了破坏性变更，也是官方开始暂停新特性开发只进行维护的版本。 + +也就是说： + +- 项目使用 < v2.4.7 版本的引擎可以完全无痛升级至 v2.4.6。 +- 项目使用 >= v2.4.7 版本的引擎可以完全无痛升级至最新版。 diff --git a/docs/versioned_docs/version-1.0.0/installation-guide/installation-intro.mdx b/docs/versioned_docs/version-1.0.0/installation-guide/installation-intro.mdx new file mode 100644 index 00000000..6a30e820 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/installation-guide/installation-intro.mdx @@ -0,0 +1,14 @@ +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + +# 安装指南 + +服务包主要使用 [自定义引擎](https://docs.cocos.com/creator/2.4/manual/zh/advanced-topics/engine-customization.html) 的方式对引擎进行修改。 + +但由于自定义引擎不能添加内置资源与扩展内置组件的 Inspector，所以还需要安装配套的引擎扩展。 + +对于使用 TypeScript 的项目，服务包提供了 `creator-sp.d.ts` 类型提示文件。 + +以下是两种常用的安装方式： + + diff --git a/docs/versioned_docs/version-1.0.0/installation-guide/installation-manual.md b/docs/versioned_docs/version-1.0.0/installation-guide/installation-manual.md new file mode 100644 index 00000000..f9003074 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/installation-guide/installation-manual.md @@ -0,0 +1,109 @@ +--- +sidebar_position: 2 +description: "需掌握一定的自定义引擎知识。" +--- + +# 手动安装 + +## Service Pack v1.0.0 + +适配 Cocos Creator v2.4.9 版本，[点此下载服务包](https://github.com/smallmain/cocos-service-pack/releases/tag/v1.0.0) + +--- +## 标准安装 + +**请确保您的项目所使用的引擎版本与服务包适配的引擎版本一致，否则请使用 [补丁安装](#补丁安装)。** + +:::tip 提示 + +建议升级到最新的引擎版本，官方只会对 2.x 版本只会进行维护性更新，所以不用担心其稳定性问题。 + +如果你的项目引擎版本较低，可以看一看 [使用引擎扩展安装](./installation-engine-plugin.md) ，支持对多个引擎版本进行一键安装。 + +::: + +### 1.替换自定义引擎 + +下载服务包后，解压压缩包可以看到压缩包内的 `engine` `cocos2d-x` `jsb-adapter` 这三个目录分别是已经整理好的 **JavaScript 引擎**、**Cocos2d-x 引擎** 和 **jsb-adpater**。 + +接着打开 Cocos Creator 菜单的 **项目 - 项目设置 - 自定义引擎**。 + +分别填写 **JavaScript 引擎路径**（对应 `engine` 目录）和 **Cocos2d-x 引擎路径**（对应 `cocos2d-x` 目录）。 + +![custom-engine](./assets/custom-engine.png) + +然后点击 Cocos Creator 主界面右上角的 **编辑器** 按钮，进入到编辑器的资源目录。 + +![ide-cocos-path](./assets//ide-cocos-path.png) + +接着使用压缩包内的 `jsb-adapter` 替换掉编辑器的 `Resources/builtin/jsb-adapter` 目录。 + +:::info 提示 + +如果你的项目不需要在原生平台上运行，则只定制 JavaScript 引擎即可。 + +::: + +### 2.安装引擎扩展 + +:::caution 注意 + +**请勿将此引擎扩展与 [使用引擎扩展安装](./installation-engine-plugin) 中的引擎扩展混淆！** + +**该扩展提供了必需的内置资源，是服务包开源的一部分，请勿同时安装两个引擎扩展，这会引起冲突！** + +::: + +压缩包内 `service-pack-support` 目录即是扩展本身，将其放到项目的 `packages` 目录即可。 + +服务包需要使用名为 `sp` 的 AssetBundle 存放资源，如果你的项目有使用 AssetBundle，请**确保该名称未被占用**。 + +没有必要将这个 Asset Bundle 设为远程包或者 Zip 压缩，里面只有 Effect 着色器资源。 + +更多详情可阅读官方的 [安装扩展](https://docs.cocos.com/creator/2.4/manual/zh/extension/install-and-share.html) 文档。 + +### 3.TypeScript 类型提示（可选） + +如果你的项目使用 TypeScript，可将压缩包内 `creator-sp.d.ts` 文件拷贝到项目根目录中。 + +![dts](assets/dts.png) + +部分代码编辑器可能需要重启之后类型提示才会生效。 + +### 4.重启 Cocos Creator + +完成以上的步骤后重启 Cocos Creator。 + +可在项目预览时检查 Devtools Console 打印的是否为 `Cocos Creator SP v2.4.x`，是的话则已经成功安装。 + +![](./assets/installed-console.png) + +接下来推荐你从 [入门教程](../start-guide/start-guide-intro.mdx) 开始了解服务包为你的开发都带来了哪些新特性！ + +--- +## 补丁安装 + +:::caution 提示 + +**建议至少将 Cocos Creator 升级到 v2.4.x 版本，服务包所做的改动不保证对 v2.4 版本以下的兼容性。** + +补丁安装需要掌握一定的 [Git](https://git-scm.com/doc) 知识和修改引擎源码的能力。 + +::: + +补丁安装实际上就是打 Git Patch，**在压缩包内的 `patches` 目录放着最新的 Git Patch 文件。** + +这种方式理论上可以在任意版本的引擎上进行，但由于这种方式如果需要正确的进行下去本就需要你拥有相关的知识与能力，所以我们不会说的很细致。 + +Git Patch 存储了我们所有的源码提交信息，所以你可以只挑选你想要的提交进行应用，在引擎目录去打补丁文件就等同于应用了我们对引擎的改动，之后就可以按照官方的自定义引擎文档去使用了。 + +打补丁一般使用两种命令： + +- 直接提交使用 `git am` +- 只将改动保留到工作区使用 `git apply` + +最好在打补丁时加上输出详细信息的命令参数以更好地确认补丁应用的情况。 + +常见的问题是我们在仓库的 `engine`、`jsb-adapter`、`cocos2d-x` 文件夹存放源码，那么提供的补丁文件对源码的应用路径也会是 `./engine` 这样的二级目录，如果你直接在引擎目录应用补丁，可能会发生没反应、补丁被跳过的问题，需要使用相应的命令参数来修正补丁应用的路径。 + +在完成自定义引擎的工作后，请别忘了安装引擎扩展哦。（可参考[标准安装的第 2 步](#2安装引擎扩展)进行操作）。 diff --git a/docs/versioned_docs/version-1.0.0/intro.md b/docs/versioned_docs/version-1.0.0/intro.md new file mode 100644 index 00000000..e1aa186b --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/intro.md @@ -0,0 +1,105 @@ +--- +sidebar_position: 1 +title: 介绍 +hide_title: true +--- + +![logo](/img/logo2.png) + +这是一个提供 Cocos Creator 引擎特性增强、修复与优化的**开源非官方服务包**。 + +该项目使用自定义引擎的方式在符合原始引擎架构设计的基础上为 Cocos Creator 引擎加入新的特性、修复已知问题以及性能优化。 + +正因为如此，服务包中的大部分特性能像升级引擎版本一样无需改动项目代码即可生效。 + +:::info 项目的起源 + +2021 年 2 月，Cocos 发布 Cocos Creator 3.0，之后不会再开发 2.x 版本的新特性，但 2.x 在一些方面还并不完善，所以这个非官方的引擎“魔改”合集应运而生。 + +给项目取名的时候想到相似的事情发生在 2014 年 4 月，官方停止了对 Windows XP 的维护，之后 Harkaz 发布了一个非官方服务包 Service Pack 4 (SP4)。 + +受到这个命名的启发，遂项目取名为 Service Pack。 + +::: + +## 重要特性 + +- **支持多纹理渲染**（多纹理材质、多纹理合批） + ![demo1](/demo-imgs/demo1.png) + +- **支持高 DPI 文本渲染**（Label、RichText 组件） + ![demo4](/demo-imgs/demo4.png) + +- **重构动态合图**（支持自动多纹理合批、优化算法、复用废弃空间等特性） + ![demo2](/demo-imgs/demo2.png) + +- **重构 Label 组件的 CHAR 缓存模式**（支持自动多纹理合批、多图集、复用废弃空间等特性） + ![demo3](/demo-imgs/demo3.png) + +- **Spine 组件支持与其它组件合批、合入动态图集与 SpriteFrame 换装** + ![demo5](/demo-imgs/demo5.png) + +## 功能演示 + +[Web Desktop 演示项目](https://smallmain.github.io/cocos-service-pack/demo/v1.0.0/web-desktop/index.html) + +[Web Mobile 演示项目](https://smallmain.github.io/cocos-service-pack/demo/v1.0.0/web-mobile/index.html)（请将设备横屏） + +:::note 提示 + +服务包对引擎的改动完全开源，每个改动会带有原理说明文档，当你发现问题时请与我们进行反馈，如果你有兴致，可以默默帅气地提交一个 PR，帮助我们一起完善这个项目。 + +::: + +## 使用方法 + +请阅读文档的 [安装指南](./installation-guide/installation-intro.mdx) 与 [入门教程](./start-guide/start-guide-intro.mdx)。 + +## 更新日志 + +### Service Pack v1.0.0 + +- **[新特性] 支持多纹理渲染** +- **[新特性] 重构动态图集，支持多个新特性** +- **[新特性] 重构 cc.Label 的 Char 缓存模式，支持多个新特性** +- **[新特性] 支持高 DPI 文本渲染** +- **[新特性] Spine 组件支持参与动态图集、与其它组件合批、使用 SpriteFrame 换装** +- [新特性] cc.Label、cc.RichText、cc.Sprite、cc.MotionStreak、Spine 组件支持使用多纹理材质，并支持自动切换材质机制 +- [新特性] cc.RichText 支持使用自定义材质 +- [修复] 直接修改 Effect 的属性不回导致其变体的 hash 值刷新 +- [修复] CHAR 缓存模式 hash 计算可能会有重复的问题 +- [调整] 默认禁用 Label 原生 TTF 渲染器 + +[点此](https://smallmain.github.io/cocos-service-pack/docs/update-log) 查看所有的更新日志。 + +## 贡献指南 + +非常欢迎你能和我们一起来完善这个项目，请通过 Github 进行： + +- 如果你发现了问题请建立 `Issues` +- 如果你有好的想法，请进入 `Discussions` +- 如果你有新的代码提交，请建立 `Pull requests` + +**原则上你提交的任何修改都不能影响引擎原有功能，不允许删除引擎原有的特性，请认真思考代码设计。** + +## 常见问题 + +### 为什么要直接修改引擎？ + +直接修改引擎可能是大部分人认为的下下策，比如我们常听到的： + +- 可以通过 “修改对象原型” 等编程技巧将改动做成一个插件脚本 +- 没接触过自定义引擎，不知道该如何使用 +- 已经修改过引擎了，不能直接进行标准安装，会覆盖原有的修改 + +以上问题我们都思考过，首先，现在引擎的 2.x 版本已经停止了更新（仅做一些维护工作），也就是说修改引擎不会遇到在官方新版本发布后需要用大量时间去适配的情况。 + +其次，即使服务包的所有改动都能做成一个插件脚本，但无法兼容原生平台，并且一般都需要大量拷贝代码，包体会增大，可维护性会大幅降低。 + +最后，我们希望它接近 “原生” 的使用体验，就像引擎本来就有的功能一样，对于没有接触过自定义引擎的人，可以通过引擎扩展一键安装。 + +对于已经修改过引擎的人，由于服务包提供的是 Git Patch，所以可以让你在原有的基础上轻松应用服务包的改动，你甚至可以只选取你想要的特性进行应用。 + +### 启动 Cocos Creator 报 Error: Can not parse this input:undefined 错误 + +这是你可能忘记安装配套的引擎扩展，所以没有找到服务包的内置资源导致的报错。 diff --git a/docs/versioned_docs/version-1.0.0/start-guide/_category_.json b/docs/versioned_docs/version-1.0.0/start-guide/_category_.json new file mode 100644 index 00000000..f2162559 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/start-guide/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "入门教程", + "position": 3, + "collapsed": false, + "link": { + "type": "doc", + "id": "start-guide-intro" + } +} diff --git a/docs/versioned_docs/version-1.0.0/start-guide/advance-batcher-guide.md b/docs/versioned_docs/version-1.0.0/start-guide/advance-batcher-guide.md new file mode 100644 index 00000000..c1138440 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/start-guide/advance-batcher-guide.md @@ -0,0 +1,12 @@ +--- +sidebar_position: 2 +description: "极致地减少游戏 Draw Call。" +--- + +# 进阶合批指南 + +:::caution TODO + +施工中... + +::: diff --git a/docs/versioned_docs/version-1.0.0/start-guide/assets/changespine.png b/docs/versioned_docs/version-1.0.0/start-guide/assets/changespine.png new file mode 100644 index 00000000..e1c7655a Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/start-guide/assets/changespine.png differ diff --git a/docs/versioned_docs/version-1.0.0/start-guide/assets/labelscaledemo.png b/docs/versioned_docs/version-1.0.0/start-guide/assets/labelscaledemo.png new file mode 100644 index 00000000..c0910da7 Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/start-guide/assets/labelscaledemo.png differ diff --git a/docs/versioned_docs/version-1.0.0/start-guide/batcher-guide.md b/docs/versioned_docs/version-1.0.0/start-guide/batcher-guide.md new file mode 100644 index 00000000..6c90654d --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/start-guide/batcher-guide.md @@ -0,0 +1,177 @@ +--- +sidebar_position: 1 +description: "在游戏开发中享受不用关注 Draw Call 的快乐。" +--- + +# 新 UI 渲染批次合并指南 + +在官方文档的进阶主题中有一个 [UI 渲染批次合并指南](https://docs.cocos.com/creator/2.4/manual/zh/advanced-topics/ui-auto-batch.html)，批次合并一直是游戏开发中重要的优化手段，如果你未阅读过官方的指南，可以先阅读一遍。 + +当 **多纹理渲染**、**新动态图集** 等特性出现后，在进行批次合并时可以变得更加简单且自动化。 + + + +--- +## 什么是多纹理渲染？ + +在以前的认识里，我们知道相邻的节点使用不同的纹理（Texture）会导致不能合并批次。 + +其根本原因是纹理是使用 uniform 变量传给着色器的，而需要合并批次的话不允许每次渲染都拥有不同的 uniform 变量值。 + +服务包实现的是先设置多个 uniform 变量，比如将 8 张纹理写入到 "texture1" "texture2" "texture3"... 的 8 个 uniform 变量中，然后在着色器里再判断应该在渲染时使用哪个 uniform 变量。 + +这样的话如果所有渲染都只用这 8 张纹理，就都能合并为 1 个批次。 + +这要求设备支持采样多个纹理，而在现代绝大多数设备中都至少支持采样 8 张纹理，所以这不是问题。 + +当然除了这种方法，还有另外几种进行多纹理合批的方法，例如 "Texture Array" 和 "Bindless"，但都有实用性与兼容性的问题。 + +:::info 提示 + +以这种方式实现的多纹理渲染并不是没有弊端的： + +因为会多传递一个顶点属性，并且需要在着色器中去判断该使用哪个纹理，导致**合并批次并不一定会提升性能**。 + +所以我们建议在多个档次设备中实际测试项目是否使用多纹理渲染的性能差距。 + +如果你对这种技术有所担心，可以看看这些： + +**PixiJS 引擎在 2016 年发布的 v4 版本就已经正式实装了多纹理渲染机制** [资料出处](https://medium.com/goodboy-digital/gpu-multi-texture-sprite-batching-21c90ae8f89b)。 + +**Phaser 引擎在 v4 与 v3 版本都实装了多纹理渲染机制（2019 - 2020年）**[资料出处](https://www.patreon.com/posts/39665256)。 + +::: + +--- +## 启用动态合图 + +在之前的开发中我们通常会关闭动态图集，更倾向于靠静态图集或者自动图集达到降低 Draw Call 的目的。 + +不使用动态图集最重要的原因是其不能复用图集的废弃区域，随着游戏的运行动态图集会完全用完。 + +引擎只提供了在切换场景（Scene）后重置所有图集的机制来解决这个问题，但对于大部分项目来说，这种治标不治本的机制基本等于没有解决。 + +现在，服务包几乎重构了整个动态合图系统，你可以考虑重新启用动态合图了。 + +:::note 提示 + +开启动态图集常见的反对意见是： + +在部分小游戏平台里，启用动态图集会有保留 Image 对象导致内存占用大的问题。 + +建议： + +- 实际测试是否启用动态图集的内存占用差距。 +- 有没有一种可能，只是说可能，内存占用大更多是因为你的项目根本没做任何资源释放呢？ + +::: + +--- +## 充分利用动态合图 + +一般情况下只需要保持动态图集的默认设置即可，如果出现动态图集很多纹理不会打入或者图集很快用完的情况，可以参考以下建议调整。 + +### 放宽能参与合图的纹理尺寸限制 + +**动态图集会自动进行多纹理合批，你可以放心地使用多达 7 张图集而不用担心交叉渲染导致的打断批次！** + +你可以根据项目的具体情况来放宽能参与合图的纹理尺寸限制。 + +```js +cc.dynamicAtlasManager.maxFrameSize = 1024; // 推荐 512、1024 甚至 2048 +``` + +:::tip + +服务包会自动将图集的最大数量调整至（设备能同时采样纹理数 - Char 缓存模式自动合批图集数），这个值默认为 `7`。 + +::: + +### 无需管理动态图集，只需要释放资源 + +**动态合图会在纹理被释放的同时释放其在动态图集使用的空间。** + +如果动态图集的使用量一直在增长，请检查是否做了资源释放，因为你不需要关心动态图集的使用情况，只需要做好应有的资源释放就能保持动态图集的长期有效。 + +### 更加细致地优化图集的使用效率 + +除了通过调整纹理的 `packable` 属性可以控制纹理是否会参与动态合图之外，服务包提供了**控制组件是否默认参与动态合图，控制单个组件是否参与动态合图**的新特性。 + +可前往 [动态合图](../user-guide/dynamic-batcher/dynamic-batcher-intro.mdx) 的文档了解详情。 + +你可以考虑将纹理尺寸限制放宽到 `2048`，这听起来貌似有点离谱，但只要规划得当确实可行，比如： + +- 禁止优化程度有限但尺寸巨大的纹理参与动态合图 +- 分模块存放资源，禁止冷门（如活动界面）的纹理参与动态合图或尽早地释放掉 +- 在资源太多的项目中，可考虑控制界面的渲染组件是否参与动态合图 + +完成上面几点这可能需要一些工作量，但能将动态图集用在刀刃上，发挥更大的作用。 + +--- +## Label 不再是合批噩梦 + +在之前的开发中我们可能会使用字体图集、调整节点顺序、甚至修改渲染流程来解决 Label 的性能问题。 + +也是因为引擎提供的 Bitmap 和 Char 两种缓存模式在稍大一点的项目上显得力所不及： + +- Bitmap 缓存模式：字体纹理会打入动态图集，但动态图集却无法复用，随着游戏的进行，图集用完则直接失去作用。 + +- Char 缓存模式的缺点：还是无法复用，并且只有一张图集，图集用完则直接无法渲染，应该没人能接受游戏可能跑着跑着字就全部消失了的情况。 + +但现在你可以使用这两种缓存模式了，服务包重构了 Char 缓存模式，除了解决了不能复用的问题之外，还支持了多纹理渲染，所以既能与动态图集合批，还有最多 8 张字符图集可以使用。 + +### 脱胎换骨的 Char 缓存模式 + +**如果你不知道该选择什么缓存模式，那就遇事不决，先选 Char 缓存模式。** + +虽然 Char 模式也有一些缺点，但由于它既能与动态图集一起合批，还是是按字符进行复用的，所以相比 Bitmap 模式它有着更高的性能优势。 + +不用担心字符图集会被用完，内部会用引用计数自动释放废弃字符所占用的空间。 + +但 Char 缓存模式不适合下面的场景： + +- 无法显示带有像 emoji 的字素簇的字符串，这种字符串现在不能被完美地分割成单个字符，所以 Char 缓存模式也就不能正常显示了。 +- 接上条，像聊天消息、输入框这类不可控的内容文本都不建议用 Char 缓存模式。 +- Char 缓存模式不支持一些字体样式，可以在官方文档中了解详情。 +- 巨大的字体大小（比如几百的）可能会瞬间占满整张字符图集，字符图集虽然有 8 张但也不能这么霍霍。 + +### 兜底的 Bitmap 缓存模式 + +即使不能选择 Char 缓存模式，Bitmap 缓存模式也能成为批次的最后一道防线。 + +在解决了动态图集的复用问题后，Bitmap 缓存模式的纹理也会使用引用计数自动释放，并且不会有 Char 缓存模式无法显示字素簇的问题。 + +但当然，Bitmap 缓存模式也不是万能的，如果遇到了下面这种情况，就需要考虑使用调整节点顺序这样的老办法来解决了： + +- 巨大的字体大小也会瞬间占满整张动态图集，动态图集也不能这么霍霍。 +- 在大量的 Label 需频繁改变文本的情况下，请使用性能分析工具检查动态图集的性能消耗，避免合批的弊大于利。 + +:::caution 注意 + +无论使用哪种缓存模式，在做缩放动画时不要对 `fontSize` 属性进行缓动，这会导致每帧都需要重新生成文字纹理，造成巨大的性能负担，可以使用节点的 `scale` 来代替。 + +::: + +### 注意事项 + +- **Char 缓存模式所使用的字符图集与动态图集不是一个东西** + +有多种因素导致没有让 Char 缓存模式直接使用动态图集来实现，这个原因在 Char 缓存模式的原理文档中有详细解释。 + +- **Char 缓存模式依然不能在图集用完的情况下正常渲染** + +原因有以下几点： + +- 我们认为 8 张数量已经够多了，8 张都用完的情况大部分是没有合理搭配使用两种缓存模式 +- 8 张是多纹理渲染的上限，这意味着如果超过 8 张，1 个 Label 有 100 个字，就可能有 100 个 Draw Call + +--- +## 总结 + +以上就是新合批指南的全部内容了，稍微总结一下渲染批次合并的几个要点： + +- 启用动态合图，只需要合理地释放资源即可保持动态合图的一直有效 +- Label 优先使用 Char 缓存模式，不适合则使用 Bitmap 缓存模式 +- 不要优先考虑修改节点顺序这种需要维护成本的优化方式 + +如果你对批次合并还有着更高的需求，可以阅读 [进阶合批指南](./advance-batcher-guide.md)。 diff --git a/docs/versioned_docs/version-1.0.0/start-guide/breaking-change.md b/docs/versioned_docs/version-1.0.0/start-guide/breaking-change.md new file mode 100644 index 00000000..8e02db1d --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/start-guide/breaking-change.md @@ -0,0 +1,76 @@ +--- +sidebar_position: 4 +description: "一般情况下都不需要了解。" +--- + +# 破坏性变更 + +在添加新特性的过程中，就像引擎升级一样，有些变化在所难免，在这里你可以对变更进行评估是否会对项目造成巨大的影响。 + +--- +### 默认禁用原生 TTF 渲染器 + +引擎的 Label 在使用 Char 缓存模式并且使用 TTF 字体时，会使用一个原生 TTF 渲染器。 + +这个渲染器理论上能提升原生平台的 Label 性能，但仅在 Char 缓存模式并且还要使用 TTF 字体时才生效，这也导致了在原生平台上字体样式可能与其它平台不一致的问题。 + +在重构 CHAR 缓存模式时考虑到这些因素和人力有限的原因，我们暂时不打算适配这个原生 TTF 渲染器，所以直接默认禁用了原生 TTF 渲染器，这个禁用是官方提供的接口，不会造成其它问题。 + +**大部分项目可以不用关心**。 + +```js +cc.macro.ENABLE_NATIVE_TTF_RENDERER = false; +``` + +--- +### 动态图集的一些变化 + +对动态图集的重构虽然保留了所有原有的公开接口，但实现细节与以前不同了。 + +如果你的项目有在细致地管理动态图集，请注意以下几点： + +- **如果你有手动修改 `cc.dynamicAtlasManager.maxAtlasCount` 属性，请考虑删除** + +服务包会根据设备最大纹理数和 Char 缓存模式字符图集的相关设置自动调整动态合图的最大图集数量。 + +这不意味着你不能手动调整了，而是建议你阅读新动态图集和新 Char 缓存模式相关的文档后再考虑是否有必要进行调整。 + +关于这个你可以从 [新 UI 渲染批次合并指南](./batcher-guide.md) 进行了解。 + +- **动态图集重复纹理的判断从 `texture._id` 改为使用 `texture._uuid`** + +具体的设计原因和原理可查看动态合图的原理文档。 + +- **`cc.dynamicAtlasManager.insertSpriteFrame(spriteFrame)` 不再检查纹理的 `packable` 属性** + +并不是说 `packable` 属性无效了，而是 `insertSpriteFrame` 现在作为将纹理强制加入动态图集的接口使用。 + +- **如果你的项目依赖动态图集的内部实现细节，请重新检查相关代码** + +比如你的项目依赖一些动态图集未公开的类或者接口（引擎在 `creator.d.ts` 声明了的则是已经公开的），则可能需要重新编写。 + +--- +### Char 缓存模式的一些变化 + +对 Char 缓存模式也进行了重构，内部变化比较大。 + +- **暂不支持自定义材质** + +如果项目中有组件在使用 Char 缓存模式并且设置了自定义材质则可能会失效，具体原因可前往 [新的 Char 缓存模式](../user-guide/text-render/text-char-mode.md) 文档进行了解。 + +- **如果你的项目依赖 Char 缓存模式的内部实现细节，请重新检查相关代码** + +比如你的项目依赖一些 Char 缓存模式未公开的类或者接口（引擎在 `creator.d.ts` 声明了的则是已经公开的），则可能需要重新编写。 + +--- +### 材质 Hash 计算的变化 + +在解决材质本身 Hash 变化不会更新材质变体的 Hash 的问题时，为了兼顾原生平台与 Web 平台，我们采取了使材质本身的 Hash 值不变并且修改变体 Hash 计算方式的方法来解决这个问题。 + +解决这个问题后，在两个材质变体一样的情况下，无论怎么修改材质，都不会影响该材质的变体进行合批（在这之前，修改材质后生成的变体无法和之前的变体合批，因为 Hash 值问题）。 + +但这引入了新的问题，这会导致完全相同的两个材质不能合批，比如你复制了一个 `multi-2d-sprite` 材质，分别使用这两个材质的组件不再会进行合批。 + +我们考虑了性能、影响程度等多方面因素之后采取了这个实现，因为后者比较少见，并且可以手动解决： + +你只需要手动设置该材质的 Hash 值为 `multi-2d-sprite` 材质的 Hash 值即可使两个材质合批。 diff --git a/docs/versioned_docs/version-1.0.0/start-guide/new-features.md b/docs/versioned_docs/version-1.0.0/start-guide/new-features.md new file mode 100644 index 00000000..3eeb2a6b --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/start-guide/new-features.md @@ -0,0 +1,59 @@ +--- +sidebar_position: 3 +description: "了解并上手服务包提供的所有其他新特性。" +--- + +# 上手其它新特性 + +除了前面提到的多纹理渲染、新动态图集、新 Label Char 缓存模式等特性之外，还有一些其它的也很实用的新特性。 + +--- +## 高 DPI 文本渲染 + +以前我们会使用将 Label 字号放大一倍，Label 节点缩小一倍的方式去解决字体模糊的问题。 + +而现在不需要了，你可以通过一句代码调整渲染比例： + +```js +cc.sp.labelRetinaScale = 2; // 渲染文本时纹理的缩放倍数，默认值为 1. +``` + +![labelscaledemo](./assets/labelscaledemo.png) + +> 图片中，上方的是开启后效果，下面是未开启效果。 + +**推荐你根据设备像素比（devicePixelRatio）来动态设置该值，并且该值不要大于 `2`，这不会带来更好的效果，但却将字体纹理放大了数倍，会影响到游戏整体性能，影响动态图集的效率。** + +可前往 [高 DPI 支持](../user-guide/text-render/text-high-dpi.md) 文档了解更多详情。 + +--- +## 使用 SpriteFrame 进行 Spine 换装 + +官方文档中介绍了替换 attachment 对象进行换装的方法，但如果动画中有切换 attachment 的关键帧，这种方法就失效了。 + +还有一种方法是修改 attachment 的 region 对象来进行换装，但这种方法引擎没有直接支持，所以服务包对其进行了支持。 + +只需要一句代码即可使用 cc.SpriteFrame 的数据修改 attachment 的 region 对象数据： + +```js +skeletonComponent.setRegionData('Head', 'Head', new sp.RegionData(spriteFrame)); +``` + +![changespine](./assets/changespine.png) + +> 图片中是被换头的小男孩。 + +这样做是直接修改了 SkeletonData 的数据，所有使用该数据的 Spine 组件都会受到影响（被换头），但我们提供了克隆 SkeletonData 数据的接口，可前往 [Spine](../user-guide/spine/spine-intro.mdx) 文档了解更多详情。 + +:::tip 提示 + +还有一个小特性，Spine 组件也支持了自动参与动态图集，并且也支持了和其它组件合批。 + +::: + +--- +## 给 RichText 使用自定义材质 + +虽然加上去也简单，但这可能是很少用得到的功能，主要还是我们看到几乎所有渲染组件都可以自定义材质，这个组件却不可以。 + +可前往 [RichText 自定义材质](../user-guide/text-render/text-richtext.md) 文档了解更多详情。 diff --git a/docs/versioned_docs/version-1.0.0/start-guide/start-guide-intro.mdx b/docs/versioned_docs/version-1.0.0/start-guide/start-guide-intro.mdx new file mode 100644 index 00000000..d0c750ff --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/start-guide/start-guide-intro.mdx @@ -0,0 +1,8 @@ +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + +# 入门指南 + +这个教程会简单地介绍如何利用服务包提供的新特性来更好地使用 Cocos Creator 引擎： + + diff --git a/docs/versioned_docs/version-1.0.0/theory-guide/_category_.json b/docs/versioned_docs/version-1.0.0/theory-guide/_category_.json new file mode 100644 index 00000000..8831e2b8 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/theory-guide/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "原理文档", + "position": 5, + "collapsed": true, + "link": { + "type": "doc", + "id": "theory-guide-intro" + } +} diff --git a/docs/versioned_docs/version-1.0.0/theory-guide/char-theory.md b/docs/versioned_docs/version-1.0.0/theory-guide/char-theory.md new file mode 100644 index 00000000..72fa8b06 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/theory-guide/char-theory.md @@ -0,0 +1,12 @@ +--- +sidebar_position: 3 +description: "详细了解新 Char 缓存模式的实现方式。" +--- + +# 新 Char 缓存模式 + +:::caution TODO + +施工中... + +::: diff --git a/docs/versioned_docs/version-1.0.0/theory-guide/dynamic-batcher-theory.md b/docs/versioned_docs/version-1.0.0/theory-guide/dynamic-batcher-theory.md new file mode 100644 index 00000000..d2937ba2 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/theory-guide/dynamic-batcher-theory.md @@ -0,0 +1,12 @@ +--- +sidebar_position: 2 +description: "详细了解新动态合图的实现方式。" +--- + +# 新动态合图 + +:::caution TODO + +施工中... + +::: diff --git a/docs/versioned_docs/version-1.0.0/theory-guide/high-dpi-theory.md b/docs/versioned_docs/version-1.0.0/theory-guide/high-dpi-theory.md new file mode 100644 index 00000000..578b363d --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/theory-guide/high-dpi-theory.md @@ -0,0 +1,12 @@ +--- +sidebar_position: 4 +description: "详细了解高 DPI 文本渲染的实现方式。" +--- + +# 高 DPI 文本渲染 + +:::caution TODO + +施工中... + +::: diff --git a/docs/versioned_docs/version-1.0.0/theory-guide/multi-theory.md b/docs/versioned_docs/version-1.0.0/theory-guide/multi-theory.md new file mode 100644 index 00000000..c63160cd --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/theory-guide/multi-theory.md @@ -0,0 +1,12 @@ +--- +sidebar_position: 1 +description: "详细了解多纹理渲染的实现方式。" +--- + +# 多纹理渲染 + +:::caution TODO + +施工中... + +::: diff --git a/docs/versioned_docs/version-1.0.0/theory-guide/richtext-custom-material-theory.md b/docs/versioned_docs/version-1.0.0/theory-guide/richtext-custom-material-theory.md new file mode 100644 index 00000000..aac4ce93 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/theory-guide/richtext-custom-material-theory.md @@ -0,0 +1,12 @@ +--- +sidebar_position: 5 +description: "详细了解使 RichText 支持自定义材质的实现方式。" +--- + +# 使 RichText 支持自定义材质 + +:::caution TODO + +施工中... + +::: diff --git a/docs/versioned_docs/version-1.0.0/theory-guide/spine-theory.md b/docs/versioned_docs/version-1.0.0/theory-guide/spine-theory.md new file mode 100644 index 00000000..60174be7 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/theory-guide/spine-theory.md @@ -0,0 +1,12 @@ +--- +sidebar_position: 5 +description: "详细了解增强 Spine 的实现方式。" +--- + +# 增强 Spine + +:::caution TODO + +施工中... + +::: diff --git a/docs/versioned_docs/version-1.0.0/theory-guide/theory-guide-intro.mdx b/docs/versioned_docs/version-1.0.0/theory-guide/theory-guide-intro.mdx new file mode 100644 index 00000000..d7f7adac --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/theory-guide/theory-guide-intro.mdx @@ -0,0 +1,10 @@ +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + +# 原理文档 + +:::caution TODO + +施工中... + +::: diff --git a/docs/versioned_docs/version-1.0.0/uninstall-guide.md b/docs/versioned_docs/version-1.0.0/uninstall-guide.md new file mode 100644 index 00000000..be62e2be --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/uninstall-guide.md @@ -0,0 +1,45 @@ +--- +sidebar_position: 6 +--- + +# 卸载指南 + +服务包不会对项目进行修改，但就像要将引擎降级一样，这种操作还是有风险的，所以我们提供两种卸载方式以供参考： + +:::tip 提示 + +因为原理是一样的，即使是手动安装的服务包，依然可以通过引擎扩展进行卸载，反之亦然。 + +::: + +--- +## 使用引擎扩展卸载 + +请参考 [手动卸载](#手动卸载) 中提到的 **解除代码依赖与资源依赖**，确保项目不再依赖任何服务包的特性之后再卸载。 + +在 Cocos Creator 的菜单栏依次点击 **扩展 - 服务包管理 - 卸载服务包** 即可。 + +![plugin-uninstall](./assets/plugin-uninstall.png) + +之后重启即可生效。 + +--- +## 手动卸载 + +### 1.代码依赖 + +如果你的是 TypeScript 项目，则可以先删除 `creator-sp.d.ts` 文件，让 TypeScript 对使用了服务包接口的代码发出报错。 + +之后我们要确保所有代码都不再依赖服务包的特性。 + +### 2.资源依赖 + +服务包提供了一些内置资源，像是多纹理 Effect 着色器资源，你可以通过查找 UUID 引用将对服务包内置资源的引用全部移除。 + +### 3.恢复自定义引擎与删除扩展 + +打开 Cocos Creator 菜单的项目 - 项目设置 - 自定义引擎，勾选使用内置引擎。 + +点击 Cocos Creator 主界面右上角的 **编辑器** 按钮，进入到编辑器的资源目录。 + +然后使用未修改过的 `jsb-adapter` 替换掉编辑器的 `Resources/builtin/jsb-adapter` 目录，最后将服务包的引擎扩展（比如 `service-pack-support` 目录）删除。 diff --git a/docs/versioned_docs/version-1.0.0/update-log.md b/docs/versioned_docs/version-1.0.0/update-log.md new file mode 100644 index 00000000..ed454673 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/update-log.md @@ -0,0 +1,22 @@ +--- +sidebar_position: 7 +--- + +# 更新日志 + +--- +## Service Pack v1.0.0 + +适配 Cocos Creator v2.4.9 版本，[点此下载服务包](https://github.com/smallmain/cocos-service-pack/releases/tag/v1.0.0) + +- **[新特性] 支持多纹理渲染** +- **[新特性] 重构动态图集，支持多个新特性** +- **[新特性] 重构 cc.Label 的 Char 缓存模式，支持多个新特性** +- **[新特性] 支持高 DPI 文本渲染** +- **[新特性] Spine 组件支持参与动态图集、与其它组件合批、使用 SpriteFrame 换装** +- [新特性] cc.Label、cc.RichText、cc.Sprite、cc.MotionStreak、Spine 组件支持使用多纹理材质，并支持自动切换材质机制 +- [新特性] cc.RichText 支持使用自定义材质 +- [修复] 直接修改 Effect 的属性不回导致其变体的 hash 值刷新 +- [修复] CHAR 缓存模式 hash 计算可能会有重复的问题 +- [调整] 默认禁用 Label 原生 TTF 渲染器 + diff --git a/docs/versioned_docs/version-1.0.0/user-guide/_category_.json b/docs/versioned_docs/version-1.0.0/user-guide/_category_.json new file mode 100644 index 00000000..d44dd7f3 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "使用指南", + "position": 4, + "collapsed": false, + "link": { + "type": "doc", + "id": "user-guide-intro" + } +} diff --git a/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/_category_.json b/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/_category_.json new file mode 100644 index 00000000..e49d9902 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "动态合图", + "position": 3, + "collapsed": true, + "link": { + "type": "doc", + "id": "dynamic-batcher-intro" + } +} diff --git a/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/assets/7.png b/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/assets/7.png new file mode 100644 index 00000000..2f8317bf Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/assets/7.png differ diff --git a/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/assets/dynamic-batch-settings.png b/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/assets/dynamic-batch-settings.png new file mode 100644 index 00000000..82996c53 Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/assets/dynamic-batch-settings.png differ diff --git a/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/dynamic-batcher-basics.md b/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/dynamic-batcher-basics.md new file mode 100644 index 00000000..1970c55f --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/dynamic-batcher-basics.md @@ -0,0 +1,99 @@ +--- +sidebar_position: 1 +description: "了解调校动态合图的方式。" +--- +# 调整合图设置 + +--- +## 动态图集最大数量为什么是 7 + +在前面的文档中有提到动态图集的最大数量默认为 **设备能同时采样纹理数 - Char 缓存模式自动合批图集数**。 + +因为设备能同时采样纹理数固定为 `8`，而 Char 缓存模式自动合批图集数默认为 `1`，所以动态合图的最大数量默认值为 `7`。 + +这样就只需要使用 1 个材质，也就是能在 1 Draw Call 里完成所有参与动态合图的纹理（包括 Bitmap 缓存模式 Label）与 Char 缓存模式 Label 的渲染。 + +一般情况下不推荐直接修改 `maxAtlasCount`，请参考 [新的 Char 缓存模式](../text-render/text-char-mode.md#与动态图集合批的注意事项) 文档。 + +> 难道真正的原因是... +> +> ![7的意志](./assets/7.png) + +--- +## 控制纹理是否参与动态合图 + +可以在编辑器上调整纹理的 `packable` 属性，或者用代码控制： + +```js +texture.packable = false; +``` + +--- +## 控制组件是否参与动态合图 + +使用下面的代码控制组件是否默认激活动态合图机制，默认为开启： + +```js +cc.sp.allowDynamicAtlas = false; +``` + +也可以控制单组件是否激活动态合图机制： + +![dynamic-batch-settings](./assets/dynamic-batch-settings.png) + +除了在编辑器调整，也可以通过代码控制： + +```js +// cc.RenderComponent.EnableType +// GLOBAL: 全局默认值 +// ENABLE: 开启 +// DISABLE: 关闭 +label.allowDynamicAtlas = cc.RenderComponent.EnableType.ENABLE; +``` + +如果一个纹理参与动态合图但是组件不参与，那么使用该组件进行渲染时就不会参与，但如果同时在其它参与的组件上渲染，那么依然会被打入动态图集。 + +:::caution 注意 + +组件有脏检查标记，修改后可能需要对渲染组件调用 `comp.setVertsDirty()` 才会生效。 + +::: + +--- +## 是否自动多纹理合批 + +控制图集纹理是否会自动添加到多纹理合批管理器，默认为开启状态，如果关闭也就意味着**失去了自动进行多个图集纹理合批的特性**。 + +```js +cc.dynamicAtlasManager.autoMultiBatch = false; +``` + +--- +## 在场景切换时清空所有图集 + +控制在场景切换时是否会清空所有的动态图集，默认为开启状态。 + +```js +cc.dynamicAtlasManager.autoResetBeforeSceneLoad = false; +``` + +:::tip 提示 + +在引擎原来的设计中，该机制不可被关闭，由于旧动态合图不支持复用废弃的空间，图集终究会被用完，所以引擎加入了这个治标不治本的功能。 + +但现在，我们认为该机制可以关闭，你只需要管理好纹理资源的释放即可，因为纹理资源释放的同时会释放使用的动态图集空间。 + +::: + +--- +## 不进行复用的区域空间大小 + +在实际的测试中，我们发现废弃空间出现碎片化的现象，比如尺寸 5 * 2 这样的非常小的废弃空间，当碎图尝试加入图集的时候会在这些废弃空间中寻找，这些数量多的小废弃空间无法被复用，却要在每次加入时遍历判断一次。 + +所以我们加入了 `ignoreRectSize` 设置，当废弃空间尺寸小于这个值就不会被遍历到（但是能合并为大的废弃空间时还是会合并），这能提升大约 50% 的理论性能。 + +这个值默认为 `10`，如果你的项目有很多小于 10 * 10 的纹理，可以考虑进行调整： + +```js +cc.dynamicAtlasManager.Atlas.ignoreRectSize = 2; +``` diff --git a/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/dynamic-batcher-intro.mdx b/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/dynamic-batcher-intro.mdx new file mode 100644 index 00000000..189dfae1 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/dynamic-batcher-intro.mdx @@ -0,0 +1,10 @@ +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + +# 动态合图 + +动态合图是一个非常好的合批手段，但是在之前引擎实现的比较简陋，所以服务包重构了动态合图系统，在原有功能基础上增加了许多重要特性。 + +比如支持复用废弃碎图空间，优化了图集装箱算法，所有图集作为一个整体进行管理等等，你可以阅读下面的文档了解详情： + + diff --git a/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/dynamic-batcher-manual.md b/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/dynamic-batcher-manual.md new file mode 100644 index 00000000..3e63d189 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/dynamic-batcher/dynamic-batcher-manual.md @@ -0,0 +1,59 @@ +--- +sidebar_position: 2 +description: "随心所欲地控制动态合图的使用。" +--- + +# 手动管理合图 + +有时候你可能需要更细致地去控制哪些纹理加入动态图集，考虑到这一点，服务包在保留原来所有接口的基础上完全开放了动态图集相关的所有接口。 + +--- +## 访问图集数组与已用空间集合 + +你可以通过 + +```js +cc.dynamicAtlasManager.atlases +``` + +和 + +```js +cc.dynamicAtlasManager.rects +``` + +分别访问到图集数组与所有图集的已用空间集合。 + +--- +## 添加 SpriteFrame 到动态图集 + +```js +cc.dynamicAtlasManager.insertSpriteFrame(spriteFrame); +``` + +可以将 SpriteFrame 所使用的纹理添加到动态图集，这是引擎原有接口，但服务包对其做了一点修改，这个接口不再会检查纹理的 `packable` 属性，也就是变成了一个强制添加的接口。 + +这样设计的原因是你可以将所有纹理的 `packable` 都设为 `false`，或者直接将 `maxFrameSize` 设为 `0`，然后完全手动地进行动态合图。 + +--- +## 从动态图集删除 SpriteFrame + +```js +cc.dynamicAtlasManager.deleteSpriteFrame(spriteFrame); +``` + +可以使 SpriteFrame 取消使用动态图集纹理，这不一定会将 SpriteFrame 的纹理从动态图集删除，因为可能还会有其它 SpriteFrame 在使用，只有没有 SpriteFrame 在使用时才会删除纹理。 + +--- +## 从动态图集删除 Texture + +```js +cc.dynamicAtlasManager.deleteTexture(texture); +``` + +这个接口与 `deleteSpriteFrame` 相似，但是它会直接删除纹理，并且会使使用该纹理的 SpriteFrame 全部恢复。 + +--- +## 更多接口 + +虽然还暴露了其它接口出来，但因为太过于底层所以不推荐使用，如果你想了解可以阅读原理文档。 diff --git a/docs/versioned_docs/version-1.0.0/user-guide/multi-render/_category_.json b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/_category_.json new file mode 100644 index 00000000..3582acce --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "多纹理渲染", + "position": 1, + "collapsed": true, + "link": { + "type": "doc", + "id": "multi-render-intro" + } +} diff --git a/docs/versioned_docs/version-1.0.0/user-guide/multi-render/assets/autoswitch-settings.png b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/assets/autoswitch-settings.png new file mode 100644 index 00000000..e12e8e7b Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/assets/autoswitch-settings.png differ diff --git a/docs/versioned_docs/version-1.0.0/user-guide/multi-render/assets/material-comp.png b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/assets/material-comp.png new file mode 100644 index 00000000..6e86fbea Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/assets/material-comp.png differ diff --git a/docs/versioned_docs/version-1.0.0/user-guide/multi-render/assets/material-final.png b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/assets/material-final.png new file mode 100644 index 00000000..30865949 Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/assets/material-final.png differ diff --git a/docs/versioned_docs/version-1.0.0/user-guide/multi-render/assets/material-settings.png b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/assets/material-settings.png new file mode 100644 index 00000000..c1efc426 Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/assets/material-settings.png differ diff --git a/docs/versioned_docs/version-1.0.0/user-guide/multi-render/multi-batcher.md b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/multi-batcher.md new file mode 100644 index 00000000..c9002457 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/multi-batcher.md @@ -0,0 +1,125 @@ +--- +sidebar_position: 2 +description: "了解如何手动进行多纹理合批。" +--- + +# 多纹理合批 + +在 [新 UI 渲染批次合并指南](../../start-guide/batcher-guide.md#充分利用动态合图) 中提到了动态合图与多纹理渲染结合后，能让多张图集纹理在同一批次渲染。 + +如果你阅读过 [多纹理材质](./multi-material.md) 文档的话，肯定知道能使用 `MultiHandler` 的接口来动态设置材质的纹理插槽来实现。 + +但是这种完全手动的方式实现起来比较麻烦，比如你需要使用一个纹理时，还得找到该纹理所在的材质并设置到渲染组件上。 + +为了能更方便地进行多纹理合批，服务包封装了一个自动切换多纹理材质的机制与多纹理合批管理类 `cc.sp.MultiBatcher`。 + +动态图集与字符图集使用的是一个全局的多纹理合批管理器实例，可以通过 `cc.sp.multiBatcher` 访问。 + +--- +## 开关自动切换多纹理材质 + +要让动态合图自动进行多纹理合批，首先要解决设置材质的问题，当切换成动态图集的纹理时，需要自动将组件的材质设置为有动态图集纹理的材质。 + +所以我们增加了一个机制，在支持的组件内使用开启了该机制的纹理进行渲染时，会提前切换为该纹理关联的材质（只要支持多纹理渲染就支持自动切换材质）。 + +这个机制默认是开启的，可以通过全局开关来控制默认值： + +```js +cc.sp.autoSwitchMaterial = false; +``` + +默认情况下组件会使用全局值，你可以控制单个组件是否强制启用/禁用该机制： + +![autoswitchsettings](./assets/autoswitch-settings.png) + +除了在编辑器调整，也可以通过代码控制： + +```js +// cc.RenderComponent.EnableType +// GLOBAL: 全局默认值 +// ENABLE: 开启 +// DISABLE: 关闭 +sprite.autoSwitchMaterial = cc.RenderComponent.EnableType.ENABLE; +``` + +:::caution 注意 + +组件有脏检查标记，如果修改全局开关或者修改纹理关联的材质，需要对所有使用该纹理的渲染组件调用 `comp.setVertsDirty()` 重新检查。 + +::: + +:::caution 特别注意 + +如果 Spine 组件所使用的 `SkeletonData` 同时使用了多个纹理，那么只会遍历数据以找到的第一个纹理为主执行自动切换机制。 + +::: + +--- +## 设置纹理的关联材质 + +:::info + +每个纹理只能关联一个材质，如果同一个纹理，不同的渲染组件需要使用不同材质就需要手动设置。 + +::: + +关联材质的接口有两种用法： + +```js +const bool = texture.linkMaterial(material); +const bool = texture.linkMaterial(material, index); +``` + +第一句代码会自动将纹理设置到材质的空插槽中，然后将该材质设置为该纹理的关联材质，如果没有空插槽会返回 `false`。 + +第二句则是强制将纹理设置到指定的插槽中，并将该材质设置为该纹理的关联材质。 + +想要解除两者的关联可以使用： + +```js +texture.unlinkMaterial(); +``` + +获取关联的材质可以使用： + +```js +const material = texture.getLinkedMaterial(); +``` + +--- +## 多纹理合批管理器 + +手动关联材质就意味着你需要手动创建并管理创建的所有材质，如果是大量纹理需要关联材质就会比较麻烦。 + +所以我们封装了一个小巧的多纹理合批管理器 `cc.sp.MultiBatcher`。 + +这个管理器有点像动态合图管理器，它会持有一个材质数组，初始化后会使用内置的多纹理 Effect 着色器创建一个材质并放在数组中。 + +你可以传给管理器一个纹理，它会查找所有材质的空插槽，如果没有材质有空插槽则会创建一个新材质，然后把纹理与材质关联。 + +### 如何使用 + +创建管理器并初始化可以使用： + +```js +const batcher = new cc.sp.MultiBatcher(); +batcher.init(); +``` + +传入纹理可以使用： + +```js +const material = batcher.requsetMaterial(texture); +``` + +会返回关联的材质，如果纹理本来就已经有关联的材质，则会直接返回已关联的材质。 + +清空内部数组可以使用（这不会取消纹理的关联）： + +```js +batcher.reset(); +``` + +### 它的用途 + +在 [进阶合批指南](../../start-guide/advance-batcher-guide.md) 中有提供一些常见的使用案例。 diff --git a/docs/versioned_docs/version-1.0.0/user-guide/multi-render/multi-material.md b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/multi-material.md new file mode 100644 index 00000000..bc63f7fe --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/multi-material.md @@ -0,0 +1,137 @@ +--- +sidebar_position: 1 +description: "了解如何手动管理多纹理材质。" +toc_max_heading_level: 5 +--- + +# 多纹理材质 + +服务包在引擎内置了可以直接使用的多纹理 Effect 着色器资源，并且你可以直接使用多纹理材质而不需要编写任何代码。 + +--- +## 创建多纹理材质 + +你可以正常创建一个材质文件，Effect 选择内置的多纹理 Effect 着色器 `multi-2d-universal` 即可。 + +![material-settings](./assets/material-settings.png) + +勾选 `USE_MULTI_TEXTURE` 后可以看到上面有 `texture` - `texture8` 一共 8 个纹理插槽，将需要使用的纹理拖到上面的插槽即可完成多纹理材质的配置。 + +--- +## 在组件中使用多纹理材质 + +直接拖到组件的 `Materials` 属性上即可。 + +![material-comp](./assets/material-comp.png) + +注意上图中已经在 `cc.Sprite` 组件拖入了刚刚创建的多纹理材质，并且其 `SpriteFrame` 属性设置的是材质中 `texture3` 插槽中的纹理。 + +![material-final](./assets/material-final.png) + +你不需要指定组件要使用的纹理插槽 id，组件内部在渲染前会自动查找纹理在材质中的 id。 + +:::caution 警告 + +如果组件使用的纹理在材质中找不到，为了保证渲染的正常（毕竟性能只是锦上添花）会在组件的材质变体中将纹理设置到 `texture` 插槽中。 + +这会导致这个组件的多纹理材质变体之后都不能按预期进行合批，就像 “退化” 成了普通材质。 + +所以使用时必须要确保纹理在材质中，假如材质变体已经 “退化” 了，那你可以通过重新设置材质的方式使组件持有一个新的材质变体。 + +::: + +:::caution 特别注意 + +Spine 组件使用多纹理材质时会强制勾选 `enableBatch`，因为不开启就不能合批，那也就没必要使用多纹理材质。 + +::: + +--- +## 自定义多纹理材质 + +上面介绍的多纹理材质都是使用的内置的多纹理 Effect 着色器，你可以直接在内置多纹理 Effect 着色器的基础上修改。 + +除了直接在内置着色器的基础上修改之外，任何着色器中如果存在一个宏 `USE_MULTI_TEXTURE = true`，则会被认为是多纹理材质。 + +[演示项目](https://smallmain.github.io/cocos-service-pack/demo/v1.0.0/web-desktop/index.html) 中有自定义材质的示范代码。 + +:::tip 提示 + +是否为多纹理材质的判断逻辑流程： + +1. 获取材质当前使用的 Technique 中的第一个 Pass +2. 判断这个 Pass 是否 `USE_MULTI_TEXTURE = true` +3. 是的话，这个材质即为多纹理材质 + +在某些情况下通过代码修改材质可能需要调用 `material.updateMultiSupport()` 来触发这个流程。 + +::: + +--- +## 通过代码设置纹理插槽 + +每个多纹理材质都对应着一个多纹理材质管理器，这是服务包新增的一个工具类，其主要用处是便捷、高性能地管理多纹理材质上面的纹理插槽。 + +通过 `material.getMultiHandler()` 可以获取到管理器实例，请使用这个实例来操作多纹理材质的纹理插槽。 + +比如： + +```js +// 获取管理器实例 +const handler = material.getMultiHandler(); + +// 设置 `texture` 纹理插槽 +handler.setTexture(0, texture); + +// 置空 `texture2` 纹理插槽 +handler.setTexture(1, null); + +// 直接移除指定纹理 +handler.removeTexture(texture.getImpl()); + +// 将纹理自动设置到材质的空插槽 +handler.autoSetTexture(texture); +``` + +从上面的代码中可以看出操作纹理插槽的时候并不是传入插槽的名称，而是需要提供下标。 + +下标 `0` - `7` 分别对应着名称为 `texture` - `texture8` 的插槽。 + +可以使用这两个函数进行转换： + +```js +// index to name +cc.sp.propertyIndex2Name(0); // return: "texture" + +// name to index +cc.sp.propertyName2Index("texture"); // return: 0 +``` + +:::caution 注意 + +注意区分材质 `cc.Material` 与材质变体 `cc.MaterialVariant`。 + +::: + +:::caution 警告 + +请勿直接通过材质原始的 `setProperty` 接口修改多纹理材质的纹理插槽。 + +如果你必须这么做，需要调用 `material.getMultiHandler().syncTextures()` 来同步插槽数据到 `MultiHandler` 上。 + +::: + +--- +## 强制设置材质的类型 + +如果你想将某个材质强制视为多纹理材质或非多纹理材质，可以： + +```js +// 视为多纹理材质 +material.setMultiSupport(true); + +// 视为非多纹理材质 +material.setMultiSupport(false); +``` + +没有特殊情况不需要这么做。 diff --git a/docs/versioned_docs/version-1.0.0/user-guide/multi-render/multi-render-intro.mdx b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/multi-render-intro.mdx new file mode 100644 index 00000000..d72345e8 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/multi-render/multi-render-intro.mdx @@ -0,0 +1,30 @@ +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + +# 多纹理渲染 + +:::tip 提示 + +多纹理渲染属底层设施，如果你不是准备手动使用多纹理材质或者多纹理合批管理器的话，请跳过本特性文档。 + +::: + +多纹理渲染在 [新 UI 渲染批次合并指南](../../start-guide/batcher-guide.md#什么是多纹理渲染) 中有所介绍。 + +其原理非常简单，并且为了让它能以最简单的方式在引擎中使用，已经在内部做好了封装： + + + +:::caution 注意 + +- **支持的渲染组件** + + cc.Sprite、cc.Label、cc.RichText、cc.MotionSteak、Spine 组件。 + +- **不支持的渲染组件** + + cc.ParticleSystem、TiledMap 组件：这两个组件当前的引擎实现会强制打断合批，暂时不支持。 + + DragonBones 组件：因人力有限，并且这个组件与 Spine 组件可以相互代替，所以暂时不支持该组件。 + +::: diff --git a/docs/versioned_docs/version-1.0.0/user-guide/spine/_category_.json b/docs/versioned_docs/version-1.0.0/user-guide/spine/_category_.json new file mode 100644 index 00000000..3dc6c21d --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/spine/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "Spine", + "position": 4, + "collapsed": true, + "link": { + "type": "doc", + "id": "spine-intro" + } +} diff --git a/docs/versioned_docs/version-1.0.0/user-guide/spine/spine-batch.md b/docs/versioned_docs/version-1.0.0/user-guide/spine/spine-batch.md new file mode 100644 index 00000000..0946bb9a --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/spine/spine-batch.md @@ -0,0 +1,14 @@ +--- +sidebar_position: 2 +description: "像其它渲染组件一样在 Spine 组件上使用动态合图。" +--- + +# 动态合图 + +你可以像其它渲染组件一样在 Spine 组件上使用动态合图，如果想了解有关动态合图的更多详情，可以阅读 [动态合图](../dynamic-batcher/dynamic-batcher-intro.mdx) 文档。 + +:::caution 注意 + +由于引擎实现差异，在原生平台上 Spine 暂不支持与其它组件合批。 + +::: diff --git a/docs/versioned_docs/version-1.0.0/user-guide/spine/spine-intro.mdx b/docs/versioned_docs/version-1.0.0/user-guide/spine/spine-intro.mdx new file mode 100644 index 00000000..ef612831 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/spine/spine-intro.mdx @@ -0,0 +1,22 @@ +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + +# Spine + +服务包解决了 Spine 在 Cocos Creator 中的三大痛点： + +- 不参与动态合图 +- 无法与其它组件合批 +- 不能使用 SpriteFrame 换装 + +你可以阅读下面的文档了解详情： + + + +:::caution 注意 + +由于引擎这部分的 C++ 实现与 JavaScript 实现在一些细节上不太一样，比如一些内部函数的执行时机。 + +所以当你在 Web 平台上测试得出的一些结论请不要想当然地以为在原生平台上也一样，具体实现差异请阅读 Spine 的原理文档。 + +::: diff --git a/docs/versioned_docs/version-1.0.0/user-guide/spine/spine-skin.md b/docs/versioned_docs/version-1.0.0/user-guide/spine/spine-skin.md new file mode 100644 index 00000000..103d9040 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/spine/spine-skin.md @@ -0,0 +1,91 @@ +--- +sidebar_position: 2 +description: "随心所欲地更换 Spine 动画的部份纹理。" +--- + +# SpriteFrame 换装 + +引擎提供了一个替换插槽的 attachment 对象进行换装的方法，可以在 [Spine 组件参考](https://docs.cocos.com/creator/2.4/manual/zh/components/spine.html) 官方文档进行了解。 + +但是使用替换插槽的 attachment 对象这种方法比较绕，并且 Spine 动画中有切换 attachment 的关键帧时这种方法就没用了。 + +而 attachment 对象持有一个 region 对象，这个对象类似引擎的 SpriteFrame，所以我们可以通过修改 region 对象的数据来进行换装。 + +--- +## 认识 RegionData + +请勿混淆 RegionData 与 region，RegionData 主要作为 SpriteFrame 和 region 对象之间的桥梁，实现两者的相互转换。 + +将 SpriteFrame 转换为 RegionData： + +```js +const regionData = new sp.RegionData(spriteFrame); +``` + +将 RegionData 转换为 SpriteFrame： + +```js +const spriteFrame = regionData.toSpriteFrame(); +``` + +将 attachment 对象的 region 数据转换为 RegionData ： + +```js +const regionData = new sp.RegionData(attachment); +``` + +将 RegionData 数据更新到 attachment 对象上： + +```js +regionData.assignToAttachment(attachment); +``` + +:::caution 注意 + +Spine 的 Region 支持 `0`、`90`、`180`、`270` 四种旋转角度，而 Cocos Creator 的 SpriteFrame 只支持 `0` 与 `270` 两种旋转角度，所以如果是 RegionData 转为 SpriteFrame 则可能导致方向不同的问题。 + +**要进行换装的话使用的是 SpriteFrame 转为 RegionData，所以不用担心这个问题。** + +::: + +--- +## 使用 SpriteFrame 修改 Region 数据 + +虽然使用上面的 RegionData 即可实现使用 SpriteFrame 换装的需求，但我们还在 Spine 组件上提供了两个更方便的接口： + +只使用 `regionData.assignToAttachment(attachment)` 只会修改 SkeletonData 的数据，但不会触发 Spine 组件的渲染更新。 + +推荐直接使用： + +```js +skeletonComponent.setRegionData('Head', 'Head', new sp.RegionData(spriteFrame)); +``` + +在修改的同时刷新组件的渲染实现换装，并且不会打断当前正在播放的动画。 + +还提供了一个通过 attachment 名称获取 RegionData 的接口： + +```js +a.getRegion(slotName, attachmentName); +``` + +--- +## 注意事项 + + +### 多实例问题 + +由于是直接修改 Spine 组件所使用 SkeletonData 的 attachment 数据，所以所有 Spine 组件都会受到影响。 + +如果你只想替换其中一个组件，那么就可以克隆这个 SkeletonData 让每个组件都使用不同的 SkeletonData 实例进行渲染。 + +服务包提供了一个克隆数据的接口来实现这个需求： + +```js +const clonedSkeletonData = skeletonData.clone(); +``` + +使用以上代码克隆 SkeletonData 后再进行换装，赋值给 Spine 组件，那么替换操作就只会对这个 Spine 组件生效。 + +--- +以上所有用法你可以在 [演示项目](https://smallmain.github.io/cocos-service-pack/demo/v1.0.0/web-desktop/index.html) 中找到示范代码。 diff --git a/docs/versioned_docs/version-1.0.0/user-guide/text-render/_category_.json b/docs/versioned_docs/version-1.0.0/user-guide/text-render/_category_.json new file mode 100644 index 00000000..667abadd --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/text-render/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "文本渲染", + "position": 2, + "collapsed": true, + "link": { + "type": "doc", + "id": "text-render-intro" + } +} diff --git a/docs/versioned_docs/version-1.0.0/user-guide/text-render/assets/reina-settings.png b/docs/versioned_docs/version-1.0.0/user-guide/text-render/assets/reina-settings.png new file mode 100644 index 00000000..0ad9a25d Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/user-guide/text-render/assets/reina-settings.png differ diff --git a/docs/versioned_docs/version-1.0.0/user-guide/text-render/assets/richtext-settings.png b/docs/versioned_docs/version-1.0.0/user-guide/text-render/assets/richtext-settings.png new file mode 100644 index 00000000..22019953 Binary files /dev/null and b/docs/versioned_docs/version-1.0.0/user-guide/text-render/assets/richtext-settings.png differ diff --git a/docs/versioned_docs/version-1.0.0/user-guide/text-render/text-char-mode.md b/docs/versioned_docs/version-1.0.0/user-guide/text-render/text-char-mode.md new file mode 100644 index 00000000..69952776 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/text-render/text-char-mode.md @@ -0,0 +1,106 @@ +--- +sidebar_position: 1 +description: "详细了解该缓存模式重构后的所有新特性。" +--- +# 新的 Char 缓存模式 + +在 [新 UI 渲染批次合并指南](../../start-guide/batcher-guide.md#充分利用动态合图) 中提到 Bitmap 与 Char 缓存模式都支持了废弃字符空间复用的特性，但 Char 缓存模式的内部变化比较大，并且提供了一些可调整的设置项，使用上依旧只需要设置缓存模式即可。 + +--- +## 在场景切换时清空所有字符图集 + +控制在场景切换时是否会清空所有的字符图集，默认为开启状态。 + +```js +cc.sp.charAtlasAutoResetBeforeSceneLoad = false; +``` + +:::tip 提示 + +在引擎原来的设计中，该机制不可被关闭，由于旧 Char 缓存模式不支持复用废弃的空间，图集终究会被用完，所以引擎加入了这个治标不治本的功能。 + +现在推荐关闭该机制，除非你知道你需要。 + +::: + +--- +## 字符图集的数量与内置材质 + +现在在内部最多会创建 8 张字符图集，与多纹理材质的最大纹理插槽数一致，如果合理使用缓存模式，8 张应该对所有项目都是足够的。 + +在这种情况下，可能发生的事是 Char 缓存模式的组件使用了一个普通材质，这个材质只能使用第一张字符图集进行渲染，那么就会导致其他图集上的字就无法渲染出来了。 + +为了解决这个问题，Char 缓存模式会在内部维护一个使用内置多纹理 Effect 着色器的材质，如果你有特殊的用途，可以通过 + +```js +const material = cc.Label._shareAtlas.material; +``` + +获取、修改或替换该材质。 + +渲染时内部会先判断当前所使用的是否为多纹理材质，是的话判断是否能在材质纹理插槽中找到字符图集纹理，如果有一个判断不满足则会将组件的材质设为内部维护的材质。 + +但 Char 字符图集是运行时才创建的，所以**暂时无法在使用 Char 缓存模式时直接设置自定义材质**。 + +你可以通过代码创建含有当前所有字符图集纹理的自定义材质来解决这个问题，但内部会不断创建新的字符图集（直到 8 张），所以需注意同步更新这个自定义材质，建议有自定义材质需求时使用 Bitmap 缓存模式。 + +--- +## 与动态图集合批的注意事项 + +多纹理材质只有 8 个纹理插槽，默认情况下字符图集自动多纹理合批的数量为 1，也就是说会将第 1 张字符图集纹理放入材质。 + +**你可以自己调整这个分配值，但请注意调整的时机。** + +下面举一个例子，假设有一个脚本 `example.ts` 的部分内容是： + +```js + +class Example extends cc.Component { + + onLoad() { + // 1 + } + +} + +// 2 + +``` + +一般情况下，代码位置 2 是当用户脚本被加载时就会被执行，而代码位置 1 可能需要等到引擎首场景加载后的某个时间执行。 + +服务包会自动调整动态图集的最大数量，这个调整的时机是在代码位置 2 之后的，所以比如你的项目对 Char 缓存模式使用量比较大时，想尝试将动态图集最大数量调整为 6，自动合批的字符图集数量调整为 2，那么你只需要在代码位置 2 修改字符图集自动多纹理合批的数量： + +```js +cc.sp.charAtlasAutoBatchCount = 2; +``` + +之后服务包会自动将动态图集的最大数量调整为 `8 - 2`，即 6。 + +这个自动调整的时机并不意味着你在代码位置 2 修改动态图集的最大数量是无效的，因为一开始动态图集的最大数量为 `-1`，你打印一下可以看到 + +```js +console.log(cc.dynamicAtlasManager.maxAtlasCount); // -1 +``` + +如果你在代码位置 2 修改了动态图集的最大数量，服务包就不会调整该值了。 + +```js +cc.dynamicAtlasManager.maxAtlasCount = 5; +``` + +这时候动态图集的最大数量是 5，字符图集自动多纹理合批的数量依旧默认为 1，多纹理材质会有 2 个空纹理插槽。 + +如果这两个数量加起来超过 8 就会使用更多的材质进行渲染，这会导致项目的 Draw Call 数量升高，建议保持加起来的数量不超过 8 张，能保持 1 Draw Call。 + +```js +cc.dynamicAtlasManager.maxAtlasCount = 13; +cc.sp.charAtlasAutoBatchCount = 3; +``` + +比如上面这个设置，这会使得引擎需要用 2 个材质进行渲染，但是可用的动态图集扩充到了 13 张，Char 能自动合批的图集数量扩充到了 3 张，对于某些项目来说可能并不是一件坏事。 + +服务包使用这个 “7 + 1” 的默认值有以下几点原因： + +- 引擎原本就只有 1 张 Char 字符图集 +- 大多数项目使用 1 张 Char 字符图集是足够的 diff --git a/docs/versioned_docs/version-1.0.0/user-guide/text-render/text-high-dpi.md b/docs/versioned_docs/version-1.0.0/user-guide/text-render/text-high-dpi.md new file mode 100644 index 00000000..79f3f16c --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/text-render/text-high-dpi.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 2 +description: "一行代码开启高清文本渲染。" +--- +# 高 DPI 支持 + +可阅读 [上手其它新特性](../../start-guide/new-features.md#高-dpi-文本渲染) 了解基本的使用方法，除了注意性能以外，没有其它的注意事项。 + +--- +## 调整全局开关 + +使用下面的代码控制组件是否默认开启高 DPI 支持： + +```js +cc.sp.enableLabelRetina = false; +``` + +--- +## 调整渲染缩放比例 + +使用下面的代码调整内部渲染的缩放倍数： + +```js +cc.sp.labelRetinaScale = 2; +``` + +--- +## 控制单个组件开关 + +![reinasettings](./assets/reina-settings.png) + +除了在编辑器调整，也可以通过代码控制： + +```js +// cc.RenderComponent.EnableType +// GLOBAL: 全局默认值 +// ENABLE: 开启 +// DISABLE: 关闭 +label.enableRetina = cc.RenderComponent.EnableType.ENABLE; +``` diff --git a/docs/versioned_docs/version-1.0.0/user-guide/text-render/text-render-intro.mdx b/docs/versioned_docs/version-1.0.0/user-guide/text-render/text-render-intro.mdx new file mode 100644 index 00000000..8b54d876 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/text-render/text-render-intro.mdx @@ -0,0 +1,8 @@ +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + +# 文本渲染 + +文本渲染一般是游戏性能优化需要重点关注的地方，并且其显示效果也非常重要，所以服务包提供了以下新特性： + + diff --git a/docs/versioned_docs/version-1.0.0/user-guide/text-render/text-richtext.md b/docs/versioned_docs/version-1.0.0/user-guide/text-render/text-richtext.md new file mode 100644 index 00000000..568d662d --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/text-render/text-richtext.md @@ -0,0 +1,9 @@ +--- +sidebar_position: 3 +description: "就像在其它组件里一样使用自定义材质。" +--- +# RichText 自定义材质 + +![richtextsettings](./assets/richtext-settings.png) + +像往常一样使用即可。 diff --git a/docs/versioned_docs/version-1.0.0/user-guide/user-guide-intro.mdx b/docs/versioned_docs/version-1.0.0/user-guide/user-guide-intro.mdx new file mode 100644 index 00000000..0047e7d5 --- /dev/null +++ b/docs/versioned_docs/version-1.0.0/user-guide/user-guide-intro.mdx @@ -0,0 +1,16 @@ +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + +# 使用指南 + +在 [入门教程](../start-guide/start-guide-intro.mdx) 里，你应该对如何更好地使用安装服务包后的引擎已经有所了解了。 + +通过该指南你可以更详细地了解服务包为引擎添加的每个特性与改动： + + + +:::caution 注意 + +在几乎所有平台上引擎都是使用 WebGL 渲染模式，所以服务包的大部分特性都未支持引擎的 Canvas 渲染模式，部分特性在 3D 节点下不生效。 + +::: diff --git a/docs/versioned_sidebars/version-1.0.0-sidebars.json b/docs/versioned_sidebars/version-1.0.0-sidebars.json new file mode 100644 index 00000000..caea0c03 --- /dev/null +++ b/docs/versioned_sidebars/version-1.0.0-sidebars.json @@ -0,0 +1,8 @@ +{ + "tutorialSidebar": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} diff --git a/docs/versions.json b/docs/versions.json new file mode 100644 index 00000000..5e1abcd8 --- /dev/null +++ b/docs/versions.json @@ -0,0 +1,3 @@ +[ + "1.0.0" +]