%prevogre%

Tip_icon.png Deprecated. See Codeblocks and MinGW instead.
CBsplash.jpg
Using Ogre 1.2.2 with Code::Blocks + MingW + STLPort


This toolchain configuration is only supported upto Ogre 1.2.2. For Ogre 1.2.3 and later, STLPort was dropped in favor of a modified version of libstdc++. See Codeblocks and MinGW for more details

WARNING! The SDK will not work with Code::Blocks 1.0 RC2, you must use a nightly build. Read on to find out how to get a nightly build of Code::Blocks.

Ogre 1.2.1 SDK for Code::Blocks + MingW + STLPort

SDK Download

NOTE: This SDK uses STLPort instead of libstdc++ with MingW. If you have Ogre SDK 1.2 RC1 or RC2 installed, uninstall it before installing Ogre SDK 1.2.2.

Why use STLPort instead of libstdc++ v3 that comes with MingW?

MingW will statically link libstdc++ (the library portion, not the STL) to each dll or exe built. This creates a problem when passing strings and any stream types across dll's. Because the static linking has each copy of libstdc++ managing its own strings and streams, passing a string or stream to another dll and then having it modified there will trash memory. Ogre has several dll's and does pass strings and streams around. Do a debug build of Ogre with libstdc++ and then run it in gdb. You'll quickly find that OgrePlatform_d.dll crashes after the config window closes when it tries to modify/deallocate a string passed to it from OgreMain.dll.

A release build using libstdc++ "seems" to run fine for simple Ogre demos but if you start passing a lot of Ogre strings across dll's in a more complicated app, the app starts to misbehave. After a while crashes occur.

You could rebuild libstdc++ as a dll so that there is only one place where strings and streams are being managed.

That is what I tried. It does solve the problem, but there were still some issues. And doing the modifications to build a dll were a pain in the butt. Having used STLPort with vc6 back in 2003, I thought I would give it a try with MingW. STLPort 5.0.1 built out of the box with gcc 3.4.5 and was painless to setup up. It is used to build the dependencies and Ogre. STLPorts license is very clear too, but the license for libstdc++ as a dll doesn't seem so clear.

The MingW team has talked about supplying libstdc++.dll for many years (since 2000) but many roadblocks have prevented this.
Some links you can read about the issue:
http://sourceforge.net/mailarchive/message.php?msg_id=14918030
http://sourceforge.net/mailarchive/message.php?msg_id=12649857
http://sourceforge.net/mailarchive/message.php?msg_id=12648237
http://sourceforge.net/mailarchive/message.php?msg_id=14837422
http://www.cygwin.com/ml/cygwin/2005-10/msg00083.html

The Ogre SDK Contents:

The Ogre SDK comes with:

  • all the Ogre modules built for you ie the dll's and static archives
  • STLPort 5.0.2 pre-built + headers
  • the Ogre manual in HTML format
  • API reference in the form of a windows compiled help (.chm)
  • All header files (*.h) for the libs/dll are included
  • Source code and project files for 30 demos that you can compile and run as a confidence test of the SDK installation and to see what Ogre can do.
  • All media resources required for demos
    • Material Scripts + shader programs
    • Compositor Scripts
    • Particle Scripts
    • Meshes + Animations
    • Textures

What you need to provide that is not supplied in the SDK

WARNING: this SDK requires the use of the latest Code::Blocks from svn HEAD and will not work with Code::Blocks 1.0rc2.


The SDK was built and tested with the following:

Download the following in the order given. MinGW must be setup before running Code::Blocks for the first time to make detection of MinGW go smoothly.

Download the following packages in the order given and unzip them in your MinGW directory ie C:\MinGW.

- use latest Nightly Build
DO NOT USE Code::Blocks 1.0 RC2 or earlier, you must use the Nightly build or build from svn HEAD.
- Do not install the Nightly build over 1.0 RC2 or you will experience crashes. Unzip the build into a clean directory. You can unzip Nightly builds into a previous nightly build with no problems.
There are two downloads you must get from the Nightly build post:

    • wxmsw26u_gcc_cb.7z
    • CB_2006xxxx_revxxxx_win32.7z


