Building CEGUI for Ogre / OgreRenderer - Revision history

Ident: /* A snapshot of using CMake */

2016-05-01T10:48:58Z

‎A snapshot of using CMake

Ident: /* Optional: If you want to use CMake to set up your own project */

2016-05-01T10:48:45Z

‎Optional: If you want to use CMake to set up your own project

Ident at 10:48, 1 May 2016

2016-05-01T10:48:05Z

Ident: /* Tested versions */

2015-03-24T10:22:40Z

‎Tested versions

Ident: /* Tested versions */

2015-03-24T10:21:53Z

‎Tested versions

Ident: /* Tested versions */

2015-03-24T10:21:32Z

‎Tested versions

Underworldguardian: Added the most straight-forward way to compile a cmake project.

2015-02-13T11:26:18Z

Added the most straight-forward way to compile a cmake project.

Ident: /* A snapshot of using CMake */

2014-12-21T13:16:01Z

‎A snapshot of using CMake

Ident: /* CEGUI 0.8.x */

2014-12-20T16:08:16Z

‎CEGUI 0.8.x

Ident at 16:07, 20 December 2014

2014-12-20T16:07:58Z

@@ Line 33: / Line 33: @@
 <div class="mw-collapsible-content">
 {{[[File:Ogrescreen.png|How to set CMake variables]]}}
 </div>
 </div>

