白鹭引擎(Egret Engine)

　　白鹭引擎(Egret Engine)是一款顾名思义就是一款引擎软件，不一样的是，它还是一款游戏框架；该程序的开发严格遵循HTML5标准，在此基础上开发出2D引擎以及成功全新打造出完美的3D引擎，在游戏框架领域，程序依旧以最主流的设计思路研发，一举成就了现在最新的白鹭引擎；用户可以使用该程序应用于构建二维游戏、支持演示程序和其他图形界面交互应用等；在程序中使用了TypeScript脚本语言开发，可以大大提高用户的开发效率以及开发缩短流程；支持将编辑成型的数据包转换为HTML5游戏，可以实现跨平台推广。强大又实用，需要的用户可以下载体验

软件功能

　　Egret Engine继承了Flash的优点，同时更加针对游戏开发，主要包括如下功能：

　　显示列表：清晰、稳健、高效的视觉抽象结构

　　精灵：一种轻量级显示容器

　　事件机制：提供了一套生成和处理事件消息的标准方法

　　纹理集合：将大量图片汇集为一张纹理图进行处理

　　矢量绘图：封装了方便简单的矢量绘图功能

　　网络加载：封装了常用的网络通讯协议

　　位图字体：可通过位图字体方式显示文本

　　性能监控：可在游戏中快速开启性能监控面板

　　反射：对TypeScript增加了反射机制，方便模块化开发

　　XML处理：提供标准的XML格式解析生成功能

　　骨骼动画：支持业内最优骨骼动画解决方案DragonBones

　　资源加载：提供了整套资源加载方案，优化网络加载功能

　　EUI：提供大量组件，可快速开发游戏中的UI控件

软件特色

　　wing：包括 Egret 项目的任务配置文件和启动配置文件。

　　wingProperties.json：Egret Wing 项目配置文件。

　　bin-debug：项目调试时，所产生的文件存放于此目录。

　　libs：库文件，包括 Egret 核心库和其他扩展库存放于此目录。

　　resource：项目资源文件存放于此目录。

　　scripts：项目构建和发布时需要用到的脚本文件存放在此目录。

　　src：项目代码文件存放于此目录。

　　template：项目模板文件存放于此目录。

　　egretProperties.json：项目的配置文件。

　　index.html：入口文件。

　　manifest.json：网页清单文件。

　　tsconfig.json：typescript 编译配置文件。

　　项目名称

　　当前项目的名称，如 HelloWorld。

　　项目路径

　　该项目所存放的文件路径。

　　项目类型

　　该项目的项目类型，如 Egret 游戏项目 ， Egret EUI 项目。

　　引擎版本

　　当前项目所使用的 Egret 的版本。

　　选择扩展库

　　项目中需要使用的系统库。

　　舞台尺寸

　　默认游戏舞台的高度与宽度，以像素为单位.

　　缩放模式

　　屏幕的适配方式，这里选择showALL模式。旋转方式

　　屏幕的旋转模式，这里选择auto模式。

安装步骤

　　1、需要的用户可以点击本网站提供的下载路径下载得到对应的程序安装包

　　2、通过解压功能将压缩包打开，找到主程序，双击主程序即可进行安装

　　3、弹出程序安装界面，可以点击自定义安装程序，选择程序安装路径

　　4、点击语言选择，可以根据自己最熟悉的语言选择进行安装

　　5、信息选择完成后，可以直接点击立即安装按钮进行程序安装

　　6、等待程序安装进度条加载完成，需要等待一会儿

　　7、程序还在玩命地安装，等待加载到100即可安装完成

　　8、安装完成后，点击立即运行程序即可打开程序

　　9、弹出程序更新信息，用户可以根据自己的需要点击更新

使用说明

　　生命周期在游戏中，用户可以切换应用的前后台。在用户进入后台时，关闭游戏逻辑、渲染逻辑、背景音乐，可以保证更好的用户体验。

