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

Merge pull request #16305 from minggo/update-doc 

[ci skip]Update doc
This commit is contained in:
minggo 2016-08-04 09:50:57 +08:00 committed by GitHub
parent efc6da8439 7a463b41a5
commit ad721ec3a4
3 changed files with 94 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
CHANGELOG
View File

@ -1,3 +1,57 @@
cocos2d-x-3.13 Aug 22 2016
[HIGHLIGHT] add VR plugin
[HIGHLIGHT] support ETC1 alpha channel
[HIGHLIGHT] fix AudioEngine performance for Android 4.2+
[HIGHLIGHT] add Andorid arm-64 support
[HIGHLIGHT] switch to use gcc 4.9
[HIGHLIGHT] upgrade CURL to 7.50.0
[HIGHLIGHT] upgrade Spine to 3.4
[HIGHLIGHT] update glfw to 3.2
[NEW] add `Configuration::supportsMapBuffer()`
[NEW] support hexagonal tile maps
[NEW] add `ListView::setScrollDuration()`
[NEW] implement `SimpleAudioEngine::willPlayBackgroundMusic()` on Android
[NEW] implement `AudioEngine::preload()` on Android
[NEW] add `cc.Node['.classname']` to get class name for tolua C++ class in lua
[REFINE] optimize Node sorting speed for 64-bit
[REFINE] using `chrono::steady_clock()` instread of gettimeofday for FPS calculation
[REFINE] use `fstat` instead of `fseek` and `ftell` for performance to read file content
[REFINE] use std::string reference instead of char* for `utils::findChild()`
[REFINE] make `MotionStreak` _maxPoints framerate independent
[REFINE] support utf-8 bom lua script
[REFINE] can show utf-8 characters in MessageBox and lua log on win32
[FIX] the color of underline is different from the text color
[FIX] memory leak in `MenuItemToggle::create()`
[FIX] crash after removing a physics body right after adding it
[FIX] SpriteBatchNode crash if CC_SPRITE_DEBUG_DRAW is enabled
[FIX] `FileUtils::removeDirectory()` can not work on all platforms except iOS and Mac
[FIX] memory leak in `Data::move()`
[FIX] crash in `EaseExpoentialOut::clone()`
[FIX] buffer over-read in `GLProgram::updateUniformLocation()`
[FIX] `dirty` variable incorrectly reset with a multiple camera setup causing drawing issues on Sprite
[FIX] fix label text formatter right alignment
[FIX] `bsd_signal` link error on Android
[FIX] crash while decoding small MP3 file on Android
[FIX] `AppDelegate::applicationWillEnterForeground()` is invoked at launch on Android
[FIX] fix `relocation overflow in R_ARM_THM_CALL` on Android
[FIX] navigation bar doesn't hide if show and dismiss keyboard on Android
[FIX] `utils::getTimeInMilliseconds()` may return wrong value on Android
[FIX] compiling error with Android 6.0(API 23)
[FIX] music is not resumed when app is reactived on iOS
[FIX] random crash in `alGenBuffers` at startup on iOS
[FIX] can not play audio if uncache and play audio many times on iOS
[FIX] `Text::create()` crash if it contains invalid string on iOS
[FIX] new js project link error on linux
[FIX] design resolution broken after minimize on desk platforms
[FIX] can not get the `backClicked` in lua
[FIX] `cc.convertColor` issue in lua
[FIX] browser version detection
[FIX] compiling error with `cocos gen-libs`
cocos2d-x-3.12 Jul 06 2016 cocos2d-x-3.12 Jul 06 2016
[HIGHLIGHT] add VR support [HIGHLIGHT] add VR support

4
README.md
View File

@ -170,11 +170,11 @@ Main features
Build Requirements Build Requirements
------------------ ------------------
* Mac OS X 10.7+, Xcode 5.1+ * Mac OS X 10.7+, Xcode 7+
* or Ubuntu 12.10+, CMake 2.6+ * or Ubuntu 12.10+, CMake 2.6+
* or Windows 7+, VS 2013+ * or Windows 7+, VS 2013+
* Python 2.7.5 * Python 2.7.5
* NDK r11+ is required to build Android games * NDK r11+ and API level 19 is required to build Android games
* Windows Phone/Store 8.1 VS 2013 Update 4+ or VS 2015 * Windows Phone/Store 8.1 VS 2013 Update 4+ or VS 2015
* Windows Phone/Store 10.0 VS 2015 * Windows Phone/Store 10.0 VS 2015
* JRE or JDK 1.6+ is required for web publishing * JRE or JDK 1.6+ is required for web publishing

67
docs/RELEASE_NOTES.md
View File

