RE/RE_OGLErrorChecker.h

Go to the documentation of this file.

#ifndef __RE_OGLErrorChecker__
#define __RE_OGLErrorChecker__

#include "RE_API.h"
#include <UT/UT_Defines.h>

class RE_OGLRender;

//
//  functions for checking the OpenGL state for invalid operations
//
//  RE_CHECK_STATE      ERROR CHECKING (cumulative):
//
//      0               No checking performed.
//      1               Check for valid context, errors checked on swapbuffers
//      2               errors checked by RE_CheckNoErrors...()
//      3               errors checked every glEnd...() call.
//      4               OpenGL state verified for each RE call (debug RE).
//

// by default, we check for a valid context, and for errors on swapbuffers().
#ifndef RE_CHECK_STATE
#ifdef UT_DEBUG
#     define RE_CHECK_STATE     4
#else
#     define RE_CHECK_STATE     0
#endif // UT_DEBUG
#endif // RE_CHECK_STATE


#if (RE_CHECK_STATE >= 1)
    #define     RE_CheckForErrorsOnSwap()       REcheckForErrorsOnSwap()
    #define     RE_CheckValidContext()          REcheckValidContext()
    #define     RE_CheckNoErrors(string)        REcheckNoErrors(string)
    #define     RE_CheckInBegin( )              REcheckInBegin()
    #define     RE_CheckNotInBegin( )           REcheckNotInBegin()
    #define     RE_CheckInBeginWithoutContext() \
                                REcheckInBeginWithoutContext()
    #define     RE_CheckNotInBeginWithoutContext()      \
                                REcheckNotInBeginWithoutContext()
    #define     RE_Begin()                      REbegin()
    #define     RE_End()                        REend()

    #define     RE_SetLockedContext(render)     REsetLockedContext(render)
#else  /* RE_CHECK_STATE */
    #define     RE_CheckForErrorsOnSwap()
    #define     RE_CheckValidContext()
    #define     RE_CheckNoErrors(string)
    #define     RE_CheckInBegin( )
    #define     RE_CheckNotInBegin( )
    #define     RE_CheckInBeginWithoutContext( )
    #define     RE_CheckNotInBeginWithoutContext( )
    #define     RE_Begin()
    #define     RE_End()
    #define     RE_SetLockedContext(render)
#endif  /* RE_CHECK_STATE */

// Actual implemention
RE_API extern void      REcheckForErrorsOnSwap();
RE_API extern void      REcheckValidContext();
RE_API extern void      REcheckNoErrors(const char *str);
RE_API extern void      REcheckInBegin();
RE_API extern void      REcheckNotInBegin();
RE_API extern void      REcheckInBeginWithoutContext();
RE_API extern void      REcheckNotInBeginWithoutContext();
RE_API extern void      REbegin();
RE_API extern void      REend();
RE_API extern void      REsetLockedContext(const RE_OGLRender * render);

#endif /* __RE_OGLErrorChecker__ */

---