unzip wxmsw26u_gcc_cb.7z into the directory you will unzip CB into.
You may have to copy mingwm10.dll from the MinGW bin directory to the Code::Blocks bin directory if you didn't download it from the Nightly Build page.

There are some more detailed install instructions that can be found on the Code::Blocks wiki site

Make sure that Code::Blocks found your MinGW 3.4.5 installation by following these instructions here: Code Blocks Compiler Setup

  • You will need the DirectX SDK if you plan to build and run in debug mode when using Direct3D9 Rendering mode. If you plan on building Ogre from source at a later date then you will need the DirectX SDK also.


Note: You do not need to download the dependecies package for Code::Blocks+MingW+STLPort, everything you need is included in the SDK.

Files in the SDK:

The Ogre Core libraries and plugins:

Missing table

Directory setup in Code::Blocks


CB_SetC_D.jpg

In the settings menu select Compiler and Debugger to setup the directories.

CB_CompilerDir.jpg

Setup the include directories for the compiler.

CB_LinkerDir.jpg

Setup the lib directories for the linker. Note that DirectX SDK lib is not used. The import libs in the Ogre dependencies will be used instead since MingW cannot link directly to the libs provided in the DirectX SDK.

CB_ResDir.jpg

Include directory for windows resource compiler.

Building


To build Ogre, open Ogre_stlp.workspace in Code::Blocks. Make sure you use Ogre_stlp.workspace and not Ogre.workspace. Ogre.workspace is for Code::Blocks 1.0 RC2 and does not use STLPort.

CB_BuildWorkspace.jpg

In the build menu select Build Workspace. This will build the debug and release targets of all projects listed in the workspace manager window.

When building Ogre for the very first time in Code::Blocks, a warning message will popup indicating that you must setup a global variable called stlport_dir.

CB_BV_Msg.jpg

Select OK and the Global Variable Editor will popup. All you have to do is fill in the base directory for stlport ie where you unzipped stlport in the dependencies zip and then select OK. The build process should then continue.

CB_GV_Dir.jpg

Note: The button to the right of the directory entry field will call up a directory dialogue so you can point and click the directory required. Do not fill in the fields below the Base Directory field.

The build process will take over an hour if all projects are built.

Building Ogre Core DLLs

If you don't want to build the samples then use Save Workspace as... in the file menu, change the save name ie to OgreCore_stlp.workspace. Then close the Samples/projects you don't want and save again. You can use this workspace to build Ogre each time you update from cvs.

Here is an example of the minimum Ogre Core DLL's that must be built for the SDK. This assumes you need the BSP and Octree scenemanagers, both DirextX and OpenGL renderers, are using Cg shaders, and CEGUI.

CB_OgreCoreWS.jpg

Note: Code::Blocks builds the projects in the order listed in the Manager window. Dependencies have been setup so that if you decide to build a demo before the core libraries, the core library projects are built first if required.

CodeBlocks Ogre SDK Tips

CodeBlocks MinGW FAQ


Alias: CodeBlocks_MingW_STLPort

<HR>
Creative Commons Copyright -- Some rights reserved.


THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

1. Definitions

  • "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
  • "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
  • "Licensor" means the individual or entity that offers the Work under the terms of this License.
  • "Original Author" means the individual or entity who created the Work.
  • "Work" means the copyrightable work of authorship offered under the terms of this License.
  • "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
  • "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.

2. Fair Use Rights

Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.

3. License Grant

Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:

  • to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
  • to create and reproduce Derivative Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
  • For the avoidance of doubt, where the work is a musical composition:
    • Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
    • Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
    • Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).


The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.

4. Restrictions

The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

  • You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
  • You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
  • If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.

5. Representations, Warranties and Disclaimer

UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.

6. Limitation on Liability.

EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. Termination

  • This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
  • Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.

8. Miscellaneous

  • Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
  • Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
  • If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
  • No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
  • This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.