OOOpenGLStateManager.m File Reference

import "OOOpenGL.h"
import "OOLogging.h"
import "OOMaths.h"
import "OOMacroOpenGL.h"
import "OOFunctionAttributes.h"
import "OOOpenGLExtensionManager.h"
#include "OOOpenGLStates.tbl"

Include dependency graph for OOOpenGLStateManager.m:

Go to the source code of this file.

Classes
struct	OOOpenGLState

Macros
#define	ITEM_STATEFLAG(NAME)
#define	ITEM_CLIENTSTATEFLAG(NAME)
#define	ITEM_SPECIAL(NAME, TYPE, _)
#define	ITEM_INT(NAME)
#define	SetState_DEPTH_WRITEMASK(VALUE)
#define	SetState_SHADE_MODEL(VALUE)
#define	SetState_TEXTURE_ENV_MODE(VALUE)
#define	SetState_FRONT_FACE(VALUE)
#define	ITEM_STATEFLAG(NAME)
#define	ITEM_CLIENTSTATEFLAG(NAME)
#define	ITEM_SPECIAL(NAME, _, __)
#define	ITEM_INT(NAME)
#define	ITEM_STATEFLAG(NAME)
#define	ITEM_CLIENTSTATEFLAG(NAME)
#define	ITEM_SPECIAL(NAME, _, __)
#define	ITEM_INT(NAME)
#define	TEST_ITEM(NAME_, DISP_)
#define	ITEM_STATEFLAG(NAME)
#define	ITEM_CLIENTSTATEFLAG(NAME)
#define	ITEM_SPECIAL(NAME, _, __)
#define	ITEM_INT(NAME)
#define	ITEM_STATEFLAG(NAME)
#define	ITEM_CLIENTSTATEFLAG(NAME)
#define	ITEM_SPECIAL(NAME, TYPE, _)
#define	ITEM_INT(NAME)

Enumerations
enum	StateFlag { kStateFalse = false , kStateTrue = true , kStateMaybe }

Functions
static void	SwitchOpenGLStateInternal (const OOOpenGLState *sourceState, const OOOpenGLState *targetState) NONNULL_FUNC
static bool	GetState_DEPTH_WRITEMASK (void)
static GLenum	GetState_TEXTURE_ENV_MODE (void)
static GLenum	GetState_ACTIVE_TEXTURE (void)
static void	SetState_ACTIVE_TEXTURE (GLenum value)
static GLenum	GetState_CLIENT_ACTIVE_TEXTURE (void)
static void	SetState_CLIENT_ACTIVE_TEXTURE (GLenum value)
static void	SetState_CULL_FACE_MODE (GLint value)
static void	VerifyOpenGLStateInternal (const char *caller, const char *nominalCaller, unsigned line) NONNULL_FUNC
static void	GetCurrentOpenGLState (OOOpenGLState *state) NONNULL_FUNC
static bool	StatesEqual (const OOOpenGLState *a, const OOOpenGLState *b) NONNULL_FUNC
static void	OOGLNoteCurrentFunction (const char *function, unsigned line)
static void	SetFunctionTracking (bool value)
void	OOSetOpenGLState_ (OOOpenGLStateID state, const char *function, unsigned line)
void	OOVerifyOpenGLState_ (const char *function, unsigned line)
void	OOResetGLStateVerifier (void)

Variables
static const OOOpenGLState	kStandardStates [OPENGL_STATE_INTERNAL_USE_ONLY+1]
static OOOpenGLStateID	sCurrentStateID = OPENGL_STATE_INTERNAL_USE_ONLY
static NSString *const	kOOLogOpenGLVerifyDump = @"rendering.opengl.state"

Macro Definition Documentation

ITEM_CLIENTSTATEFLAG [1/5]

#define ITEM_CLIENTSTATEFLAG

(

NAME

)

Value:

bool NAME

Definition at line 66 of file OOOpenGLStateManager.m.

ITEM_CLIENTSTATEFLAG [2/5]

#define ITEM_CLIENTSTATEFLAG

(

NAME

)

Value:

