/*

* glStateCache.h

* ARToolKit5

*

* This file is part of ARToolKit.

*

* ARToolKit is free software: you can redistribute it and/or modify

* it under the terms of the GNU Lesser General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* ARToolKit is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU Lesser General Public License for more details.

*

* You should have received a copy of the GNU Lesser General Public License

* along with ARToolKit. If not, see <http://www.gnu.org/licenses/>.

*

* As a special exception, the copyright holders of this library give you

* permission to link this library with independent modules to produce an

* executable, regardless of the license terms of these independent modules, and to

* copy and distribute the resulting executable under terms of your choice,

* provided that you also meet, for each linked independent module, the terms and

* conditions of the license of that module. An independent module is a module

* which is neither derived from nor based on this library. If you modify this

* library, you may extend this exception to your version of the library, but you

* are not obligated to do so. If you do not wish to do so, delete this exception

* statement from your version.

*

* Copyright 2015 Daqri, LLC.

* Copyright 2008-2015 ARToolworks, Inc.

*

* Author(s): Philip Lamb

*

*/

// glStateCache optimises OpenGL ES on implementations where

// changes in GL state are expensive, by eliminating redundant

// changes to state.

#ifndef __glStateCache_h__

#define __glStateCache_h__

#ifndef DISABLE_GL_STATE_CACHE

#if defined ANDROID

# include <GLES/gl.h>

# include <GLES/glext.h>

#else

# include <OpenGLES/ES1/gl.h>

# include <OpenGLES/ES1/glext.h>

#endif

#endif

#ifdef __cplusplus

