glut-state.h

Go to the documentation of this file.
00001 /*
00002  * glut-state.h
00003  *
00004  * Copyright (C) 2009  Thomas A. Vaughan
00005  * All rights reserved.
00006  *
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *     * Redistributions of source code must retain the above copyright
00011  *       notice, this list of conditions and the following disclaimer.
00012  *     * Redistributions in binary form must reproduce the above copyright
00013  *       notice, this list of conditions and the following disclaimer in the
00014  *       documentation and/or other materials provided with the distribution.
00015  *     * Neither the name of the <organization> nor the
00016  *       names of its contributors may be used to endorse or promote products
00017  *       derived from this software without specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
00020  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
00021  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00022  * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
00023  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
00024  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00025  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00026  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00027  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00028  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00029  *
00030  *
00031  * Code to grab/display/save/restore OpenGL state.  Mostly helpful for
00032  * debugging!
00033  */
00034 
00035 #ifndef WAVE_GLUT_GLUT_STATE_H__
00036 #define WAVE_GLUT_GLUT_STATE_H__
00037 
00038 
00039 // includes --------------------------------------------------------------------
00040 #include "common/common.h"
00041 #include "threadsafe/smart_ptr.h"
00042 
00043 #include "GL/glew.h"
00044 #include "GL/glxew.h"
00045 #include "GL/freeglut.h"
00046 
00047 
00048 namespace glut {
00049 
00050 
00051 /// \ingroup wave_glut
00052 /*@{*/
00053 
00054 
00055 /// encapsulates a lot of OpenGL state
00056 class State {
00057 public:
00058         // virtual destructor --------------------------------------------------
00059         virtual ~State(void) throw();
00060 
00061         // glut::State class interface methods ---------------------------------
00062         virtual void dump(IN const char * msg) const throw() = 0;
00063         virtual void diff(IN const State * other) const throw() = 0;
00064 
00065         // static factory methods ----------------------------------------------
00066         static smart_ptr<State> snapshotFromOpenGL(void);
00067 };
00068 
00069 
00070 
00071 
00072 };      // glut namespace
00073 
00074 
00075 #endif  //WAVE_GLUT_GLUT_STATE_H__
00076