Horde3D Wiki - User contributions [en]

Building Horde3D

2010-05-18T01:05:36Z

Swiftcoder: Added command line build instructions for Mac OS X

__NOTOC__ __NOEDITSECTION__{{ContentBlock|color=white|content={{!!}}
This article contains instructions for building Horde3D from source on all supported platforms. Since Horde3D is very lightweight and has a minimal amount of external dependencies, getting it to compile and run is usually quite straightforward.

== Obtaining the SDK ==

Besides the [http://sourceforge.net/projects/horde3d/files/ official release packages], there is also a subversion repository hosted at SourceForge which is usually more up-to-date than the stable point releases.

The repository has the common SVN structure ''branches'', ''tags'' and ''trunk''. The latest development snapshot can be found in the ''trunk'' folder, while the official releases are tagged in the ''tags'' folder. If you check out the trunk folder, you will get the SDK along with all official extensions.

See [[SVN Source Instructions]] for instructions on how to obtain code from Subversion.

== Building on Windows ==

The preferred way of building Horde3D on Windows is using '''Visual Studio'''. The SDK comes with a solution file for Visual Studio 2005 that can be opened with the Visual C++ Express Edition as well. If you have Visual Studio 2008 (Standard/Professional or Express), you can simply use the VS Conversion Wizard to update the solution and project files. The solution contains the samples that can be started directly from Visual Studio. Just set the desired sample as startup project.

It is also possible to use CMake to create the Visual Studio solution files. The process is similar to what you do on Linux then. However, if you want to use Visual Studio's ''nmake'', you usually have to use the Visual Studio Command Prompt instead of the standard ''cmd'' shell. Sample batch files for creating VS 2005 and 2008 projects can be found in the ''CMake'' folder located in the Horde3D repository.

== Building on Linux ==

The Horde3D SDK is compatible with gcc and ships with [http://www.cmake.org CMake] configuration files. To build Horde3D, just switch to the Horde3D root directory. Create a new directory which will contain the makefiles created by CMake, for example ''CMake'' and change into it. After that, type

cmake ..

which will create the makefiles. Once they are created, you can type <tt>make</tt> to build the code or <tt>make clean</tt> to remove all generated files.

=== Linkage order for your application ===
You must link Horde3D library to your final executable before GL one.

'''WRONG''':
gcc -o app main.cpp -lGL '''-lHorde3D'''

'''RIGHT''':
gcc -o app main.cpp '''-lHorde3D''' -lGL

This is required for GCC 3.x and 4.x series on Linux. If you don't follow the linkage order, you will get [http://horde3d.org/forums/viewtopic.php?f=2&t=384 glCreateShader error within h3dInit call].

== Building on Max OS X ==

Mac OS X is an advanced graphical system layered over a traditional Unix core. Because of this, you can either use Apple's graphical Xcode IDE to develop Horde3D based applications, or you can go the traditional Unix way using gcc and makefiles.

==== The Mac Way Using Xcode ====

To create the Xcode project files, you have to install CMake first. After installing the CMake command line tools (so choose NOT to skip the installation when asked during the CMake installation), you should be able to run CMake from the console. Switch to Horde3D root directory and create a new directory in which the CMake output will be stored, for example ''CMake''. Change the current directory to that newly created one and type

cmake -G "Xcode" ..

You should now be able to open the newly created project in Xcode in order to build Horde3D.

==== The Unix Way Using the Command Line ====

To create the Makefiles, you have to install CMake first. After installing the CMake command line tools (so choose NOT to skip the installation when asked during the CMake installation), you should be able to run CMake from the console. Switch to Horde3D root directory and create a new directory in which the CMake output will be stored, for example ''CMake''. Change the current directory to that newly created one and type

cmake -G "Unix Makefiles" ..

The current directory should now contain a set of Makefiles, and you can build Horde3D by typing

make

be warned that this makefile method generates an incorrect directory structure, and you may have to move the ''Content'' directory up one level before the samples will find their data.

}}

Community Roadmap

2009-07-21T18:32:58Z

Swiftcoder:

As a way to keep the Horde3D community on the same page in regards to the development of future features, this Community Roadmap will keep an up to date log of the undergoing activities.

{| cellpadding="2" cellspacing="0" style="width: 100%"
|- bgcolor="#6699FF" style="font-size: medium; font-weight: bold"
| Feature
| Description
| Assigned to
| Completion
| Release date
|-
| D3D Backend
| Write a D3D9/D3D10 backend, in addition to the current OpenGL backend
|  
| Waiting for definition of gfx API Abstraction Layer.
|  
|- bgcolor="#ECECEC"
| [[Community_Roadmap_-_Compressed_Texture_Support|Compressed Texture Support]]
| Support for DDS, PowerVR, and other Texture formats.
| swiftcoder
| superseded by 1.0 Beta3
|  
|-
| OpenGL ES2.x Backend
| Write a OpenGL ES2.x backend, Horde3D port for mobile platforms
|  
| In Standby. Waiting for definition of gfx API Abstraction Layer.
|  
|- bgcolor="#ECECEC"
| Ambient Occlusion
| Add ambient occlusion support for Horde3D
|  
|  
|  
|-
| [[Community_Roadmap_-_Alpha_Depth_Test|Alpha & Depth Test]]
| Provide support for the different tests in the shader context configuration, present in Community SVN
| AcidFaucet
| 100%
| (EST.) September 22nd, 2008
|- bgcolor="#ECECEC"
| [[Community_Roadmap_-_Shader_Context_Linking|Shader Context Linking]]
| Enable Shader XML to link to contexts in other shaders, [http://www.horde3d.org/forums/viewtopic.php?f=8&t=500 public draft available], currently experimenting with multiple implementations
| AcidFaucet
| 75%
| (EST.) September 26th, 2008
|-
| Terrain system improvements
| Enable larger terrains that can be "paged" in blocks. Enable different sources of data than just textures (eg: procedurally generated data).
| Reiko
| 25%
| No estimate

|}

<h3>Wishlist:</h3>
{| cellpadding="2" cellspacing="0" style="width: 100%"
|- bgcolor="#6699FF" style="font-size: medium; font-weight: bold"
| Feature
| Description
|-
| Texture Improvements
| Support for simple downloading of texture data, mipmaps for RTT render targets (for e.g. impostors)
|}
----

{| style="width: 100%"
|-
| <h3><span class="mw-headline">Upcoming Horde3D Version: 1.0</span></h3>
| <h3><span class="mw-headline">Upcoming Horde3D Editor version: 0.8</span></h3>
|-
| <b>The current version is: v1.0.0 Beta3</b>
| <b>The current version is: v0.8.0</b>
|-
|For version 1.0.0 Beta2 of Horde3D the following features have been
integrated:</p>
<ul>
<li><b>Support For Compressed Animations</b></li>
<li><b>Occlusion Culling For Light Sources</b></li>
<li><b>Statistics For Better Debugging</b></li>
<li><b>CMake Files For More Compiler Support</b></li>
</ul>
See also the [http://www.horde3d.org/docs/_changeLog.html changelog] for more details.
In the following weeks no new features will be implemented. Instead the development will be focused on bug fixes and further documentation.

| The next version 0.8.0 will be based on Horde3D v.1.0.0 Beta2 and will bring a sample plugin for attachments.
|}

Tutorial - Setup Horde with SDL

2008-10-11T21:44:35Z

Swiftcoder: Added SDL error checking.

{| border="0"
| {{ContentBlock|width=800|color=white
|content='''Here is a small example on how to use Horde with sdl.'''
Its a simple window that closes when the x is clicked
{{CppSourceCode|
description= Simple SDL Frame|
code=
<source lang="cpp" line="1">

#include <iostream>
#include <Horde3D.h>
#include <SDL.h>

using namespace std;

int main(int argc, char* args[]){
//Creates are bool value for the while loop.
bool running = true;

//Inits sdl with only the video extention.
if (SDL_Init(SDL_INIT_VIDEO) != 0) {
std::cerr << "SDL_Init failed: " << SDL_GetError() << std::endl;
return 0;
}

//Sets are window Caption
SDL_WM_SetCaption("Simple SDL Frame",NULL);

//Sets the sdl video mode width and height as well has creates are opengl context.
if (!SDL_SetVideoMode(800,600,32,SDL_OPENGL)) {
std::cerr << "SDL_SetVideoMode failed: " << SDL_GetError() << std::endl;
return 0;
}

//Creates Our Event Reciver
SDL_Event event;

//Inits Horde3D
Horde3D::init();

//Sizes the Horde3D View
Horde3D::resize( 0, 0, 800, 600 );

// Add pipeline resource
ResHandle pipeRes = Horde3D::addResource( ResourceTypes::Pipeline, "standard.pipeline.xml", 0 );
// Add model resource
ResHandle modelRes = Horde3D::addResource( ResourceTypes::SceneGraph, "character.scene.xml", 0 );
// Add animation resource
ResHandle animRes = Horde3D::addResource( ResourceTypes::Animation, "walk.anim.xml", 0 );
// Load added resources
Horde3DUtils::loadResourcesFromDisk( "" );

// Add model to scene
model = Horde3D::addNodes( RootNode, modelRes );
// Apply animation
Horde3D::setupModelAnimStage( model, 0, animRes, "" );

// Add light source
NodeHandle light = Horde3D::addLightNode( RootNode, "Light1", 0, "LIGHTING", "SHADOWMAP" );
// Set light position and radius
Horde3D::setNodeTransform( light, 0, 20, 0, 0, 0, 0, 1, 1, 1 );

//Sets the lightnodes radius
Horde3D::setNodeParamf( light, LightNodeParams::Radius, 50 );
//Sets the lightnodes Field of view
Horde3D::setNodeParamf( light, LightNodeParams::FOV, 90 );
//Sets the lightnodes ShadowMapCOunt
Horde3D::setNodeParami( light, LightNodeParams::ShadowMapCount, 3 );
//Sets the lightnodes ShadowSplitLambda
Horde3D::setNodeParamf( light, LightNodeParams::ShadowSplitLambda, 0.9f );
//Sets the lightnodes ShadowMapBias
Horde3D::setNodeParamf( light, LightNodeParams::ShadowMapBias, 0.001f );
//Sets the lightnodes red value
Horde3D::setNodeParamf( light, LightNodeParams::Col_R, 0.9f );
//Sets the lightnodes green value
Horde3D::setNodeParamf( light, LightNodeParams::Col_G, 0.7f );
//Sets the lightnodes blue value
Horde3D::setNodeParamf( light, LightNodeParams::Col_B, 0.75f );

// Add camera
cam = Horde3D::addCameraNode( RootNode, "Camera", pipeRes );

// Our While loop
while(running == true){
static float t = 0;

// Increase animation time
t = t + 10.0f * (1 / 60);
//Checks if there is a event that needs processing
if(SDL_PollEvent(&event)){
//Checks to see if the event is a SDL_QUIT*x on the window is clicked*
if(event.type == SDL_QUIT){
//Sets the while loop to false and ends program
running = false;
}
}

// Play animation
Horde3D::setModelAnimParams( model, 0, t, 1.0f );

// Set new model position
Horde3D::setNodeTransform( model, t * 10, 0, 0, // Translation
0, 0, 0, // Rotation
1, 1, 1 ); // Scale
// Render scene
Horde3D::render( cam );

//Swaps the sdl opengl buffers
SDL_GL_SwapBuffers();
}
//Releases the Horde3D Engine
Horde3D::release();
//Releases SDL and quits the program
SDL_Quit();

}

</source>
}}
--[[User:Wild13|Rj]] 05:28, 1 August 2008 (CEST)
}}
| valign="top" | {{Extension_Summary|
name = Horde With SDL|
screenshot = H3DPlaceHolder.png|
description = This tutorial introduces the use of Horde3D with SDL|
version = 1.0|
horde3dversion = 1.0 beta|
released = 2008-07-31|
author = Raynaldo Rivera|
}}
|}
[[category: Tutorials]]

Community Roadmap - Compressed Texture Support

2008-08-27T16:16:53Z

Swiftcoder:

=== Goals ===
Load textures in a variety of compressed formats: DXT/S3TC, PVRTC, ETC for now.
=== OpenGL tokens ===
<pre>GL_EXT_texture_compression_s3tc

GL_COMPRESSED_RGB_S3TC_DXT1_EXT
GL_COMPRESSED_RGBA_S3TC_DXT1_EXT
GL_COMPRESSED_RGBA_S3TC_DXT3_EXT
GL_COMPRESSED_RGBA_S3TC_DXT5_EXT

GL_IMG_texture_compression_pvrtc

GL_COMPRESSED_RGB_PVRTC_4BPPV1_IMG
GL_COMPRESSED_RGB_PVRTC_2BPPV1_IMG
GL_COMPRESSED_RGBA_PVRTC_4BPPV1_IMG
GL_COMPRESSED_RGBA_PVRTC_2BPPV1_IMG

GL_OES_compressed_ETC1_RGB8_texture

GL_ETC1_RGB8_OES</pre>
=== Discussion ===
I was initially going to add support for compressed textures directly to the existing texture loading functions, but given the differences in the way compressed textures are handled, this is not feasible. I plan to add a set of functions dedicated to loading compressed textures directly.

However, there are a few points in need of discussion:

'''Fallbacks:''' Although S3TC is present on all recent desktop hardware, PVRTC and ETC are specific to their respective hardware vendors, neither of which support S3TC.
Do we provide a fallback which decompresses these formats in software if they are not supported by the current hardware?
Do we provide a way for the application to query the supported compression formats at runtime?

'''Containers:''' Several of these formats have multiple containers, and some containers can contain multiple compression schemes.
Which format/container combinations do we want to support?

Community Roadmap - Compressed Texture Support

2008-08-27T16:05:37Z

Swiftcoder: New page: === Goals === Load textures in a variety of compressed formats: DXT/S3TC, PVRTC, ETC for now. === OpenGL tokens === <pre>GL_EXT_texture_compression_s3tc GL_COMPRESSED_RGB_S3TC_DXT1_EXT G...

Community Roadmap

2008-08-27T15:44:00Z

Swiftcoder:

2008-04-09T21:33:51Z

Swiftcoder:

<div class="noprint relarticle mainarticle">''Main article{{#if:{{{2|}}}|s}}: [[{{{1}}}|{{{l1|{{{1}}}}}}]]{{#if:{{{2| }}}
|{{#if:{{{3|}}}|, | and }}[[{{{2}}}|{{{l2|{{{2}}}}}}]]}}{{#if:{{{3|}}}
|{{#if:{{{4|}}}|, |, and }}[[{{{3}}}|{{{l3|{{{3}}}}}}]]}}{{#if:{{{4|}}}
|{{#if:{{{5|}}}|, |, and }}[[{{{4}}}|{{{l4|{{{4}}}}}}]]}}{{#if:{{{5|}}}
|{{#if:{{{6|}}}|, |, and }}[[{{{5}}}|{{{l5|{{{5}}}}}}]]}}{{#if:{{{6|}}}
|{{#if:{{{7|}}}|, |, and }}[[{{{6}}}|{{{l6|{{{6}}}}}}]]}}{{#if:{{{7|}}}
|{{#if:{{{8|}}}|, |, and }}[[{{{7}}}|{{{l7|{{{7}}}}}}]]}}{{#if:{{{8|}}}
|{{#if:{{{9|}}}|, |, and }}[[{{{8}}}|{{{l8|{{{8}}}}}}]]}}{{#if:{{{9|}}}
|{{#if:{{{10|}}}|, |, and }}[[{{{9}}}|{{{l9|{{{9}}}}}}]]}}{{#if:{{{10|}}}
|, and [[{{{10}}}|{{{l10|{{{10}}}}}}]]}}''{{#if:{{{11| }}}|  (too many parameters in {{[[Template:main|main]]}})}}</div>

2008-04-09T20:57:26Z

Swiftcoder:

Main Page

2008-04-09T20:54:09Z

Swiftcoder:

Welcome to the wiki for the open source next-generation graphics engine '''Horde3D'''.

This wiki collects information about how to make best use of the numerous features of Horde3D. Since it is a collaborative effort to which all community members are invited to contribute, the Horde3D team does not take any responsibility for the content or the accuracy of the content provided on these pages.

=='''Getting started'''==

* [http://www.horde3d.org/features.html] - Features supported by Horde3D
* [http://www.horde3d.org/screenshots.html] - Screenshots of sample applications created with Horde3D
* [http://www.horde3d.org/docs/_tutorial.html] - A small introductive tutorial which shows the API style

=='''Using Horde3D'''==

* [http://www.horde3d.org/docs/_usageguide.html#Concepts] - Introduction to basic concepts
* [http://www.horde3d.org/docs/_usageguide.html#Content] - Advice for bringing content to the engine
* [http://www.horde3d.org/docs/_usageguide.html#Advanced] - Introduction to more advanved topics

=='''Resources'''==

* [http://www.horde3d.org] - Official Horde3D Website
* [http://www.horde3d.org/forums] - Forums for discussions and support
* [http://www.horde3d.org/docs/manual.html] - Horde3D Manual
* [http://mm-werkstatt.informatik.uni-augsburg.de/Horde3DEditor] - Official Horde3D Editor

=='''Horde3D Development'''==
These pages are only of interest to developers who are modifying horde itself, or developing extensions.

[[Mac OS X]] - Development issues specific to Mac OS X

Main Page

2008-04-09T20:40:02Z

Swiftcoder: