gls_state_manager.h

Go to the documentation of this file.

/*! \file
  \brief The disti::GlsStateManager factory class. Creates an instance of a
state manager that manages the GL Studio runtime library's use of
the OpenGL context, minimizing unnecessary state changes.
 
  \par Copyright Information
 
 Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>
 
  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.
 
  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
 
  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).
 
 The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America. Use, distribution,
duplication, or disclosure by the U. S. Government is subject to
"Restricted Rights" as set forth in DFARS 252.227-7014(c)(1)(ii).
 
*/
 
#ifndef DISTI_GLS_STATE_MANAGER_H_INCLUDED
#define DISTI_GLS_STATE_MANAGER_H_INCLUDED
 
#include "gls_state_manager_interface.h"
 
#ifdef GLES20
#    include "gls_state_manager_es20_interface.h"
#endif
 
/// \cond INTERNAL
#ifdef GLS_GL_DEBUGGING
#    define ERROR_CHECK() DistiAssert( GL_NO_ERROR == GlsStateManager::CheckError() );
#else
#    define ERROR_CHECK()
#endif
/// \endcond
 
namespace disti
{
/** The GlsStateManager singleton class that holds an instance of a
  * state manager that manages the GL Studio runtime library's use of
  * the OpenGL context, minimizing unnecessary state changes.
  */
class GlsStateManager
{
public:
    /** The singleton accessor method for an implementation of an IGlsStateManager, which manages
      * the GL Studio runtime library's use of the OpenGL context, minimizing unnecessary state changes
      * \return Returns a pointer to the IGlsStateManager implementation singleton.
      *         For OpenGL ES 2.0, returns an implementation of an IGlsStateManagerES20
      */
    GLS_EXPORT static IGlsStateManager* Instance();
 
    /// \return The value of glGetError(), and prints the value if not equal to GL_NO_ERROR.
    GLS_EXPORT static GLenum CheckError();
 
private:
    /** ctor */
    GlsStateManager();
 
    /** dtor */
    ~GlsStateManager();
 
    // Creates the proper instance for management by GlsGlobals
    static IGlsStateManager* CreateStateManager();
    friend class GlsGlobals;
};
 
} // namespace disti
 
#endif // DISTI_GLS_STATE_MANAGER_H_INCLUDED