glut-state.h

Go to the documentation of this file.

/*
 * glut-state.h
 *
 * Copyright (C) 2009  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Code to grab/display/save/restore OpenGL state.  Mostly helpful for
 * debugging!
 */

#ifndef WAVE_GLUT_GLUT_STATE_H__
#define WAVE_GLUT_GLUT_STATE_H__


// includes --------------------------------------------------------------------
#include "wave-glut.h"


namespace glut {

/// \ingroup wave_glut
/*@{*/


/// encapsulates a lot of OpenGL state
class State {
public:
        // virtual destructor --------------------------------------------------
        virtual ~State(void) throw();

        // glut::State class interface methods ---------------------------------
        virtual void dump(IN const char * msg) const throw() = 0;
        virtual void diff(IN const State * other) const throw() = 0;

        // static factory methods ----------------------------------------------
        static smart_ptr<State> snapshotFromOpenGL(void);
};




};      // glut namespace


#endif  //WAVE_GLUT_GLUT_STATE_H__