Skip to content

Documentation: Xenon

Liam edited this page Nov 4, 2016 · 11 revisions

( Up one level: Root )

Overview

Xenon is an OpenGL abstraction library.

It is a class library designed for modular, efficient 3D and 2D graphics by cleanly and concisely wrapping OpenGL function calls (which interact with server-side object state) in relevant objects. It is designed to wrap OpenGL 3.2, but may be modified easily to cover older or newer versions of the library, to some extent.

The overall namespace is defined in Xenon/Xenon.h

The define XENON_DEBUG in Xenon.h turns on or off the inbuilt debugging output in the xenon library.

An SSE optimization toolset is defined in Xenon/SSE.h which is used frequently in the math subsection of the library.

The define SSE_ALLOW in SSE.h configures whether or not SSE should be used (if made available by the compiler) in generated machine code.

Classes and namespaces in the 'Xenon' namespace:

  • GPU: A namespace for all directly gpu-related Xenon features, such as buffers
  • Geometry: A namespace for all geometry utilities provided buy Xenon, such as generated primitive creation
  • Math: A namespace containing the Xenon linear algebra (and other math related code) library