Exception class for out-of-memory OpenGL errors. More...

#include </home/chochlik/devel/oglplus/include/oglplus/error.hpp>

Inheritance diagram for oglplus::OutOfMemory:

Collaboration diagram for oglplus::OutOfMemory:

Public Types
typedef std::map< String, String >	PropertyMap
	A map of properties attached to the exception.

typedef std::list< ErrorInfo >	PropagationInfoList
	List of ErrorInfo objects marking exception trace points.

Public Member Functions
GLenum	Code (void) const
	Returns the OpenGL error code. More...

const ErrorInfo &	ThrowInfo (void) const
	Returns information about the throw site of the exception. More...

const char *	GLSymbol (void) const
	Returns the name of the symbol or constant related to the error. More...

const char *	File (void) const
	Returns the path of the source file where the exception originated. More...

const char *	Func (void) const
	Returns the name of the function where the exception originated. More...

unsigned	Line (void) const
	Returns the line in the source file where the exception originated. More...

const char *	ClassName (void) const
	Returns the class name of the object that caused the exception.

const char *	BindTarget (void) const
	Returns the name of the binding point that caused the exception.

const String &	ObjectDescription (void) const
	Returns the description of the object that caused the exception.

PropertyMap	Properties (void) const
	Returns the properties of the exception. More...

void	SetPropertyValue (const String &key, const String &value)
	Set a property key/value to the exception.

PropagationInfoList	PropagationInfo (void) const
	Returns a list of ErrorInfo objects marking exception trace points. More...

Static Public Member Functions
template<typename Key , typename Value >
static void	AddPropertyValue (PropertyMapInit &properties, Key &&key, Value &&value)
	Set a property key/value to the property map.

Detailed Description

Exception class for out-of-memory OpenGL errors.

Out-of-memory is a very serious error and applications generally should not try to recover from such errors, but terminate gracefully if possible.

Member Function Documentation

GLenum oglplus::Error::Code ( void ) const

inherited

Returns the OpenGL error code.

This is basically the value of error code returned by the glGetError functions.

See Also: ThrowInfo; File; Func; Line; ClassName; ObjectDescription

const char* oglplus::Error::File ( void ) const

inherited

Returns the path of the source file where the exception originated.

See Also: ThrowInfo; GLSymbol; Code; Func; Line; ClassName; ObjectDescription

Examples:: standalone/001_ati_meminfo.cpp, standalone/001_gl_info.cpp, standalone/001_gl_limits.cpp, standalone/001_program_resources.cpp, standalone/001_shape2dot.cpp, standalone/001_triangle_glut_gles3.cpp, standalone/001_triangle_glut_glew.cpp, standalone/001_triangle_screenshot.cpp, standalone/001_triangle_sdl_glew.cpp, standalone/001_triangle_wxgl_glew.cpp, standalone/002_amd_perf_monitor.cpp, standalone/002_rectangle_glut_glew.cpp, standalone/002_triangle_compatibility.cpp, and standalone/029_mandelbrot_glfw3.cpp.

References ErrorFile().

const char* oglplus::Error::Func ( void ) const

inherited

Returns the name of the function where the exception originated.

See Also: ThrowInfo; GLSymbol; Code; File; Line; ClassName; ObjectDescription

References ErrorFunc().

const char* oglplus::Error::GLSymbol ( void ) const

inherited

Returns the name of the symbol or constant related to the error.

This function returns the name of the failed OpenGL function without the gl prefix in case of a function error or the name of the OpenGL constant (usually a implementation-dependent) limit which are related to the error.