　　白鹭引擎从 4.1 版本开始引入生命周期管理器：egret.lifecycle。其代码示例如下：

　　针对不同的游戏运行环境，开发者可以对生命周期管理器进行扩展，以手机QQ举例，其扩展如下：

　　小游戏新手教程开发环境准备

　　Egret Launcher 1.0.32 以上版本（包括 1.0.32）

　　白鹭引擎 5.1.2 以上版本（包括 5.1.2）

　　准备最新版微信开发者工具。下载地址

　　从微信公众平台获取了小游戏的 appid，如您自己没有可以使用官方默认提供测试的 appid

　　创建小游戏

　　使用最新的 Egret Launcher 创建 5.1.2 以上版本的项目，项目名字叫做 “helloworld”。

　　然后在 Egret Launcher 您会看到刚刚创建的项目，点击发布设置:

　　会弹出发布设置面板：

　　其中 AppID 白鹭已经填写了一个默认 AppID，仅用于调试项目。

　　项目名称填写要发布微信小游戏的名字。

　　点击确定按钮后，弹出提示面板（注：只有 Egret Launcher 1.0.37 以上版本会显示“使用微信开发者工具打开”按钮）：

　　点击“使用微信开发者工具打开”按钮，Launcher 会自动打开开发者工具。

　　在 wing 编辑器中，修改 egretProperties.json 配置文件中的 target 对象的 current 属性为 wxgame，然后点击调试按钮，会自动打开 微信开发者工具。

　　开发者也可以使用命令行：

　　发布小游戏 egret publish --target wxgame 命令发布。

　　用微信开发者工具打开 egret run --target wxgame 命令。

　　注：简写 egret publish 或 egret run 将读取 egretProperties.json 配置文件中的 target 对象的 current 属性。

　　现在就可以运行小游戏了，如在开发中遇到任何问题都可到官方论坛提问，官方团队很愿意为您解答

　　小游戏进阶教程注意：

　　因为小游戏特殊机制，涉及到的小游戏接口主要逻辑都需要写在小游戏逻辑代码内，但是可以通过 Egret 代码来调用

　　后续版本 Egret 将会提供调用小游戏接口模板，届时大家可以参照模板编写代码。

　　文件系统

　　文件系统有两类文件：代码包文件和本地文件。

　　代码包文件

　　代码包文件指的是在项目目录中添加的文件。由于代码包文件大小限制，代码包文件适用于放置首次加载时需要的文件，对于内容较大或需要动态替换的文件，不推荐用添加到代码包中，推荐在小程序启动之后再用下载接口下载到本地。

　　访问代码包文件

　　代码包文件的访问方式是从项目根目录开始写文件路径。

　　修改代码包文件

　　代码包内的文件无法在运行后动态修改或删除，修改代码包文件需要重新发布版本。

　　本地文件

　　本地文件指的是小程序被用户添加到手机后，会有一块独立的文件存储区域，以用户维度隔离。即同一台手机，每个微信用户不能访问到其他登录用户的文件，同一个用户不同 appId 之间的文件也不能互相访问。

　　本地文件的文件路径均为以下格式：

　　本地临时文件

　　本地临时文件只能通过调用特定接口产生，不能直接写入内容。本地临时文件产生后，仅在当前生命周期内有效，重启之后即不可用。因此，不可把本地临时文件路径存储起来下次使用。如果需要下次在使用，可通过 saveFile 或 copyFile 接口把本地临时文件转换成本地存储文件或本地用户文件。

　　示例

　　本地缓存文件

　　本地存储文件只能通过调用特定接口产生，不能直接写入内容。本地缓存文件产生后，重启之后仍可用。本地缓存文件只能通过 saveFile 接口将本地临时文件保存获得。

　　示例

　　本地缓存文件是最初的设计，1.7.0 版本开始，提供了功能更完整的本地用户文件，可以完全覆盖本地缓存文件的功能，如果不需要兼容低于 1.7.0 版本，可以不使用本地缓存文件。

