Hydrax.jpg
Author: Xavier 'Xavyiy' Verguí­n González
Project: OGRE Add-on Library (water)
Version: 0.5.1
Supported Platforms: Windows, Linux, Mac
Supported Ogre Releases: 1.4, 1.6, 1,7, 1.8, 1.9
Official Download Page: Hydrax & SkyX at Paradise Studios
Documentation: API Documentation(0.5 for the moment, 0.5.1 included in the sources .rar package), Demo application source code and forum support
License: GNU Lesser General Public License (LGPL) (free for any use)
Status and bug reports: Hydrax forum

Introduction

Hydrax is an add-on for Ogre which aim is to provide an easy-use library in order to render pretty water scenes.

It's fully configurable, all effect, such as water depth effects, smooth transitions, foam effects, caustics, underwater god rays, ... can be modified in real-time as well as all options that do not depend of shaders such as Rtt's texture quality, hydrax geometry and noise modules options, you can change between different modules(geometry and noise) on-fly, etc... Hydrax has a modulable interface wich allows any kind of water geometry, actually there're three modules availables: The infinite ocean module, based on the projected grid concept, the simple grid module and the radial grid module; of course, hydrax geometry modules and noise modules can be coded by users.

Videos

Screenshots

Hydrax_screenshot.png
Hydrax screenshot 2
Hydrax_04_5_.png
Hydrax_04_2.png
Hydrax_04_1_.png

Underwater rendering: (With underwater reflections and sun god rays!)
Hydrax_04_3_.png
Hydrax_04_4_.png

Videos

Main features

  • Realistic fresnel refraction and reflection effects
  • Intelligent depth effects based on depth maps
  • Smooth transitions effects: Smooth transitions with all objects in the scene using the depth map
  • Caustics effects
  • Sunlight effects (Colour, Position, Sun strength, area, etc...)
  • Full underwater effects like underwater reflections, god rays...
  • Foam effects
  • Water editor
  • Vertex and GPU Normals generation
  • Decals support (to place any kind of texture on the water, like ship trails, water vegetables, etc)
  • Modulable interface (Geometry and noise modules)
  • HLSL and CG support (and GLSL in future versions)


Geometry modules:

  • Projected grid
  • Simple grid
  • Radial grid


Noise modules:

  • Perlin
  • FFT

For more information go to the Hydrax forum.

Downloads


Official download link can be found at the top of this page. Below are some alternative mirrors and links to forks:

In lack of updates from the original author, here is a Github repository with latest community version and fixes:
(Current version 0.5.4-5 (last updated 2012-11-01))
https://github.com/imperative/CommunityHydrax


