Table of contents
I. Introduction
This article will explain the modifications that need to be made to Ogre and Ogre's dependencies, so they can be compiled with TDM 4.9.2 MinGW. Generally, this guide should apply to all MinGW64 editions.
It is meant for building Ogre 1.10.0 from source.
II. Ogredeps
1. To have a true static build, we also want static OIS. To achieve this we need to build it from source.
First get OIS source package here: OIS SourceForge repository
From here on let's assume you extracted the package into 'ois-v-1-3' (original folder name)
Open 'ois-v-1-3/Win32/ois.cbp' and go to project build options:
In all the build targets (select OIS), go to compiler search directories and change:
C:\Program Files\Microsoft DirectX SDK (November 2008)\Includeto
C:\C++\TDM-4.9.2\x86_64-w64-mingw32\include(This is an example installation dir of TDM, change it to yours)
In 'OIS_DebugDll' and 'OIS_ReleaseDll' build targets add these libraries to linker options: wbemuuid, ole32, oleaut32 (dinput8 and dxguid should already be there)
This package is designed to be compiled with MSVC, so we need to make some changes to the source to make it compile under TDM.
Open 'Win32Joystick.cpp'
At line 587 change this:hr = CoCreateInstance(uuidof(WbemLocator), NULL, CLSCTX_INPROC_SERVER, uuidof(IWbemLocator), (LPVOID*)&pIWbemLocator);To this:
hr = CoCreateInstance(CLSID_WbemLocator, NULL, CLSCTX_INPROC_SERVER, IID_IWbemLocator, (LPVOID*)&pIWbemLocator);At lines 637 and 641, replace
swscanf_swith just
swscanf
Now OIS should successfully build with only 25 warnings or so (it's safe to ignore them).
Open 'ois-v-1-3/lib' and rename libOIS_static.a to libOIS.a (same for the _d version)
2. Now that OIS is succesfully built you will want to get NVidia's Cg Toolkit from: https://developer.nvidia.com/cg-toolkit-download
Install the package.
The toolkit is in MSVC format and sadly doesn't work with MinGW, so we will need to convert it (read further about this here: http://www.mingw.org/wiki/msvc_and_mingw_dlls
Download 'reimp' tool to convert Cg libs from MSVC to MinGW format (Google will help you here).
Make a folder and call it 'converter'.
In 'converter' make two folders, one called 'bin' and the other 'lib'.
Move 'reimp.exe' into 'converter/bin'.
Copy 'cg.dll' and 'cg.lib' from Cg Toolkit's installation directory into 'converter/lib'.
Now open notepad and save this as 'convert.bat' (MAKE SURE THE EXTENSION IS .BAT AND NOT .TXT) in 'converter' folder.
set lib_file=Cg.lib set dll_file=Cg.dll set def_file=Cg.def set a_file=libcg.a cls @echo off cd lib echo [ Making .DEF file ] echo. ..\bin\reimp.exe -d %lib_file% echo [ Making .A linker library ] echo. echo. dlltool --as-flags=-64 -m i386:x86-64 --input-def %def_file% -dllname %dll_file% --kill-at --output-lib %a_file% echo Success, now exiting. exit
Run 'convert.bat' and you should find 'libcg.a' in 'converter/lib'. Use this instead of cg.lib in ogredeps (CMake should find it automatically, even when the names are not the same).
3. Now that OIS is succesfully built you need to get the rest of Ogredeps from here: Ogredeps Bitbucket repository
From here on, let's assume that you extracted the package into 'ogredeps' and used 'ogredeps-build' as the build directory.
On 64 bit systems, you need to change Line 210 of 'ogredeps\src\FreeImage\Source\FreeImage\PluginTIFF.cpp'
// Warning: tif_fd is declared as 'int' currently (see libTIFF), // may result in incorrect file pointers inside libTIFF on // 64bit machines (sizeof(int) != sizeof(long)). // Needs to be fixed within libTIFF. if (tif) { tif->tif_fd = (long)handle; } return tif;
Change to this:
tif->tif_fd = (intptr_t)handle;
zziplib builds fine itself, but it errors pop up when you try to link against it at the end of building Ogre.
# if defined _MSC_VER || defined __BORLANDC__ || defined __WATCOMC__to
# if defined _MSC_VER || defined __BORLANDC__ || defined __WATCOMC__ || defined _WIN32and line 162 from
#if defined _MSC_VER || defined __WATCOMC__to
#if defined _MSC_VER || defined __WATCOMC__ || defined _WIN32and line 166 from
#ifdef _MSC_VERto
#if defined _MSC_VER || defined _WIN32and line 186 from
#if defined _MSC_VER || defined __WATCOMC__to
#if defined _MSC_VER || defined __WATCOMC__ || defined _WIN32Then open "ogredeps/src/zziplib/CMakeLists.txt" and change line 45 from:
if (WIN32) add_definitions(-D_MSC_VER)to
if (WIN32 AND BUILD_SHARED_LIBS) add_definitions(-DZZIP_DLL) link_libraries(zlib)
In CMake uncheck "OGREDEPS_BUILD_OIS"
Ogredeps should build successfully. Run the 'install' build target.
Now run the 'edit_cache' build target and change CMAKE_BUILD_TYPE from "Release" to "Debug", then press generate and close CMake when it's done.
Build 'all' again and run 'install'.
Rename 'ogredeps-build/ogredeps' to 'Dependencies'.
Copy OIS includes and libs from OIS source dir to Dependencies (also the .dlls, even though we use static OIS, Ogre will want to see the .dlls because it expects dynamic OIS. Don't worry, Ogre will still link statically), make sure to follow the filesystem of the rest of the dependencies.
III. Ogre
Download Ogre from Ogre Bitbucket repository
From here on let's assume you extracted Ogre source to 'ogre' and use 'ogre-build' as the build directory.
Move 'Dependencies' into the 'ogre' folder.
To fix an Ogre bug with 64 bit MinGW, Open 'ogre/CMakeLists.txt', find the flag '-march=i686' and change it to '-march=native'.
Download the attached 'winres.h' file and put it in 'ogre/OgreMain/src/WIN32' (For some odd reason it's missing from newer commits)
In 'ogre/OgreMain/include/WIN32/OgreMinGWSupport.h' change line 46 from:
#define WINAPI_INLINE inlineto
#ifndef WINAPI_INLINE #define WINAPI_INLINE inline #endif // WINAPI_INLINE
Then, to remove an annoying warning that pops up a lot, change:
#ifndef __uuidof(Object)to
#ifndef __uuidof
Now open 'ogre/OgreMain/src/WIN32/OgreMinGWSupport.cpp' and comment out line 46 like this (it is already defined in TDM headers, multiple definitions cause errors):
//intptr_t __security_cookie;Then change line 48 from:
void _fastcall __security_check_cookie(intptr_t i)to
void _fastcall __security_check_cookie(uintptr_t i)
Edit 'ogre/RenderSystems/Direct3D9/src/OgreD3D9Plugin.cpp'.
void _fastcall __security_check_cookie(intptr_t i);to
void _fastcall __security_check_cookie(uintptr_t i);And change line 63 from:
__security_check_cookie((intptr_t)NULL);to
__security_check_cookie((uintptr_t)NULL);
Edit 'ogre/RenderSystems/Direct3D9/include/OgreD3D9Prerequisites.h' at line 75:
#include <DxErr.hAdd
#include <dxerr9.h> #define DXGetErrorDescription(hr) DXGetErrorDescription9(hr)
Edit 'ogre/RenderSystems/Direct3D9/src/OgreD3D9HLSLProgram.cpp'.
#include <d3dcompiler.h>
At line 865 (864 originally, 865 after added include) change:
LPD3DXBUFFER pDisassembly=0; HRESULT hr=D3DXDisassembleShader(code,FALSE,"// assemble code from D3D9HLSLProgram\n",&pDisassembly);to
LPD3DBLOB pDisassembly=0; HRESULT hr=D3DDisassemble(code,sizeof(code),FALSE,"// assemble code from D3D9HLSLProgram\n",&pDisassembly);
In 'ogre/RenderSystems/Direct3D9/src/OgreD3D9RenderSystem.cpp' change line 473 from:
d3dEx->QueryInterface(__uuidof(IDirect3D9), reinterpret_cast<void **>(&mD3D));to
d3dEx->QueryInterface(IID_IDirect3D9, reinterpret_cast<void **>(&mD3D));
In 'ogre/RenderSystems/GL/src/Win32/OgreWin32Window.cpp' change line 260 from:
+ ::Ogre::StringConverter::toString(le)to
+ ::Ogre::StringConverter::toString(size_t(le))
In 'ogre/Samples/EndlessWorld/include/EndlessWorld.h' change line 143 from:
String lName = StringConverter::toString((unsigned long)(t))+"/"+"LodInfoLabel";to
String lName = StringConverter::toString((size_t)(t))+"/"+"LodInfoLabel";
CMake settings:
CMAKE_BUILD_TYPE: (do both Release and Debug separately running install after each one, just like when building ogredeps)
Change DirectX9_D3DX_LIBRARY to: C:/C++/TDM-4.9.2/x86_64-w64-mingw32/lib/libd3dx9_43.a
Change DirectX9_DXERR_LIBRARY to: C:/C++/TDM-4.9.2/x86_64-w64-mingw32/lib/libdxerr9.a
Change DirectX9_DXGUID_LIBRARY to: C:/C++/TDM-4.9.2/x86_64-w64-mingw32/lib/libdxguid.a
Change DirectX9_INCLUDE_DIR to: C:/C++/TDM-4.9.2/x86_64-w64-mingw32/include
Change DirectX9_LIBRARY to: C:/C++/TDM-4.9.2/x86_64-w64-mingw32/lib/libd3d9.a
Untick OGRE_BUILD_PLUGIN_CG
Untick OGRE_BUILD_RENDERSYSTEM_D3D11
Tick OGRE_BUILD_RENDERSYSTEM_GL3PLUS
Tick OGRE_STATIC
Now generate makefiles.
DO THIS STEP AGAIN AFTER BUILDING RELEASE (OR DEBUG) AND SWITCHING TO THE OTHER (regenerated makefiles will reset this file):
Edit 'ogre-build/Samples/Browser/CMakeFiles/SampleBrowser.dir/link.txt' by adding "-lwbemuuid -ldinput8 -ldxguid -ld3dcompiler_46" at the end of it (we need to link against extra libs, because we use static OIS and because we included d3dcompiler in DirectX9). Sadly, DirectX is not static, so you will need to get d3dcompiler_46.dll from the Windows 8 kit bin folder.
Now after all these changes (whew!), you can finally open the project file and build Ogre. Remember to build and install both targets. When all is done, run SampleBrowser to make sure it works - if it doesn't, something went wrong in the process. If that happens, first make sure you followed all the steps carefully. If you did, post about the problem details in the forum help section.
You may delete OIS.dll and OIS_d.dll from the 'ogre-build/sdk/bin' folder as they are not needed, OIS is static.
Because of this, you must remember to link against wbemuuid, dinput8, dxguid and, if you use directx9 rendering, d3dcompiler_46 in your Ogre projects.
Another thing to remember is to add OgreWin32Resources.res to your projects, all static builds of Ogre need it.
IV. Known problems:
- DirectX11 render system won't compile, it's not supported by MinGW
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.