　　本地用户文件

　　本地用户文件是从 1.7.0 版本开始新增的概念。我们提供了一个用户文件目录给开发者，开发者对这个目录有完全自由的读写权限。通过 wx.env.USER_DATA_PATH 可以获取到这个目录的路径。

　　获取更多转发信息

　　通常开发者希望转发出去的小程序被二次打开的时候能够获取到一些信息，例如群的标识。现在通过调用 wx.showShareMenu 并且设置 withShareTicket 为 true ，当用户将小程序转发到任一群聊之后，可以获取到此次转发的 shareTicket，此转发卡片在群聊中被其他用户打开时，可以通过 getLaunchOptionsSync() 获取到另一个 shareTicket。这两步获取到的 shareTicket 均可通过 wx.getShareInfo() 接口可以获取到相同的转发信息。

　　用户数据的签名验证和加解密

　　数据签名校验

　　为了确保开放接口返回用户数据的安全性，微信会对明文数据进行签名。开发者可以根据业务需要对数据包进行签名校验，确保数据的完整性。

　　签名校验算法涉及用户的session_key，通过 wx.login 登录流程获取用户session_key，并自行维护与应用自身登录态的对应关系。

　　通过调用接口（如 wx.getUserInfo）获取数据时，接口会同时返回 rawData、signature，其中 signature = sha1( rawData + session_key )

　　开发者将 signature、rawData 发送到开发者服务器进行校验。服务器利用用户对应的 session_key 使用相同的算法计算出签名 signature2 ，比对 signature 与 signature2 即可校验数据的完整性。

　　WebGL渲染1.介绍

　　WebGL 是一套用于渲染 2D 和 3D 图形的标准图形库，其标准是由 Khronos、AMD、爱立信、谷歌、Mozilla、Nvidia 以及 Opera 等共同制定。

　　WebGL 通过增加 OpenGL ES 2.0 的一个 JavaScript 绑定，可以为 HTML5 Canvas 提供硬件 3D 加速渲染。 Egret Engine 2D 提供了 WebGL 渲染模式。只需开启 WebGL 渲染，就能获得硬件加速。

　　WebGL 提供了底层的渲染 API，对于传统 Web 开发者来说使用 WebGL API 是比较复杂的，需要补充大量的 OpenGL ES 相关知识。 但在 Egret Engine 中使用 WebGL 却十分方便， 只需在程序开始时选择开启 WebGL 渲染。

　　无需担心 WebGL 标准的兼容性问题。在开启 WebGL 渲染模式下，如果浏览器不支持将自动切换到 Canvas 渲染模式下。

　　WebGL 兼容性

　　使用 WebGL 渲染可以获得硬件加速渲染，提升性能。因此希望可以在所有环境中使用 WebGL 渲染。目前 WebGL 正在获得更多更广泛的支持。

　　PC浏览器兼容性

　　ChromeChrome 8 开始支持。

　　FirefoxWebGL 在 Firefox 4 及以上版本默认支持。

　　SafariSafari 5.1 开始支持 (Lion 版本系统已经使用)。

　　OperaOpera 12 alpha 及以上版本。

　　IEIE 11 开始支持。

　　手机浏览器兼容性

　　ChromeAndroidChrome 30 开始在支持 GL_EXT_robustness 扩展的设备上支持.

　　腾讯x5内核QQ浏览器以及X5 tbs 2.x： android 4.0以下不支持webgl功能，4.0以上会根据手机的gl指令进行检查从而最终决定是否开启webgl功能

　　2.使用

　　开启 WebGL 渲染

　　在 Egret 项目根目录中可以找到 index.html 文件。该文件是 Egret 项目的入口，包含初始化设置。

　　在 index.html 中有 Egret 的启动函数。如果要开启 WebGL 渲染，在其中传入参数即可，代码如下。

