devela::_dep::sdl3::sys::assert

Function SDL_GetAssertionReport

pub unsafe extern "C" fn SDL_GetAssertionReport() -> *const SDL_AssertData
Available on crate feature dep_sdl3 only.
Expand description

Get a list of all assertion failures.

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

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.

§See also