API Reference Start Page

Introduction

What is this?

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

The API references for some of the 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, 1.8, etc.).

It's so BIG!

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:

• The Manual: The OGRE manual is a general introduction to the OGRE principles and core components, and a reference to various important parts of the OGRE system, especially the script syntax for materials, particle systems, and overlays. You should find a local copy of this in your distribution.
• The OGRE 2.1 FAQ: This page contains a list of frequently asked questions (FAQ) around Ogre 2.1, pertaining to its general state, the supported rendering components as well as more specific building / compiling / coding questions. This list will be extended as new central questions arise.

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.

License

The OGRE rendering engine itself is licensed under the MIT License. More details can be found here.
This documentation work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Copyright © 2015 Torus Knot Software Ltd