opengl.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2016 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  {
69 
70  } MessageLog_GL;
71 
73  class OpenGL
74  {
75  public:
77  static ProcAddress *get_proc_address(const std::string &function_name);
78 
80  static cl_tls_variable GLFunctions *functions;
81 
84 
86  static void set_active(GraphicContext &gc);
87 
89  static void set_active(const OpenGLGraphicContextProvider * const gc_provider);
90 
96  static bool set_active();
97 
101  static void check_error();
102 
109  static std::vector<MessageLog_GL> get_message_log(GLuint numMsgs);
110 
112  static GLuint get_texture_handle(Texture &texture);
113 
117  static Texture from_texture_handle(GLuint type, GLuint handle);
118 
119  static GLenum to_enum(DrawBuffer buf);
120  static GLenum to_enum(CompareFunction func);
121  static GLenum to_enum(StencilOp op);
122  static GLenum to_enum(CullMode mode);
123  static GLenum to_enum(FillMode mode);
124  static GLenum to_enum(BlendFunc func);
125  static GLenum to_enum(BlendEquation eq);
126  static GLenum to_enum(VertexAttributeDataType value);
127  static GLenum to_enum(PrimitivesType value);
128  static GLenum to_enum(LogicOp op);
129  static GLenum to_enum(TextureFilter filter);
130  static GLenum to_enum(TextureWrapMode mode);
131  static GLenum to_enum(TextureCompareMode mode);
132  static GLenum to_cube_target(int index);
133  static GLenum to_enum(BufferUsage usage);
134  static GLenum to_enum(BufferAccess access);
135 
136  private:
140  static void remove_active(const OpenGLGraphicContextProvider * const gc_provider);
141 
144  friend class PBuffer_GL1_Impl;
145  };
146 
148 }
Definition: clanapp.h:35
static GLenum to_cube_target(int index)
static bool set_active()
Sets the thread's OpenGL context to the first valid allocated one.
TextureFilter
Texture filters.
Definition: texture.h:72
TextureWrapMode
Texture coordinate wrapping modes.
Definition: texture.h:64
Texture object class.
Definition: texture.h:102
BlendEquation
Blending equations.
Definition: graphic_context.h:202
OpenGL utility class.
Definition: opengl.h:73
DrawBuffer
Drawing buffers.
Definition: graphic_context.h:117
CullMode
Polygon culling modes.
Definition: graphic_context.h:68
static GLenum to_enum(DrawBuffer buf)
unsigned int GLenum
Definition: opengl_defines.h:54
static TextureFormat_GL get_textureformat(TextureFormat format)
Returns the opengl texture format.
std::string message
Definition: opengl.h:68
void( ProcAddress)()
Extension procedure address typedef for OpenGL.
Definition: opengl.h:51
TextureCompareMode
Texture compare modes.
Definition: texture.h:83
GLenum source
Definition: opengl.h:64
StencilOp
Stencil operations.
Definition: graphic_context.h:104
int GLint
Definition: opengl_defines.h:59
bool valid
True when this is a valid opengl format.
Definition: opengl.h:56
BufferUsage
Array Buffer usage enum.
Definition: buffer_usage.h:38
FillMode
Polygon filling modes.
Definition: graphic_context.h:76
friend class GL3GraphicContextProvider
Definition: opengl.h:143
friend class PBuffer_GL1_Impl
Definition: opengl.h:144
GLenum severity
Definition: opengl.h:66
TextureFormat
Texture format.
Definition: texture_format.h:38
TextureFormat texture_format
Definition: opengl.h:55
GLenum type
Definition: opengl.h:65
static cl_tls_variable GLFunctions * functions
Function table for OpenGL 2.0.
Definition: opengl.h:80
BlendFunc
Blending functions.
Definition: graphic_context.h:153
Interface to drawing graphics.
Definition: graphic_context.h:256
VertexAttributeDataType
Primitives array description.
Definition: primitives_array.h:55
static GLuint get_texture_handle(Texture &texture)
Returns the OpenGL texture handle.
static void check_error()
Throw an exception if an OpenGL error was detected ( Using glGetError() )
CompareFunction
Compare functions.
Definition: graphic_context.h:91
unsigned int GLuint
Definition: opengl_defines.h:63
GLint internal_format
Definition: opengl.h:57
friend class GL1GraphicContextProvider
Definition: opengl.h:142
BufferAccess
Array Buffer access enum.
Definition: buffer_usage.h:52
static std::vector< MessageLog_GL > get_message_log(GLuint numMsgs)
Get the OpenGL message log.
GLFunctions.
Definition: opengl_wrap.h:51
GLenum pixel_format
Definition: opengl.h:58
GLenum pixel_datatype
Definition: opengl.h:59
LogicOp
Logic Op.
Definition: graphic_context.h:132
static ProcAddress * get_proc_address(const std::string &function_name)
Get OpenGL extension specific function address.
PrimitivesType
Primitive types.
Definition: graphic_context.h:219
GLuint id
Definition: opengl.h:67
static Texture from_texture_handle(GLuint type, GLuint handle)
Creates a texture object from an OpenGL texture handle.
Definition: opengl.h:53
Definition: opengl.h:62