(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_TriggerBreakpoint

Attempt to tell an attached debugger to pause.

Header File

Defined in <SDL3/SDL_assert.h>

Syntax

#define SDL_TriggerBreakpoint() TriggerABreakpointInAPlatformSpecificManner

Remarks

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--not a function--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.

Thread Safety

It is safe to call this macro from any thread.

Version

This macro is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIMacro, CategoryAssert

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.