API Reference Start Page

Introduction

What is this?

This is the complete API reference for OGRE (Object-Oriented Graphics Rendering Engine) version 1.9 ("Ghadamon"). Contained within are the specifications for each class and the methods from those classes which you can refer to when writing code which uses OGRE.

The API references for previous OGRE versions can be found under the following link: www.ogre3d.org/docs/api/X.Y (replace X.Y with the version number, for example 1.7 or 1.8).

It's so BIG!

Yes, yes it is (and thank you for noticing). OGRE is a large and complex system so the API documentation, whilst fully inclusive and the most complete reference to OGRE that you'll find, is not the recommended way to start learning. You will certainly want to refer to this documentation once you have found your feet, and pretty soon referring to it will become second nature. Until then, you should begin with more "discussive" documentation such as:

We make an effort to document our classes fully so we hope you can find what you need here. However, if you can't find it, or you're not sure where to start looking, visit the main OGRE website and dip into the community areas like the wiki and the forums to get some assistance.


Copyright © 2013 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Sat Dec 14 2013 14:36:58