Skip to content

Commit

Permalink
update 1.10 Notes [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
paroj committed Feb 12, 2017
1 parent 78827e2 commit 21253e1
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion Docs/1.10-Notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ This is only a high level overview. For a detailed changes, see the git changelo
## Core Improvements
* [Unified documentation](https://ogrecave.github.io/ogre/api/1.10/index.html) API reference, manual and some of the wiki tutorials are now all available through Doxygen and editable using Markdown. Now there is syntax highlighting in the snippets and automatic links to corresponding function documentation. To locally build the docs, just do `make OgreDoc`. The sources are in `Docs/src/`.
* by default Ogre will now automatically fetch and build its core dependencies. This way your deps have the same compile options like Ogre and you do not have to track the separate OgreDeps repository.
* Pass now uses a proper HashFunc and defaults to `MinGpuProgramChangeHashFunc`. This should give a performance boost when using the RTSS and with shader based materials.
* new `OgreAssertDbg` macro that only fires in Debug configuration. To be used in performance critical code. In turn the existing `OgreAssert` macro is now enabled in Release/ RelWithDebug configurations.
* FileSystemLayer: use `$XDG_CACHE_HOME` as base path on Linux
* allow using `std::thread` (with c++11) for background resource loading
Expand All @@ -14,9 +15,15 @@ This is only a high level overview. For a detailed changes, see the git changelo
* the nedmalloc allocator is now deprecated and disabled by default due to memory leaks. Use the default STL allocator.
* several functions were deprecated and will be dropped in the next major release. [See the deprecation list here.](https://ogrecave.github.io/ogre/api/1.10/deprecated.html)
* several SceneNode and Node functions were de-virtualised as they are internal API and were not overriden. If this breaks you code though, this will be considered a regression and be reverted/ fixed.
* performance improvements to Ogre::ResourceGroupManager
* performance improvements for `Ogre::ResourceGroupManager`
* upgraded embedded TinyXML from 2.5.2 to 2.6.2

### ResourceManager strict mode
By defining `OGRE_RESOURCEMANAGER_STRICT=ON` in CMake the Resource System is put into the a "strict" mode. In this mode resource lookup is case sensitive and all lookup quirks are disabled.
This greatly improves performance as now usually only one group has to be searched - also this makes the lookup predictable. If you specify a group and the resource is not found, the managers will not fall back to some arbitrary other resource with the same name.

While enabling the strict mode is highly recommended, the default is the legacy mode to ensure compatibility with existing projects.

### CMake Config-File support
A CMake config-file package is now installed making it easy to discover OGRE for third-party projects. This means that you no longer have to copy paste the FindOGRE.cmake script into your project. Instad you can specify `OGRE_DIR` to point to the installed OGREConfig.cmake and thats it. On Linux CMake will even automatically find OGRE if it is installed in one of the default system paths like `/usr/local/`.

Expand Down Expand Up @@ -102,3 +109,4 @@ Furthermore the following Samples were updated/ added:
* ShaderSystemMultiLight: ported to GLES3
* VolumeTerrain: fixed the triplanar texturing part
* HLMS: shows how to use the new HLMS in combination with the RTSS
* Shadows: fixed GLSL shaders for Stencil shadowing (now woriking on GL3Plus)

0 comments on commit 21253e1

Please sign in to comment.