Student: Noam Gat
Mentor: Assaf Raman
Status: Development complete, merged into Ogre 1.6
Keeping up with the latest in bleeding edge technologies is a tough task in the 3d rendering world. New technologies are being developed, which require a state-of-the-art 3D engine to be in constant development in order to keep up. I would like to help the Ogre project keep up with the pack by adding in support for geometry shaders.
One of the biggest changes in the DirectX 10 / Shader Model 4 generation is the introduction of Geometry Shader support. Geometry shaders open up new opportunities for developers to perform operations that were used to be only possible in the CPU. Some examples of the possibilities include shadow volume extrusion ( http://msdn2.microsoft.com/en-us/library/bb172445(VS.85).aspx ), single pass render-to-cubemap (http://msdn2.microsoft.com/en-us/library/bb172445(VS.85).aspx ), GPU only particle systems ( http://msdn2.microsoft.com/en-us/library/bb172445(VS.85).aspx ) and many more.
With support for the new generation of shaders already out for both DirectX and OpenGL (Ogre's main render systems) it seems like the perfect summer to add geometry shader support to Ogre.
Stage 1 (May 26 - June 2) (DONE) : Add geometry shader support to the GpuProgramManager and Pass, so that the render system gets the information. (Time estimation - A week, its mostly interface work and there are already similar classes to base it on)
Stage 2 : (June 3 - June 24) (DONE) : Add geometry shader support to the OpenGL render system. The GL render system has been selected because only DirectX10 supports geometry shaders, and the DX10 render system is still in early stages. (Time estimation - Three weeks, because most of the work for stage 3 will also be done here because I will need to test the implementation somehow)
Stage 3 : (June 24 - July 1st) (DONE) : Create a basic demonstration application which uses a geometry program. (Time estimation - A week. This is more of a cleanup phase. The demo will already be ready, but cleanup of the code & documentation will have to be done to move the code from an internal playpen project to a proper sample people can learn from).
Milestone 1 (July 1st) (DONE) : When these first three steps are done, Ogre already has functional geometry shader support. Won't be too comfortable to use (programs have to be defined in code) and won't have much of a wow factor (no examples showing off next-gen features) but it will work.
Stage 4 (July 1st - July 15) (DONE) : Add geometry shader support to Ogre's scripting interface. Geometry program declaration in .program scripts and referencing in material definition. (Time estimation - two weeks. Like stage 1, I have code to base this part on, but I am not currently familiar with the implementation of Ogre's scripting interface and might decide to add this to the next generation of script compilers rather than the current one)
Stage 5 (July 15 - July 29) (DONE) : Create more advanced geometry shader examples, using the scripts for their definitions this time. This set of examples should be reusable in real-world scenarios. This will probably mean porting some demos to Ogre (perhaps from the DX10 SDK). (Time estimation - This stage is the first diverse stage, because depending on time constraints I can put more (or less) effort into it since more examples can always be added).
Milestone 2 (End of july) (DONE) : Ogre now has proper geometry shader support, including script support and some eye-poking examples, making sure the whole world knows that Ogre supports geometry shaders.
Milestone 2 is the core of what definitely needs to be achieved in the project. When I achieve it, I will continue working on features which are less critical.
Stage 6 (August 1 - August 7, if selected) (NOT SELECTED) : Add geometry shader support to the DX10 render system. The render system is not part of Ogre's core distribution yet, so this is of lesser priority. Also, since DX10 is windows vista only, less end-users will be able to take advantage of this addition. I do personally know Assaf Raman, the creator of the DX10 render system, which will make it easier to integrate it into the render system if I find the time to do so. (Time estimation - If the DX10 render system will be in a state that this stage will be possible, I don't expect many difficulties since I already implemented it for one render system)
Stage 7 (August 1 - August 7, if selected) (DONE) : Add geometry shader support to the CG program manager. This is more of a future compatibility move, but is also for current user. Despite the current cg compiler not supporting DX10 HLSL or ATI cards, it does already have profiles for geometry shaders. This will enable people who are accustomed to CG but not GLSL to develop geometry shaders as well.
Stage 8 (August 1 - August 14, if selected) (NOT SELECTED) : Integrate a geometry shader-based shadow technique in Ogre. This will allow users of SM4-level hardware to utilize the additions in a relatively out-of-the-box manner, much like some of Ogre's current shadowing options. (Time estimation - Most of the code will be based on the stencil shadow implementation which Ogre already has, but this still requires quite a bit of work. However, I will already have much knowledge about geometry shaders at this point so I believe it is very possible.)
Two unplanned stages were added (and completed) - Add RenderToVertexBuffer API, and implement the feature in OpenGL.
The code has been merged into the Ogre 1.6 code base, so it can be found in
If for some reason you want to have a look at the original code branch, it will still be available at
The sample created in stage 5 is a port of NVIDIA's IsoSurf example to Ogre. The sample makes use of the API (Stage 1), the OpenGL implementation (Stage 3), Scripting interface support (Stage 4) and the CG program manager (Stage 7), so it pretty much sums up all the work that has been done so far.
It can be found in the Isosurf Showcase thread in the Ogre3D forums.
After the two unplanned stages were done, the ParticleGS demo (which required them) was also ported.
It can be found in the PartcleGS Showcase thread in the Ogre3D forums.
Thats all folks!
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.
- "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.
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.
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.
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.
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.
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.
- 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.
- 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.