Purpose of SHOW_DEBUG_HELPERS

The SHOW_DEBUG_HELPERS definition in Globals.h is a debugging tool that allows us to include or exclude certain code sections based on whether we're in debug or release mode. This is a common practice in game development and software engineering in general.

Here's how it works. First, we define SHOW_DEBUG_HELPERS at the top of our Globals.h file:

1#define SHOW_DEBUG_HELPERS

Then, we use preprocessor directives to include or exclude code based on this definition:

1#ifdef SHOW_DEBUG_HELPERS
2inline void
3  CheckSDLError(const std::string &Msg) {
4  const char *error = SDL_GetError();
5  if (*error != '\0') {
6    std::cerr << Msg << " Error: " << error
7              << '\n';
8    SDL_ClearError();
9  }
10}
11#endif

In this example, the CheckSDLError() function is only defined when SHOW_DEBUG_HELPERS is defined. This function helps us catch and print SDL errors during development.

We can use this helper function in our code like this:

1#include <SDL.h>
2#include "Globals.h"
3
4int main() {
5  if (SDL_Init(SDL_INIT_VIDEO) < 0) {
6#ifdef SHOW_DEBUG_HELPERS
7    Utils::CheckSDLError("SDL_Init"); 
8#endif
9    return 1;
10  }
11  // Rest of the code...
12}

The highlighted line will only be compiled when SHOW_DEBUG_HELPERS is defined.

The main benefits of using SHOW_DEBUG_HELPERS are:

1. Easier debugging: We can include additional error checking and logging in debug builds.
2. Performance optimization: We can remove these checks in release builds for better performance.
3. Code cleanliness: We can keep debugging code in our source files without cluttering release builds.

To disable debug helpers, we simply comment out or remove the #define SHOW_DEBUG_HELPERS line in Globals.h. This is typically done when preparing a release build of the game.

Remember, while debugging helpers are invaluable during development, they should be used judiciously to avoid impacting the game's performance in release builds.