Loading...
Searching...
No Matches
API Reference Start Page

# What is this?

This is the complete API reference for OGRE (Object-Oriented Graphics Rendering Engine). 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 reference for a specific OGRE version can be found under:

- https://ogrecave.github.io/ogre/api/13
- https://ogrecave.github.io/ogre/api/1.12

i.e. replace the last part with the version number, for example 14, 1.11, 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.
- The OGRE Tutorials: This is a gold mine for new and experienced users alike.

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.