extern "C" {

#endif

//

// Use of the state cache:

//

// Prior to drawing, a given piece of code should set the state

// it prefers using the calls below. All code that uses the state

// cache should refrain from querying state, and refrain from saving

// and restoring state. The state cache maintains track of the current

// state and no GL calls to make state changes will be made if the

// requested state is already set.

//

// One additional note: If you have some code in your application

// which does NOT use the state cache routines, then the state cache's

// record of the state of the GL machine may be erroneous. In this

// case you will have to call glStateCacheFlush() at the beginning

// of the section of your code which DOES cache state.

//

// Tells the state cache that changes to state have been made

// elsewhere, and that the cache should be emptied.

#ifdef DISABLE_GL_STATE_CACHE

#define glStateCacheFlush()

#else

void glStateCacheFlush(void);

#endif

#define glStateCacheBeginAgain glStateCacheFlush // Deprecated name.

// Depth testing.

#ifdef DISABLE_GL_STATE_CACHE

#define glStateCacheEnableDepthTest() glEnable(GL_DEPTH_TEST)

#define glStateCacheDisableDepthTest() glDisable(GL_DEPTH_TEST)

#else

void glStateCacheEnableDepthTest(void);

void glStateCacheDisableDepthTest(void);

#endif

// Client-side vertex and normal operations.

#ifdef DISABLE_GL_STATE_CACHE

#define glStateCacheEnableClientStateVertexArray() glEnableClientState(GL_VERTEX_ARRAY)

#define glStateCacheDisableClientStateVertexArray() glDisableClientState(GL_VERTEX_ARRAY)

#define glStateCacheEnableClientStateNormalArray() glEnableClientState(GL_NORMAL_ARRAY)

#define glStateCacheDisableClientStateNormalArray() glDisableClientState(GL_NORMAL_ARRAY)

#else

void glStateCacheEnableClientStateVertexArray(void);

void glStateCacheDisableClientStateVertexArray(void);

void glStateCacheEnableClientStateNormalArray(void);

void glStateCacheDisableClientStateNormalArray(void);

#endif

// No longer included in cached state. Definitions retained here for backwards compatibility.

#define glStateCacheVertexPtr(size, type, stride, ptr) glVertexPointer(size, type, stride, ptr)

#define glStateCacheNormalPtr(type, stride, ptr) glNormalPointer(type, stride, ptr)

// Client-side texture operations.

// The glStateCacheEnableClientStateTexCoordArray()/glStateCacheDisableClientStateTexCoordArray()

// operations all operate on the current active texture set with glStateCacheClientActiveTexture().

#ifdef DISABLE_GL_STATE_CACHE

#ifdef GL_VERSION_1_3

# define glStateCacheClientActiveTexture(texture) glClientActiveTexture(texture)

#else

# define glStateCacheClientActiveTexture(texture)

#endif

#define glStateCacheEnableClientStateTexCoordArray() glEnableClientState(GL_TEXTURE_COORD_ARRAY)

#define glStateCacheDisableClientStateTexCoordArray() glDisableClientState(GL_TEXTURE_COORD_ARRAY)

#else

void glStateCacheClientActiveTexture(GLenum texture);

void glStateCacheEnableClientStateTexCoordArray(void);

void glStateCacheDisableClientStateTexCoordArray(void);

#endif

// No longer included in cached state. Definitions retained here for backwards compatibility.

#define glStateCacheTexCoordPtr(size, type, stride, ptr) glTexCoordPointer(size, type, stride, ptr)

// Server-side texture operations.

// The glStateCacheBindTexture2D()/glStateCacheEnableTex2D()/glStateCacheDisableTex2D() and glStateCacheTexEnv*()

// operations all operate on the current active texture set with glStateCacheActiveTexture().

#ifdef DISABLE_GL_STATE_CACHE

#ifdef GL_VERSION_1_3

# define glStateCacheActiveTexture(texture) glActiveTexture(texture)

#else

# define glStateCacheActiveTexture(texture)

#endif

#define glStateCacheBindTexture2D(name) glBindTexture(GL_TEXTURE_2D, name)

#define glStateCacheEnableTex2D() glEnable(GL_TEXTURE_2D)

#define glStateCacheDisableTex2D() glDisable(GL_TEXTURE_2D)

#define glStateCacheTexEnvMode(mode) glTexEnvi(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, mode)

#define glStateCacheTexEnvSrc0(source) glTexEnvi(GL_TEXTURE_ENV, GL_SRC0_RGB, source)

#define glStateCacheTexEnvSrc1(source) glTexEnvi(GL_TEXTURE_ENV, GL_SRC1_RGB, source)

#define glStateCacheTexEnvCombine(combine) glTexEnvi(GL_TEXTURE_ENV, GL_COMBINE_RGB, combine)

#else

#define GLSTATECACHE_MAX_COMBINED_TEXTURE_IMAGE_UNITS 8 // Minimum value for GL_MAX_COMBINED_TEXTURE_IMAGE_UNITS is 8

void glStateCacheActiveTexture(GLuint texture);

void glStateCacheBindTexture2D(GLuint name);

void glStateCacheEnableTex2D(void);

void glStateCacheDisableTex2D(void);

void glStateCacheTexEnvMode(GLint mode);

void glStateCacheTexEnvSrc0(GLint source);

void glStateCacheTexEnvSrc1(GLint source);

void glStateCacheTexEnvCombine(GLint combine);

#endif

// Materials and lighting.

#ifdef DISABLE_GL_STATE_CACHE

#define glStateCacheEnableLighting() glEnable(GL_LIGHTING)

#define glStateCacheDisableLighting() glDisable(GL_LIGHTING)

#define glStateCacheMaterialv(pname, param) glMaterialfv(GL_FRONT_AND_BACK, pname, param)

#define glStateCacheMaterial(pname, param) glMaterialf(GL_FRONT_AND_BACK, pname, param)

#else

void glStateCacheEnableLighting(void);

void glStateCacheDisableLighting(void);

void glStateCacheMaterialv(GLenum pname, GLfloat *param);

void glStateCacheMaterial(GLenum pname, GLfloat param);

#endif

// Blending.

#ifdef DISABLE_GL_STATE_CACHE

#define glStateCacheEnableBlend() glEnable(GL_BLEND)

#define glStateCacheDisableBlend() glDisable(GL_BLEND)

#define glStateCacheBlendFunc(sfactor, dfactor) glBlendFunc(sfactor, dfactor)

#else

void glStateCacheEnableBlend(void);

void glStateCacheDisableBlend(void);

void glStateCacheBlendFunc(GLenum sfactor, GLenum dfactor);

#endif

// Buffer masking operations.

#ifdef DISABLE_GL_STATE_CACHE

#define glStateCacheColorMask(red, green, blue, alpha) glColorMask(red, green, blue, alpha)

#define glStateCacheDepthMask(flag) glDepthMask(flag)

#else

void glStateCacheColorMask(GLboolean red, GLboolean green, GLboolean blue, GLboolean alpha);

void glStateCacheDepthMask(GLboolean flag);

#endif

// Pixel transfer.

#ifdef DISABLE_GL_STATE_CACHE

#define glStateCachePixelStoreUnpackAlignment(param) glPixelStorei(GL_UNPACK_ALIGNMENT, param)

#else

void glStateCachePixelStoreUnpackAlignment(GLint param);

#endif

#ifdef __cplusplus

}

#endif

#endif // !__glStateCache_h__