Skip to content

Commit

Permalink
Update porting documentation regarding header renames
Browse files Browse the repository at this point in the history
  • Loading branch information
darksylinc committed Dec 19, 2024
1 parent 1c284e6 commit c34e880
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion Docs/src/manual/Migrating/Ogre4.0.Changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,4 +81,15 @@ The variable `HlmsUnlit::mSamplerUnitSlotStart` was removed and `HlmsUnlit::mTex

Users deriving from HlmsUnlit must set mReservedTexBufferSlots & mReservedTexSlots instead, like it is done for HlmsPbs.

See [Colibri project's commit](https://github.com/darksylinc/colibrigui/commit/87e74824973007ee9f7f3f46719d2a6ba4948678) for an example of how the change was ported.
See [Colibri project's commit](https://github.com/darksylinc/colibrigui/commit/87e74824973007ee9f7f3f46719d2a6ba4948678) for an example of how the change was ported.

## Header renames

Due to issues with different IDEs and build systems, renamed several headers so that all header files have a unique name, even if they live in a different folder.

For example `Animation/OgreTagPoint.h` is now `Animation/OgreTagPoint2.h` because `OgreTagPoint.h` already existed. This can cause build errors when upgrading to 4.0 that are easily fix by switching to their new names.

See commits [75801f33df72844384549b11de96b10421584bce](https://github.com/OGRECave/ogre-next/commit/75801f33df72844384549b11de96b10421584bce) and [67f9fddd4292877dbedb2507fba7719c42aad97c](https://github.com/OGRECave/ogre-next/commit/67f9fddd4292877dbedb2507fba7719c42aad97c) for affected files.
The message of the commit was:

> Avoid identically named source files - some build systems have problems with it, even if CMake have none (headermaps in XCode, shared intermediate folder in Visual Studio)

0 comments on commit c34e880

Please sign in to comment.