SDL_GetAssertionReport(3)

SDL_GetAssertionReport3

Get a list of all assertion failures.

Usage

#include "SDL3/SDL.h"

const SDL_AssertData * SDL_GetAssertionReport(void);

Header file

Defined in SDL3/SDL_assert.h

Overview

This function gets all assertions triggered since the last call to

SDL_ResetAssertionReport (), or the start of the program.

The proper way to examine this data looks something like this:

const SDL_AssertData *item = SDL_GetAssertionReport();
while (item) {
   printf("'%s', %s (%s:%d), triggered %u times, always ignore: %s.\n",
          item->condition, item->function, item->filename,
          item->linenum, item->trigger_count,
          item->always_ignore ? "yes" : "no");
   item = item->next;
}

Return value

(const SDL_AssertData
*) Returns a list of all failed assertions or NULL if the list is empty. This memory should not be modified or freed by the application. This pointer remains valid until the next call to SDL_Quit () or

SDL_ResetAssertionReport ().

Thread safety

This function is not thread safe. Other threads calling

SDL_ResetAssertionReport () simultaneously, may render the returned pointer invalid.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.