@ -26,7 +26,7 @@
<!-- END doctoc generated TOC please keep comment here to allow auto update --> <!-- END doctoc generated TOC please keep comment here to allow auto update -->
# Cocos2d-x 3.12 Release Notes # # Cocos2d-x 3.13 Release Notes #
# Misc Information # Misc Information
@ -47,9 +47,9 @@
## Compiler Requirements ## Compiler Requirements
* Xcode 5.1 or newer for iOS or Mac * Xcode 7+ for iOS or Mac
* gcc 4.9 or newer for Linux * gcc 4.9+ for Linux
* ndk-r11+ for Android * ndk-r11+ and API level 19 for Android
* Visual Studio 2013 or newer for Windows (win32) * Visual Studio 2013 or newer for Windows (win32)
* Visual Studio 2013 update4 or newer for Windows 8.1 universal Apps * Visual Studio 2013 update4 or newer for Windows 8.1 universal Apps
* Visual Studio 2015 or newer and Windows 10.0 (build 10074 or higher) for Windows 10.0 UWP Apps * Visual Studio 2015 or newer and Windows 10.0 (build 10074 or higher) for Windows 10.0 UWP Apps
@ -150,45 +150,54 @@ Use the __cocos__ console app to create a new game:
cocos new -l cpp|js|lua MyNewGame cocos new -l cpp|js|lua MyNewGame
``` ```
# v3.12 # v3.13
## Highlights ## Highlights
* add VR support in experimental * add VR plugin
* add Tizen support * support ETC1 alpha channel
* improve Android performance issue * fix AudioEngine performance for Android 4.2+
* improve web engine performance in WebGL mode * add Andorid arm-64 support
* support Android obb extension * switch to use gcc 4.9
* use clang instead of gcc on Android, use NDK r11+ * upgrade CURL to 7.50.0
* upgrade Spine to 3.4
* update glfw to 3.2
## The main features in detail of Cocos2d-x v3.12 ## The main features in detail of Cocos2d-x v3.13
### VR support ### Add VR plugin
VR Support is now available! Currently there is support for __Google Cardboard__, __Oculus Rift__, __Samsung Gear__ and __Deepoon E2__. Also provided is a *generic* __VR__ renderer to help with testing. It should not be used to trust deploying a production __VR__ game. In usual Cocos2d-x fashion it is very easy to get started with an easy to understand API. Read our chapter in the [Programmers Guide](http://cocos2d-x.org/docs/programmers-guide/vr/index.html) for more information.
### Tizen support TBD: add link of PG
You can now develop for the __Tizen__ mobile platform. The latest __2.4__ SDK is supported. Tizen development uses it's own uniqie IDE as well as a simulator for testing applications. For setup instructions please read our [documentation](http://cocos2d-x.org/docs/installation/Tizen/).
### Improve Android performance ### Support ETC1 alpha channel
Thank you to our users for helping diagnose performance issues on some Android devices. It is because Cocos2d-x creates a big map buffer by default and fills the map buffer with actual data, which is less than the map buffer size. On some Android devices, it will transfer as much data as the map buffer size which causes performance issue. Thanks [halx99](https://github.com/halx99)'s contribution, now cocos2d-x supports ETC1 alpha channel by default.
More detail information and discussion can refer to [the issue](https://github.com/cocos2d/cocos2d-x/issues/15652). If want to use ETC1 alpha chaneel, you should put `xxx.pkm` and `xxx.pkm@alpha` in the same folder, and use it like this:
### Improve web engine performance in WebGL mode ```c++
auto sprite = Sprite::create("xxx.pkm");
```
The web engine is receiving a big performance upgrade. The WebGL renderer have been completely refactored from the ground up. This means improved rendering and a reduced memory footprint. `xxx.pkm@alpha` is the resource for alpha channel. `@alpha` subfix is required by engine to load alpha texture automatically.
![rendering performance](https://raw.githubusercontent.com/minggo/Pictures/master/web-performance-improve/adverage-time-per-frame.png) More detail usage can refer to the implementation of `Sprite1ETC1Alpha` in `tests/cpp-tests/Classes/SpriteTest/SpriteTest.cpp`.
![cpu-usage](https://raw.githubusercontent.com/minggo/Pictures/master/web-performance-improve/cpu-usage.png) ### AudioEngine performance for Android 4.2+
![memory-usage](https://raw.githubusercontent.com/minggo/Pictures/master/web-performance-improve/memory-usage.png) AudioEngine uses [OpenSL ES](https://developer.android.com/ndk/guides/audio/opensl-for-android.html) on Android, and it supports decoding audio source file to PCM data in codes since Android 4.2. Now AudioEngine uses this feature to fix the performance issue. The performane is the same as before if running on Android 4.1 or lower version.
### Use clang on Android ### Android arm-64 support
[Google deprecated gcc starting in NDK r11](https://developer.android.com/ndk/downloads/revision_history.html), Cocos2d-x now uses clang. We suggest using the NDK r11c.
We found an issue that, if using NDKr 10c + clang, then `Node::enumerateChildren()` will crash on Android. Now we provide arm-64 bit 3rd party libraries, which means can build 64-bit apps on Android. You can use the command to build 64-bit apps:
```
cocos run -p android --app-abi arm64-v8a
```
## Other changes ### Switch to use gcc 4.9
View our [full changelog](https://github.com/cocos2d/cocos2d-x/blob/v3/CHANGELOG).
cocos2d-x switch to use clang in `v3.12`, but developers reported [some crash issue](https://github.com/cocos2d/cocos2d-x/issues/16244) that caused by using `clang+gnustl_static`, so we switch to use gcc 4.9. We will change to use `clang+c++_static` when `c++_static` is stable.
### Upgrade CURL to 7.50.0
Because CURL has [a bug about connect to IPV4 numerical IP address in NAT64 environment](https://github.com/curl/curl/issues/863), and it is fixed in v7.50.0, so we upgrade to this version when v7.50.0 is released.