summaryrefslogtreecommitdiff
path: root/src/gl/error.h
blob: a56bae9fb2e33177fd61b5f1330d09529ff86da5 (plain)
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
// Copyright 2021 Benjamin Barenblat
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.

// Error handling and thread-safety checking.

#ifndef GLPLANET_SRC_GL_ERROR_H_
#define GLPLANET_SRC_GL_ERROR_H_

namespace gl_internal {

#ifdef GLPLANET_DISABLE_GL_THREAD_SAFETY_CHECKS
constexpr bool kThreadSafetyChecks = false;
#else
constexpr bool kThreadSafetyChecks = true;
#endif

#ifdef GLPLANET_DISABLE_AGGRESSIVE_ERROR_CHECKING
constexpr bool kAggressiveErrorChecking = false;
#else
constexpr bool kAggressiveErrorChecking = true;
#endif

#ifndef GLPLANET_DISABLE_GL_THREAD_SAFETY_CHECKS

void RecordThreadImpl();

void CheckThreadSafetyImpl();

#endif

// Records the calling thread as the OpenGL thread.
inline void RecordThread() noexcept(!kThreadSafetyChecks) {
#ifndef GLPLANET_DISABLE_GL_THREAD_SAFETY_CHECKS
  RecordThreadImpl();
#endif
}

// Throws std::logic_error if the current thread is not the OpenGL thread.
inline void CheckThreadSafety() noexcept(!kThreadSafetyChecks) {
#ifndef GLPLANET_DISABLE_GL_THREAD_SAFETY_CHECKS
  CheckThreadSafetyImpl();
#endif
}

// Checks the GL state for errors and throws if an error is present.
void ErrorCheck();

// As ErrorCheck, but disabled by GLPLANET_DISABLE_AGGRESSIVE_ERROR_CHECKING.
inline void UnnecessaryErrorCheck() noexcept(!kAggressiveErrorChecking) {
  if constexpr (kAggressiveErrorChecking) {
    ErrorCheck();
  }
}

}  // namespace gl_internal

#endif  // GLPLANET_SRC_GL_ERROR_H_