1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/* Copyright (C) 2022 Wildfire Games.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
/*
* OpenGL helper functions.
*/
#ifndef INCLUDED_OGL
#define INCLUDED_OGL
#include "lib/config2.h" // CONFIG2_GLES
#include "lib/sysdep/os.h" // OS_WIN
#if CONFIG2_GLES
# include "external_libraries/opengles2_wrapper.h"
#else
# include <glad/gl.h>
#endif
/**
* initialization: import extension function pointers and do feature detect.
* call before using any other function.
* fails if OpenGL not ready for use.
* TODO: move loading functionality to GL backend.
**/
#if OS_WIN
extern bool ogl_Init(void* (load)(const char*), void* hdc);
#elif !OS_MACOSX && !OS_MAC && !CONFIG2_GLES
extern bool ogl_Init(void* (load)(const char*), void* display, int subsystem);
#else
extern bool ogl_Init(void* (load)(const char*));
#endif
/**
* Change vsync state.
**/
extern void ogl_SetVsyncEnabled(bool enabled);
//-----------------------------------------------------------------------------
// extensions
/**
* Check whether the given OpenGL extension is supported.
* NOTE: this does not check whether the extensions is *loaded*.
* for that, check whether GLAD_<extension name> is not null.
*
* @param ext extension string; exact case.
* @return bool.
**/
extern bool ogl_HaveExtension(const char* ext);
/**
* make sure the OpenGL implementation version matches or is newer than
* the given version.
*/
extern bool ogl_HaveVersion(int major, int minor);
/**
* check if a list of extensions are all supported (as determined by
* ogl_HaveExtension).
*
* @param dummy value ignored; varargs requires a placeholder.
* follow it by a list of const char* extension string parameters,
* terminated by a 0 pointer.
* @return 0 if all are present; otherwise, the first extension in the
* list that's not supported (useful for reporting errors).
**/
extern const char* ogl_HaveExtensions(int dummy, ...) SENTINEL_ARG;
/**
* get a list of all supported extensions.
*
* useful for crash logs / system information.
*
* @return read-only C string of unspecified length containing all
* advertised extension names, separated by space.
**/
extern const char* ogl_ExtensionString();
//-----------------------------------------------------------------------------
// errors
/**
* raise a warning (break into the debugger) if an OpenGL error is pending.
* resets the OpenGL error state afterwards.
*
* when an error is reported, insert calls to this in a binary-search scheme
* to quickly narrow down the actual error location.
*
* reports a bogus invalid_operation error if called before OpenGL is
* initialized, so don't!
*
* disabled in release mode for efficiency and to avoid annoying errors.
**/
extern void ogl_WarnIfErrorLoc(const char *file, int line);
#ifdef NDEBUG
# define ogl_WarnIfError()
#else
# define ogl_WarnIfError() ogl_WarnIfErrorLoc(__FILE__, __LINE__)
#endif
/**
* get a name of the error.
*
* useful for debug.
*
* @return read-only C string of unspecified length containing
* the error's name.
**/
extern const char* ogl_GetErrorName(GLenum err);
/**
* ignore and reset the specified OpenGL error.
*
* this is useful for suppressing annoying error messages, e.g.
* "invalid enum" for GL_CLAMP_TO_EDGE even though we've already
* warned the user that their OpenGL implementation is too old.
*
* call after the fact, i.e. the error has been raised. if another or
* different error is pending, those are reported immediately.
*
* @param err_to_ignore: one of the glGetError enums.
* @return true if the requested error was seen and ignored
**/
extern bool ogl_SquelchError(GLenum err_to_ignore);
#endif // INCLUDED_OGL
|