OOGL(state->NAME = glIsEnabled(GL_##NAME))

Definition at line 66 of file OOOpenGLStateManager.m.

ITEM_CLIENTSTATEFLAG [3/5]

#define ITEM_CLIENTSTATEFLAG

(

NAME

)

Value:

do { if (a->NAME != b->NAME)  return false; } while (0)

Definition at line 66 of file OOOpenGLStateManager.m.

ITEM_CLIENTSTATEFLAG [4/5]

#define ITEM_CLIENTSTATEFLAG

(

NAME

)

Value:

TEST_ITEM(NAME, OOGLFlagToString)

Definition at line 66 of file OOOpenGLStateManager.m.

ITEM_CLIENTSTATEFLAG [5/5]

#define ITEM_CLIENTSTATEFLAG

(

NAME

)

Value:

    if (sourceState->NAME != targetState->NAME) \
    { \
        if (targetState->NAME) \
        { \
            OOGL(glEnableClientState(GL_##NAME)); \
        } \
        else \
        { \
            OOGL(glDisableClientState(GL_##NAME)); \
        } \
    }

Definition at line 66 of file OOOpenGLStateManager.m.

ITEM_INT [1/5]

#define ITEM_INT

(

NAME

)

Value:

GLint NAME

Definition at line 68 of file OOOpenGLStateManager.m.

ITEM_INT [2/5]

#define ITEM_INT

(

NAME

)

Value:

OOGL(glGetIntegerv(GL_##NAME, &state->NAME))

Definition at line 68 of file OOOpenGLStateManager.m.

ITEM_INT [3/5]

#define ITEM_INT

(

NAME

)

Value:

do { if (a->NAME != b->NAME)  return false; } while (0)

Definition at line 68 of file OOOpenGLStateManager.m.

ITEM_INT [4/5]

#define ITEM_INT

(

NAME

)

Value:

TEST_ITEM(NAME, OOGLEnumToString)

Definition at line 68 of file OOOpenGLStateManager.m.

ITEM_INT [5/5]

#define ITEM_INT

(

NAME

)

Value:

    if (sourceState->NAME != targetState->NAME) \
    { \
        SetState_##NAME(targetState->NAME); \
    }

Definition at line 68 of file OOOpenGLStateManager.m.

ITEM_SPECIAL [1/5]

#define ITEM_SPECIAL	(		NAME,
			_,
			__ )

Value:

state->NAME = GetState_##NAME()

Definition at line 67 of file OOOpenGLStateManager.m.

ITEM_SPECIAL [2/5]

#define ITEM_SPECIAL	(		NAME,
			_,
			__ )

Value:

do { if (a->NAME != b->NAME)  return false; } while (0)

Definition at line 67 of file OOOpenGLStateManager.m.

ITEM_SPECIAL [3/5]

#define ITEM_SPECIAL	(		NAME,
			_,
			__ )

Value:

TEST_ITEM(NAME, OOGLFlagToString)

Definition at line 67 of file OOOpenGLStateManager.m.

ITEM_SPECIAL [4/5]

#define ITEM_SPECIAL	(		NAME,
			TYPE,
			_ )

Value:

TYPE NAME

Definition at line 67 of file OOOpenGLStateManager.m.

ITEM_SPECIAL [5/5]

#define ITEM_SPECIAL	(		NAME,
			TYPE,
			_ )

Value:

    if (sourceState->NAME != targetState->NAME) \
    { \
        SetState_##NAME(targetState->NAME); \
    }

Definition at line 67 of file OOOpenGLStateManager.m.

ITEM_STATEFLAG [1/5]

#define ITEM_STATEFLAG

(

NAME

)

Value:

StateFlag NAME

Definition at line 65 of file OOOpenGLStateManager.m.

ITEM_STATEFLAG [2/5]

#define ITEM_STATEFLAG

(

NAME

)

Value:

OOGL(state->NAME = glIsEnabled(GL_##NAME))

Definition at line 65 of file OOOpenGLStateManager.m.

ITEM_STATEFLAG [3/5]

#define ITEM_STATEFLAG

(

NAME

)

Value:

do { if (a->NAME != b->NAME && a->NAME != kStateMaybe && b->NAME != kStateMaybe)  return false; } while (0)

Definition at line 65 of file OOOpenGLStateManager.m.

ITEM_STATEFLAG [4/5]

#define ITEM_STATEFLAG

(

NAME

)

Value:

if (expectedState->NAME != kStateMaybe) { TEST_ITEM(NAME, OOGLFlagToString) }

Definition at line 65 of file OOOpenGLStateManager.m.

ITEM_STATEFLAG [5/5]

#define ITEM_STATEFLAG

(

NAME

)

Value:

    if (sourceState->NAME != targetState->NAME && sourceState->NAME != kStateMaybe && targetState->NAME != kStateMaybe) \
    { \
        if (targetState->NAME) \
        { \
            OOGL(glEnable(GL_##NAME)); \
        } \
        else \
        { \
            OOGL(glDisable(GL_##NAME)); \
        } \
    }

Definition at line 65 of file OOOpenGLStateManager.m.

SetState_DEPTH_WRITEMASK

#define SetState_DEPTH_WRITEMASK

(

VALUE

)

Value:

OOGL(glDepthMask(VALUE))

Definition at line 113 of file OOOpenGLStateManager.m.

SetState_FRONT_FACE

#define SetState_FRONT_FACE

(

VALUE

)

Value:

OOGL(glFrontFace(VALUE))

Definition at line 171 of file OOOpenGLStateManager.m.

SetState_SHADE_MODEL

#define SetState_SHADE_MODEL

(

VALUE

)

Value:

OOGL(glShadeModel(VALUE))

Definition at line 115 of file OOOpenGLStateManager.m.

SetState_TEXTURE_ENV_MODE

#define SetState_TEXTURE_ENV_MODE

(

VALUE

)

Value:

OOGL(glTexEnvi(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, VALUE))

Definition at line 128 of file OOOpenGLStateManager.m.

TEST_ITEM

#define TEST_ITEM	(		NAME_,
			DISP_ )

Value:

                if (currentState.NAME_ != expectedState->NAME_) \
                { \
                    OOLog(kOOLogOpenGLVerifyDump, @"GL_%@ should be %@ but is %@.", @#NAME_, DISP_(expectedState->NAME_), DISP_(currentState.NAME_)); \
                }

Enumeration Type Documentation

StateFlag

enum StateFlag

Enumerator
kStateFalse
kStateTrue
kStateMaybe

Definition at line 53 of file OOOpenGLStateManager.m.

{
    kStateFalse = false,
    kStateTrue = true,
    kStateMaybe
} StateFlag;

Function Documentation

GetCurrentOpenGLState()

static void GetCurrentOpenGLState ( OOOpenGLState * state )

static

Definition at line 283 of file OOOpenGLStateManager.m.

{
    static const char *name = "<current state>";
    
    NSCParameterAssert(state != NULL);
    OO_ENTER_OPENGL();
    memset(state, 0, sizeof *state);
    state->name = name;
    
    #define ITEM_STATEFLAG(NAME)        OOGL(state->NAME = glIsEnabled(GL_##NAME))
    #define ITEM_CLIENTSTATEFLAG(NAME)  OOGL(state->NAME = glIsEnabled(GL_##NAME))
    #define ITEM_SPECIAL(NAME, _, __)   state->NAME = GetState_##NAME()
    #define ITEM_INT(NAME)              OOGL(glGetIntegerv(GL_##NAME, &state->NAME))
    
    #include "OOOpenGLStates.tbl"
    
    OOGL(glGetIntegerv(GL_BLEND_SRC, &state->BLEND_SRC));
    OOGL(glGetIntegerv(GL_BLEND_DST, &state->BLEND_DST));
    
    #undef ITEM_STATEFLAG
    #undef ITEM_CLIENTSTATEFLAG
    #undef ITEM_SPECIAL
    #undef ITEM_INT
}

References OOOpenGLState::BLEND_DST, OOOpenGLState::BLEND_SRC, OOOpenGLState::name, OO_ENTER_OPENGL, and OOGL.

Referenced by VerifyOpenGLStateInternal().

Here is the caller graph for this function:

GetState_ACTIVE_TEXTURE()

static GLenum GetState_ACTIVE_TEXTURE ( void )

inlinestatic

Definition at line 158 of file OOOpenGLStateManager.m.

{}

GetState_CLIENT_ACTIVE_TEXTURE()

static GLenum GetState_CLIENT_ACTIVE_TEXTURE ( void )

inlinestatic

Definition at line 160 of file OOOpenGLStateManager.m.

{}

GetState_DEPTH_WRITEMASK()

static bool GetState_DEPTH_WRITEMASK ( void )

inlinestatic

Definition at line 103 of file OOOpenGLStateManager.m.

{
    OO_ENTER_OPENGL();
    
    GLboolean value;
    OOGL(glGetBooleanv(GL_DEPTH_WRITEMASK, &value));
    return value;
}

References OO_ENTER_OPENGL, and OOGL.

GetState_TEXTURE_ENV_MODE()

static GLenum GetState_TEXTURE_ENV_MODE ( void )

inlinestatic

Definition at line 118 of file OOOpenGLStateManager.m.

{
    OO_ENTER_OPENGL();
    
    GLint value;
    OOGL(glGetTexEnviv(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, &value));
    return value;
}

References OO_ENTER_OPENGL, and OOGL.

OOGLNoteCurrentFunction()

static void OOGLNoteCurrentFunction ( const char * function, unsigned line )

inlinestatic

Definition at line 247 of file OOOpenGLStateManager.m.

{}

Referenced by OOSetOpenGLState_(), and OOVerifyOpenGLState_().

Here is the caller graph for this function:

OOResetGLStateVerifier()

void OOResetGLStateVerifier

(

void

)

Definition at line 462 of file OOOpenGLStateManager.m.

{
    // State has been reset behind our backs, so to speak; don't verify.
    sCurrentStateID = OPENGL_STATE_INTERNAL_USE_ONLY;
}

References OPENGL_STATE_INTERNAL_USE_ONLY, and sCurrentStateID.

OOSetOpenGLState_()

void OOSetOpenGLState_	(	OOOpenGLStateID	state,
		const char *	function,
		unsigned	line )

Definition at line 253 of file OOOpenGLStateManager.m.

{
    NSCParameterAssert((unsigned)state < OPENGL_STATE_INTERNAL_USE_ONLY);
    
    OOGLNoteCurrentFunction(function, line);
    SetFunctionTracking(false);
    
    VerifyOpenGLStateInternal("OOSetOpenGLState", function, line);
    
    if (state != sCurrentStateID)
    {
        SwitchOpenGLStateInternal(&kStandardStates[sCurrentStateID], &kStandardStates[state]);
        sCurrentStateID = state;
    }
    
    SetFunctionTracking(true);
}

References kStandardStates, OOGLNoteCurrentFunction(), OPENGL_STATE_INTERNAL_USE_ONLY, sCurrentStateID, SetFunctionTracking(), SwitchOpenGLStateInternal(), and VerifyOpenGLStateInternal().

Here is the call graph for this function:

OOVerifyOpenGLState_()

void OOVerifyOpenGLState_	(	const char *	function,
		unsigned	line )

Definition at line 272 of file OOOpenGLStateManager.m.

{
    OOGLNoteCurrentFunction(function, line);
    SetFunctionTracking(false);
    
    VerifyOpenGLStateInternal("OOVerifyOpenGLState", function, line);
    
    SetFunctionTracking(true);
}

References OOGLNoteCurrentFunction(), SetFunctionTracking(), and VerifyOpenGLStateInternal().

Here is the call graph for this function:

SetFunctionTracking()

static void SetFunctionTracking ( bool value )

inlinestatic

Definition at line 248 of file OOOpenGLStateManager.m.

{}

Referenced by OOSetOpenGLState_(), and OOVerifyOpenGLState_().

Here is the caller graph for this function:

SetState_ACTIVE_TEXTURE()

static void SetState_ACTIVE_TEXTURE ( GLenum value )

inlinestatic

Definition at line 159 of file OOOpenGLStateManager.m.

{}

SetState_CLIENT_ACTIVE_TEXTURE()

static void SetState_CLIENT_ACTIVE_TEXTURE ( GLenum value )

inlinestatic

Definition at line 161 of file OOOpenGLStateManager.m.

{}

SetState_CULL_FACE_MODE()

static void SetState_CULL_FACE_MODE ( GLint value )

inlinestatic

Definition at line 164 of file OOOpenGLStateManager.m.

{
    OO_ENTER_OPENGL();
    
    OOGL(glCullFace(value));
}

References OO_ENTER_OPENGL, and OOGL.

StatesEqual()

static bool StatesEqual ( const OOOpenGLState * a, const OOOpenGLState * b )

static

Definition at line 309 of file OOOpenGLStateManager.m.

{
    NSCParameterAssert(a != NULL && b != NULL);
    
    #define ITEM_STATEFLAG(NAME)        do { if (a->NAME != b->NAME && a->NAME != kStateMaybe && b->NAME != kStateMaybe)  return false; } while (0)
    #define ITEM_CLIENTSTATEFLAG(NAME)  do { if (a->NAME != b->NAME)  return false; } while (0)
    #define ITEM_SPECIAL(NAME, _, __)   do { if (a->NAME != b->NAME)  return false; } while (0)
    #define ITEM_INT(NAME)              do { if (a->NAME != b->NAME)  return false; } while (0)
    
    #include "OOOpenGLStates.tbl"
    
    #undef ITEM_STATEFLAG
    #undef ITEM_CLIENTSTATEFLAG
    #undef ITEM_SPECIAL
    #undef ITEM_INT
    
    return true;
}

Referenced by VerifyOpenGLStateInternal().

Here is the caller graph for this function:

SwitchOpenGLStateInternal()

static void SwitchOpenGLStateInternal ( const OOOpenGLState * sourceState, const OOOpenGLState * targetState )

static

Definition at line 404 of file OOOpenGLStateManager.m.

{
    NSCParameterAssert(sourceState != NULL && targetState != NULL);
    OO_ENTER_OPENGL();
    
    #define ITEM_STATEFLAG(NAME) \
    if (sourceState->NAME != targetState->NAME && sourceState->NAME != kStateMaybe && targetState->NAME != kStateMaybe) \
    { \
        if (targetState->NAME) \
        { \
            OOGL(glEnable(GL_##NAME)); \
        } \
        else \
        { \
            OOGL(glDisable(GL_##NAME)); \
        } \
    }
    #define ITEM_CLIENTSTATEFLAG(NAME) \
    if (sourceState->NAME != targetState->NAME) \
    { \
        if (targetState->NAME) \
        { \
            OOGL(glEnableClientState(GL_##NAME)); \
        } \
        else \
        { \
            OOGL(glDisableClientState(GL_##NAME)); \
        } \
    }
    #define ITEM_SPECIAL(NAME, TYPE, _) \
    if (sourceState->NAME != targetState->NAME) \
    { \
        SetState_##NAME(targetState->NAME); \
    }
    #define ITEM_INT(NAME) \
    if (sourceState->NAME != targetState->NAME) \
    { \
        SetState_##NAME(targetState->NAME); \
    }
    
    #include "OOOpenGLStates.tbl"
    
    /* some implementations, in non-shader mode, seem to throw out/reset
     * BlendFunc if Blend is disabled. Therefore, if coming from Blend=false
     * always reset the blend function even if this should be unnecessary
     * CIM: 3/1/13 */
    if (sourceState->BLEND_SRC != targetState->BLEND_SRC || sourceState->BLEND_DST != targetState->BLEND_DST || !sourceState->BLEND)
    {
        OOGL(glBlendFunc(targetState->BLEND_SRC, targetState->BLEND_DST));
    }
    
    #undef ITEM_STATEFLAG
    #undef ITEM_CLIENTSTATEFLAG
    #undef ITEM_SPECIAL
    #undef ITEM_INT
}

References OOOpenGLState::BLEND_DST, OOOpenGLState::BLEND_SRC, OO_ENTER_OPENGL, and OOGL.

Referenced by OOSetOpenGLState_(), and VerifyOpenGLStateInternal().

Here is the caller graph for this function:

VerifyOpenGLStateInternal()

static void VerifyOpenGLStateInternal ( const char * caller, const char * nominalCaller, unsigned line )

static

Definition at line 329 of file OOOpenGLStateManager.m.

{
    OOOpenGLState currentState;
    GetCurrentOpenGLState(&currentState);
    
    NSCParameterAssert(sCurrentStateID <= OPENGL_STATE_INTERNAL_USE_ONLY);
    
    const OOOpenGLState *expectedState = &kStandardStates[sCurrentStateID];
    
    if (!StatesEqual(&currentState, expectedState))
    {
        if (OOLogWillDisplayMessagesInClass(kOOLogOpenGLVerifyDump))
        {
            OOLog(kOOLogOpenGLVerifyDump, @"Incorrect OpenGL state in %s (line %u)->%s", nominalCaller, line, caller);
#if OO_CHECK_GL_HEAVY
            OOLog(kOOLogOpenGLVerifyDump, @"Previous OpenGL-using function: %s (line %u)", sPreviousFunction, sPreviousLine);
#endif
            OOLog(kOOLogOpenGLVerifyDump, @"Expected previous state: %s", expectedState->name);
            
            OOLogIndent();
            
            #define TEST_ITEM(NAME_, DISP_) \
                if (currentState.NAME_ != expectedState->NAME_) \
                { \
                    OOLog(kOOLogOpenGLVerifyDump, @"GL_%@ should be %@ but is %@.", @#NAME_, DISP_(expectedState->NAME_), DISP_(currentState.NAME_)); \
                }
            
            #define ITEM_STATEFLAG(NAME)        if (expectedState->NAME != kStateMaybe) { TEST_ITEM(NAME, OOGLFlagToString) }
            #define ITEM_CLIENTSTATEFLAG(NAME)  TEST_ITEM(NAME, OOGLFlagToString)
            #define ITEM_SPECIAL(NAME, _, __)   TEST_ITEM(NAME, OOGLFlagToString)
            #define ITEM_INT(NAME)              TEST_ITEM(NAME, OOGLEnumToString)
            
            #include "OOOpenGLStates.tbl"
            
            if (currentState.BLEND_SRC != expectedState->BLEND_SRC || currentState.BLEND_DST != expectedState->BLEND_DST)
            {
                OOLog(kOOLogOpenGLVerifyDump, @"GL blend mode should be %@, %@ but is %@, %@.", OOGLEnumToString(expectedState->BLEND_SRC), OOGLEnumToString(expectedState->BLEND_DST), OOGLEnumToString(currentState.BLEND_SRC), OOGLEnumToString(currentState.BLEND_DST));
            }
            
            #undef ITEM_STATEFLAG
            #undef ITEM_CLIENTSTATEFLAG
            #undef ITEM_SPECIAL
            #undef ITEM_INT
            
            #undef TEST_ITEM
            
            OOLogOutdent();
        }
        
        SwitchOpenGLStateInternal(&currentState, expectedState);
    }
}

References OOOpenGLState::BLEND_DST, OOOpenGLState::BLEND_SRC, GetCurrentOpenGLState(), kOOLogOpenGLVerifyDump, kStandardStates, OOOpenGLState::name, OOGLEnumToString(), OOLog, OOLogIndent(), OOLogOutdent(), OOLogWillDisplayMessagesInClass(), OPENGL_STATE_INTERNAL_USE_ONLY, sCurrentStateID, StatesEqual(), and SwitchOpenGLStateInternal().

Referenced by OOSetOpenGLState_(), and OOVerifyOpenGLState_().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

kOOLogOpenGLVerifyDump

NSString* const kOOLogOpenGLVerifyDump = @"rendering.opengl.state"

static

Definition at line 178 of file OOOpenGLStateManager.m.

Referenced by VerifyOpenGLStateInternal().

kStandardStates

static const OOOpenGLState kStandardStates

static

Definition at line 83 of file OOOpenGLStateManager.m.

Referenced by OOSetOpenGLState_(), and VerifyOpenGLStateInternal().

sCurrentStateID

OOOpenGLStateID sCurrentStateID = OPENGL_STATE_INTERNAL_USE_ONLY

static

Definition at line 85 of file OOOpenGLStateManager.m.

Referenced by OOResetGLStateVerifier(), OOSetOpenGLState_(), and VerifyOpenGLStateInternal().