geemili
/
SDL
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

main
SDL Wiki Bot 2024-04-14 05:50:22 +00:00
parent 291edc073c
commit 11de629dd2
1 changed files with 10 additions and 11 deletions
Show Stats 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 */
#ifdef SDL_WIKI_DOCUMENTATION_SECTION
/**
* Attempt to tell an attached debugger to pause.
*
* This allows an app to programmatically halt ("break") the debugger
* as if it had hit a breakpoint, allowing the developer to examine
* program state, etc.
* This allows an app to programmatically halt ("break") the debugger as if it
* had hit a breakpoint, allowing the developer to examine program state, etc.
*
* This is a macro and not first class functions so that the debugger
* breaks on the source code line that used SDL_TriggerBreakpoint and
* not in some random guts of SDL. SDL_assert uses this macro for the
* same reason.
* This is a macro and not first class functions so that the debugger breaks
* on the source code line that used SDL_TriggerBreakpoint and not in some
* random guts of SDL. SDL_assert uses this macro for the same reason.
*
* If the program is not running under a debugger, SDL_TriggerBreakpoint
* will likely terminate the app, possibly without warning. If the
* current platform isn't supported (SDL doesn't know how to trigger a
* breakpoint), this macro does nothing.
* If the program is not running under a debugger, SDL_TriggerBreakpoint will
* likely terminate the app, possibly without warning. If the current platform
* isn't supported (SDL doesn't know how to trigger a breakpoint), this macro
* does nothing.
*
* \threadsafety It is safe to call this function from any thread.
*