eden-emu/SDL
14
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-05-15 17:28:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

Sync SDL3 wiki -> header

Browse source
This commit is contained in:
SDL Wiki Bot 2024-04-14 05:50:22 +00:00
parent 291edc073c
commit 11de629dd2
1 changed files with 10 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

21
include/SDL3/SDL_assert.h
View file

@ -48,22 +48,21 @@ extern "C" {
#endif /* SDL_ASSERT_LEVEL */ #endif /* SDL_ASSERT_LEVEL */
#ifdef SDL_WIKI_DOCUMENTATION_SECTION #ifdef SDL_WIKI_DOCUMENTATION_SECTION
/** /**
* Attempt to tell an attached debugger to pause. * Attempt to tell an attached debugger to pause.
* *
* This allows an app to programmatically halt ("break") the debugger * This allows an app to programmatically halt ("break") the debugger as if it
* as if it had hit a breakpoint, allowing the developer to examine * had hit a breakpoint, allowing the developer to examine program state, etc.
* program state, etc.
* *
* This is a macro and not first class functions so that the debugger * This is a macro and not first class functions so that the debugger breaks
* breaks on the source code line that used SDL_TriggerBreakpoint and * on the source code line that used SDL_TriggerBreakpoint and not in some
* not in some random guts of SDL. SDL_assert uses this macro for the * random guts of SDL. SDL_assert uses this macro for the same reason.
* same reason.
* *
* If the program is not running under a debugger, SDL_TriggerBreakpoint * If the program is not running under a debugger, SDL_TriggerBreakpoint will
* will likely terminate the app, possibly without warning. If the * likely terminate the app, possibly without warning. If the current platform
* current platform isn't supported (SDL doesn't know how to trigger a * isn't supported (SDL doesn't know how to trigger a breakpoint), this macro
* breakpoint), this macro does nothing. * does nothing.
* *
* \threadsafety It is safe to call this function from any thread. * \threadsafety It is safe to call this function from any thread.
* *