　　egret.runEgret({renderMode:"webgl"});

　　当然也可以指定渲染模式为 Canvas :

　　egret.runEgret({renderMode:"canvas"});

　　目前默认的渲染模式为 webGL。

　　判断当前的渲染模式

　　可以通过 Capabilities 类的 renderMode 来判断当前的渲染模式。

　　console.log(egret.Capabilities.renderMode);

　　上面一行代码在 Canvas 模式下将打印 canvas,在 WebGL 模式下将打印 webgl;

　　WebGL 与脏矩形

　　由于在一些浏览器上兼容性问题比较严重，目前暂时在 WebGL 下关闭了的脏矩形渲染。

　　其他注意事项

　　可以在 Egret 程序的入口中开启 WebGL。如果浏览器不支持 WebGL 渲染将自动切换到 Canvas 渲染模式上。

　　使用 WebGL 渲染可以得到性能提升。但在使用很多文本和矢量绘图的情况下，可能有更多的开销，起不到提升性能的作用。因为在 WebGL 渲染模式下文本和矢量绘图是需要在 Canvas 中缓存下来再渲染到 WebGL 中。由于多了在 Canvas 渲染的过程，如果使用大量的文本或者矢量绘图将不能得到相应的性能提升。

　　在 WebGL 下如果要使用 Texture 对象的 toDataURL() 方法把纹理转换为 base64 字符串，那么纹理图片应放在同一服务器下，引用不同的服务器下的资源将不成功。

　　当然 WebGL 标准正在普及，在手机上有些特性支持还不是很友好。手机上非 Chrome 浏览器现在对不规则遮罩支持还不是很好，在使用 WebGL 渲染器时可以尽量避免使用不规则遮罩。

修复说明

　　【修复】设置 TextField.textFlow 渲染异常问题

　　【修复】Audio 在 chrome 浏览器可能引发报错问题

　　【修复】MovieClip 帧事件派发异常问题

　　【修复】容器设置 cacheAsBitmap 后渲染异常问题

　　【修复】设置 MovieClipData 之后帧频没有变化问题

　　【修复】autoGenerateExmlsList 逻辑异常

　　【新增】命令行 TypeScript 版本升级到 2.1.4

　　【新增】eui.Label.style 增加设置多个功能

　　【修复】MovieClip 移出舞台后循环次数错乱问题

　　【修复】输入文本会阻止 TOUCH_BEGIN 事件问题

　　【修复】设置 audioType 不生效问题

　　【修复】声音循环播放音量失效问题

　　【修复】exml 数据绑定设置负数异常问题

　　【修复】某些浏览器下设置滤镜后不显示问题

　　【新增】资源管理框架

　　【新增】骨骼动画-白鹭极速格式

　　【新增】Facebook Instant Game 模板

　　【新增】eui 添加 Style 的机制，允许开发者通过设置 Style 的方式批量修改皮肤样式，提升开发效率

　　【优化】TypeScriptCompiler 2.1.4 核心

　　【修复】egret create_app 命令在 windows 上执行，如果不在同一个盘符可能报错的BUG

　　* 命令行

　　【优化】参与编译的 TypeScript 文件列表由 tsconfig.json 进行开发者自由指定，与标准 TypeScript 项目行为一致

　　【优化】完善项目的文件结构，如果第三方库已经在项目中，不会重复拷贝至 libs/modules 文件夹中

　　【修复】一个由复杂文件排序引发的构建 BUG

　　【修复】egret publish 后， DEBUG 枚举仍然为 true 的 BUG

　　【优化】精简命令行体积，从 21mb 降低至 18mb，并重构内部逻辑，为未来进一步扩展做准备

　　【新增】新项目模板默认添加 Promise 支持

　　【新增】使用 egret upgrade 命令升级至 4.0.1 会为项目添加 Promise 支持

