cyGL.h File Reference

Detailed Description

OpenGL helper classes.

Author

Cem Yuksel

The classes in this file are designed to provide convenient interfaces for some OpenGL features. They are not intended to provide the full flexibility of the underlying OpenGL functions, but they greatly simplify the implementation of some general OpenGL operations.

#include <vector>
#include <string>
#include <iostream>
#include <fstream>
#include <sstream>
#include <cassert>

Classes
class	GL
	General OpenGL queries. More...
class	GLDebugCallback
	OpenGL debug callback class. More...
class	GLTexture< TEXTURE_TYPE >
	OpenGL texture base class. More...
class	GLTexture1< TEXTURE_TYPE >
	OpenGL 1D texture class. More...
class	GLTexture2< TEXTURE_TYPE >
	OpenGL 2D texture class. More...
class	GLTexture3< TEXTURE_TYPE >
	OpenGL 3D texture class. More...
class	GLTextureCubeMap
	OpenGL cube map texture class. More...
class	GLRenderBuffer< TEXTURE_TYPE >
	OpenGL render buffer. More...
class	GLRenderTexture< TEXTURE_TYPE >
	OpenGL render color buffer. More...
class	GLRenderDepth< TEXTURE_TYPE >
	OpenGL render depth buffer. More...
class	GLRenderTextureCubeBase< ATTACHMENT_TYPE, BASE >
	OpenGL render buffer with a cube map texture. More...
class	GLSLShader
	GLSL shader class. More...
class	GLSLProgram
	GLSL program class. More...
class	GLSLProgram::Param

Macros
#define	CY_GL_INVALID_ID   0xFFFFFFFF
	Invalid ID value.
#define	CY_GL_ERROR   _CY_GL_ERROR
	Checks and prints OpenGL error messages to the default output stream.
#define	CY_GL_ERR(gl_function_call)   _CY_GL_ERR(gl_function_call)
	Checks OpenGL errors before calling the given function, calls the function, and then checks OpenGL errors again. If an error is found, it is printed to the default output stream.
#define	CY_GL_ERROR_D
	Checks and prints OpenGL error messages using CY_GL_ERROR in code compiled in debug mode only (with _DEBUG defined).
#define	CY_GL_ERR_D
	Checks and prints OpenGL error messages using CY_GL_ERR in code compiled in debug mode only (with _DEBUG defined).
#define	CY_GL_REGISTER_DEBUG_CALLBACK   _CY_GL_REGISTER_DEBUG_CALLBACK
	Registers the OpenGL callback by ignoring notifications. After this macro is called, the debug messages get printed to the default output stream. The OpenGL context must be created before using this macro. Note that OpenGL may not generate debug messages if it is not created in debug mode.

Typedefs
typedef GLTexture1< GL_TEXTURE_1D >	GLTexture1D
	OpenGL 1D Texture.
typedef GLTexture2< GL_TEXTURE_2D >	GLTexture2D
	OpenGL 2D Texture.
typedef GLTexture3< GL_TEXTURE_3D >	GLTexture3D
	OpenGL 3D Texture.
typedef GLRenderTexture< GL_TEXTURE_2D >	GLRenderTexture2D
	OpenGL render color buffer with a 2D texture.
typedef GLRenderDepth< GL_TEXTURE_2D >	GLRenderDepth2D
	OpenGL render depth buffer with a 2D texture.
typedef GLRenderTextureCubeBase< GL_COLOR_ATTACHMENT0, GLRenderTexture< GL_TEXTURE_CUBE_MAP > >	GLRenderTextureCube
	OpenGL render color buffer with a cube map texture.
typedef GLRenderTextureCubeBase< GL_DEPTH_ATTACHMENT, GLRenderDepth< GL_TEXTURE_CUBE_MAP > >	GLRenderDepthCube
	OpenGL render depth buffer with a cube map texture.
typedef cy::GL	cyGL
	General OpenGL queries.
typedef cy::GLDebugCallback	cyGLDebugCallback
	OpenGL debug callback class.
typedef cy::GLTextureCubeMapSide	cyGLTextureCubeMapSide
typedef cy::GLTexture1D	cyGLTexture1D
	Sides of a cube map.
typedef cy::GLTexture2D	cyGLTexture2D
	OpenGL 2D Texture.
typedef cy::GLTexture3D	cyGLTexture3D
	OpenGL 3D Texture.
typedef cy::GLTextureCubeMap	cyGLTextureCubeMap
	OpenGL Cube Map Texture.
typedef cy::GLRenderTexture2D	cyGLRenderTexture2D
	OpenGL render color buffer with a 2D texture.
typedef cy::GLRenderDepth2D	cyGLRenderDepth2D
	OpenGL render depth buffer with a 2D texture.
typedef cy::GLRenderTextureCube	cyGLRenderTextureCube
	OpenGL render color buffer with a cube map texture.
typedef cy::GLRenderDepthCube	cyGLRenderDepthCube
	OpenGL render depth buffer with a cube map texture.
typedef cy::GLSLShader	cyGLSLShader
	GLSL shader class.
typedef cy::GLSLProgram	cyGLSLProgram
	GLSL program class.

Enumerations
enum	GLTextureCubeMapSide {   POSITIVE_X =0 , NEGATIVE_X , POSITIVE_Y , NEGATIVE_Y ,   POSITIVE_Z , NEGATIVE_Z }
	Sides of a cube map.

Typedef Documentation

cyGLTexture1D

typedef cy::GLTexture1D cyGLTexture1D

Sides of a cube map.

OpenGL 1D Texture