%prevogre%

Download the SDK

Ogre 1.4.0 SDK for Code::Blocks + MingW

Ogre 1.2.5 SDK for Code::Blocks + MingW

MingW will statically link libstdc++ (the library portion, not the STL) to each build ie each dll or exe. 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/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 in gdb and you find out quickly that a crash occurs in OgrePlatform_d.dll 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 and crashes occur.

libstdc++ was rebuilt with the configure option --enable-fully-dynamic-string so that strings are dynamically allocated using the RTL and can be passed across the dll boundry.<br />

wchar, wstring and wide streams for unicode support don't work in the standard pre-built libstdc++ that comes with g++ 3.4.5. libstdc++ was rebuilt with wchar, wstring and wide stream to support wide strings so that Ogre 1.4.x could be built.

The Ogre SDK comes with:

• all the Ogre modules built for you ie the dll's and static archives
• 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

The SDK was built and tested with the following:

MinGW C++ Toolbox

Download the MinGW C++ Toolbox provided on the Ogre SF files site. MinGW must be setup before running Code::Blocks for the first time to make detection of MinGW go smoothly.

• MingW C++ Toolbox:

Download the installer package which will install the following in your mingw directory ie c:\mingw.

• gcc-core-3.4.5-20060117-1
• gcc-g++-3.4.5-20060117-1 with modified libstdc++ with dynamic string and wide string support (online Manual)
• w32api-3.8
• binutils-2.17.50-20070129-1 (online Manual)
• mingw-runtime-3.11
• gdb-6.3-2.exe (online Manual)
• DrMingw (online manual)

MinGW Toolbox Install Guide

Read the MinGW Toolbox Install Guide before running the toolbox installer.

Code::Blocks

• Code::Blocks - Release 8.02

There is an official release of Code::Blocks as of February 2008. This supersedes the previous release candidate, which even the
Code::Blocks team didn't recommend anyway. For the longest time, to use Code::Blocks you had to have a nightly build of the development trunk,
certainly so if you wanted to compile OGRE. If you have used release candidate RC2 or one of the pre-release nghtly builds, do get the
new official release instead! In any case, the build files supplied with OGRE will not work with the old release candidate.

Check Code::Blocks + MinGW installation

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

DirectX 9.0c August 2006 edition

• Download the SDK
  . 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 that this SDK doesnt work on Windows 2000 or less.

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

The Ogre Core libraries and plugins:

The Ogre Core libraries and plugins:

• CEGUI 0.5.0
• zlib 1.2.3
• zziplib 0.13.49
• FreeImage 3.9.3 cvs HEAD
• Cg 1.4.1
• FreeType 2.3.0
• DX9.0c SDK Aug 2006

Installation size is 234 Megs after the installer decompresses

Before you install the Ogre SDK make sure Code::Blocks is not running. The Ogre SDK installer will set an environment variable OGRE_HOME and if Code::Blocks is running then it won't see it until the next time you run Code::Blocks. There is another way to get Code::Blocks to see the new environment variable without restarting Code::Blocks but for new users the simplest way is to not have CB running when the Ogre SDK is installed.

Run OgreSDKSetup1.4.0_CBMingW.exe which will install the Ogre SDK into c:\OgreSDK if you don't change the installation directory. The installer will create an Environment Variable called OGRE_HOME that points to the SDK installation directory. If you decide to change the SDK directory name or move the SDK after installation, make sure you update OGRE_HOME in your environment settings.

NOTE: Some people have had linker problems when the SDK is intalled in a directory that has spaces in its name so it is recommended not to install the SDK into a directory that uses spaces in its name.

After the installer finishes, you should do a confidence test to make sure MingW and Code::Blocks are setup properly. If the dev tools are setup correctly you should be able to build all the demos in debug and release with a few clicks of the mouse.

Launch Code::Blocks and then open Samples.workspace in C:\OgreSDK\Samples directory. Select build workspace in the build menu. Both debug and release targets will be built and takes about 13 minutes to do all demos on a Athlon XP 2000+ with 512Megs ram.

To run a demo within CB, right click on the demo in the project listing, then select Activate Project. You can now do Ctrl-F10 or click on the blue arrow (looks like a play button) beside the blue gear. A window will probably popup if target is set to all asking you to select Debug or release.

Have a look at the build options for Demo_CameraTrack, most of the demos use the same build options.

Note: with MinGW gcc 3.4.5 you can link directly against dll's built by gcc 3.4.5 and do not require an import lib. This is the same setup on Linux where you link directly to the shared object (.so). This is why the SDK does not come with import libs for Ogre. You don't need them.

Build options that you should use:

Normally you will have two targets: Debug and Release.

To create a new target:

1. Right click on the project in the Management window and select Properties in the popup and this will open up the properties window for your project.
2. Select the Target tab.
3. Select Add to define a new target.
4. Type in the target name ie Debug.
5. Select OK.

Select Build Options to modify build options for a target.

Project build options

will be used for both Debug and Release target build options:

ensure Selected compiler is: GNU GCC Compiler

• Compiler
  • Other options
    • -mthreads
    • -fmessage-length=0
    • -fexceptions
    • -fident
• Linker
  • Other linker options:
    • -Wl,--enable-auto-image-base
    • -Wl,--add-stdcall-alias
• Directories
  • Compiler
    • $(OGRE_HOME)\include
    • Your project include directories
  • Linker
    • $(OGRE_HOME)\bin\$(TARGET_NAME)

this is the path to OgreMain.dll or OgreMain_d.dll depending on TARGET_NAME state. $(TARGET_NAME) is a built in Code::Blocks macro that you can use in your project settings. It gives you the active project target build name.

Debug build target options:

ensure Selected compiler is: GNU GCC Compiler
set Policy to 'Append target options to project options'

• Compiler
  • '#defines'
    • WIN32
    • _DEBUG
    • _WINDOWS
• Linker
  • Link libraries:
    • Your project dll's or static libs (.a)
    • OgreMain_d
      this is the name of the debug build of OgreMain dll.
    • OIS_d.dll
      this is the debug build of OIS found in the SDK bin folder. (needed in 1.4.0)

Release build target options:

ensure Selected compiler is: GNU GCC Compiler
set Policy to 'Append target options to project options'

• Compiler
  • '#defines'
    • WIN32
    • NDEBUG
    • _WINDOWS
• Linker
  • Link libraries:
    • Your project dll's or static libs (.a)
    • OgreMain
      this is the name of the release build of OgreMain dll.
    • OIS.dll
      this is the release build of OIS found in the SDK bin folder. (needed in 1.4.0)

Note: OGRE_HOME is a pre-defined environment variable setup by the SDK installer. OGRE_HOME points to the directory where the SDK is installed. You can use $(OGRE_HOME) within your build options when setting up paths to specific directories with the SDK that you will need to access.

• ParticleFx demo in GL rendering has problem on ATI cards with latest catalyst driver

• There are some memory leaks in debug builds of apps using CEGUI.

Make sure you have the latest Code::Blocks and MingW C++ Toolbox installed.

If you decide you want to keep current with cvs and not wait for the next SDK release, get the Ogre source from cvs. Use the latest stable branch (v1-4-5 "Eihort" as of September 2007).

You need to install the DirectX SDK. Get the August 2006 edition since the dependencies contain the import libs only for this version.

To build the Ogre 1.4.x source, you will need to install the Ogre 1.4.x Dependencies file.
It contains all the dependencies pre-built for use with Ogre 1.4.x. It includes the debug and release import libs pre-built using the August 2006 DirectX SDK. Don't use the libs that come with MingW.

To build the Ogre 1.2.x source, you will need to install the Ogre 1.2.3 Dependencies file.
It contains all the dependencies pre-built for use with Ogre 1.2.3. It includes the debug and release import libs pre-built using the August 2006 DirectX SDK. Don't use the libs that come with MingW.

Unzip the dependencies into your Ogrenew directory.

• CEGUI 0.5.0
• zlib 1.2.3
• zziplib 0.13.49
• FreeImage 3.9.3 cvs HEAD
• Cg 1.4.1
• FreeType 2.3.0
• DX9.0c SDK August 2006 debug and release import libs

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

Setup the include directories for the compiler.

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.

Include directory for windows resource compiler.

To build Ogre in Code::Blocks, open the Ogre.workspace file. If you have installed or are using Code::Blocks + MinGW + STLPort, open the Ogre_stlp.workspace file.

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

The build process will take about 30 minutes on a AMD Athlon XP 2000+ with 512Megs if all projects are built.

You will (hopefully) find the newly build sample demos under:

• ogrenew\Samples\Common\bin\Debug
• ogrenew\Samples\Common\bin\Release

Building Ogre Core DLLs

If you don't want to build the samples choose Save Workspace as... under the file menu, enter OgreCore_stlp.workspace for the file name and save. Next, close the samples and projects in the workspace that you don't want, and save again. You can use the OgreCore_stlp workspace to re-build Ogre each time you update from CVS.

Here is an example of the minimum Ogre Core DLLs that must be built for the SDK. This assumes that you are utilizing the BSP and Octree scenemanagers, both DirectX and OpenGL renderers, CG shaders, and CEGUI.

Note: Code::Blocks builds the projects in the order listed in the Manager window. Dependencies have been set up to insure that if you decide to build a demo before the core libraries, the core library projects will be built first.

---

Alias: Codeblocks_and_MinGW

<HR>

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.