　　【优化】不再支持白鹭引擎 2.0 以下版本的项目升级至 4.0 版本

　　* 白鹭引擎 3D 渲染核心

　　【新增】允许在白鹭引擎中直接添加 3D 渲染模块，开发者可以在现有的 2D 游戏中，快速添加 3D 场景地形、人物、特效等功能，并复用游戏的现有 UI。

　　【优化】大幅提升 3D 渲染核心在低端机的表现，大部分 2014年出厂的旗舰机型（ 如小米4，Nexus 5等）均可流畅运行

　　【优化】降低部分 Shader 的编译时间，保证游戏的启动速度更快

　　【优化】略微提升整体性能，大约有 5% - 10% 的性能提升

　　【优化】Unity 导出插件更新至最新版本

　　【优化】采用 TypeScript 2.1.4 编译

　　【优化】创建新的 3D 项目采用白鹭引擎的资源管理框架以及 2D UI

　　* 资源管理框架

　　【修复】加载 BitmapFont 类型文件可能报错的 BUG

　　【优化】完善多处 res 命令行和运行时的报错信息，提供更友好的错误提示

　　【修复】res build 在文件删除之后，资源配置文件不会正确同步删除的BUG

　　【新增】在创建项目时允许创建资源管理框架的示例项目

　　【优化】完善文档

　　* 命令行

　　【优化】编译器升级到 TypeScript 2.1.5

　　【修复】srartserver 命令端口号固定为3000的问题

　　* 白鹭引擎渲染核心

　　【修复】滤镜可能会引发内存泄漏问题

　　【修复】canvas 模式下滤镜跨域策略异常问题

　　【修复】webgl 模式下绘制反转的矩形遮罩异常问题

　　* 资源管理框架

　　【修复】RES.isGroupLoaded 与旧版行为不一致问题

　　【优化】支持 npm 2.x 版本

　　【修复】RES.loadGroup bug

　　【修复】res build 在转换 resource.json 时，没有对应删除 resource.json 中已经被删除的 Group 问题

　　* 实验性功能更新

　　【新增】照片选择器功能，可以选择手机照片并显示

　　* 命令行

　　【修复】Linux 命令行报错问题

　　* 白鹭引擎渲染核心

　　【修复】滤镜测量边界错误问题

　　【修复】URLLoader 发送 POST 请求异常问题

　　【修复】WebGL 下 cacheAsBitmap 对象渲染异常问题

　　【修复】eui.RadioButton 内存泄漏问题

　　【修复】Rectangle.containsPoint 边界检查异常问题

　　* 资源管理框架

　　【修复】mapConfig 中排除了一部分文件，而 default.res.json 中又包含这部分文件，res build 命令报错问题

　　【优化】createGroup 如果传递的是 url 而不是 alias，加载显示一个警告

　　【优化】subkey 不存在时的报错信息

　　【新增】watch 功能

　　【修复】打包 iOS / Android 原生项目启动黑屏问题

　　* Egret3D

　　【修复】透明物体渲染bug

　　【优化】包围盒线框渲染逻辑

　　【增加】debug 模式性能监控面板

　　【新增】导出插件支持 MacOS 版本，重构部分业务逻辑

更新日志

　　Egret Engine2D 5.2.22白鹭引擎 5.2.22 发布日志

　　白鹭引擎在 2019年6月25日，发布 5.2.22 稳定版本。

　　2D 渲染 - JavaScript

　　[修复] 修复 htmlSound 音频初始加载时销毁错误的问题

　　[优化] 在 Mac 上的 Safari 浏览器中，默认使用 web audio 的方式播放音频

　　[优化] 重命名插件 RenamePlugin 增加设置回调函数，获取文件的相关信息

　　微信小游戏 v1.1.17

　　[优化] 移除无效的报错信息

　　[优化] 优化资源管理模块中 binary 的加载方式

　　OPPO 小游戏 v0.1.5

　　[优化] 优化对声音的支持