@@ Line 38: / Line 38: @@
 == Optional: If you want to use CMake to set up your own project ==
 We offer a FindCEGUI.cmake file in our repository [https://bitbucket.org/cegui/cegui/src/b975a6885624277808189ac3d503dea7ba82b1a7/cmake/FindCEGUI.cmake?at=v0-8&fileviewer=file-view-default *here*] that you may want to use. An example CMake file can be found in this post: http://www.ogre3d.org/addonforums/viewtopic.php?f=34&t=30480&p=103432#p103432
 = Step-by-step guide =

@@ Line 35: / Line 35: @@
 </div>
 </div>
 <div class="toccolours mw-collapsible mw-collapsed" style="width:80%">

@@ Line 10: / Line 10: @@
 * CEGUI 0.8.5 (not yet released at the point of writing) and v0-8 branch support Ogre 2.0 and 2.1 with OGL3+ Renderer only.
 * CEGUI v-0 branch and releases starting with 0.8.4 will support Ogre 1.7, 1.8, 1.9. They will also be updated from time to time to support the current version of Ogre default branch (right now it works with the Ogre default branch version of 6th Jan. 2014, including Ogre's OGL3 Renderer)
-* CEGUI default branch is currently not containing a functional OgreRenderer and is not recommended to be used by Ogre users until the new OgreRenderer is finished
+* CEGUI default branch (unstable) contains an entirely changed but mostly functional OgreRenderer that should work with 1.7-2.0 but might need to be tested further.
 == Environment variables for CMake ==

@@ Line 11: / Line 11: @@
 * CEGUI v-0 branch and releases starting with 0.8.4 will support Ogre 1.7, 1.8, 1.9. They will also be updated from time to time to support the current version of Ogre default branch (right now it works with the Ogre default branch version of 6th Jan. 2014, including Ogre's OGL3 Renderer)
 * CEGUI default branch is currently not containing a functional OgreRenderer and is not recommended to be used by Ogre users until the new OgreRenderer is finished
 == Environment variables for CMake ==

@@ Line 7: / Line 7: @@
 == Tested versions ==
-* CEGUI 0.8 supports basic configurations of Ogre 1.7 and 1.8 and 1.9. Other versions and special configurations (such as using boost) are supported but might require additional steps from your side.
+* CEGUI 0.8.X and v0-8 branch supports basic configurations of Ogre 1.7 and 1.8 and 1.9. Other versions and specific configurations (such as using boost) are supported but might require additional steps from your side (see below).
 * CEGUI v-0 branch and releases starting with 0.8.4 will support Ogre 1.7, 1.8, 1.9. They will also be updated from time to time to support the current version of Ogre default branch (right now it works with the Ogre default branch version of 6th Jan. 2014, including Ogre's OGL3 Renderer)
 * CEGUI default branch is currently not containing a functional OgreRenderer and is not recommended to be used by Ogre users until the new OgreRenderer is finished
 <p>If somebody wants to use CEGUI from v0-8 together with Ogre's Direct3D 11 Renderer urgently, we can try to help you modify the CEGUIOgreRenderer for D3D 11 compatibilities - with strong pre-existing knowledge about hlsl it shouldn't take longer than 1 hour with our help.</p>
 == Environment variables for CMake ==

@@ Line 113: / Line 113: @@
 == Steps for GNU and Unix-like environments ==
 ===CEGUI 0.8.x ===
 ===CEGUI 0.7.x ===

@@ Line 30: / Line 30: @@
 == A snapshot of using CMake ==
-CMake has a great GUI that allows to change your configuration and fill in the correct dependency paths. It will also generate your project/solution/However-your-IDE-calls-it.
+CMake has a great GUI that allows to change your project's configuration by specifiying the dependencies, renderers and parsers you want. You need to fill out the paths to all files and folders the dependencies require.
 <div class="toccolours mw-collapsible mw-collapsed" style="width:80%">
-''' Expand this to see an example on how to utilise the filters/search in CMake and how to set a variable'''
+''' Expand this to see an example on how to utilise the filters/search in CMake and how to set the Ogre variables'''
 <div class="mw-collapsible-content">
 {{[[File:Ogrescreen.png|How to set CMake variables]]}}
@@ Line 38: / Line 38: @@
 </div>
 = Step-by-step guide =

@@ Line 60: / Line 60: @@
 * 7. Search the '''CEGUI_BUILD_RENDERER_OGRE''' boolean variable in the list of CMake GUI Utility and set the value to TRUE by clicking on the checkbox.
 * 8. Check if OGRE and OIS (and boost - '''IF''' your Ogre version was built with boost as dependency) were found by cmake. (For more information about how boost can be found by CMake please see the Cmake docu: http://www.cmake.org/cmake/help/git-master/module/FindBoost.html) Look through the CMake GUI Utility output to see if there is a message like 'Could NOT find OGRE'. '''If both Ogre and OIS (and boost) were found (and reference the right version in case you got multiple ones) you can jump to step #9 now'''. <span style="color:#3333AA">  If this was not the case it means that you either have not set the environment variables for Ogre (OGRE_SDK and OGRE_HOME) and OIS (OIS_HOME) at all, or that you have not set them correctly. You can try to fix this and click configure again to see if it works. If it does you can skip to #9. If it does not work then set the paths yourself.
 <div class="toccolours mw-collapsible mw-collapsed" style="width:80%">
@@ Line 74: / Line 73: @@
 * 12 Build the entire cegui solution.
 * 13 (Optional) Start the SampleBrowser to see if the samples work correctly (don't forget to copy the created samples.xml from build/datafiles/samples to your datafiles/samples folder so that the SampleBrowser can find the samples you want to use. Also make sure you copied all the dlls that your setup requires to the foldering containing the SampleBrowser.exe and in Visual Studio: for Project->Properties->Debugging->Working Directory set the value to $(OutDir) )
 ===CEGUI 0.7.x ===

← Older revision		Revision as of 16:07, 20 December 2014
Line 47:		Line 47:

	* 2. Get the latest '''Ogre''' version. If you are build it yourself (recommended), you will need to compile/link it first in the modes you want to use (Debug/Release) to get Ogre's .lib and .dll files ready for CEGUI.		* 2. Get the latest '''Ogre''' version. If you are build it yourself (recommended), you will need to compile/link it first in the modes you want to use (Debug/Release) to get Ogre's .lib and .dll files ready for CEGUI.
		+

	== Steps for Microsoft Visual Studio ==		== Steps for Microsoft Visual Studio ==
		+