Linux install packs (by user SanguinarioJoe):
(None of these links seem to work anymore, but the same packages seem to be in the "Mirror of all published Hydrax files" link right above this.

Support the author

If you have loved Hydrax, consider making a donation: (Xavyiy)
Image

Current development status 2012-11

There hasn't been any activity from Hydrax author for a while, and many others has been finding bugs on the forum and even developing some new features. However since there was no central public place for Hydrax code, people have been just making their changes public on the forums in different places. So now I've tried to gather together all those fixes and start a community-maintained repository of the “latest” version of Hydrax. (github repository)

If you find any bugs or develop new features which you feel should be a part of generic Hydrax (and not some specific modification for your application), please add them to this repository. Either send a pull request or ask me (“heavydist” on the forums) to add you to the repository. You can even help the project by for example incorporating the demo into the repository, or writing documentation, etc...

Also, here are some notes and some ad-hoc documentation which I've compiled based on my experiments with Hydrax.
Current status (what works).
If you start up the Hydrax/SkyX demo, you may notice that it only allows you to choose the Direct3D rendering system, and as it turns out, that's not a coincidence. Many things did not work correctly for my project in OpenGL, and it seems that Hydrax did not fully support it. However the things that didn't/don't work are due to lack of testing, not due to not being implemented, so you should be able to easily fix them.

The situation with shaders requires special attention: original hydrax provides a choice of which shader language to use: Cg, HLSL or GLSL. All the shaders used by Hydrax are dynamically generated in MaterialManager.cpp and not stored in any resources. For example the dynamic generation can remove some textures from the shader if you shutdown certain functions of Hydrax.

But the choice of shader language has created a lot of problems: in most cases, both the original author and some of the people working on the project have only been testing one shader language (the one they've been using in their project), and different things have worked differently in different languages. You can find many threads on the forum about things working in HLSL, but not in GLSL, or looking one way in cg, but not in HLSL, etc. This is both because there are different parts of code generating different shader language code, but also because there seem to be some subtle caveats, like HLSL and cg not being *exactly* the same, even though they appear to, or cg shaders handling differently in Direct3D or OpenGL, etc.

The described problem, as well as the fact that everything that is needed for Hydrax can be done in cg, which compiles both for OpenGL and DirectX, I don't see the point in maintaining the support for different shader languages or even it's purpose from the beginning.

I've been only developing the cg version of shaders, and I advise you to do the same. At this point (0.5.4 unofficial) cg seem to be the version where most features work.


Things that people often ask about and that don't seem to be implemented right now are multiple hydraxes in the same scene and water which does not have the default planar shape perpendicular to y-axis. Both of them could be implemented of course, but you would have to really get familiar with how Hydrax is built and make a lot of modifications to it. Please submit a patch to the repo if you do though.

Otherwise just check out the Demo to see how to use it and play with parameters, it's all pretty obvious.

Currently known “bugs”:
The certain bugs I know about I've put into the Community Hydrax code, but these are more cases of strange behaviour which I am not sure are due to a bug in Hydrax, they probably just due to me not using it correctly. But if you would stumble upon these, at least you will know how to fix them:
Normal calculation in NM_VERTEX
In MaterialManager.cpp there is a clause that calculates a term called dotProduct (in the shader) differently for NM_VERTEX than it does for the other two types of rendering. In my application that caused the term to always be 0, and the water was not rendered correctly.
If you want to know if your water suffers from this, try to set globalTransparency Hydrax config value to 0 and check if the water looks fine. If there are like no reflections at all, you have this problem.
(also this is the problem to fix if your image suffers from distant horizon looking too sharp)
Fix: changed 

else
	{
		FragmentProgramData +=
			"float dotProduct=dot(-camToSurface,pixelNormal);\n"; 
	}


to 

else
	{
		FragmentProgramData +=
			"float dotProduct=dot(camToSurface,pixelNormal);\n"; // was -camToSurface
	}

This bug seemed to be the same in both OpenGL and DirectX.

Reflection flipped:
For some reason DirectX and OpenGL handles a certain parameter differently in the cg shader, which for my application caused the reflection to be flipped in one of them or the other. And it only happened in some weird conditions, like other compositors being added to the scene, obscure...
Anyway, if you do have this problem, you WILL know, the reflection looks completely fucked up, like this: http://www.youtube.com/watch?v=DC1SV41lypI
But the fix is simple:
Find the line 

"float3 reflection=tex2D(uReflectionMap,ProjectionCoord.xy+pixelNormalModified);\n" +

and insert this right before it: 

"ProjectionCoord.y = 1.0 - ProjectionCoord.y;\n" +

Roadmap

Version 0.6:

Library:

  • Improve underwater rendering. Update underwater depth calculations based on the distance, like the Crysis (Crytek) approach.
  • Improve Perlin and FFT normal map generator shaders
  • GLSL shaders
  • Multi-camera rendering support
  • Ogre 1.7.X native support


Editor:

  • Port RBGui to Ogre 1.7.X
  • Port the editor to Ogre 1.7.X


Demo:

Examples:

  • Advanced example: using custom textures for depth calculations (0.5 version feature)
  • Advanced example: creating ship trails (decals).


Tutorials:

  • Creating custom geometry and noise modules


See also

<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.