opengl.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 The ClanLib Team
4 **
5 ** This software is provided 'as-is', without any express or implied
6 ** warranty. In no event will the authors be held liable for any damages
7 ** arising from the use of this software.
8 **
9 ** Permission is granted to anyone to use this software for any purpose,
10 ** including commercial applications, and to alter it and redistribute it
11 ** freely, subject to the following restrictions:
12 **
13 ** 1. The origin of this software must not be misrepresented; you must not
14 ** claim that you wrote the original software. If you use this software
15 ** in a product, an acknowledgment in the product documentation would be
16 ** appreciated but is not required.
17 ** 2. Altered source versions must be plainly marked as such, and must not be
18 ** misrepresented as being the original software.
19 ** 3. This notice may not be removed or altered from any source distribution.
20 **
21 ** Note: Some of the libraries ClanLib may link to may have additional
22 ** requirements or restrictions.
23 **
24 ** File Author(s):
25 **
26 ** Magnus Norddahl
27 */
28 
29 
30 #pragma once
31 
32 #include "opengl_defines.h"
33 #include <utility>
34 #include "../Display/Render/texture.h"
35 #include "../Core/System/thread_local_storage.h"
36 
37 namespace clan
38 {
41 
42 class GLFunctions;
43 class GraphicContext;
44 class OpenGLGraphicContextProvider;
45 class GL1GraphicContextProvider;
46 class GL3GraphicContextProvider;
47 
48 enum TextureFormat;
49 
51 typedef void (ProcAddress)();
52 
53 typedef struct
54 {
56  bool valid;
61 
62 typedef struct
63 {
68  std::string message;
69 
71 
73 class OpenGL
74 {
77 
78 public:
80  static ProcAddress *get_proc_address(const std::string &function_name);
81 
84 
87 
89  static void set_active(GraphicContext &gc);
90 
92  static void set_active(const OpenGLGraphicContextProvider * const gc_provider);
93 
99  static bool set_active();
100 
104  static void check_error();
105 
112  static std::vector<MessageLog_GL> get_message_log(GLuint numMsgs);
113 
116 
120  static Texture from_texture_handle(GLuint type, GLuint handle);
121 
122  static GLenum to_enum(DrawBuffer buf);
125  static GLenum to_enum(CullMode mode);
126  static GLenum to_enum(FillMode mode);
127  static GLenum to_enum(BlendFunc func);
131  static GLenum to_enum(LogicOp op);
132  static GLenum to_enum(TextureFilter filter);
135  static GLenum to_cube_target(int index);
136  static GLenum to_enum(BufferUsage usage);
137  static GLenum to_enum(BufferAccess access);
138 
140 
141 private:
145  static void remove_active(const OpenGLGraphicContextProvider * const gc_provider);
146 
149  friend class PBuffer_GL1_Impl;
150 
151 };
152 
153 }
154 
GLenum severity
Definition: opengl.h:66
static GLenum to_enum(BufferAccess access)
static GLenum to_enum(TextureWrapMode mode)
GLenum pixel_format
Definition: opengl.h:58
static GLenum to_enum(LogicOp op)
TextureWrapMode
Texture coordinate wrapping modes.
Definition: texture.h:66
Texture object class.
Definition: texture.h:104
static GLenum to_enum(StencilOp op)
TextureFilter
Texture filters.
Definition: texture.h:74
#define cl_tls_variable
Definition: thread_local_storage.h:45
DrawBuffer
Drawing buffers.
Definition: graphic_context.h:119
static bool set_active()
Sets the thread's OpenGL context to the first valid allocated one.
CullMode
Polygon culling modes.
Definition: graphic_context.h:70
static GLenum to_enum(BufferUsage usage)
BlendEquation
Blending equations.
Definition: graphic_context.h:204
int GLint
Definition: opengl_defines.h:59
friend class GL3GraphicContextProvider
Definition: opengl.h:148
friend class GL1GraphicContextProvider
Definition: opengl.h:147
static GLenum to_enum(FillMode mode)
GLenum type
Definition: opengl.h:65
std::string message
Definition: opengl.h:68
static GLenum to_enum(BlendEquation eq)
TextureCompareMode
Texture compare modes.
Definition: texture.h:85
static void set_active(const OpenGLGraphicContextProvider *const gc_provider)
Sets the thread's OpenGL context to the one used by the graphic context.
StencilOp
Stencil operations.
Definition: graphic_context.h:106
GLFunctions.
Definition: opengl_wrap.h:52
unsigned int GLuint
Definition: opengl_defines.h:63
BufferUsage
Array Buffer usage enum.
Definition: buffer_usage.h:41
GLuint id
Definition: opengl.h:67
FillMode
Polygon filling modes.
Definition: graphic_context.h:78
static void check_error()
Throw an exception if an OpenGL error was detected ( Using glGetError() )
Interface to drawing graphics.
Definition: graphic_context.h:258
static GLenum to_enum(CullMode mode)
Definition: opengl.h:54
static cl_tls_variable GLFunctions * functions
Function table for OpenGL 2.0.
Definition: opengl.h:83
static GLenum to_enum(PrimitivesType value)
OpenGL utility class.
Definition: opengl.h:74
static GLenum to_enum(BlendFunc func)
static ProcAddress * get_proc_address(const std::string &function_name)
Get OpenGL extension specific function address.
static GLenum to_enum(TextureCompareMode mode)
static TextureFormat_GL get_textureformat(TextureFormat format)
Returns the opengl texture format.
GLint internal_format
Definition: opengl.h:57
TextureFormat
Texture format.
Definition: texture_format.h:41
BlendFunc
Blending functions.
Definition: graphic_context.h:155
static GLenum to_enum(DrawBuffer buf)
TextureFormat texture_format
Definition: opengl.h:55
Definition: clanapp.h:36
GLenum pixel_datatype
Definition: opengl.h:59
unsigned int GLenum
Definition: opengl_defines.h:54
VertexAttributeDataType
Primitives array description.
Definition: primitives_array.h:57
static Texture from_texture_handle(GLuint type, GLuint handle)
Creates a texture object from an OpenGL texture handle.
static GLenum to_enum(VertexAttributeDataType value)
Definition: opengl.h:63
static GLuint get_texture_handle(Texture &texture)
Returns the OpenGL texture handle.
CompareFunction
Compare functions.
Definition: graphic_context.h:93
bool valid
True when this is a valid opengl format.
Definition: opengl.h:56
BufferAccess
Array Buffer access enum.
Definition: buffer_usage.h:55
void() ProcAddress()
Extension procedure address typedef for OpenGL.
Definition: opengl.h:51
static std::vector< MessageLog_GL > get_message_log(GLuint numMsgs)
Get the OpenGL message log.
friend class PBuffer_GL1_Impl
Definition: opengl.h:149
static GLenum to_cube_target(int index)
LogicOp
Logic Op.
Definition: graphic_context.h:134
GLenum source
Definition: opengl.h:64
PrimitivesType
Primitive types.
Definition: graphic_context.h:221
static GLenum to_enum(TextureFilter filter)
static void set_active(GraphicContext &gc)
Sets the thread's OpenGL context to the one used by the graphic context.
static GLenum to_enum(CompareFunction func)